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

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.

Make sure you can sign in to CUCM with the newly created account by signing out and sign back in again with 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.

Browse to the CUCM then select "Cisco Unified Serviceability" from the navigation menu.

Configure SNMP V1/V2

Navigate to SNMP>V1/V2>Community String

From the drop-down List Choose the server you want to configure SNMP and click find>>Add new if none was configured.

SNMP needs to be configured on all the servers in the CUCM Cluster.

Fill in the SNMP Community String Page with the following values.

SNMP Community String 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.

Once completed the following message display with the status of the restart.

Configure CUCM to send SNMP Traps by navigating to SNMP>>V1/V2>>Notification Destination

SNMP Notification Destination

Choose server >>Find>>Click Add New

The following page appears, from the drop-down list choose "Add New".

Enter the Values in the page as per the following table.

SNMP Notification Destination

Once you choose Notification Type Community String Information will display.

Choose the community String created earlier and check 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.

Once restart is completed SNMP Notification Destination Configuration will show the new Destination IP Address.

CUCM SNMP V3 Configuration

Navigate to SNMP> V3> User

Select Server from the drop-down list and click find.

Click Add New to create SNMP User

SNMP V3 User configuration

Click ok to the pop up to restart SNMP master agent for configuration to take effect

Once restart is completed SNMP user configuration will be displayed with the new user configured.

  Navigate to Snmp >> V3 >> Notification Destination 

Choose server >>Find>>Click Add New

The following page appear, from the drop down list choose Add new.

Enter the Values in the page as per following

SNMP Notification Destination Configuration Table

Click Insert.

Click ok to the pop up to restart SNMP master agent for configuration to take effect

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

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.

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.

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.

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.

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

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.

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

Enter the required details for the Backup Device

Backup Device Details

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.

Click on Save and notice the warning as shown in the image. Click on OK in order to move forward.

Once the Backup Schedule is created, click on Enable Schedule

Make sure the schedule status is changed to 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

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

CUCM SNMP V1/V2 Field Descriptions

SNMP V3

CUCM SNMP V3 Field Description

Test Access

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:

Both API and SNMP should return success. If not, troubleshoot the configuration.

Once testing is successful, click Add.