.. _set_up_cisco_unified_communications_manager_servers: Add a CUCM Server ------------------ .. _18.1-Patch-Bundle-3|VOSSSOL-8699: .. _21.1|VOSS-842: .. _21.3|EKB-12240: This procedure adds and configures a CUCM server (Cisco Unified Communications Manager) within a CUCM cluster. .. note:: References to HCM-F and Shared Data Repository (SDR) are only relevant if installed. 1. 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. 2. 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. 3. Go to (default menus) **Apps Management > CUCM > Servers**. 4. Click **Add**. 5. Configure server details on the **Base** tab: a. 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. b. If you're configuring a publisher node, select the **Publisher** checkbox. This displays an additional tab (Publisher tab). c. 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. d. At **Server Type**, choose an option, either **VOICE_VIDEO** or **IM_P**. e. To trigger a sync (auto-import) of the UC app server when saving the form, select **Sync on Create/Update**. f. Expand **Network Addresses**, and add network addresses, one or more: * At **Address Space**, choose **SERVICE_PROVIDER_SPACE**. .. note:: If NAT is used, you will also need to add a APPLICATION_SPACE network address (repeat these steps and for address space, choose APPLICATION_SPACE). * 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. g. 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* 6. Fill out fields on the **Publisher** tab: .. note:: This tab displays only if you've selected the **Publisher** checkbox on the **Base** tab. .. tabularcolumns:: |p{4cm}|p{11cm}| +--------------------------+---------------------------------------------------------------+ | Field | Description | +==========================+===============================================================+ | | Choose the Prime Collaboration | | | management application monitoring this | | Prime Collab | 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**. | +--------------------------+---------------------------------------------------------------+ | | Choose the version of the Unified CM | | Version | Servers in this cluster. The available | | | versions depend on the version of the | | | HCM-F device that has been configured. | +--------------------------+---------------------------------------------------------------+ | | Read-only field. If creating at | | Multi-Tenant | 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. | +--------------------------+---------------------------------------------------------------+ | | 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 Unified CM are | | | entitled to. | | | | | | Note: | | | | | User Entitlement Profile | 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 | Select this check box to enable Change Notification. | | Notification Sync | 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 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 :ref:`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 VOSS Automate. .. rubric:: Related Topics * For details on monitoring and VOSS Insights, refer to :ref:`voss-assurance-overview`. * For more information on Change Notification Feature (CNF) see :ref:`VOSS_CNF_overview`. Test a CUCM and VOSS Automate Connection ............................................. Once you've added a CUCM server, you should test the connection between the CUCM server and VOSS Automate. 1. In the VOSS Automate Admin Portal, to to (default menus) **Apps Management > Advanced > CUCM Network Device**. 2. Click the CUCM you just added. 3. Choose **Action > Test Connection**. 4. 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. 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 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``