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:

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

Follow these steps to enable the Cisco UCM VKM:

Navigate to RIG > Module Configuration.
The Module Configuration window appears.
Select Cisco UCM.

Enable CUCM VKM
Click Apply.
To restart the RIG and apply the changes:
1. Navigate to RIG > Admin > Restart.
2. When the following message appears, click Yes.
  
  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.

Open the Maritime Terminal and execute the following commands:
1. PLATFORM SETDISABLESNMP TRUE
2. PLATFORM SETDISABLEICMP TRUE
Verify the configuration by executing the following command:
1. PLATFORM STATUS

Configure the server.properties File

Follow these steps to locate, download, update, and save the server.properties file:

Navigate to RIG > File Manager.
The File Manager window appears.

server.properties File
Look for the Remote File System pane on the right; then navigate to the etc\ server.properties configuration file in the RIG installation directory.

server.properties File
Right-click on the server.properties file and select Download.
Save the server.properties file to the local destination.
Navigate to the server.properties file.
Right-click on the server.properties file and select Open With.
Open the file using Notepad.
See Configure RIG Credentials for FTP below
See Configure to Collect CDRs below
Navigate to File > Save to save any changes.
Navigate to RIG > File Manager.
The File Manager window appears.
Navigate to the etc\server.properties configuration file in the RIG installation directory.
Right-click on the server.properties file and select Upload.
Browse to the updated server.properties file, select, and click Open.
The Upload File window appears.

Upload
Click Upload.
To restart the RIG and apply the changes:
1. Navigate to RIG > Admin > Restart.
2. When the following message appears, click Yes.
  
  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.

Create a username and password for SFTP/FTP connections.
Add these credentials to the configuration file, as shown in the following example:

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

sshAllowInsecureAlgorithms=true

View the following example.

sshAllowInsecureAlgorithms

Configure the ciscoucm-module.properties File

Follow these steps to locate, download, update, and save the ciscoucm-module.properties file:

Navigate to RIG > File Manager. The File Manager window appears.

Remote File System
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.

ciscoucm-module.properties File
Right-click on the ciscoucm-module.properties file and select Download.
Save the ciscoucm-module.properties file to the local destination.
Navigate to the ciscoucm-module.properties file.
Right-click on the ciscoucm-module.properties file and select Open With.
Open the file using Notepad.
See Enable Registration Events below.
See Change CDR Retention below.
Navigate to File > Save to save the changes.
Navigate to RIG > File Manager.
The File Manager window appears.
Navigate to the \etc\ciscoucm-module.properties configuration file in the RIG installation directory.
Right-click on the ciscoumc-module.properties file and select Upload.
Browse to the updated ciscoumc-module.properties file, select, and click Open.
The Upload File window appears.
Click Upload.
To restart the RIG and apply the changes:
1. Navigate to RIG > Admin > Restart.
2. When the following message appears, click Yes.
  
  Restart

Enable Registration Events

Follow these steps to receive events for registration and de-registration of phones:

Locate the send.registration.event parameter.
Change the value to true, as shown below:

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:

Locate the cdrAgeDays parameter.
Enter a new value. The default value is 30 days, as shown in Figure cdrAgeDays

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:

Navigate to RIG > File Manager.
The File Manager window appears.

Remote File System
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.

receiver-module.properties File
Right-click on the receiver-module.properties file and select Download.
Save the receiver-module.properties file to the local destination.
Navigate to the receiver-module.properties file.
Right-click on the receiver-module.properties file and select Open With.
Open the file using Notepad.
See Enable Syslog below.
Navigate to File > Save to save the changes.
Navigate to RIG > File Manager.
The File Manager window appears.
Navigate to the etc\receiver-module.properties configuration file in the RIG installation directory.
Right-click on the receiver-module.properties file and select Upload.
Browse to the updated receiver-module.properties file, select, and click Open.
The Upload File window appears.
Click Upload.
To restart the RIG and apply the changes:
1. Navigate to RIG > Admin > Restart.
2. When the following message appears, click Yes.
  
  Restart

Enable Syslog

To enable Syslog, add the following property and value:

syslog.enable

Configure Cisco U CM

Configuring the CUCM includes the following tasks:

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:

Access Cisco Unified Serviceability using the drop-down; then click Go.

Cisco Unified Serviceability
Enter your Username and Password; then click Login.

Login
Navigate to SNMP > V1/V2 > Community String.
The SNMP Community String Configuration window appears.

Select a Server
Select a Server* using the drop-down; then click Find.
A list of community strings appears.

Search Results/Community Strings
NOTE
You can also use the Find Community Strings where Name field to search for existing community strings.
To add a new community string, click Add New.
A new SNMP Community String Configuration window appears.

Add a New Community String
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:

Select a community string listed in the Search Results area.
When the SNMP Community String Configuration window appears, make changes to the Access Privileges.

Add a SNMP Notification Destination

Follow these steps to add a SNMP notification destination:

Access Cisco Unified Serviceability using the drop-down; then click Go.

Cisco Unified Serviceability
Enter your Username and Password; then click Login.

Login
Navigate to SNMP > V1/V2 > Notification Destination.
The SNMP Notification Destination Configuration window appears.

SNMP Notification Destination Configuration
Select a Server* using the drop-down; then click Find.
Click Add New.
A new SNMP Notification Destination Configuration window appears.

Add a New Notification Destination
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:

Access Cisco Unified CM Administration using the drop-down; then click Go.

Cisco Unified CM Administration
Enter your Username and Password; then click Login.

Login
Navigate to User Management > Application User.
The Find and List Application Users window appears.

Find and List Application Users
Click Add New.
The Application User Configuration window appears.

Application User Configuration
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.
Click Add to Access Control Group.

Add to Access Control Group

The Find and List Access Control Groups window appears.

Find and List Access Control Groups
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
Click Add Selected.
The Application User Configuration window appears with the new Access Control Groups listed.

Application User Configuration
Click Save.
Notice that the Roles pane populates with the roles associated with the Application User.

Roles

Activate Services

Follow these steps to activate service:

Access Cisco Unified Serviceability using the drop-down; then click Go.

Cisco Unified Serviceability
Enter your Username and Password; then click Login.

Login
Navigate to Tools > Service Activation.
The Service Activation window appears.

Select a Server
Select a Server* using the drop-down; then click Go.
The Service Activation window appears.

Service Activation
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
  
  CDR Services
Confirm the following services are selected for Database and Admin Services:
1. Cisco Bulk Provisioning Service
2. Cisco AXL Web Service
  
  Database and Admin Services
Confirm the following services are selected for Performance and Monitoring Services:
1. Cisco Serviceability Reporter
2. Cisco CallManager SNMP Service
  
  Performance and Monitoring Services
Click Save.

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:

Access Cisco Unified CM Administration using the drop-down; then click Go.

Cisco Unified CM Administration
Enter your Username and Password; then click Login.

Login
Navigate to System > Service Parameters.
The Service Parameters Configuration window appears.

Select Server and Service
Select the Server* using the drop-down.
Select the Service* (in this case, Cisco CallManager (Active)) using the drop-down.
The Service Parameter Configuration window expands to show the service parameters.

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.

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 CDRAdd 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).

Click Save.

Manage CDRs

Follow these steps to manage the CDRs:

Access Cisco Unified Serviceability using the drop-down; then click Go.

Cisco Unified Serviceability
Enter your Username and Password; then click Login.

Login
Navigate to Tools > CDR Management.
The CDR Management window appears.

CDR Management
In the Billing Application Server Parameters area, click Add New.

Billing Application Server Parameters
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/.
Click Add.

Verify Load CDR Only Option

Follow these steps to verify that the Load CDR Only check box is NOT selected:

Access Cisco Unified Serviceability using the drop-down; then click Go.

Cisco Unified Serviceability
Enter your Username and Password; then click Login.

Login
Navigate to Tools > CDR Analysis and Reporting.

Tools > CDR Analysis and Reporting

The Cisco Unified CM CDR Analysis and Reporting window appears.
Navigate to System > Scheduler > CDR Load.

System > Scheduler > CDR Load

The CDR Load window appears.

CDR Load
Verify that the Load CDR Only check box is not selected.
Click Update.
NOTE
Changes 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.

Access Cisco Unified Serviceability using the drop-down; then click Go.
Navigate to System > Enterprise Parameters.
The Enterprise Parameters Configuration window appears.

Enterprise Parameters Configuration
Scroll down to CCM Web Services Parameters area.
The Enterprise Parameters Configuration window appears.

CCM Web Services Parameters
Change the Allowed Performance Queries Per Minute parameter to 80.
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).

Access Cisco Unified Serviceability using the drop-down; then click Go.
Navigate to Tools > Control Center - Network Services.
The Control Center - Network Services window appears.

Control Center - Network Services
Select a Server* using the drop-down; then click Go.
Scroll down to Soap Services area.
Verify that the SOAP - Real-Time Service APIs is running, which means the RisPort service is also activated.

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:

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

Navigate to Modules > Cisco > UCM.

Modules > Cisco > UCM

The Cisco UCM Setup - Configurations window appears.
Click Add.

Cisco UCM Setup - Configurations

The Add Cisco UCM - General window appears.

Add Cisco UCM
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.

Add Cisco UCM - SNMP

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 NOTE Enabled for SNMP V3 only.
Privacy Password	Password for the Privacy Protocol. NOTE Enabled for SNMP V3 only.

The Add Cisco UCM - AXL window appears.

Add Cisco UCM - AXL

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.

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.

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.

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:

Navigate to Modules > Cisco > UCM.
The Cisco UCM Setup - Configurations window appears.
Select the new cluster configuration; then click View Collections.

View Collections

The Collections window appears.

Collections
View collection data for the system configuration, such as:
1. Name
2. Enabled
3. Status
4. Schedule
5. Last Execution
6. Last Execution Duration
Right-click on a collection and select one of the following:

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:

Navigate to Modules > Cisco > UCM.

Modules > Cisco > UCM

The Cisco UCM Setup - Configurations window appears.

Cisco UCM Setup - Configurations
Select an existing cluster configuration that you want to remove or offboard.
Click Remove.
When the following message appears, click Yes.

Remove

The cluster configuration is removed and no longer appears in the list on the Cisco UCM Setup- Configurations 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:

Navigate to RIG > File Manager. The File Manager window appears.
Locate the cdr folder in the Apps folder.
Locate the cucm folder in the cdr folder.
View the following example path.
<dir>:\applicationhomedirectory\cdr\cucm
View a list of archived files in the cucm folder.

archive folder

Follow these steps to navigate to the archive folder:

Navigate to RIG > File Manager. The File Manager window appears.
Navigate to the folder where the application is installed.
Locate the archive folder in the application folder.
Locate the cucm folder in the archive folder.
View the following example path:
<dir>:\applicationhomedirectory\archive\cucm
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

Access Cisco Unified CM Administration using the drop-down; then click Go.

Cisco Unified CM Administration
Enter your Username and Password; then click Login.

Login
Navigate to System > Enterprise Parameters.
The Enterprise Parameters Configuration window appears.
Scroll down to the Cisco Syslog Agent area.

Cisco Syslog Agent

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.

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:

Navigate to Modules > Cisco > UCM.
The Cisco UCM Setup - Configurations window appears.
Click the Trunk Types tab.
The Cisco UCM Setup - Trunk Types window appears.

Cisco UCM Setup - Trunk Types
Right click and select Add.

Add Trunk Type

The Add Trunk Type window appears.

Add Trunk Type

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

Click OK.

Edit a Trunk Type

Follow these steps to edit a trunk type:

Navigate to Modules > Cisco > UCM.
The Cisco UCM Setup - Configurations window appears.
Click the Trunk Types tab.
The Cisco UCM Setup - Trunk Types window appears.

Cisco UCM Setup - Trunk Types
Right-click on a trunk type and select Edit.

Edit Trunk Type

The Edit Trunk Type window appears.

Edit Trunk Type
Make changes, as needed.
Click OK.

Remove a Trunk Type

Follow these steps to remove a trunk type:

Navigate to Modules > Cisco > UCM.
The Cisco UCM Setup - Configurations window appears.
Click the Trunk Types tab.
The Cisco UCM Setup - Trunk Types window appears.

Cisco UCM Setup - Trunk Types
Right-click on a trunk type to delete and select Remove.

Remove Trunk Type

The Remove window appears.

Remove
Click Yes.

Configure VKM Options

Follow these steps to configure the VKM options for the CUCM:

Navigate to Modules > Cisco > UCM.
The Cisco UCM Setup - Configurations window appears.
Click the VKM Options tab.
The Cisco UCM Setup - VKM Options window appears.

Cisco UCM Setup - VKM Options

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. NOTE This 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.
uploadDestDiruploadDestDir	Identifies the destination directory on the specified host. Default value is /.
uploadEnableuploadEnable	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.

To change a value, right-click on the VKM option and select Edit.
The Edit VKM Option window appears for that option/parameter.

Edit VKM Option
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:

Navigate to Reports > Inventory > Cisco > UCM.

Reports > Inventory > Cisco UCM

The Cisco UCM Inventory window appears with a list of the inventory categories.

Cisco UCM Inventory
Select an inventory category, such as Call Manager. The Listing window appears with data for Call Manager.

Call Manager - Example
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:

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:

Navigate to Health > Elements.

Health > Elements

The Elements window appears.

Elements
Click Agents.
A list of agents appears.

Agents

NOTE
The actual list of agents will depend on the architecture of each individual CUCM deployment.
Click on an agent to view the poll functions for that agent.
View the following example.

Poll Functions

Edit Poll Thresholds

Follow these steps to edit a poll threshold:

See View Agents and Poll Functions above.
Select a poll function; then right-click and select Edit.

Edit Poll Function

The Edit Poll Functions - Parameters window appears.

Edit Poll Functions
Click the Thresholds tab.

Threshold Values
View the various threshold values.
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:

See View Agents and Poll Functions above.
Right-click on a poll function and select Edit.
The Edit Poll Functions - Parameters window appears.
Click ... for Compression.
The Edit Compression window appears.

Edit Compression
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.
Click Select.
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:

Navigate to Health > Elements.
The Elements window appears.

Elements
Click Poll Functions.
A list of poll functions appears.

Poll Functions
Select SNMP Connection Test; then right-click and select Edit.
The Edit Poll Functions - Parameters window appears.

Edit Poll Functions

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.

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:

Navigate to Configure > Dependency Tree.
The Dependency Trees window appears with a list of tree names.

Configure Dependency Tree
Double-click on one of the listed trees; then view the dependency tree in the pane to the right.

Dependency Tree
Scroll to view all of the dependency tree.

View Publisher Connectivity Node

Follow these steps to view the Publisher Connectivity node:

Navigate to Configure > Dependency Tree.
The Dependency Trees window appears with a list of tree names.
Select a dependency tree with Publisher connectivity.
Scroll to view the Connectivity node with the following three end nodes:

AXL API Connection Test
Perfmon Connection Test
SNMP Connection Test

Publisher Connectivity Tree

View Subscriber Connectivity Node

Follow these steps to view the Subscriber Connectivity node:

Navigate to Configure > Dependency Tree.
The Dependency Trees window appears with a list of tree names.
Select a dependency tree with Subscriber connectivity.
Scroll to view the Connectivity node with the following two end nodes:

Perfmon Connection Test
SNMP Connection Test

Subscriber Connectivity Tree

View Call Details

Follow these steps to view more information about a specific call.

Navigate to Health > Quality Management > Call Details.
The Call Details window appears.

Call Details

Select a call; then right-click and select View Details.

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.

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:

Log on to the CUCM command line via ssh.
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

Use the command file get activelog platform/cli/packets.cap to collect the packets.cap file to the SFTP server.
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)

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.

RTMT Window
From the Collect Files window, select Packet Capture Logs.

Collect Files
Select a time range when the capture is performed and a download directory on the local PC:

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:

Navigate to Modules > Cisco > UCM.

The Cisco UCM Setup - Configurations window appears.
Right-click on the configuration you want to change and select Edit.

The Edit Cisco UCM window appears.

Edit Cisco UCM - General
Select one of the following tabs:

- SNMP
- AXL
- Gateways
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.
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:

See View Collections. under Configure CUCM VKM.
Select the collection you want to enable.
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:

See View Collections. under Configure CUCM VKM.
Select the collection you want to disable.
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:

See View Collections under Configure CUCM VKM.
Select the collection you want to change.
Right-click on the collection and select Change Cron String.
The Update Cron String window appears.

Update Cron String
Enter the new collection schedule using a Cron expression.
Click OK.

Execute a Collection

Follow these steps to execute a collection:

See View Collections under Configure CUCM VKM.
Select the collection you want to execute.
Right-click on the collection and select Execute Now.

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.

Parameter	Enter...
Name	Name of the onboarding cluster configuration.
Description	Description of the cluster configuration.

Documentation Index

Cisco UCM VKM Configuration Guide

Overview

About this Guide

Supported Software Versions

Configure the Nectar RIG

Enable the Cisco UCM VKM

Cloud CUCM Support

Configure the server.properties File

Configure RIG Credentials for FTP

Configure to Collect CDRs

Configure the ciscoucm-module.properties File

Enable Registration Events

Change CDR Retention

Configure the receiver-module.properties File

Enable Syslog

Configure Cisco U CM

Configure SNMP

Create the SNMP Community String

Add a SNMP Notification Destination

Configure Nectar User

Activate Services

Administer Call Detail Records

Configure System Parameters

Manage CDRs

Verify Load CDR Only Option

Edit Performance Monitoring Parameter

Verify Cisco RisPort Service Activation

Configure SNMP on Routers/Voice Gateways

Configure CUCM VKM

Add a New Cluster Configuration

View Collections

Remove or Offboard a Cluster Configuration

CUCM CDR File Storage

cdr folder

archive folder

Configure CUCM Alarms

Manage Trunk Types

Add a Trunk Type

Edit a Trunk Type

Remove a Trunk Type

Configure VKM Options

View Inventory

CUCM VKM and Nectar UCMP

View Elements

View Agents and Poll Functions

Edit Poll Thresholds

Change Poller Data Storage Setting

Edit an SNMP Connection Test Poll Function

View Dependency Trees

View Dependency Tree

View Publisher Connectivity Node

View Subscriber Connectivity Node

View Call Details

Troubleshoot Communications from CUCM to RIG

Transfer Capture File through the CLI to a SFTP server

Transfer Capture File to Local PC Using Real-Time Monitoring Tool (RTMT)

Manage CUCM Clusters

Edit a Cluster Configuration

Manage Collections

Enable a Collection

Disable a Collection

Change a Collection Schedule

Execute a Collection