CUCM Servers#

Add a CUCM server#

This procedure adds and configures a Cisco Unified Communications Manager (CUCM) server within a CUCM cluster.

  1. Log in to the Automate Admin portal with the appropriate hierarchy administrator credentials.

    • Creating a shared instance? Log in as provider or reseller admin.

    • Creating a dedicated instance? Log in as customer, provider, or reseller admin.

  2. Set the hierarchy path to the correct level:

    • Creating a shared instance? Set the hierarchy to the provider or reseller level.

    • Creating a dedicated instance? Set the hierarchy to the customer level.

  3. Use the Action search to open the CUCM Servers (all Servers) list view.

  4. Click the Plus icon (+) to add a new server.

  5. On the Base tab/panel, configure server details:

    Field

    Description

    CUCM Server Name

    Fill out the CUCM server name.

    Publisher

    When checked, defines that the UC application instance is a publisher, and displays an additional tab/panel (Publisher).

    When unchecked, defines that the UC application instance is a subscriber.

    When checked, you’ll fill out the Publisher tab/panel fields in the next step.

    Cluster Name

    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.

    Server Type

    Mandatory. Choose an option, either VOICE_VIDEO or IM_P.

    Sync on Create/Update

    Defines whether to trigger a sync (auto-import) of the UC app server when saving the form.

    Network Addresses

    Add network addresses, one or more. Click the Plus icon to add a network address, then fill out details:

    • At Address Space (the type of network address), select SERVICE_PROVIDER_SPACE.

      If NAT is used, you’ll need to add an additional network address (click the Plus icon at Network Addresses), but select address space option APPLICATION_SPACE as the second address space. Additional 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.

    • At IPv4 Address, fill out the IP address of the CUCM server.

      Either the hostname or the IP address is required. Ensure the hostname or IP address does not contain a trailing blank space since 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.

    Field

    Description

    Credentials

    Click the Plus icon to add a set of credentials, one or more:

    • Credential type is ADMIN. This credential is required for Service Inventory to generate reports for UC applications. Expiration of the ADMIN account results in failed data syncs between CUCM and Automate.

    • Fill out the user ID and password that you configured when installing the CUCM.

    • Optionally, provide a description for the credential.

    The CUCM Admin Account requires the following roles (can be added in a group):

    • For normal AXL Add, Update, Delete transactions: Standard AXL API Access

    • For Extension Mobility Login/Logout: 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): Standard CCM Admin Users

  6. On the Publisher tab/panel, fill out details for the publisher node.

    Note

    This tab/panel displays only if the Publisher checkbox is selected on the Base tab/panel.

    Field

    Description

    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 CUCM servers in this cluster.

    Multi-Tenant

    Read-only. 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 CUCM 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

    Defines whether to enable Change Notification. When enabled, 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.

  7. Inspect the default mappings and modify if required, see User field mapping.

  8. Click Save. A CUCM network device is created in VOSS Automate. (If installed, a cluster and CUCM are created in the SDR.)

  9. Test the connection between CUCM and Automate.

Related Topics

Test the connection from the CUCM server to Automate#

Once you’ve added a CUCM server, you should test the connection between the CUCM server and VOSS Automate.

  1. In the Automate Admin Portal, use the Action search to open the CUCM Network Devices list view.

  2. Click on the CUCM you added.

  3. Click the toolbar Test Connection icon.

  4. If the test fails, and you used a hostname, ensure that Automate has the correct DNS and Domain set. Refer to the Network services topic in the Platform Guide.

    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 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 CUCM server, including:

  • Users

  • Configuration parameters

  • Dial plan information (if applicable)

Restore a CUCM server#

When restoring a CUCM server from a backup, you will need to run a full sync without workflows after the restore, then run the overbuild to return your records to the correct sites.

Set Up IM and Presence Service servers#

This procedure configures IM and Presence Service servers within a Cisco Unified Communications Manager (CUCM) cluster.

  1. Log in as the appropriate hierarchy administrator.

    • Creating a shared instance? Log in as provider or reseller admin.

    • Creating a dedicated instance? Log in as customer, provider, or reseller admin.

  2. Set the hierarchy path to the correct level:

    • Creating a shared instance? Set the hierarchy to the provider or reseller level.

    • Creating a dedicated instance? Set the hierarchy to the customer level.

  3. Use the Action search to open the CUCM Servers (all Servers) list view, then click the Plus icon (+) to add a new server.

  4. At CUCM Server Name, fill out the IM and Presence Service server name.

  5. At Server Type, select IM_P.

  6. 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.

  7. At Cluster Name, select the CUCM cluster.

  8. Expand Network Addresses.

    1. At Address Space, select the SERVICE_PROVIDER_SPACE address space.

    2. The Hostname field is automatically populated with the IM and Presence Service Server Name. Edit it if necessary.

    3. At IPv4 Address, fill out the IP address of the IM and Presence Service server.

      Note

      Either the hostname or the IP address is required. Ensure that the hostname or IP address does not contain a trailing blank space. Automate 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 IM and Presence Service application.

    5. Provide an optional description for the network address.

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

  9. Expand Credentials.

    1. Add credentials for credential type ADMIN. ADMIN is required for Service Inventory to generate reports for UC applications.

    2. Fill in the user ID and password that you configured when you installed the IM and Presence Service.

    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.

    5. Click the Plus icon (+) to add more credentials.

  10. Save your changes.