[Index]

Model: relation/HcsPrimeCollabREL

Prime Collaboration Servers

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

These workflow steps allow you to integrate VOSS-4-UC with Prime Collaboration Assurance.

Prerequisites:

Perform these steps:

  1. Configure Prime Collaboration Assurance.

  2. Set up Prime Collaboration Assurance to monitor the Unified Computing System.

  3. Add the Service Provider space and Application space under Address space information when adding Cisco Unity Connection and Cisco IM and Presence server to VOSS-4-UC. Prime Collaboration Assurance uses the server's Service provider space to monitor the applications. See Set Up IM and Presence Service Servers

  4. Add Cisco IM and Presence Service subnode information to VOSS-4-UC if you have multiple instances of Cisco IM and Presence Service deployed.

  5. Ensure that your Unified Communications applications have all the needed credentials. At a minimum, you require credentials for Administration, platform, SNMP, JTAPI, and HTTP.

    Note:

    Depending on what you are monitoring, other credentials may be needed. For more information about the required protocols, support, and credentials to set up devices for Prime Collaboration Assurance monitoring, see:

    http://docwiki.cisco.com/wiki/Setting_up_Devices_for_Prime_Collaboration_Assurance.

  6. Synchronize your customer information with VOSS-4-UC. See Set Up Cisco Unified Communications Manager Servers for more information.

  7. (Optional) Ensure that the Session Border Controller has the required credentials in Hosted Collaboration Mediation-Fulfillment.

  8. Ensure that the CPE (analog gateway or LBO deployed at CPE) has the required credentials in VOSS-4-UC under Devices.

  9. Enter the SNMP commands manually on the Local Break Out (LBO) gateway or analog gateway. This task is required to manage the LBO gateway and analog gateway in Prime Collaboration Assurance.

    Note:

    IOS default command builder does not generate SNMP commands. The administrator must manually enter the SNMP commands.

  10. Add Prime Collaboration Assurance to VOSS-4-UC (Device Management > Prime Collab > Servers). (Administration and SFTP credentials are required.)

  11. Onboard the customer to Prime Collaboration Assurance using the Cisco Unified Communications Manager administrative interface. In HCMF, the CHPA pushes SNMP, Syslog, and Billing server configuration information to your VOSS-4-UC automatically. Add Syslog and SNMP configurations manually for Cisco Unity Connection and IM and Presence Service before onboarding.

    Note:

    Configure these credentials in Unified CM nodes to ensure a successful CHPA configuration:

    Note:

    This configuration is pushed to Unified CM:

    Note:

    JTAPI credentials are optional credentials used for TelePresence session monitoring. They are used to retrieve session status information from TelePresence devices. Create a JTAPI user in the Unified Communications Manager with the required permission to receive JTAPI events on endpoints. The credentials must be manually configured in Unified CM. Note also that Prime Collaboration Assurance manages multiple call processor clusters and as a result you must ensure that the cluster IDs are unique.

  12. Synchronize Active Directory users with VOSS-4-UC.

    Note: Only users at the provider hierarchy are pushed to PCA.

  13. To confirm if the Cisco HCM-F (if installed) push and subsequent Device Discovery were successful, verify that the devices are managed in Prime Collaboration Assurance. Review the Current Inventory table at Operate > Device Work Center (Prime Collaboration Assurance 10.5.1) or Device Inventory > Inventory Management (Prime Collaboration Assurance 11.5 or later). Devices appear in Inventory Management with the Managed status. For details on the Prime Collaboration Assurance Inventory table, see the Manage Inventory section of Cisco Prime Collaboration Assurance Guide Advanced, available at:

    http://www.cisco.com/c/en/us/support/cloud-systems-management/prime-collaboration/products-user-guide-list.html.

    Note:

    In Cisco HCM-F (if installed), you may receive a Credential-related error message, but there can be other reasons for this error, such as a firewall issue. We recommend that you use Prime Collaboration Assurance to verify that devices are managed. If a device is not going into the managed state successfully, refer to the Troubleshooting section of the Discover Devices chapter in Cisco Prime Collaboration Assurance Guide Advanced for troubleshooting tips.

    A list of the devices supported by Prime Collaboration Assurance is available at:

    http://www.cisco.com/c/en/us/support/cloud-systems-management/prime-collaboration/products-device-support-tables-list.html.

  14. Check the Prime Collaboration Assurance dashboard.

    See UC Performance Monitor Dashboards in the Cisco Prime Collaboration Assurance Guide Standard or Cisco Prime Collaboration Assurance Guide Advanced and Analytics Guide.

  15. Monitor components and devices with Prime Collaboration Assurance.

Prime Collaboration Servers

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

These workflow steps allow you to integrate VOSS Automate with Prime Collaboration Assurance (PCA).

Prerequisites:

Perform these steps:

  1. Configure PCA.

  2. Set up PCA to monitor the Unified Computing System.

  3. Add the Service Provider space and Application space under Address space information when adding Cisco Unity Connection (CUC) and Cisco IM and Presence server to VOSS Automate. PCA uses the server's Service provider space to monitor the applications. See Set Up IM and Presence Service Servers

  4. Add Cisco IM and Presence Service subnode information to VOSS Automate if you have multiple instances of Cisco IM and Presence Service deployed.

  5. Ensure that your Unified Communications applications have all the needed credentials. At a minimum, you require credentials for Administration, platform, SNMP, JTAPI, and HTTP.

    Note

    Depending on what you are monitoring, other credentials may be needed. For more information about the required protocols, support, and credentials to set up devices for Prime Collaboration Assurance monitoring, see:

    http://docwiki.cisco.com/wiki/Setting_up_Devices_for_Prime_Collaboration_Assurance.

  6. Synchronize your customer information with VOSS Automate. See Set Up Cisco Unified Communications Manager Servers for more information.

  7. (Optional) Ensure that the Session Border Controller has the required credentials in Hosted Collaboration Mediation-Fulfillment (HCMF).

  8. Ensure that the CPE (analog gateway or LBO deployed at CPE) has the required credentials in VOSS Automate under Devices.

  9. Enter the SNMP commands manually on the Local Break Out (LBO) gateway or analog gateway. This task is required to manage the LBO gateway and analog gateway in Prime Collaboration Assurance.

    Note

    IOS default command builder does not generate SNMP commands. The administrator must manually enter the SNMP commands.

  10. Add PCA to VOSS Automate (Apps Management > Prime Collab > Servers). (Administration and SFTP credentials are required.)

  11. Onboard the customer to PCA, using the Cisco Unified Communications Manager (CUCM) administrative interface. In HCMF, the CHPA pushes SNMP, Syslog, and Billing server configuration information to your VOSS Automate automatically. Add Syslog and SNMP configurations manually for Cisco Unity Connection (CUC) and IM and Presence Service before onboarding.

    Note

    • Configure these credentials in Unified CM nodes to ensure a successful CHPA configuration:
      • Administration credentials for Unified CM
      • Platform credentials for Unified CM
      • SNMP and HTTP credentials for Unified CM
      • SFTP for Prime Collaboration Assurance
    • This configuration is pushed to Unified CM (CUCM):
      • The SNMP community string
      • CDR (SFTP of the Prime Collaboration Assurance server)
      • Syslog configuration
    • JTAPI credentials are optional credentials used for TelePresence session monitoring. They are used to retrieve session status information from TelePresence devices. Create a JTAPI user in the Unified Communications Manager with the required permission to receive JTAPI events on endpoints. The credentials must be manually configured in Unified CM. Note also that Prime Collaboration Assurance manages multiple call processor clusters and as a result you must ensure that the cluster IDs are unique.
  12. Synchronize Active Directory users with VOSS Automate.

    Note

    Only users at the provider hierarchy are pushed to PCA.

  13. To confirm if the Cisco HCM-F (if installed) push and subsequent Device Discovery were successful, verify that the devices are managed in PCA.

    Review the Current Inventory table at Operate > Device Work Center (Prime Collaboration Assurance 10.5.1) or Device Inventory > Inventory Management (Prime Collaboration Assurance 11.5 or later). Devices appear in Inventory Management with the Managed status.

    For details on the Prime Collaboration Assurance Inventory table, see the Manage Inventory section of Cisco Prime Collaboration Assurance Guide Advanced, available at:

    http://www.cisco.com/c/en/us/support/cloud-systems-management/prime-collaboration/products-user-guide-list.html.

    Note

    In Cisco HCM-F (if installed), you may receive a Credential-related error message, but there can be other reasons for this error, such as a firewall issue. We recommend that you use PCA to verify that devices are managed. If a device is not going into the managed state successfully, refer to the Troubleshooting section of the Discover Devices chapter in Cisco Prime Collaboration Assurance Guide Advanced for troubleshooting tips.

    A list of the devices supported by Prime Collaboration Assurance is available at:

    http://www.cisco.com/c/en/us/support/cloud-systems-management/prime-collaboration/products-device-support-tables-list.html.

  14. Check the PCA dashboard.

    See UC Performance Monitor Dashboards in the Cisco Prime Collaboration Assurance Guide Standard or Cisco Prime Collaboration Assurance Guide Advanced and Analytics Guide.

  15. Monitor components and devices with Prime Collaboration Assurance.

Prime Collaboration Servers

Full HTML Help

These workflow steps allow you to integrate VOSS Automate with Prime Collaboration Assurance (PCA).

Prerequisites:

Perform these steps:

  1. Configure PCA.

  2. Set up PCA to monitor the Unified Computing System.

  3. Add the Service Provider space and Application space under Address space information when adding Cisco Unity Connection (CUC) and Cisco IM and Presence server to VOSS Automate. PCA uses the server's service provider space to monitor the applications. See Set Up IM and Presence Service Servers.

  4. Add Cisco IM and Presence Service subnode information to VOSS Automate if you have multiple instances of Cisco IM and Presence Service deployed.

  5. Ensure that your UC applications have all required credentials. At minimum, credentials are required for Administration, platform, SNMP, JTAPI, and HTTP.

    Note

    Other credentials may be required, depending on what you're monitoring. For more information about the required protocols, support, and credentials to set up devices for PCA monitoring, see:

    https://www.cisco.com/c/en/us/td/docs/net_mgmt/prime/collaboration/setting_up_devices/PCA_12-1/Setting_up_Devices_for_Cisco_Prime_Collaboration_Assurance.html

  6. Sync your customer information with VOSS Automate. See Set Up Cisco Unified Communications Manager Servers for details.

  7. Ensure that the CPE (analog gateway, or LBO deployed at CPE) has the required credentials in VOSS Automate under Devices.

  8. Enter the SNMP commands manually on the Local Break Out (LBO) gateway or analog gateway. This task is required to manage the LBO gateway and analog gateway in PCA.

    Note

    IOS default command builder does not generate SNMP commands. The administrator must enter SNMP commands.

  9. Add PCA to VOSS Automate (default menus: Apps Management > Prime Collab > Servers). Administration and SFTP credentials are required.

  10. Onboard the customer to PCA, using the Cisco Unified Communications Manager (CUCM) admin interface.

    Note

    Configure these credentials in CUCM nodes to ensure a successful CHPA configuration:

    • Administration credentials for CUCM
    • Platform credentials for CUCM
    • SNMP and HTTP credentials for CUCM
    • SFTP for PCA

    This configuration is pushed to CUCM:

    • The SNMP community string
    • CDR (SFTP of the PCA server)
    • Syslog configuration

    JTAPI credentials are optional credentials used for TelePresence session monitoring. They are used to retrieve session status information from TelePresence devices. Create a JTAPI user in the CUCM with the required permission to receive JTAPI events on endpoints. The credentials must be manually configured in CUCM.

    PCA manages multiple call processor clusters and as a result you must ensure that the cluster IDs are unique.

  11. Sync Active Directory users with VOSS Automate.

    Note

    Only users at the provider hierarchy are pushed to PCA.

  12. Check the PCA dashboard.

    See UC Performance Monitor Dashboards in the Cisco Prime Collaboration Assurance Guide Standard or Cisco Prime Collaboration Assurance Guide Advanced and Analytics Guide.

  13. Monitor components and devices with Prime Collaboration Assurance.

Model Details: relation/HcsPrimeCollabREL

Title Description Details
id
  • Field Name: id
  • Type: String
  • MaxLength: 1024
Server Name *
  • Field Name: name
  • Type: String
  • MaxLength: 64
Description
  • Field Name: description
  • Type: String
  • MaxLength: 128
Type Deployment Mode
  • Field Name: typeDeploymentMode
  • Type: String
  • MaxLength: 1024
  • Choices: ["HCS", "HCS_LE", "ENTERPRISE"]
Is Auto Linked Default: True
  • Field Name: isAutoLinked
  • Type: Boolean
  • Default: True
Routing Id
  • Field Name: routingId
  • Type: String
  • MaxLength: 128
Management Network *
  • Field Name: managementNetwork
  • Type: String
  • Target: data/HCSHcmfManagementNetworkDAT
  • MaxLength: 1024
  • Format: uri
Virtual Machine
  • Field Name: virtualMachine
  • Type: String
  • Target: data/HCSHcmfVirtualMachineDAT
  • MaxLength: 1024
  • Format: uri
Owns Org Unit
  • Field Name: ownsOrgUnit
  • Type: String
  • Target: data/HCSHcmfOrgUnitDAT
  • MaxLength: 1024
  • Format: uri
Credentials
  • Field Name: credentials.[n]
  • Type: Array
Description
  • Field Name: credentials.[n].description
  • Type: String
  • MaxLength: 128
Type Credential *
  • Field Name: credentials.[n].typeCredential
  • Type: String
  • MaxLength: 1024
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
User ID
  • Field Name: credentials.[n].userID
  • Type: String
  • MaxLength: 256
Password Community String
  • Field Name: credentials.[n].password_CommunityString
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 512
Type SNMP Access Default: RO
  • Field Name: credentials.[n].typeSNMPAccess
  • Type: String
  • Default: RO
  • MaxLength: 1024
  • Choices: ["RO", "RW"]
Network Addresses
  • Field Name: networkAddresses.[n]
  • Type: Array
Type Address Space *
  • Field Name: networkAddresses.[n].typeAddressSpace
  • Type: String
  • MaxLength: 1024
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
Description
  • Field Name: networkAddresses.[n].description
  • Type: String
  • MaxLength: 128
IP Addr V4
  • Field Name: networkAddresses.[n].iPAddrV4
  • Type: String
  • MaxLength: 64
IP Addr V6
  • Field Name: networkAddresses.[n].iPAddrV6
  • Type: String
  • MaxLength: 64
Host Short Name Only
  • Field Name: networkAddresses.[n].hostShortNameOnly
  • Type: String
  • MaxLength: 128
Domain
  • Field Name: networkAddresses.[n].domain
  • Type: String
  • MaxLength: 128
Is SRV Address *
  • Field Name: networkAddresses.[n].isSRVAddress
  • Type: Boolean
Management Network Id
  • Field Name: bkManagementNetwork_id
  • Type: String
  • Target: data/HCSHcmfManagementNetworkDAT
  • Target attr: id
  • MaxLength: 1024
  • Format: uri
Shadow
  • Field Name: shadow
  • Type: Object
Name *
  • Field Name: shadow.name
  • Type: String
  • MaxLength: 1024