Set Up CUCM Servers¶
This procedure configures Cisco Unified Communications Manager (CUCM) servers within a CUCM cluster.
Note
References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.
Perform these steps:
Log in as the appropriate hierarchy administrator.
Note
Only a Provider or Reseller administrator may create a shared instance. To create a dedicated instance, you can be a Customer, Provider, or Reseller administrator.
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.
Go to (default menus) Device Management > CUCM > Servers.
Click Add.
Enter the CUCM server name in the CUCM Server Name field.
Note
A CUCM server that has been configured in HCM-F and synced into VOSS Automate may exist at the sys.hcs hierarchy. If the server name you enter matches this server, the Migrate from HCM-F to VOSS Automate check box displays.
To migrate this server to the current hierarchy level, click Save. The fields are populated with the values configured in HCM-F. If you don’t want to migrate the server, enter a different server name.
From the Server Type drop-down, choose Voice/Video.
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 Automate 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.
Monitoring
For new servers and if arbitrator servers are available, monitoring can be enabled for this Unified CM on VOSS Insights.
The arbitrator server check boxes can be selected to add the server as an asset. The arbitrator server will be updated.
Existing servers can be managed from the Onboard Assets and Offboard Assets menus under VOSS Insights. The arbitrator checkboxes will then reflect the asset status.
For details on monitoring and VOSS Insights, refer to VOSS Insights Monitoring Overview.
Refer to the topic on the Change Notification Feature (CNF) following Change Notification Feature Overview.
Mandatory. For a CUCM Publisher node, fill out the Cluster Name field with the name you want for this cluster. A new cluster is created with this name. For CUCM Subscribers, choose the CUCM cluster from the Cluster Name drop-down menu.
Expand Network Addresses.
Choose the SERVICE_PROVIDER_SPACE address space.
The Hostname field is automatically populated with the CUCM Server Name. Edit it if necessary.
Enter the IP address of the CUCM 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 Automate cannot validate an entry that contains a blank space at the end of the hostname or IP address.
Fill in the domain of the CUCM application.
Provide an optional description for the network address.
Note
If NAT is used, also configure an APPLICATION_SPACE network address.
Expand Credentials:
Add credentials for PLATFORM, ADMIN, HTTP, and SNMP_Vx credential types. Click + to add more credentials.
Fill out the user ID and password that you configured when you installed the Unified CM.
Choose RO (Read-only) or RW (Read or Write) for the Access Type. The default is RO.
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 Automate
The CUCM Admin Account requires the following roles (can be added in a group):
For normal AXL Add, Update, Delete transactions you need: Standard AXL API Access
For the Extension Mobility Login/Logout you need: Standard EM Authentication Proxy Rights
For querying the Phone Status via RIS API, uploading MOH files via GUI (Selenium Driver) and enabling Headset Service (also RIS API) you need: Standard CCM Admin Users
Inspect the default mappings and modify if required, see User Field Mapping.
Click Save. A CUCM network device is created in VOSS Automate. (If installed, a cluster and CUCM are created in the SDR.)
Test the connection between CUCM and VOSS Automate:
Go to (default menus) Device Management > Advanced > CUCM Network Device.
Click the CUCM you just added.
Choose Action > Test Connection.
If the test fails, and you used a hostname, ensure that VOSS Automate has the correct DNS and Domain set.
Log in to the platform CLI.
Query the current DNS setting: network dns.
Set the DNS if needed: network dns <dns_server_ip_address>.
Query the current domain setting: network domain.
Set the domain if needed: network domain <domain>.
Note
Use the CUCM Network Device page only for testing the connection. Do not edit CUCM from this page. To change any configuration of the CUCM, edit it via Device Management > CUCM > Servers in VOSS Automate.