[Index]

Model: data/CallManager

CUCM

Use this procedure to configure Cisco Unified Communications Manager servers within a Unified CM cluster.

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

Procedure

  1. Log in as the appropriate hierarchy administrator.

    Only a provider or reseller administrator can create a shared instance. A customer, provider, or reseller administrator can create a dedicated instance.

  2. Set the hierarchy path to the correct level. Create a shared instance at the provider or reseller level. Create a dedicated instance at the customer level.

  3. Choose Device Management > CUCM > Servers.

  4. Click Add.

  5. Enter the Unified CM server name in the CUCM Server Name field.

    Note: A Unified CM server that has been configured in HCM-F and synced into VOSS-4-UC may exist at the sys.hcs hierarchy. If the server name you enter matches this server, the Migrate from HCM-F to VOSS-4-UC check box is displayed. Click Save to migrate this server to the current hierarchy level. The fields are populated with the values that were configured in HCM-F. If you do not want to migrate the server, enter a different server name.

  6. From the Server Type drop-down, choose Voice/Video.

  7. To configure a publisher node, select the Publisher check box.

    On the Publisher tab, you can specify the following information:

    Field Description
    Prime Collaboration

    Choose the Prime Collaboration management application monitoring this cluster.

    To unassociate Prime Collaboration for this cluster, choose None.

    Call Processing ID The Call Processing ID of this cluster
    SDR Cluster ID The SDR CUCM cluster ID, as shown on SDR Configuration > SDR CUCM Clusters.
    Multi-Tenant Read-only field. If creating at provider level, this field is set to Shared. If creating at customer level, this field is set to Dedicated.
    Version Choose the version of the Unified CM Servers in this cluster. The available versions depend on the version of the HCM-F device that has been configured.
    Port The port on the Unified CM server to connect to. Default is 8443.
    User Move Mode Choose Automatic to automatically move synced in users to sites, based on the filters and filter order defined in User Management > Manage Filters. Choose Manual if you want an Administrator to manually move synced in users to a Site.
    User Entitlement Profile

    Choose the Entitlement Profile that specifies which devices and services users synced from this Unified CM are entitled to.

    Note:

    A violation of the Entitlement Profile does not prevent a user from being synced to VOSS-4-UC from Unified CM. However, subsequent updates to the user fail until the user's configuration satisfies the restrictions set in the Entitlement Profile.

    Enable Change Notification Sync Select this check box to enable Change Notification. By enabling this, a Change Notification data sync and corresponding Schedule will be created. The Schedule is initially created as Disabled and needs to be manually enabled from the Scheduling menu. The Change Notification Sync interval is set to 14 days by default. See the note below this table.

    Refer to the topic on the Change Notification Feature (CNF) following CNF overview.

  8. For a Unified CM Publisher node, fill in the Cluster Name field with the name you want for this cluster. A new cluster is created with this name. This field is required. For Unified CM Subscribers, choose the Unified CM cluster from the Cluster Name drop-down menu.

  9. Expand Network Addresses.

    1. Choose the SERVICE_PROVIDER_SPACE address space.
    2. The Hostname field is automatically populated with the Unified CM Server Name. Edit it if necessary.
    3. Enter the IP address of the Cisco Unified Communications Manager Server in the IPv4 Address field. Note: Either the hostname or the IP address is required. Ensure that the hostname or IP address does not contain a trailing blank space. VOSS-4-UC cannot validate an entry that contains a blank space at the end of the hostname or IP address.
    4. Fill in the domain of the Unified CM application.
    5. Provide an optional description for the network address.

    If NAT is used, also configure an APPLICATION_SPACE network address.

  10. Expand Credentials.

    1. Add credentials for PLATFORM, ADMIN, HTTP, and SNMP_Vx credential types. Click + to add more credentials.
    2. Fill in the user ID and password that you configured when you installed the Unified CM.
    3. Choose RO (Read-only) or RW (Read or Write) for the Access Type. The default is RO.
    4. Provide an optional description for the credential.

    ADMIN, HTTP, PLATFORM, and SNMP are required for PCA to manage Unified CM. PLATFORM and ADMIN are also required for Service Inventory to generate reports for UC applications.

    Note:

    Expiration of the ADMIN account results in failed data syncs between Unified CM and VOSS-4-UC

  11. On the Field Mappings tab, complete field mappings as desired. Hard-coded mappings appear in gray and cannot be modified.

  12. Click Save. A Unified CM network device is created in VOSS-4-UC.

  13. Test the connection between Unified CM and VOSS-4-UC

    1. Choose Device Management > Advanced > CUCM Network Device.
    2. Click the Unified CM you just added.
    3. Choose Action > Test Connection.

    If the test fails, and you used a hostname, make sure VOSS-4-UC has the correct DNS and Domain set.

    1. Log in to the platform CLI.
    2. Query the current DNS setting: network dns.
    3. Set the DNS if needed: network dns <dns_server_ip_address>.
    4. Query the current domain setting: network domain.
    5. Set the domain if needed: network domain <domain>.

    Note:

    Use the CUCM Network Device page only for testing the connection. Do not edit Unified CM from this page. To change any configuration of the Unified CM, edit it from the Device Management > CUCM > Servers page in VOSS-4-UC.

The model that stores the connection parameters of a Cisco Unified Communications Manager.

Model Details

Title Description Details
Description The description of the Cisco Unified Communications Manager.
  • Field Name: description
  • Type: String
Host Name * The host name of the Cisco Unified Communications Manager.
  • Field Name: host
  • Type: String
Admin Username * The administrator Username to connect to the Cisco Unified Communications Manager.
  • Field Name: username
  • Type: String
Admin Password * The administrator Password associated with the Username to connect to the Cisco Unified Communications Manager. The text will be hidden.
  • Field Name: password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Version * The selected version of the Cisco Unified Communications Manager to connect to. The list of versions is maintained in the CallManagerVersion model.
  • Field Name: version
  • Type: String
  • Choices: ["9.1", "10.0", "10.5", "11.5", "12.5"]
Port The port on the Cisco Unified Communications Manager server to connect to. Default: 8443
  • Field Name: port
  • Type: String
  • Default: 8443
Immediate Import Deprecated.
  • Field Name: import
  • Type: Boolean
CUCM Cluster Notes CUCM Cluster Notes Field
  • Field Name: notes
  • Type: String
API reference for data/CallManager