Cisco UCM configuration#

Overview#

Cisco Unified Communications Manager (UCM) devices provide the core call processing capabilities for HCS, and are a critical part of the Automate provisioning workflows.

UCM devices must be configured before setting up the dial plan (if applicable), user, line, and phone configuration.

UCM devices must then be assigned to one or more Network Devices Lists (NDLs). The NDL is then assigned to one or more sites. The NDL is used to choose the UCM used for configuration, based on the site selected in the hierarchy context.

Related topics

Shared versus dedicated UCM#

UCM devices can be dedicated to a specific customer, or they can be shared between multiple customers.

  • To share the UCM across multiple customers, add the UCM at the Provider or Reseller hierarchy level.

  • To dedicate the UCM to a single customer, add the UCM at the Customer hierarchy level.

    When setting up UCM as a dedicated instance, you can choose to set up UCM after you create the customer.

Servers within a UCM cluster#

Within a UCM cluster, you can configure the following nodes:

  • Cisco Unified Communications Manager Publisher node

    Note

    Configure a UCM Publisher node before configuring any other type node.

  • Cisco UCM Subscriber node

  • IM and Presence Service Publisher node

    Note

    Configure an IM and Presence Service Publisher node before configuring an IM and Presence Service Subscriber node.

  • IM and Presence Service Subscriber node

Sync with Automate#

Configuring a UCM device on Automate creates a scheduled data sync to import model data from the device into Automate.

Note

Some license-related models are excluded from UCM imports by default:

  • device/cucm/LicensedUser

  • device/cucm/LicensingResourceUsage

  • device/cucm/HcsLicense

  • device/cucm/CiscoCloudOnboarding

  • device/cucm/RegistrationDynamic

  • device/cucm/RoutePlan

The scheduled data sync ensures that the Automate cache maintains the most current view of the configured device. Any changes to the configuration occurring on the device, including additions, deletions, or modifications, reflect in Automate after the next data sync.

Note

  • There is no immediate data sync upon update or modification.

  • The scheduled data sync fails if the CUCM administrator account credential has expired. Expiration of the administrator account credential can cause failures in user management activities as well.

The recurring sync is scheduled to occur every 14 days, but is disabled by default. You can enable the sync and modify the schedule via the (CUCM) Schedules page.

When determining the appropriate schedule setting, the frequency of the sync must be weighed against the additional processing and network activity associated with the data sync. You can also manually run the data sync at any time via the Data Sync page.

Important

Allow the initial data sync to complete before doing more configuration on Automate that requires information from CUCM.

To improve the performance of a data sync, control the types of data synced in. See Controlling a Data Sync with a Model Type List for more information.

For details on Change Notification Sync in Automate and on switching between Full Sync and Change Notification Sync, refer to the topic on the Change Notification Feature (CNF) following Introduction to Change Notification Sync.

Field mappings in Cisco UCM#

When setting up a CUCM device with LDAP integration, you can map CUCM user data to Automate user data for any field, based on the Field Mappings in the CUCM server. These mappings are configured at the LDAP Directory in CUCM. The mapped user data, for example location data, can later be used in a filter used to move users to sites.

On the Field Mappings tab, you can modify the mappings except for hard-coded mappings. Hard-coded mappings appear in gray and are read-only.

Note

The field name entered in the mapping on Automate must exactly match the field name entered in the mapping in the UCM in the Custom User Field Name field. If the field names do not match, the field is skipped during the sync.

Related topics