Cisco Call Manager (CUCM) Setup

Step 1 - Enable the AXL API User Role

The Vyopta Data Collector leverages the AXL API for monitoring UCM registered endpoints. While the AXL API User role is not enabled by default, it is often part of standard UCM configurations. The following steps will guide you in confirming or creating this required user role:

1. Log into the Cisco UCM with an Administrator Account.
2. Navigate to the Cisco Unified CM Administration.
3. Go to User Management > User Settings > Access Control Group
   
4. Create an Access Control Group called “AXL User Group” 
   
   Note : the name of this user group is specific and case sensitive. It must be named “AXL User Group” exactly or will fail validation on initial configuration
   
   
5. Next, go to User Management > User Settings > Role
   
6. Search for AXL and confirm that “Standard AXL API Access” is present, or if “Standard AXL Read Only API Access” is present if using that role. If the role(s) already exists, then proceed to the next section, otherwise create the necessary role with the required application access as shown below
   
7. Return to the User Management > Access Control Group and find the AXL User Group which was created previously
8. Find the AXL User Group from the List, and select the ‘i’ button as shown below:
   
9. Select Assign Role to Group, find the Standard AXL API Access role, or the Standard AXL Read Only API Access and Standard AXL API Users. Select the role, click the “Add Selected” button, and click the save button. The role will now be listed in this User Group.
   

Step 2 - Configure a Service Account for Use in Vyopta

Next, you will create an application user service account on your Call Manager publisher:

1. Log into the CUCM publisher with the Administrator account.
2. Go to User Management > Application User > Add User.
3. Enter a username for the service account, typically something like “vyopta_svc” 
4. Set a password for the account.
   
   
   
5. Assign the following groups to the user account. Note these groups must be assigned or initial configuration in Vyopta may fail:
   
   • AXL User Group
   • Standard CCM Read-Only
   • Standard CCM Server Monitoring
   • Standard CTI Enabled
   • Standard CTI Allow Control of Phones supporting Connected Xfer and conf
     
6. Endpoints that you will be monitoring in real time should be moved from the ‘Available Devices’ to the ‘Controlled Devices’ list under the Device Information section. You can use the ‘Device Association’ or ‘Find more phones’ button to better navigate the endpoints in your CUCM environment.
   
7. Save the user account
8. Once you have added the account, ensure that the following services are enabled by navigating to Cisco Unified Serviceability > Tools > Service Activation on each CUCM Publisher:
   
   • Cisco Call Manager (note: If CallManager service is not activated then you will be unable to verify and enable the data collector service for CUCM. Please contact support@vyopta.com.)
   • Cisco CTI Manager
   • Cisco SOAP – CDRonDemand Service
   • Cisco CAR Web Service
   • Cisco AXL Web Service
     
9. Make sure parameters are correctly enabled under Cisco Unified CM Administration for Active Publishers:
   • Navigate to Cisco Unified CM Administration -> System -> Service Parameters.
   • Select Active Publishing Server(s).
   • Select the Cisco Call Manager Service.
   • Under System section set CDR Enabled Flag and CDR Log Calls with Zero Duration Flag to True.
   
   Note: The CDR Enabled Flag and CDR Log Calls with Zero Duration Flag must be set to True on every  cluster member –  these values are not inherited from Publishers, and these values are not set by default. If not set correctly, CDRs will not be transmitted and data loss is likely.
   • Under Cluster Wide parameters (Device - General) set Call Diagnostic Enabled to Enabled Regardless of CDR Enabled Flag and the two Show Line Group Member parameters to True
• Make sure the same parameters are enabled under Cisco Unified CM Administration for Subscribers (if applicable)
10. For large Call Manager deployments (i.e., More than 5 nodes or with multiple clusters) it is recommended to adjust the following parameters under Cisco Unified CM Administration > System > Enterprise Parameters from their default values in order to facilitate timely CDR collection: 
    • CDR File Time Interval: By increasing this value from the default of 1 minute to 5 minutes, the number of CDR files will be reduced by a factor of 5 with no impact on CUCM performance. Please ensure that any other CDR reporting / billing solutions will not be adversely affected by changing this parameter. 
    • Allowed CDRonDemand get_file Queries per Minute: For larger Call Manager deployments (greater than 20 total nodes) it is recommended to increase this value from the default value of 10 to 20, which will assist in CDR collection with no impact on CUCM performance.

To add a UCM device the following is required:

• Access to the FQDN/ IP address of the video device from the Vyopta Data Collector
• Previously created user service account credentials on each video device

Reminder:  One subscriber for each cluster is needed ONLY if the “Call Manager” service is not running on the publisher. If the “Call Manager” service is running on the publisher then there is no need to add a subscriber. 

Please follow the instructions below to add each UCM device:

1. Log into the Vyopta Admin Portal
   
2. Select the Infrastructure menu or Icon, then select New Infrastructure (near the bottom)
3. From the selection of infrastructure types, click Cisco CUCM:

On the Configuration page that opens:

• Enter the CUCM name and description as desired
• Enter the IP or hostname for the CUCM
• Enter the service account user name
• Enter the service account PW

• Click the Save button.
• Click the Validate button to confirm the connection and authorization.

Note: None of the Additional Settings in the panels below need to be changed from their defaults.

Finally, you can enable data collection for the CUCM by clicking the 'Disabled' button at the top of the page, changing it to 'Enabled'.