.. _cucm-cluster-and-servers: CUCM cluster and servers --------------------------- .. _18.1-Patch-Bundle-3|VOSSSOL-8699: .. _21.1|VOSS-842: .. _21.3|EKB-12240: .. tip:: :ref:`use-action-search-to-navigate-automate` .. _add-cucm-server: Add a Cisco UCM server ........................ This procedure adds and configures a Cisco UCM server within a UCM cluster. 1. Log in to the 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. #. 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. #. Go to the **CUCM Clusters and Servers** list view. #. Click the Plus icon (+) to add a new server. #. On the **Base** tab/panel, configure server details: .. tabularcolumns:: |p{4cm}|p{11cm}| +--------------------------+----------------------------------------------------------------------------+ | Field | Description | +==========================+============================================================================+ | CUCM Server Name | Fill out the UCM 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 user. | | | | | | When checked, you'll fill out the Publisher tab/panel fields in the next | | | step. | +--------------------------+----------------------------------------------------------------------------+ | Cluster Name | For a UCM 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 UCM users, choose the UCM 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 UCM server | | | name. Edit it if necessary. | | | * At **IPv4 Address**, fill out the IP address of the UCM server. | | | | | | Either the hostname or the IP address is required. Ensure the hostname | | | or IP address does not contain a trailing blank space since VOSS | | | can't validate entries that contain a blank space at the end of the | | | hostname or IP address. | | | | | | * Fill out the domain of the UCM application. | | | * Provide an optional description for the network address. | +--------------------------+----------------------------------------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11cm}| +--------------------------+----------------------------------------------------------------------------+ | 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 UCM and Automate. | | | | | | * Fill out the user ID and password that you configured when installing | | | the UCM. | | | * Optionally, provide a description for the credential. | | | | | | The UCM 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* | +--------------------------+----------------------------------------------------------------------------+ #. 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. .. tabularcolumns:: |p{4cm}|p{11cm}| +--------------------------+---------------------------------------------------------------+ | Field | Description | +==========================+===============================================================+ | Call Processing ID | The Call Processing ID of this cluster | +--------------------------+---------------------------------------------------------------+ | SDR Cluster ID | The SDR UCM cluster ID, as shown on | | | **SDR Configuration > SDR CUCM Clusters**. | +--------------------------+---------------------------------------------------------------+ | | Choose the version of the UCM servers in this cluster. | | Version | | +--------------------------+---------------------------------------------------------------+ | | Read-only. If creating at Provider level, this field is set | | Multi-Tenant | to *Shared*. If creating at customer level, | | | this field is set to *Dedicated*. | +--------------------------+---------------------------------------------------------------+ | Port | The port on the UCM server to connect to. Default is 8443. | +--------------------------+---------------------------------------------------------------+ | | Choose **Automatic** to automatically move | | | synced in users to sites, based on the | | | filters and filter order defined in | | User Move Mode | **User Management > Manage Filters**. Choose | | | **Manual** if you want an Administrator | | | to manually move synced in users to a | | | Site. | +--------------------------+---------------------------------------------------------------+ | | Choose the Entitlement Profile that | | | specifies which devices and services | | | users synced from this Cisco UCM are | | | entitled to. | | | | | | Note: | | | | | User Entitlement Profile | A violation of the Entitlement Profile | | | does not prevent a user from being | | | synced to VOSS from Cisco UCM. | | | However, subsequent updates to the user | | | fail until the user's configuration | | | satisfies the restrictions set in the | | | Entitlement Profile. | +--------------------------+---------------------------------------------------------------+ | Enable Change | Defines whether to enable Change Notification. When enabled, | | Notification Sync | 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 UCM on | | | 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 Insights. | | | The arbitrator checkboxes will then reflect the asset status. | +--------------------------+---------------------------------------------------------------+ #. Inspect the default mappings and modify if required, see :ref:`user-field-mapping`. #. Click **Save**. A UCM network device is created in VOSS. (If installed, a cluster and UCM are created in the SDR.) #. Test the connection between UCM and VOSS. .. rubric:: Related topics * For details on monitoring and Insights, refer to :ref:`voss-assurance-overview`. * For more information on Change Notification Feature (CNF) see :ref:`cisco-ucm-cnf-syncs`. * :ref:`restore-cucm-server` * :ref:`cucm-server-delete` * :ref:`test-connection-cucm-to-automate` .. _test-connection-cucm-to-automate: Test the connection from the Cisco UCM server to VOSS ........................................................... Once you've added a UCM server, you should test the connection between the UCM server and VOSS. 1. In the VOSS UI, go to the **CUCM Network Devices** list view. 2. Click on the UCM you added. #. Click the toolbar **Test Connection** icon. #. If the test fails, and you used a hostname, ensure that VOSS has the correct DNS and Domain set. Refer to the *Network services* topic in the Platform Guide. a. Log in to the platform CLI. #. Query the current DNS setting: **network dns**. #. Set the DNS if needed: **network dns **. #. Query the current domain setting: **network domain**. #. Set the domain if needed: **network domain **. .. note:: * Use the **CUCM Network Device** page only for testing the connection. Do not edit UCM from this page. To change any configuration of the UCM, edit it via the **Servers** (UCM) page in the VOSS UI. * After updating DNS servers, you'll need to restart the selenium service on the platform CLI: ``app start selenium`` .. _cucm-server-delete: Delete a Cisco UCM server .......................... Deleting a Cisco UCM server in VOSS also deletes local data that has been synced to it from the UCM server, including: * Users * Configuration parameters * Dial plan information (if applicable) .. _restore-cucm-server: Restore a Cisco UCM server ............................. When restoring a UCM 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. .. _auto-move-users-synced-from-cucm: Configure CUCM server to automatically move synced in UCM users .......................................................................... This procedure automatically moves users that were synced from Cisco UCM, using previously defined move filters. .. tip:: :ref:`use-action-search-to-navigate-automate` 1. In the VOSS UI, go to **CUCM Cluster and Servers** list view. 2. Click the server to modify. 3. Locate the **Publisher** tab/panel. 4. At **User Move Mode**, select **Automatic** from the drop-down. 5. Click **Save**. Users are automatically moved based on the previously defined move filters.