This section makes frequent use of data contained in the Technical Requirements.
All relevant sections of the Technical Requirements Data collection should be completed or known before commencing with the steps in this section.
AXL Configuration
VSM uses AXL API to collect data from CUCM, this can be achieved by creating a user with AXL Capabilities within CUCM.
Enable AXL Service
Browse to the CUCM then select "Cisco Unified Serviceability" from the navigation menu.
Go to Tools> Control Centre - Feature Service.
Click on the select server dropdown menu and choose the CUCM Publisher. Then click 'Go'.
Make Sure AXL Web Service status is started.
If the AXL Web Service is deactivated or stopped, start it from the top of the page
Create CUCM AXL User
Browse to the CUCM, then select 'Cisco Unified CM Administration' from the navigation menu. Once selected, click 'Go'.
Create AXL privileged Access control group
Go to User Management> User Settings> Access Control Group.
Click the "Add New" button to create a new Access Control group.
Enter an Access Control group name and click save. e.g. VSM-Access-Control-Group
In the top right corner click on the related links dropdown menu. Next, select the "Assign Role to Access Control Group" option. then click 'Go'
Under 'Role Assignment', click the "Assign Role to Group" button.
A page will appear with a list of all available roles.
Select the checkbox for the following roles, then click 'Add Selected':
- Standard AXL API Access.
- Standard CCM Admin Users.
- Standard SERVICEABILITY Read Only.
After being added, the following page will appear - click 'Save'.
Create an AXL User
From the CUCM Administration page go to User Management> Application User> then Click 'Add New'
Enter user details in the Application User Information.
Application User Information
Field | Value |
User ID | This is the user that is going to be used by VSM to access the CUCM |
Password | Enter the password for the new user. |
Confirm Password | Type the same password again. |
Here is an example of the form being filled out.
Under 'Permission Information' for the newly created Application User, click 'Add to Access Control Group'.
In the search bar enter the name of the newly created Access Control Group - then click find.
Check the checkbox next to the created Access control Group and then click 'Add Selected'.
Click Save under 'Application User Configuration'.
Once You click Save it will show the list of roles assigned to the user.
Test new user account
Make sure you can sign in to CUCM with the newly created account by signing out and sign back in again with the your new account.
CUCM SNMP Configuration
SNMP configuration is required as part of CUCM Monitoring, SNMP can be configured as V1 ,V2 or V3 based on the customer requirements.
Changes to the SNMP configuration on CUCM will require a service restart to take effect.
Browse to the CUCM then select 'Cisco Unified Serviceability' from the navigation menu.
Configure SNMP V1/V2
Navigate to SNMP>V1/V2>Community String
SNMP V1/V2
SNMP Community String Configuration
From the drop down List Choose the server you want to configure SNMP and click find>>Add new if none was configured.
SNMP need to be configured on all the servers in CUCM Cluster.
SNMP Community String Configuration
Fill in the SNMP Community String Page with the following values.
SNMP Community String Configuration
Field | Value |
Community String Name | Enter the required Name |
Hosted IP Address Information | Choose one of the following based on the client requirements 1- Accept SNMP Packets from Any host. 2- Accept SNMP Packets only from these Hosts If you choose Accept SNMP Packets only form these hosts make sure to enter IP Address of VSM Probe server under Host IP Address |
Access Privilege | Choose ReadNotifyOnly unless something else required from the customer |
Apply to All Nodes | Check the check box to apply configuration to all servers within the cluster. |
SNMP Community String Configuration
SNMP Sample Configuration
When you click save warning will display notifying of restarting SNMP Master Agent Service for the change to take effect, click ok to restart the service.
SNMP Service Restart
Once completed the following message display with the status of the restart.
SNMP Service Restart Status
Configure CUCM to send SNMP Traps by navigating to SNMP>>V1/V2>>Notification Destination
SNMP Notification Destination
Field | Value |
Host IP Address | VSM Probe IP Address |
Notification Type | Trap |
SNMP Notification Destination
Choose server >>Find>>Click Add New
SNMP Notification Destination Server Selection
The following page appear, from the drop down list choose Add new.
SNMP Notification Destination Configuration
SNMP Notification Destination Configuration Drop Down List
Enter the Values in the page as per following
SNMP Notification Destination
Field | Value |
Host IP Addresses | Add New is selected |
Host IP Address | VSM Probe IP Address |
Port Number | Default is 162, change it only if needed |
SNMP Version | Choose either V1/V2C |
Notification Type Information | Trap |
SNMP Notification Destination Configuration – Add New Page
SNMP Notification Destination Configuration Sample Configuration
Once you choose Notification Type Community String Information will display.
Choose the community String created earlier and check apply to All Nodes.
SNMP Notification Destination Configuration – Apply To All Nodes
Click ok for the pop to restart the SNMP Master Agent Service as before unless client want to do it later.
Notification Destination Service Restart.
Once restart is completed SNMP Notification Destination Configuration will show the new Destination IP Address.
SNMP Notification Destination Configuration Status
CUCM SNMP V3 Configuration
Navigate to SNMP>V3>User
SNMP V3 User Configuration
Select Server from the drop down list and click find.
SNMP V3 User Configuration
Click Add New to create SNMP User
SNMP V3 User configuration
Field | Value |
User Name | Enter SNMP User Name |
Authentication Required | Check the checkbox of Authentication |
Password | Enter the Password |
Protocol | Choose either MD5 or SHA |
Privacy Required | Optional/check the checkbox if required |
Password | Enter the password |
Protocol | Choose the preferred Protocol (DES/AES128) |
Accept SNMP Packets from Anyhost | Uncheck the checkbox |
Accept SNMP Packets only from these Hosts | Check the Check box |
Host IP Address | Enter the IP Address of the VSM Probe and click Insert |
Access Privileges | Choose ReadNotify Only |
Apply to All Nodes | Check the checkbox |
SNMP V3 User Configuration Page
SNMP V3 User Configuration Example
Click ok to the pop up to restart SNMP master agent for configuration to take effect
SNMP Master Agent Pop UP to restart the service
Once restart is completed SNMP user configuration will be displayed with the new user configured.
SNMP V3 User Configuration
Navigate to Snmp >> V3 >> Notification Destination
SNMP V3 Notification Destination
Choose server >>Find>>Click Add New
SNMP Notification Destination Server Selection
The following page appear, from the drop down list choose Add new.
SNMP Notification Destination Configuration
SNMP Notification Destination Configuration Drop Down List
Enter the Values in the page as per following
SNMP Notification Destination Configuration Table
Field | Value |
Host IP Addresses | Add New is selected |
Host IP Address | VSM Probe IP Address |
Port Number | Default is 162, change it only if needed |
SNMP Version | Choose either V1/V2C |
Notification Type Information | Trap |
| Security Level | Choose based on the security Level configured in the the user |
| User Information | Check the check box next to user created |
| Apply to All Nodes | Check the check box next to Apply to All Nodes |
Click Insert
SNMP Notification Destination Configuration Sample Configuration
Click ok to the pop up to restart SNMP master agent for configuration to take effect
SNMP Master Agent Pop UP to restart the service
CUCM Syslog configuration
Navigate to Cisco Unified CM Administration>System>Cisco Syslog Agent>Remote Syslog Server Name
Enter the IP Address of VSM Probe as one of Remote Syslog Severs.
Syslog Severity for Remote Syslog messages >> Choose based on the requirements
CUCM Syslog configuration
CDR Configuration
Navigate to Cisco Unified Serviceability
From There Navigate to >>Tools >> Control Centre – Feature Service >>Select Publisher from the drop-down list and make sure All CDR services are up.
Start the services if it was deactivated or stopped.
Control Centre – Feature Service CDR Services
Navigate to Cisco Unified Serviceability >> Tools >> Control Centre – Network Services >> Select Publisher from the drop down list and make sure all CDR services are up.
Control Centre – Network Services Publisher CDR Services
Navigate to Cisco Unified Serviceability >> Tools >> Control Centre – Network Services >> Select Subscriber from the drop down list and make sure CDR Agent service is running.
Repeat the above step for all subscribers in the Cluster.
Control Centre - Network Services Subscriber CDR Service
Navigate to Cisco Unified CM Administration >> System >> Service Parameter >> Call Manager Service. Set the CDR Enabled Flag to True. This has to be done for all the nodes in the server.
CUCM Service Parameters Configuration
Set up CDR Enabled Flag and CDR Log Calls with Duration to True
Repeat above step for all CUCM Servers in the cluster.
navigate to System >> Service Parameter >> Call Manager Service>> Clusterwide Parameters >> Call Diagnostics Enabled parameter to Enabled Only When CDR Enabled Flag is True
Setup Call Diagnostics – Enable CMR
Now add SFTP server/Billing Server where the files are to be sent. Navigate to Cisco Unified Serviceability > Tools > CDR Management and add new billing server.
CDR Management Page
Billing Application Server Parameters
Field | Value |
Host Name /IP Address | Enter Probe IP server |
Username | Enter username details for SFTP |
Password | Enter Password details for SFTP |
Protocol | SFTP |
Directory Path | \ |
Resend on Failure | Check the checkbox |
Billing Application Server Parameters
CUCM Backup Configuration
The following is required to configure VSM as destination for backup files. These Backup files will be sent from the VSM Probe to the Virsae Cloud.
Navigate Disaster Recovery System
Navigate to Backup >> Backup Device >> Add New
Disaster Recovery Page
Enter the required details for the Backup Device
Backup Device Details
Field | Value |
Backup Device Name | Enter Any name |
Host name / IP Address | VSM Probe IP Address |
Path name | \ |
User name | VSM SFTP server username |
Password | VSM SFTP server password |
Number of backups to store on Directory | Leave it to default – VSM Probe will send the backups to Virsae Cloud. |
Configure backup scheduler by navigating to Backup >> Scheduler.
Define Scheduler Name. Select the Device name (the device created earlier) and check the features you want to backup, ideally check all the options.
If using CUCM prior to Version 12.0, the features are CDR_CAR, UCM and PLM. If using CUCM Version 12.0 and later, the features are CDR_CAR, UCM and IM_AND_PRESENCE.
CUCM Backup features prior to Version 12.0
CUCM Backup features for Version 12.0 and later
Configure a schedule backup based on your scenario, recommended Daily backup after hours.
Backup Schedule
Click on Save and notice the warning as shown in the image. Click on OK in order to move forward.
Backup Warning
Once the Backup Schedule is created, click on Enable Schedule
Enable Schedule
Make sure the schedule status is changed to Enabled.
Schedule Backup Enabled
Web Portal Configuration
Add CUCM
Login to the VSM web portal using your credentials and password.
For your customer, select Service Desk > Equipment Locations. Right-click on the Equipment Location (Appliance) that will serve this particular UC Server and select ‘Manage Equipment’
At the bottom of the ‘Manage Equipment’ page click on the ‘Add Equipment’ Button
A form will open which you can populate with the equipment details as per table 8.
Select the Vendor ‘Cisco Systems’ and Product ‘Unified Communications Manager’.
Web Portal – Add CUCM Field Description
Field | Setting |
Vendor | Cisco Systems |
Product | Unified Communications Manager |
Equipment Name | Friendly name for this CUCM |
Username | Administrative Username |
Password | Administrative Password |
IP Address / Host Name | IP Address of server (Virtual in duplicated servers) |
Site | Free text field, this information will be included in alarm notifications from the VSM Workflow. |
Use Cisco APIs | Checked |
Complete the Equipment tab and then click on the ‘SNMP Query’ tab.
Click on the down arrow, and select the SNMP version you wish VSM to use for querying the CUCM:
SNMP V1 or V2
Web Portal – CUCM SNMP V1/V2 Query
CUCM SNMP V1/V2 Field Descriptions
Fields | Setting |
Version | V1, V2 |
SNMP Community String | Community String as administered on the CUCM |
SNMP V3
Web Portal – CUCM SNMP V3 Query
CUCM SNMP V3 Field Description
Fields | Setting |
Version | V3 |
Username | SNMP V3 Username |
Authentication Protocol | SHA (recommended) |
Authentication Password | Password |
Privacy Protocol | DES (recommended) |
Privacy Password | Password |
Once all fields are populated Click on the Test Access button. This will test that VSM can connect to the CUCM using the settings you have entered:
Web Portal – CUCM Test Access
Both SSH and SNMP should return success. If not, troubleshoot the configuration.
Once testing is successful, click Add.