--- title: "Cisco UCM VKM Configuration Guide" slug: "cisco-ucm-vkm-configuration-guide" updated: 2026-07-15T14:56:19Z published: 2026-07-15T14:56:19Z canonical: "support.nectarcorp.com/cisco-ucm-vkm-configuration-guide" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt > Use this file to discover all available pages before exploring further. # Cisco UCM VKM Configuration Guide ## Overview Cisco Unified Communications Manager (CUCM) provides signaling and call control services to Cisco integrated telephony and third-party applications. The CUCM Vendor Knowledge Module (VKM) provides health and performance monitoring, inventory discovery, CDR collection, and dependency trees for the CUCM platform. The VKM provides system monitoring as part of the Nectar Foundation solution and used by the Nectar Call Analysis and Recording Assurance Modules. ### About this Guide This guide provides the instructions to configure the monitoring and management of the CUCM VKM, a component of Nectar Foundation. This guide explains how to: - [**Configure the Nectar RIG**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-the-nectar-rig) - [**Configure Cisco UCM**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-cisco-ucm) [](https://support.nectarcorp.com/preview/v1/1f33e99a-af0d-44d5-8ff3-097782d27dde/1#configure-snmp-on-routersvoice-gateways) - [**Configure SNMP on Routers/Voice Gateways**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-snmp-on-routersvoice-gateways) - [**Configure CUCM VKM**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-cucm-vkm) - [**Configure CUCM Alarms**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-cucm-alarms) - [**Manage Trunk Types**](/v1/docs/cisco-ucm-vkm-configuration-guide#manage-trunk-types) - [**Configure VKM Options**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-vkm-options) - [**View Inventory**](/v1/docs/cisco-ucm-vkm-configuration-guide#view-inventory) - [**CUCM VKM and Nectar UCMP**](/v1/docs/cisco-ucm-vkm-configuration-guide#cucm-vkm-and-nectar-ucmp) - [**Troubleshoot Communications from CUCM to RIG**](/v1/docs/cisco-ucm-vkm-configuration-guide#troubleshoot-communications-from-cucm-to-rig) - [**Manage CUCM Clusters**](/v1/docs/cisco-ucm-vkm-configuration-guide#manage-cucm-clusters) NOTE***Cisco UCM*** *and* ***CUCM*** *are used interchangeably in this guide.* ### ### Supported Software Versions - Nectar UCMP v8.7 - Cisco UCM v10.x and above ### ## Configure the Nectar RIG Configuring the Nectar RIG includes the following tasks: - [**Enable the Cisco UCM VKM**](/v1/docs/cisco-ucm-vkm-configuration-guide#enable-the-cisco-ucm-vkm) - [**Cloud CUCM Support**](/docs/cisco-ucm-vkm-configuration-guide#cloud-cucm-support) - [**Configure the server.properties File**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-the-serverproperties-file) - [**Configure the ciscoucm-module.properties File**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-the-ciscoucmmoduleproperties-file) - [**Configure the receiver-module.properties File**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-the-receivermoduleproperties-file) ### Enable the Cisco UCM VKM Follow these steps to enable the Cisco UCM VKM: 1. Navigate to **RIG** > **Module Configuration**. The **Module Configuration** window appears. 2. Select **Cisco UCM**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-gzxj8ak8.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Enable CUCM VKM* 3. Click **Apply**. 4. To restart the RIG and apply the changes: 1. Navigate to **RIG > Admin > Restart**. 2. When the following message appears, click **Yes**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-jgn7mrmz.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Restart* ### Cloud CUCM Support RIG's supporting clould-based deployments of Cisco UCM where SNMP and ICMP integration is not available should be configured as follows BEFORE onboarding the CUCM system. 1. Open the Maritime Terminal and execute the following commands: 1. PLATFORM SETDISABLESNMP TRUE 2. PLATFORM SETDISABLEICMP TRUE 2. Verify the configuration by executing the following command: 1. PLATFORM STATUS![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/image-1741773043046.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D) ### Configure the server.properties File Follow these steps to locate, download, update, and save the **server.properties** file: 1. Navigate to **RIG** > **File Manager**. The **File Manager** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-750mz53k.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*server.properties File* 2. Look for the **Remote File System** pane on the right; then navigate to the **etc\ server.properties** configuration file in the RIG installation directory. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-snppcb5s.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*server.properties File* 3. Right-click on the **server.properties** file and select **Download**. 4. Save the **server.properties** file to the local destination. 5. Navigate to the **server.properties** file. 6. Right-click on the **server.properties** file and select **Open With**. 7. Open the file using Notepad. 8. See *Configure RIG Credentials for FTP*  below 9. See ***Configure to Collect CDRs*** below 10. Navigate to **File > Save** to save any changes. 11. Navigate to **RIG** > **File Manager.** The **File Manager** window appears. 12. Navigate to the **etc\server.properties** configuration file in the RIG installation directory. 13. Right-click on the **server.properties** file and select **Upload**. 14. Browse to the updated **server.properties** file, select, and click **Open.** The **Upload File** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-cf4mnze2.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Upload* 15. Click **Upload**. 16. To restart the RIG and apply the changes: 1. Navigate to **RIG > Admin > Restart**. 2. When the following message appears, click **Yes**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-zkhs9zzp.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Restart* #### Configure RIG Credentials for FTP Before administering CDRs on the Cisco UCM, you must configure credentials from the RIG for SFTP/FTP. These credentials are stored in the **etc\server.properties** configuration file located in the RIG installation directory. 1. Create a username and password for SFTP/FTP connections. 2. Add these credentials to the configuration file, as shown in the following example: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-hrau7tc8.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*FTP Credentials*NOTE If there are already existing properties for these credentials, they must be updated. Alternatively, you can use the superuser credentials, if you know the respective password that is stored in the configuration file in encrypted form. 3. Record the credentials, which will be needed when managing CDRs (see **Manage CDRs**). #### Configure to Collect CDRs Add the following line to the **server.properties** file **PRIOR** to the start of the modules in order to collect CDRs. ```actionscript sshAllowInsecureAlgorithms=true ``` View the following example. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-qqoztg83.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*sshAllowInsecureAlgorithms* ### Configure the ciscoucm-module.properties File Follow these steps to locate, download, update, and save the **ciscoucm-module.properties** file: 1. Navigate to **RIG** > **File Manager**. The **File Manager** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-cnz951vk.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Remote File System* 2. Look for the **Remote File System** pane on the right; then navigate to the **\etc\ciscoucm- module.properties** configuration file in the RIG installation directory. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-p24q3eve.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*ciscoucm-module.properties File* 3. Right-click on the **ciscoucm-module.properties** file and select **Download**. 4. Save the **ciscoucm-module.properties** file to the local destination. 5. Navigate to the **ciscoucm-module.properties** file. 6. Right-click on the **ciscoucm-module.properties** file and select **Open With**. 7. Open the file using Notepad. 8. See ***Enable Registration Events*** below. 9. See ***Change CDR Retention*** below. [](/docs/cisco-ucm-vkm-configuration-guide#_bookmark16) [](/docs/cisco-ucm-vkm-configuration-guide#_bookmark17) 10. Navigate to **File > Save** to save the changes. 11. Navigate to **RIG** > **File Manager**. *The **File Manager** window appears.* 12. Navigate to the **\etc\ciscoucm-module.properties** configuration file in the RIG installation directory. 13. Right-click on the **ciscoumc-module.properties** file and select **Upload**. 14. Browse to the updated **ciscoumc-module.properties** file, select, and click **Open**. *The **Upload File** window appears.* 15. Click **Upload**. 16. To restart the RIG and apply the changes: 1. Navigate to **RIG > Admin > Restart**. 2. When the following message appears, click **Yes**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-csf478rx.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Restart* #### Enable Registration Events Follow these steps to receive events for registration and de-registration of phones: 1. Locate the **send.registration.event** parameter. 2. Change the value to ***true***, as shown below: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-lmg71coj.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)Cisco Unified Serviceability The default value is ***false*** (or disabled). #### Change CDR Retention Follow these steps to change the CDR retention value in order to limit data that is stored: 1. Locate the **cdrAgeDays** parameter. 2. Enter a new value. The default value is ***30*** days, as shown in ***Figure*** ***cdrAgeDays*** **![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-v8v2uu7f.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*cdrAgeDays*** **NOTE*If the cdrAgeDays parameter is set to less than 5, then it will default to 30 days for Cisco UCM module.*** ### Configure the receiver-module.properties File Follow these steps to locate, download, update, and save the **receiver-module.properties** file, as needed: 1. Navigate to **RIG** > **File Manager**. The **File Manager** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-cjxqujla.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Remote File System* 2. Look for the **Remote File System** pane on the right; then navigate to the **etc\receiver- module.properties** configuration file in the RIG installation directory. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-b3jnan4f.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*receiver-module.properties File* 3. Right-click on the **receiver-module.properties** file and select **Download**. 4. Save the **receiver-module.properties** file to the local destination. 5. Navigate to the **receiver-module.properties** file. 6. Right-click on the **receiver-module.properties** file and select **Open With**. 7. Open the file using Notepad. 8. See ***Enable Syslog*** below. 9. Navigate to **File > Save** to save the changes. 10. Navigate to **RIG** > **File Manager**. *The **File Manager*** *window appears.* 11. Navigate to the **etc\receiver-module.properties** configuration file in the RIG installation directory. 12. Right-click on the **receiver-module.properties** file and select **Upload**. 13. Browse to the updated **receiver-module.properties** file, select, and click **Open**. *The **Upload File** window appears.* 14. Click **Upload**. 15. To restart the RIG and apply the changes: 1. Navigate to **RIG > Admin > Restart**. 2. When the following message appears, click **Yes**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-c49gtios.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Restart* #### Enable Syslog To enable Syslog, add the following property and value: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-mtjnyxc3.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*syslog.enable*  ## Configure Cisco U CM Configuring the CUCM includes the following tasks: - [**Configure SNMP**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-snmp) - [**Configure Nectar User**](/v1/docs/cisco-ucm-vkm-configuration-guide#configure-nectar-user) - [**Activate Services**](/v1/docs/cisco-ucm-vkm-configuration-guide#activate-services) - [**Administer Call Detail Records**](/v1/docs/cisco-ucm-vkm-configuration-guide#administer-call-detail-records) - [**Edit Performance Monitoring Parameter**](/v1/docs/cisco-ucm-vkm-configuration-guide#edit-performance-monitoring-parameter) - [**Verify Cisco RisPort Service Activation**](/v1/docs/cisco-ucm-vkm-configuration-guide#verify-cisco-risport-service-activation) ### Configure SNMP Configuring the SNMP includes the following tasks: - **Create the SNMP Community String** - **Add a SNMP Notification Destination** #### Create the SNMP Community String Follow these steps to create the SNMP community string: 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-xzzm7lk6.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified Serviceability* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-w5l3idit.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **SNMP** > **V1/V2** > **Community String**. The **SNMP Community String Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-wfrepd37.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Select a Server* 4. Select a **Server*** using the drop-down; then click **Find**. A list of community strings appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-utfx3e4m.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Search Results/Community Strings* NOTEYou can also use the Find Community Strings where Name field to search for existing community strings. 5. To add a new community string, click **Add New**. A new **SNMP Community String Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-mr3yzuj7.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add a New Community String* 6. Complete the following to define the new community string: 1. This shows the server you selected in step **4**. 2. Enter the name of the community string, such as ***cmpreadonly***. 3. Select **Accept SNMP Packets only from these hosts.** 4. Enter the IP address of the Nectar RIG that will monitor the Cisco system; then click **Insert**. 5. The IP address will appear in the **Host IP Addresses** field. 6. Click the drop-down arrow and select **ReadNotifyOnly** for access privileges. This option means the community string can read the values of MIB objects and also send the values for trap and inform messages. NOTE *Notify access privilege is required to configure Notification Destinations.* *For more information, see* ***Add a SNMP Notification Destination*** *below**.* - Select **Apply To All Nodes** to apply to all servers in the cluster. - Click **Save** to save the new community string (or updates to an existing community string), restart the SNMP master agent service, and apply the changes. NOTE *You can also edit an existing community string:* 1. *Select a community string listed in the* ***Search Results*** *area.* *![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-dto8ah34.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)* 2. *W**hen the* ***SNMP Community String Configuration*** *window appears, make* *changes to the* ***Access Privileges****.* *![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-tukmbhh6.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)* #### Add a SNMP Notification Destination Follow these steps to add a SNMP notification destination: 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-mgmgkypd.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified Serviceability* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-pnyctf0j.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **SNMP** > **V1/V2** > **Notification Destination**. The **SNMP Notification Destination Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-a8xiab6y.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*SNMP Notification Destination Configuration* 4. Select a **Server*** using the drop-down; then click **Find**. 5. Click **Add New**. A new **SNMP Notification Destination Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-z1qyg58c.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add a New Notification Destination* 6. Complete the following to define the new notification destination: 1. This shows the server you selected in ***Step 4***. 2. Select **Add New** for **Host IP Addresses*** using the drop-down 3. Enter the IP address of the Nectar RIG*.* 4. Enter the port number, such as ***162***, if not already populated. 5. Select **SNMP Version *V2C***. 6. Select **Trap** as the **Notification Type*** using the drop-down. 7. Select the community string using the drop-down, such as ***cmpreadonly***.NOTE*You can also click* ***Create New Community String*** *to add a new community string. For more information, see* ***Create the SNMP Community String*** *above**.* 8. Select **Apply To All Nodes** to apply to all servers in the cluster. 9. Click **Insert** to restart the SNMP master agent service and apply the changes. ### Configure Nectar User Follow these steps to configure the Nectar User to be used when you onboard a CUCM cluster: 1. Access **Cisco Unified CM Administration** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-rjsp0u4g.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified CM Administration* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-r0z2eu02.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **User Management > Application User**. The **Find and List Application Users** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-cu76u3zh.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Find and List Application Users* 4. Click **Add New**. The **Application User Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-wzu433qh.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Application User Configuration* 5. Enter the following information in the **Application User Information** area: | **Parameter** | **Enter** | | --- | --- | | **User ID*** | Name of the new AXL user, such as ***NectarUser1***. | | **Password** | Password associated with the new AXL user. | | **Confirm Password** | Password to confirm. | **NOTE*Due to an ongoing issue, we do not support special characters { or } in the password.*** 6. Click **Add to Access Control Group**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-l5xzqfxo.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add to Access Control Group*  The **Find and List Access Control Groups** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-kt3l9p3a.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Find and List Access Control Groups* 7. Select the following Access Control Groups, as shown in *Find and List Access Control Groups.* 1. **Standard AXL User** 2. **Standard CCM Read Only** 3. **Standard RealtimeAndTrace Collection** 8. Click **Add Selected**. The **Application User Configuration** window appears with the new Access Control **Groups** listed. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-rc6qwr6m.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Application User Configuration* 9. Click **Save.** Notice that the **Roles** pane populates with the roles associated with the Application User. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-u2643bfy.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Roles* ### Activate Services Follow these steps to activate service: 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-j4qlzoo9.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified Serviceability* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-59jlol7x.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **Tools** > **Service Activation**. The **Service Activation** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-g5wt9hms.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Select a Server* 4. Select a **Server*** using the drop-down; then click **Go**. The **Service Activation** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-l0lx5nj8.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Service Activation* 5. Confirm that the following services are selected for **CDR Services**:NOTE*If other services are selected, do not change.* 1. **Cisco SOAP - CDRonDemand Service** 2. **Cisco CAR Web Service** **![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-3h56nbxn.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*CDR Services*** 6. Confirm the following services are selected for **Database and Admin Services***:* 1. **Cisco Bulk Provisioning Service** 2. **Cisco AXL Web Service** ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-1qj4unpg.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Database and Admin Services* 7. Confirm the following services are selected for **Performance and Monitoring Services***:* 1. **Cisco Serviceability Reporter** 2. **Cisco CallManager SNMP Service** **![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-uvdmvdeg.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Performance and Monitoring Services*** 8. Click **Save**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-imlbsw6j.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Save* ### Administer Call Detail Records Configuring the Cisco UCM to deliver call detail records (CDRs) to the Nectar RIG via SFTP includes the following tasks: - **Configure System Parameters** - **Manage CDRs** NOTE *Make sure you configure the* ***server.properties*** *file on the RIG.* *For more information, see* ***Configure to Collect CDRs*** *above**.* #### Configure System Parameters To ensure that CDRs and call management records (CMRs) can be generated, follow these steps to enable certain Cisco UCM service parameters: 1. Access **Cisco Unified CM Administration** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-bqmtvl2b.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified CM Administration* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-zhxwew26.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **System** > **Service Parameters**. The **Service Parameters Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-boh6k3o5.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Select Server and Service* 4. Select the **Server*** using the drop-down. 5. Select the **Service*** (in this case, ***Cisco CallManager (Active)***) using the drop-down. The **Service Parameter Configuration** window expands to show the service parameters. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-3emrogdh.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Service Parameters Configuration* NOTE*The default value for each system parameter is* ***false****. You must enable, if not already, using the information in* ***Step 6*** *in order for the RIG to retrieve Call Manager and Call Detail records.* 6. Specify the value for the following parameters: ***Table** - System Parameters* | **Parameter** | **Description** | | --- | --- | | **CDR Enabled Flag** | - Determines whether or not CDRs are generated. - Set value to **True** to generate CDRs. - Enable this parameter on ALL servers. | | **CDR Log Calls with Zero Duration Flag** | - Set value to True.Enables or disables the logging of CDRs for calls that never connected or lasted less than one second. | ***Table** - Clusterwide Parameters (Device - General)* | **Parameter** | **Description** | | --- | --- | | **Call Diagnostics Enabled*** | - Set value to **Enabled** when CDR Enabled flag is set to **True**. - Enables CMRs/diagnostic records to be generated. | | **Show Line Group Member DN in finalCalledPartyNumber CDR Field** | - Set value to **True** to show the finalCalledPartyNumber field in the CDRs. - Shows the directory number (DN) of the line group member who answered the call or the hunt pilot DN. | ***Table** - Clusterwide Parameters (Device - Phone)* | **Parameter** | **Description** | | --- | --- | | **Add Incoming Number Prefix to CDR***Add Incoming Number Prefix to CDR* | - Located under **Advanced** of the **Service Parameter Configuration** window. - Set value to **Enabled**. - Causes Cisco UCM to add the incoming prefix to the calling party number in the CDRs for that call (as specified in the National Number Prefix, International Number Prefix, Subscriber Number Prefix, and Unknown Number Prefix service parameters). | 7. Click **Save**. #### Manage CDRs Follow these steps to manage the CDRs: 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-l8uh2c12.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified Serviceability* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-2hmrwh3n.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **Tools** > **CDR Management**. The **CDR Management** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-a456q61m.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*CDR Management* 4. In the **Billing Application Server Parameters** area, click **Add New**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-ua56znul.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Billing Application Server Parameters* 5. Using *Billing Application Server Parameters (above)*, complete the following: 1. Enter the IP address of the RIG. 2. Enter the Super User name and password from ***Configure System Parameters*** above.NOTE If the Super Username or password is preceded with a dash, it must be included, for example, -98765432101111111. 3. Enter the protocol as **FTP**. 4. Enter the directory path as **/cucm/**. 6. Click **Add**. #### Verify Load CDR Only Option Follow these steps to verify that the **Load CDR Only** check box is NOT selected: 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-44fz2nfn.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified Serviceability* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-m683df45.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **Tools** > **CDR Analysis and Reporting**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-gym6anre.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)Tools > CDR Analysis and Reporting The **Cisco Unified CM CDR Analysis and Reporting** window appears. 4. Navigate to **System** > **Scheduler > CDR Load**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-ubvepa7q.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)System > Scheduler > CDR Load  The **CDR Load** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-6p0st3pk.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*CDR Load* 5. Verify that the **Load CDR Only** check box is not selected. 6. Click **Update**.NOTEChanges will take effect at midnight. For the changes to take effect immediately, restart the Cisco CDR Analysis and Reporting Scheduler service. ### Edit Performance Monitoring Parameter Follow these steps to edit the number of performance monitoring requests that are allowed per minute. The default value is ***50***. 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. 2. Navigate to **System** > **Enterprise Parameters**. The **Enterprise Parameters Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-dehu5it4.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Enterprise Parameters Configuration* 3. Scroll down to **CCM Web Services Parameters** area. The **Enterprise Parameters Configuration** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-6a3397l5.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*CCM Web Services Parameters* 4. Change the **Allowed Performance Queries Per Minute** parameter to ***80***. 5. Click **Save**; then **Apply Config**. ### Verify Cisco RisPort Service Activation Follow these steps to verify that the Cisco RisPort Service is activated. NOTE*You need the SOAP - Real-Time Service running. You also need your application user to have the correct permissions. For more information, see* ***Configure Nectar User*** above (under *Configure Cisco UCM*)*.* 1. Access **Cisco Unified Serviceability** using the drop-down; then click **Go**. 2. Navigate to **Tools** > **Control Center - Network Services**. The **Control Center - Network Services** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-nv73bel9.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Control Center - Network Services* 3. Select a **Server*** using the drop-down; then click **Go**. 4. Scroll down to **Soap Services** area. 5. Verify that the **SOAP - Real-Time Service APIs** is running, which means the RisPort service is also activated. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-pfm3gh0g.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*SOAP - Real-Time Service APIs - Running* ## Configure SNMP on Routers/Voice Gateways You must enable SNMP on any route or voice gateway that the Nectar software monitors. Follow these steps to configure SNMP on a router or voice gateway to be monitored: 1. Login to the router or voice gateway command line interface (CLI) via SSH or Telnet: 1. Enter Enable mode. 2. Enter Configuration mode using **config terminal**. 2. Add an Access Control List (ACL) with the IP address of the Nectar RIG that monitors the router. In this example, the RIG is **10.65.1.252**. 1. hostname# **config t** 2. hostname(config)# **access-list 1 permit 10.65.1.252** 3. Add a SNMP community string for polling from Nectar Foundation:NOTE*The community string should be the same one used in* ***Create the SNMP*** ***Community String*** *above.* 1. hostname(config)# **snmp-server** 2. hostname(config)# **snmp-server community cmpreadonly ro 1** 3. hostname(config)# **exit** 4. hostname# **write memory** ## Configure CUCM VKM Configuring CUCM VKM includes the following tasks: - **Add a New Cluster Configuration** - **View Collections** - **Remove or Offboard a Cluster Configuration** - **CUCM CDR File Storage** ### Add a New Cluster Configuration Follow these steps to add a new cluster configuration: 1. Navigate to **Modules** > **Cisco > UCM**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-iulq8ibm.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)Modules > Cisco > UCM The **Cisco UCM Setup - Configurations** window appears. 2. Click **Add**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-lq118018.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Setup - Configurations* The **Add Cisco UCM - General** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-dbxer52n.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D) *Add Cisco UCM* 3. Enter the following information; then click **Next**. *- Add Cisco UCM* | **Parameter** | **Enter...** | | --- | --- | | **Name** | Name of the onboarding cluster configuration. | | **Description** | Description of the cluster configuration. | The **Add Cisco UCM - SNMP** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-gwmtlz75.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add Cisco UCM - SNMP* 4. Enter the following SNMP information; then click **Next**. ***Table** - Add Cisco UCM - SNMP* | **Parameter** | **Enter or select...** | | --- | --- | | **IP Address** | IP address of the Publisher server of the cluster. | | **SNMP Version** | SNMP version from the following: - V1 - V2 - V3 | | **Port** | SNMP port, such as **161**. | | **Community** | Community string previously configured, such as **cmpreadonly**. | | **Authentication** | Authentication from one of the following: - None - MD5 - SHA | | **User ID** | User ID previously set up for the SNMP community string. | | **Password** | Password previously set up for the SNMP community string. | | **Privacy Protocol** | Protocol from one of the following: - None - DES - AES - AES-192 - AES-256 NOTEEnabled for SNMP V3 only. | | **Privacy Password** | Password for the Privacy Protocol. NOTEEnabled for SNMP V3 only. | The **Add Cisco UCM - AXL** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-0lk2sqxk.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add Cisco UCM - AXL* 5. Enter the following AXL User information; then click **Next**. ***Table** - Add Cisco UCM - AXL* | **Parameter** | **Enter/Select ...** | | --- | --- | | **AXL User** | Name of the AXL user. For more information, see ***Configure Nectar User*** above (Under *Configure Cisco UCM*). | | **AXL Password** | Password created for the AXL user. | | **Confirm Password** | Password to confirm. NOTE*After the* ***AXL User*** *and* ***AXL Password*** *are entered and the password confirmed, they are validated. A* ***Validating*** *dialog box appears. After validation, the cluster configuration is added and listed in the* ***Cisco UCM Setup - Configurations*** *pane.* | The **Add Cisco UCM - Gateways** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-aita2yau.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add Cisco UCM - Gateways*  6. Perform the following; then click **Next**: - Specify whether or not you want to **Discover SIP Gateways**. - Select the gateway(s) you want to monitor. NOTE*Click* ***Edit*** *in the* ***Actions*** *column to modify a specific gateway’s configuration data.* 7. Click **Finish**. The **Cisco UCM Setup** window appears with the new cluster configuration listed. - ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-latuemle.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cluster Configuration* The VKM collection processes and Nectar monitoring are also initiated. For more information, see ***View Collections*** below. ### View Collections Follow these steps to view a list of collections for the CUCM cluster: 1. Navigate to **Modules** > **Cisco > UCM**. The **Cisco UCM Setup - Configurations** window appears. 2. Select the new cluster configuration; then click **View Collections**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-g4ddo6v7.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*View Collections*  The **Collections** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-s2kpao69.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Collections* 3. View collection data for the system configuration, such as: 1. **Name** 2. **Enabled** 3. **Status** 4. **Schedule** 5. **Last Execution** 6. **Last Execution Duration** 4. Right-click on a collection and select one of the following: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-gn2wr6bv.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Collections*  For more information, see ***Manage Collections*** under ***Manage CUCM Clusters**.* ### Remove or Offboard a Cluster Configuration NOTE*Before upgrading to v7.0, you must use the following procedure to offboard any cluster configurations.* Follow these steps to remove or offboard a cluster configuration: 1. Navigate to **Modules** > **Cisco > UCM**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-gx4ofx44.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)Modules > Cisco > UCM The **Cisco UCM Setup - Configurations** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-t1n2iwc9.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Setup - Configurations* 2. Select an existing cluster configuration that you want to remove or offboard. 3. Click **Remove**. 4. When the following message appears, click **Yes**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-s5ymplmw.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Remove*  The cluster configuration is removed and no longer appears in the list on the **Cisco UCM Setup****- Configuration**s window. ### CUCM CDR File Storage The CUCM VKM generates csv files for the collected CDRs. These files are generated and stored in the following directories: - **cdr/cucm** - **archive/cucm** When these files get created, the data is first stored in the **cdr/cucm** folder until the files are transferred to the destination Call Analysis Module (CAM). After the files are successfully transferred, they are then stored in the **archive/cucm** folder. Any files that remain in the **cdr/ cucm** folder did not transfer. NOTE*At this time, if a file does not transfer, there is no attempt to re-transfer that file.* #### cdr folder Follow these steps to navigate to the **cdr/cucm** folder: 1. Navigate to **RIG** > **File Manager**. The **File Manager** window appears. 2. Locate the **cdr** folder in the **Apps** folder. 3. Locate the **cucm** folder in the **cdr** folder. 4. View the following example path. <*dir>:***\***applicationhomedirectory***\cdr\cucm** 5. View a list of archived files in the **cucm** folder. #### archive folder Follow these steps to navigate to the **archive** folder: 1. Navigate to **RIG** > **File Manager**. The **File Manager** window appears. 2. Navigate to the folder where the application is installed. 3. Locate the **archive** folder in the application folder. 4. Locate the **cucm** folder in the **archive** folder. 5. View the following example path: **:****\***applicationhomedirectory***\archive\cucm** 6. View a list of archived files in the **cucm** folder. ## Configure CUCM Alarms Follow these steps to configure the CUCM to forward all alarms that meet or exceed the configured severity to the RIG: NOTE *The CUCM system should be onboarded successfully before being configured to send alarms to the RIG.* *For additional information on configuring CUCM alarms, see:* ***https://******www.cisco.com/c/en/us/td/docs/voice_ip_comm/cucm/admin/11_5_1/*** ***Admin/cucm_b_serviceability-admin-guide-1151su1/cucm_b_serviceability- admin-guide-1151su1_chapter_011.html*** 1. Access **Cisco Unified CM Administration** using the drop-down; then click **Go**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-rzr6lbch.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Unified CM Administration* 2. Enter your **Username** and **Password**; then click **Login**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-va5qzf3b.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Login* 3. Navigate to **System** > **Enterprise Parameters**. The **Enterprise Parameters Configuration** window appears. 4. Scroll down to the **Cisco Syslog Agent** area. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-i7zmxplk.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco Syslog Agent* 5. Enter the following information: ***Table** - Parameters* | **Parameters** | **Enter...** | | --- | --- | | **Remote Syslog Server Name 1, 2, etc.** | IP address(es) of the RIG(s) that will receive the alarms. | | **Syslog Severity for Remote Syslog Messages** | WARNING, which is the lowest CUCM alarm severity that the CUCM VKM will receive and process. | 6. Click **Save**; then click **Apply Config**. NOTE *By default, Local Syslogs is enabled for every service, and the associated Alarm Event Level is* ***Error****. If you want to review or change the Alarm Event Level for any CUCM services, go to the CUCM Serviceability pages (see link in* ***Note*** *above).* *When you configure the Enterprise Remote Syslog Server(s) and set the* ***Syslog Severity for Remote Syslog Messages*** *to* ***Warning****, the RIG receives any* ***Warning*** *level or above alarms from all services.* ## Manage Trunk Types Managing trunk types includes the following tasks: - **Add a Trunk Type** - **Edit a Trunk Type** - **Remove a Trunk Type** ### Add a Trunk Type Follow these steps to add a trunk type: 1. Navigate to **Modules > Cisco > UCM**. The **Cisco UCM Setup - Configurations** window appears. 2. Click the **Trunk Types** tab. The **Cisco UCM Setup - Trunk Types** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-n2qdmvuw.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Setup - Trunk Types* 3. Right click and select **Add**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-d2i0r6h3.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add Trunk Type*  The **Add Trunk Type** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-6xcl3pz7.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Add Trunk Type* 4. Enter the following information: *Table - Add a Trunk Type* | **Parameter** | **Enter or select ...** | | --- | --- | | **Cluster ID** | Cluster ID associated with this trunk type. | | **Call Manager ID** | Call Manager ID associated with this trunk type. | | **Trunk Type** | One of the following: - **CARRIER** - **INTERNAL** - **UNKNOWN** | | **Trunk Near IP** | IP address near the trunk. | | **Trunk Far IP** | IP address furthest from the trunk. | | **Rate Call** | One of the following to indicate whether or not it is a rate call: - **Yes** - **No** | 5. Click **OK**. ## Edit a Trunk Type ### Follow these steps to edit a trunk type: 1. Navigate to **Modules > Cisco > UCM**. The **Cisco UCM Setup - Configurations** window appears. 2. Click the **Trunk Types** tab. The **Cisco UCM Setup - Trunk Types** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-evyawnd0.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Setup - Trunk Types* 3. Right-click on a trunk type and select **Edit**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-p57sl67j.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Trunk Type*  The **Edit Trunk Type** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-hzvp5i55.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Trunk Type* 4. Make changes, as needed. 5. Click **OK**. ## Remove a Trunk Type Follow these steps to remove a trunk type: 1. Navigate to **Modules > Cisco > UCM**. The **Cisco UCM Setup - Configurations** window appears. 2. Click the **Trunk Types** tab. The **Cisco UCM Setup - Trunk Types** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-hn3tc9bl.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Setup - Trunk Types* 3. Right-click on a trunk type to delete and select **Remove**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-sygziahj.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Remove Trunk Type*  The **Remove** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-z2qquuz8.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Remove* 4. Click **Yes**. ## Configure VKM Options Follow these steps to configure the VKM options for the CUCM: 1. Navigate to **Modules > Cisco > UCM**. The **Cisco UCM Setup - Configurations** window appears. 2. Click the **VKM Options** tab. The **Cisco UCM Setup - VKM Options** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-4yi9fwim.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Setup - VKM Options* 3. View a list of the following parameters: ***Table** - VKM Options* | **Parameter** | **Description** | | --- | --- | | **cdrLoaderThreadCount** | Specifies the number of CDR/CMR loading threads. Default value is **2**. | | **cdrProcessorTheadCount** | Specifies the number of CDR/CMR processing threads. Default value is **4**. | | **cdrPurgeInterval** | Specifies the interval in seconds that call detail records are purged; default value is **900**. | | **exportEnable** | Specifies whether or not the call data exporting process is enabled on the RIG. Values include: - **true** - **false** Default value is **false**. | | **exportInterval** | Identifies the frequency in seconds of querying the database and uploading a data file to a destination. Default value is **900** seconds. | | **exportLastTime** | Provides a time stamp for the last exported record. | | **exportSeqNum** | Identifies the last number used to generate call and user data CSV files. NOTEThis parameter should not be changed manually. | | **fileRetention** | Defines the duration to store CSV call and user data files on the RIG. Default value is **10 days**. | | **retentionFrequency** | Defines the CSV files retention frequency in hours. | ***Table** - VKM Options continued...* | **Parameter** | **Description** | | --- | --- | | **syslogEventClearTimeout** | Identifies in seconds when Syslog events will automatically clear. Default value is **300** seconds. | | **uploadDestDir**uploadDestDir | Identifies the destination directory on the specified host. Default value is **/.** | | **uploadEnable**uploadEnable | Specifies whether or not upload is enabled. Default value is **false**. | | **uploadHost** | Identifies the host IP address or FQDN to upload call records in CSV format. | | **uploadPassword** | Identifies the password that is used to establish connection to the specified host. | | **uploadPort** | Identifies the port number to be used. This parameter is *optional*. If the port number is not specified, then the default value for the selected scheme is used. | | **uploadScheme** | Specifies the upload scheme to be used: - **ftp** - **ftps** - **sftp** Default value is **ftp**. | | **uploadUsername** | Identifies the username that will be used to establish connection to the specified host. | 4. To change a value, right-click on the VKM option and select **Edit**. The **Edit VKM Option** window appears for that option/parameter. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-x3b5oa6l.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit VKM Option* 5. Enter the new value for the parameter; then click **Update**. The new value appears for the parameter in the **VKM Options** list. NOTE *Generated files upload automatically. However, before uploading, you must configure the following VKM parameters:* *-Destination Host (****uploadHost****)**-Port (****uploadPort****)**-Directory (****uploadDestDir****)* ## View Inventory Follow these steps to view inventory data for a specific cluster or all clusters: 1. Navigate to **Reports > Inventory** > **Cisco > UCM**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-og85r1w3.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)Reports > Inventory > Cisco UCM  The **Cisco UCM Inventory** window appears with a list of the inventory categories. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-z2gbw7sh.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Cisco UCM Inventory* 2. Select an inventory category, such as **Call Manager**. The **Listing** window appears with data for **Call Manager**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-tdqjfy88.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Call Manager - Example* 3. Notice the **CUCM Clusters** drop-down. You can click the drop-down to select a specific cluster when there is multiple onboarded clusters on the same RIG to filter the data that is displayed. ## CUCM VKM and Nectar UCMP After deployment, the CUCM VKM creates elements, dependency trees, and call detail that you can view: - **View Elements** - **View Dependency Tree** - **View Call Details** ### View Elements Viewing elements includes the following tasks: - **[](/docs/cisco-ucm-vkm-configuration-guide#_bookmark63)** [](/docs/cisco-ucm-vkm-configuration-guide#_bookmark63)**View Agents and Poll Functions** - **Edit Poll Thresholds** - **Change Poller Data Storage Setting** - **Edit an SNMP Connection Test Poll Function** #### View Agents and Poll Functions The CUCM VKM adds an agent and poll functions for each onboarded cluster. Follow these steps to view the new agent and poll functions that were created for each cluster: 1. Navigate to **Health** > **Elements**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-wn0n60pi.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)Health > Elements  The **Elements** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-2jmu20lt.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Elements* 2. Click **Agents**. A list of agents appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-5fprjlal.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Agents*  NOTE*The actual list of agents will depend on the architecture of each individual CUCM deployment.* 3. Click on an agent to view the poll functions for that agent. View the following example. *![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-z0eo30ab.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Poll Functions** #### Edit Poll Thresholds Follow these steps to edit a poll threshold: 1. See ***View Agents and Poll Functions*** above. 2. Select a poll function; then right-click and select **Edit**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-09qqzyk0.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Poll Function*  The **Edit Poll Functions - Parameters** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-i6urqoyt.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Poll Functions* 3. Click the **Thresholds** tab. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-47hyv0dk.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Threshold Values* 4. View the various threshold values. 5. Perform one of the following as needed: - Click **Add** to add a new threshold for the poll function. - Edit a threshold value; then click **Update** to save. - Click **Cancel** to close the window after viewing the threshold(s). #### Change Poller Data Storage Setting By default, the Compression setting (or storage of poller data) is one month. Follow these steps to change the compression setting: 1. See ***View Agents and Poll Functions*** above. 2. Right-click on a poll function and select **Edit**. The **Edit Poll Functions - Parameters** window appears. 3. Click **...** for **Compression**. The **Edit Compression** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-ai3w3n33.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Compression* 4. Select one of the following values: - 1 Week - 2 Weeks - 1 Month - 3 Months - (Do Not Store) NOTE*Click* ***Edit*** *to add or remove a compression strategy.* 5. Click **Select**. 6. Click **Update**. #### Edit an SNMP Connection Test Poll Function You can edit the **Allowed Failures** and **Previous Failure Count** for the SNMP Connection Test poll function. Follow these steps to edit an SNMP Connection Test poll function: 1. Navigate to **Health** > **Elements**. The **Elements** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-uk54gtwg.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Elements* 2. Click **Poll Functions**. A list of poll functions appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-tzgtpxh2.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Poll Functions* 3. Select **SNMP Connection Test**; then right-click and select **Edit**. The **Edit Poll Functions - Parameters** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-t7mvbdym.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Poll Functions* 4. Review the following parameters and make changes, as needed: ***Table** - Edit Poller Functions* | **Parameter** | **Description** | | --- | --- | | **Previous Failure Count** | This value is set by the poller to its previous state’s value. For example. the SNMP Check poller executes with a failure. The Failure Count and Previous Failure Count is incremented by one. However, if any subsequent successful SNMP checks occur, the Previous Failure Count gets reset to 0 (zero). Once this value exceeds the Allowed Failure Count, a critical alert is sent. | | **Allowed Failures** | - Enter the allowed number of SNMP failures before a value is returned. For example, if a network is heavily inundated with traffic and prioritizes SNMP as ‘low priority’, the SNMP get request may be dropped or ignored. That would result in incrementing the Allowed Failure Count by one. When the Allowed Failure count exceeds this number, a value of 0 (zero), which represents a failure, sends a critical event. - This value can be set to a higher or lower value than the default value of 3. | | **Frequency** | - Enter the frequency in seconds when the poll function updates. | 5. Click **Update**. ## View Dependency Trees View a dependency tree using one of the following: - **View Dependency Tree** - **View Publisher Connectivity Node** - **View Subscriber Connectivity Node** #### View Dependency Tree Follow these steps to view the created dependency tree: 1. Navigate to **Configure** > **Dependency Tree**. The **Dependency Trees** window appears with a list of tree names. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-nvqd2wc8.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Configure Dependency Tree* 2. Double-click on one of the listed trees; then view the dependency tree in the pane to the right. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-2f52lt1y.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Dependency Tree* 3. Scroll to view all of the dependency tree. #### View Publisher Connectivity Node Follow these steps to view the Publisher Connectivity node: 1. Navigate to **Configure** > **Dependency Tree**. The **Dependency Trees** window appears with a list of tree names. 2. Select a dependency tree with Publisher connectivity. 3. Scroll to view the **Connectivity** node with the following three end nodes: - AXL API Connection Test - Perfmon Connection Test - SNMP Connection Test ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-bjwwbisy.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Publisher Connectivity Tree*  #### View Subscriber Connectivity Node Follow these steps to view the Subscriber Connectivity node: 1. Navigate to **Configure** > **Dependency Tree**. The **Dependency Trees** window appears with a list of tree names. 2. Select a dependency tree with Subscriber connectivity. 3. Scroll to view the **Connectivity** node with the following two end nodes: - Perfmon Connection Test - SNMP Connection Test ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-vaj1pne9.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Subscriber Connectivity Tree*  ### View Call Details Follow these steps to view more information about a specific call. 1. Navigate to **Health** > **Quality Management > Call Details**. The **Call Details** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-ibek45yy.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Call Details* 2. Select a call; then right-click and select **View Details**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-9vrx219w.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Call Details* The **Call Detail** window appears with the call details. The following example shows a sampling of the window and highlights the following parameters: ***Table** - Call Detail* | **Parameter** | **Description** | | --- | --- | | **PKID** | Identifies a text string that the database uses internally to uniquely identify each row; provides no meaning to the call itself. | | **Origination Details: Media Cap Bandwidth** | Identifies the media bandwidth that is used at the origination of the call; default value is **0**. | | **Destination Details: Media Cap Bandwidth** | Identifies the media bandwidth that is used at the destination of the call; default value is **0**. | | **Cisco Headset Information** | | | **Concealed Seconds (CS)** | Represents the time during which some concealment is observed during a call. | | **Severely Concealed Seconds (SCS)** | Represents the time during which a significant amount of concealment is observed during a call. | ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-jlbctl7z.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D) ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-41o9to4c.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Call Detail* NOTE***Severely Concealed Seconds Ratio (SCSR)*** *is used as a metric for rating calls. SCSR uses CS and SCS. It does not over- or under-weight calls based on duration. It is codec-independent and reflects dynamic quality of transmission, not the codec baseline. SCSR grades calls with below-default configurable thresholds* ## Troubleshoot Communications from CUCM to RIG With access to the CUCM command line, the following commands can be used to help troubleshoot communications between CUCM and the management station: NOTE*Replace the* ***[address]*** *below with the IP address of the RIG.* Follow these steps to verify traffic: 1. Log on to the CUCM command line via ssh. 2. Perform one of the following: 1. To verify that SNMP traffic is flowing between Call Manager and the RIG, enter the following command: **utils network capture host ip *[address]* port 161** 2. To verify that SOAP/AXL traffic is flowing between Call Manager and the RIG, enter the following command: **utils network capture host ip *[address]* port 8443** 3. To verify that CDR traffic is flowing from Call Manager and the RIG, enter the following command: **utils network capture host ip *[address]* port 22** 4. To stop the capture, press **Ctrl** + **C**. This causes the capture process to end; no new packets are added to the capture dump. 5. To collect the capture from the server, transfer the capture file using one of the following.NOTE*The capture files are stored in the* ***activelog platform/cli/*** *location on the server.* #### **Transfer Capture File through the CLI to a SFTP server** 1. Use the command **file get activelog platform/cli/packets.cap** to collect the packets.cap file to the SFTP server. 2. Enter the SFTP server IP/FQDN, port, username, password, and directory information. The CLI should indicate success or failure of the file transfer to the SFTP server. #### Transfer Capture File to Local PC Using Real-Time Monitoring Tool (RTMT) 1. Launch RTMT. If it is not installed on the local PC, install the appropriate version from the **CUCM Administration** window. Navigate to **Applications > Plugins** menu. Click **System**; then **Trace & Log Central**. Double-click **Collect Files**. Click **Next** through the first menu. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-98r5549j.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*RTMT Window* 2. From the **Collect Files** window, select **Packet Capture Logs**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-3u75kb2s.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Collect Files* 3. Select a time range when the capture is performed and a download directory on the local PC: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-wrvewpxr.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Collection Time*  RTMT closes this window, proceeds to collect the file, and stores it on the local PC in the specified location. ## Manage CUCM Clusters This section explains several tasks that can be used to manage the CUCM clusters, as needed. - **Edit a Cluster Configuration** - **Manage Collections** ### Edit a Cluster Configuration Follow these steps to edit a cluster configuration: 1. Navigate to **Modules** > **Cisco > UCM**. The **Cisco UCM Setup - Configurations** window appears. 2. Right-click on the configuration you want to change and select **Edit**. The **Edit Cisco UCM** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-o07okjwc.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Edit Cisco UCM - General* 3. Select one of the following tabs: **- SNMP** **- AXL** **- Gateways** 4. Make changes, as needed. NOTE*When you edit a Gateway, you will need to click the* ***Edit*** *button to the right of the Gateway you want to change. The* ***Edit Gateway*** *window appears. Make changes as needed; then click* ***OK****. You can also click* ***Reset****, if you change your mind.*NOTE*The* ***AXL User*** *and* ***AXL Password*** *cannot be changed, but they are validated again. A* ***Validating*** *dialog box appears. After validation, the cluster configuration is updated with the changes and listed in the* ***Cisco UCM Setup - Configurations*** *pane.* 5. Click **OK**. ### Manage Collections Managing collections includes the following tasks: - **Enable a Collection** - **Disable a Collection** - **Change a Collection Schedule** - **Execute a Collection** #### Enable a Collection Follow these steps to enable a collection for a particular cluster configuration: 1. See ***View Collections***. under ***Configure CUCM VKM***. 2. Select the collection you want to enable. 3. Right-click on the collection and select **Enable**. The **Enabled** column for the system changes to **Yes**. #### Disable a Collection Follow these steps to disable a collection for a particular cluster configuration: 1. See ***View Collections***. under ***Configure CUCM VKM***. 2. Select the collection you want to disable. 3. Right-click on the collection and select **Disable**. The **Enabled** column for the system changes to **No**. #### Change a Collection Schedule Follow these steps to change the collection schedule for a particular cluster configuration: 1. See [***View Collections***](/v1/docs/cisco-ucm-vkm-configuration-guide#view-collections) under ***Configure CUCM VKM***. 2. Select the collection you want to change. 3. Right-click on the collection and select **Change Cron String**. The **Update Cron String** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/cisco-ucm-vkm-configuration-guide--image-0mw6fp42.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A18%3A28Z&se=2026-11-08T17%3A18%3A28Z&sr=c&sp=r&sig=QjvbSA5EaQUAumf9QbCkuRVpeCAl%2FRD0LLcNwf7k2XQ%3D)*Update Cron String* 4. Enter the new collection schedule using a Cron expression. 5. Click **OK**. #### Execute a Collection Follow these steps to execute a collection: 1. See [***View Collections***](/v1/docs/cisco-ucm-vkm-configuration-guide#view-collections) under ***Configure CUCM VKM***. 2. Select the collection you want to execute. 3. Right-click on the collection and select **Execute Now**.