CUCM Servers#
Add a CUCM Server#
This procedure adds and configures a Cisco Unified Communications Manager (CUCM) server within a CUCM cluster.
Note
References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.
Log in to the VOSS Admin portal with the appropriate hierarchy administrator credentials.
Note
Log in as a Provider or Reseller administrator if you’re creating a shared instance.
Log in as a Customer, Provider, or Reseller administrator to create a dedicated instance.
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) Apps Management > CUCM > Servers.
Click Add.
Configure server details on the Base tab:
At CUCM Server Name, fill out the CUCM server name.
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 checkbox 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.
If you’re configuring a publisher node, select the Publisher checkbox. This displays an additional tab (Publisher tab).
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.
At Server Type, choose an option, either VOICE_VIDEO or IM_P.
To trigger a sync (auto-import) of the UC app server when saving the form, select Sync on Create/Update.
Expand Network Addresses, and add network addresses, one or more:
At Address Space (the type of network address) , choose SERVICE_PROVIDER_SPACE.
Important
If NAT is used, you’ll need to add an additional network address (click the Plus icon at Network Addresses), but choose option APPLICATION_SPACE as the second address space.
Further configuration of NAT on Arbitrator is automated.
For more information around setting up assets and probes on Insights Arbitrator, see the Insights documentation.
The Hostname field is automatically populated with the CUCM server name. Edit it if necessary.
Fill out the IP address of the CUCM server in the IPv4 Address field.
Note
Either the hostname or the IP address is required. Ensure the hostname or IP address does not contain a trailing blank space since VOSS Automate can’t validate entries that contain a blank space at the end of the hostname or IP address.
Fill out the domain of the CUCM application.
Provide an optional description for the network address.
Expand Credentials, then 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 installing the CUCM.
For Access Type, choose RO (Read-only) or RW (Read or Write). The default is RO.
Provide an optional description for the credential.
Note
Access type is relevant only for SNMP since SNMP credentials are pushed to the UC application.
ADMIN, HTTP, PLATFORM, and SNMP are required for PCA to manage CUCM.
PLATFORM and ADMIN are also required for Service Inventory to generate reports for UC applications.
Expiration of the ADMIN account results in failed data syncs between CUCM 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
Fill out fields on the Publisher tab:
Note
This tab displays only if you’ve selected the Publisher checkbox on the Base tab.
Field
Description
Prime Collab
Choose the Prime Collaboration management application monitoring this cluster.
To un-associate 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.
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.
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.
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.
Monitoring
For new servers and if Arbitrator servers are available, monitoring can be enabled for this CUCM on VOSS Insights.
The Arbitrator server checkboxes 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.
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.
Related Topics
For details on monitoring and VOSS Insights, refer to Introduction to VOSS Insights Monitoring.
For more information on Change Notification Feature (CNF) see Introduction to Change Notification Sync.
Test Connection - CUCM Server to VOSS Automate#
Once you’ve added a CUCM server, you should test the connection between the CUCM server and VOSS Automate.
In the VOSS Automate Admin Portal, to to (default menus) Apps 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. Refer to the Network services topic in the Platform Guide.
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 Apps Management > CUCM > Servers in VOSS Automate.
After updating DNS servers, you’ll need to restart the selenium service on the platform CLI:
app start selenium
Delete a CUCM Server#
Deleting a Cisco Unified Communications Manager (CUCM) Server in VOSS Automate also deletes local data that has been synced to it from the Cisco Unified Communications Manager Server, including:
Users
Configuration parameters
Dial Plan Information (if applicable)
Set Up IM and Presence Service Servers#
This procedure configures IM and Presence Service servers within a Cisco Unified Communications Manager (CUCM) cluster.
Note
References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.
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.
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) Apps Management > CUCM > Servers.
Click Add.
Enter the IM and Presence Service server name in the CUCM Server Name field.
Note
An IM and Presence Service 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 checkbox 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.
From the Server Type drop-down, choose IM_P.
To configure a publisher node, select the Publisher check box.
Note
The Publisher tab is not populated for an IM and Presence Service publisher node.
Select the CUCM cluster from the Cluster Name drop-down.
Expand Network Addresses.
Select the SERVICE_PROVIDER_SPACE address space.
The Hostname field is automatically populated with the IM and Presence Service Server Name. Edit it if necessary.
Enter the IP address of the IM and Presence Service 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 IM and Presence Service application.
Provide an optional description for the network address.
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 in the user ID and password that you configured when you installed the IM and Presence Service.
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 IM & Presence Service. PLATFORM and ADMIN are also required for Service Inventory to generate reports for UC applications.
Click Save.