| Info |
|---|
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. |
Table of Contents
AXL Configuration
VSM use uses AXL API to collect data from CUCM, ; this can be achieved by creating a user with AXL Capabilities within CUCM.
Enable AXL Service
Go to Browse to the CUCM, then select "Cisco Unified Serviceability" from the navigation menu.
Logging to Serviceability
Go to Tools >>Control > Control Centre - Feature Service.
Tools>>Feature service
Select server – Choose PublisherClick on the select server dropdown menu and choose the CUCM Publisher. Then click 'Go'.
Make Sure AXL Web Service status is started, otherwise start it if it was deactivated or stopped.
If the AXL Web Service statusis deactivated or stopped, start it from the top of the page.
Create CUCM AXL User
Log in to Browse to the CUCM, then select 'Cisco Unified CM Administration to create AXL user' from the navigation menu. Once selected, click 'Go'.
Log in to Cisco Unified CM Administration
...
Create AXL privileged Access control group
...
Go to User Management > User Management>>User Settings >>Access Control Group>>Add new
Settings > Access Control Group.
Click the "Add New" button to create a new Access Control Groupgroup.
Enter the an Access control Control group name and click save.
Create Access Control Group
, e.g. VSM-Access-Control-Group.
In the top right corner, click on the related links dropdown menu. Next, select the "On the related links on click Assign Role to Access Control Group" option, then click 'Go'.
Access Control Group Related Links
Assign Role to Access Control Group
On the Access Control Group Information Click on Under 'Role Assignment', click the "Assign Role to Group" button.
Assign Role to Group
List of Roles of page appear with all the A page will appear with a list of all available roles.
List of Roles
Select the checkbox for the following rules and roles, then click 'Add Selected':
- Standard AXL API Access.
- Standard CCM Admin Users.
- Standard SERVICEABILITY Read Only.
The following Page displays, click saveAfter being added, the following page will appear - click 'Save'.
Access Control Group with Roles assigned
Go to User Management>>Application User>>Click Add New
Application User Page
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, using the following table.
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. |
Application User Information
Here is an example of the form being filled out.
VSM Application User
Under 'Permission Information in ' for the new newly created Application User, click on 'Add to Access Control Group'.
Application User Configuration – Permission Information
In the search bar type , enter the name of previously the newly created Access Control Group - then click find.
Find and List Access Control Groups
Enter the name of previously created Access Control Group >>Click Find>>Check Check the checkbox next to the created Access control Group and Click then click 'Add Selected'.
Assign AXL Access Control Group to the VSM AXL User
Click Save under 'Application User Configuration'.
Application user with the new Access Groups Assigned
Once You you click 'Save', it will show the list of roles assigned to the user.
Application User Final Status
| Tip |
|---|
Make sure you can sign in to CUCM with the newly created account by signing out and |
...
then signing back in |
...
with |
...
your new account. |
...
...
...
CUCM SNMP Configuration
CUCM SNMP Configuration
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.
| Info |
|---|
Configure SNMP V1/V2
Navigate to Cisco Unified Serviceability>>SNMP>>V1/V2>>Community String
Cisco Unified Serviceability Navigation
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 Community String Configuration
From the drop-down List Choose list, choose the server you want to configure SNMP and click find>>Add new if none was configured.SNMP need for, then click find.
If no community strings are listed, or if you want to configure a new one, press the "Add New" button at the bottom of the page.
| Note |
|---|
SNMP needs to be configured on all the servers in the 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 any host. 2- Accept SNMP Packets only from these Hostshosts If you choose to Accept SNMP Packets only form from these hosts, make sure to enter the IP Address of the 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 checkbox to apply configuration the configurations to all servers within the cluster. |
SNMP Community String Configuration
Below is an example of the form being filled out.
SNMP Sample Configuration
When you click save, a warning will display notifying of restarting be displayed notifying you that you need to restart SNMP Master Agent Service for the change changes to take effect, click ok .
Click 'OK' to restart the service.
SNMP Service Restart
Once completed, the following message display will be displayed with the status of the restart.
SNMP
...
Traps
Configure CUCM to send SNMP Traps by navigating to SNMP>>V1/V2>>Notification DestinationSNMP > 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 > Find > Click "Add New".
SNMP Notification Destination Server Selection
The following page appear, appears; from the drop-down list, choose "Add newNew".
SNMP Notification Destination Configuration
SNMP Notification Destination Configuration Drop Down List
Enter values into the Values in the page page you are taken to as per the following table.
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
...
| Tip |
|---|
Once you choose "Notification Type", the Community String Information will |
...
be displayed. Choose the |
...
Community String created earlier and check |
...
"Apply to All Nodes". |
SNMP Notification Destination Configuration – Apply To All Nodes
When you click 'Insert', a warning will be displayed notifying you that a restart of SNMP Master Agent Service is required for the changes to take effect.
Click 'OK' to restart the service, or press 'Cancel' if you wish 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 After restarting, SNMP Notification Destination Configuration will show the new Destination IP Address.
SNMP Notification Destination Configuration Status
CUCM SNMP V3 Configuration
Navigate to Cisco Unified Serviceability>>SNMP>>V3>>SNMP Destination Configuration and follow the same steps described earlier to add SNMP V2 Destination
SNMP V3 SNMP Destination Configuration
SNMP > V3 > User.
Select a server Select Server from the drop-down list and click find'Find'.
SNMP V3 User Configuration
Click 'Add New' to create an SNMP User, then fill out the form using the table below.
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 Anyhostany host | 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
When you click 'Insert', a warning will be displayed notifying you that a restart of SNMP Master Agent Service is required for the changes to take effect.
Click 'OK' to restart the service.
After restarting, the Once restart is completed SNMP user configuration will be displayed with the new user configured.
Navigate to SNMP V3 User Configuration
Follow the same steps described in configuring SNMP Notification Configuration on SNMP V2 section.
SNMP V3 Notification Configuration
...
> V3 > Notification Destination.
Choose server >Find > Click 'Add New'.
The following page will appear. From the drop-down list, choose 'Add New'.
Enter values into the page as per the following table.
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 for the user |
| User Information | Check the checkbox next to a created user |
| Apply to All Nodes | Check the checkbox next to Apply to All Nodes |
Click Insert.
When you click 'Insert', a warning will be displayed notifying you that a restart of SNMP Master Agent Service is required for the changes to take effect.
Click 'OK' to restart the service.
CUCM Syslog configuration
Navigate to Cisco Unified CM Administration >> > System >> > Cisco Syslog Agent >>Remote > Remote Syslog Server Name.
Enter the IP Address of the VSM Probe as one of the Remote Syslog SeversServers.
Choose the Syslog Severity for Remote Syslog messages >> Choose based on the your requirements.
CUCM Syslog configuration
CDR Configuration
Navigate to Cisco Unified Serviceability.
From there, navigate to Tools > Serviceability>>Tools >> Control Centre – Feature Service >>Select > Select 'Publisher' from the drop-down list and make .
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 .
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 .
Make sure the 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' and the 'CDR Log Calls with Zero Duration Flag' to 'True'.
| Note |
|---|
This |
...
must 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
...
, as well as all CUCM servers in the cluster. |
Navigate navigate to System >> > Service Parameter >> > Call Manager Service>> Service > Clusterwide Parameters.
Set the ' >> Call Diagnostics Enabled' parameter to 'Enabled Only When CDR Enabled Flag is True'.
Navigate to Cisco Unified Serviceability > Tools >System > Scheduler > CDR Load
Make Sure that Continuous Loading 24/7 checkbox is selected.
Setup Call Diagnostics – Enable CMR
Now add an SFTP server/Billing Server where the files are to will be sent to. Navigate to Cisco Unified Serviceability > Tools > CDR Management and add new billing server> 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
Anchor CUCM Backup Configuration CUCM Backup Configuration
CUCM Backup Configuration
| CUCM Backup Configuration | |
| CUCM Backup Configuration |
The following is required to configure VSM as a destination for backup files. These Backup files will be sent from the VSM Probe to the Virsae Cloud.
Navigate to Disaster Recovery System.
Navigate to Backup > >> Backup >> Backup Device >> > Add New.
Disaster Recovery Page
Enter the required details for the Backup Device using the details in the following table.
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 a Scheduler Name. Select the Device name (the device created earlier) and check the features you want to backup; ideally, ideally check all the options.
| Tip |
|---|
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 backup schedule backup based on your scenario, recommended Daily backup situation.
We recommended a daily backup to occur after hours.
Backup Schedule
Click on Save and notice the warning 'Save'. A warning message, as shown in the image below, will pop up.
Click on OK in order to move forward'OK'.
Backup Warning
Once the Backup Schedule is created, click on Enable Schedule.
Enable Schedule
| Note |
|---|
Make sure the schedule status is changed to Enabled. |
Schedule Backup Enabled
Once complete you can move on to the administration in the VSM Web Portal.
Web Portal Configuration
Add CUCM
Login Log in to the VSM web portal using your VSM credentials and password.
...
At the bottom of the ‘Manage Equipment’ page click on the ‘Add Equipment’ Buttonbutton.
A form will open which you can populate with the equipment details as per table the table 8below.
Select the Vendor ‘Cisco Systems’ and Product ‘Unified Communications Manager’.
Web Portal – Add Equipment
| Info |
|---|
| If you are adding more than one piece of the same equipment type check the ‘Add another’ box at the bottom of the form and the bulk of the configuration will be carried over for the next item. |
...
| Info |
|---|
| Site ID information in the ‘Site’ field will advise your NOC staff of the site where the CUCM Server is physically located. This is particularly helpful when the customer has multiple sites. |
Web Portal – Add CUCM Field Description
AddCUCMAnchor
AddCUCMAddCUCMFields AddCUCMFields
Field | Setting |
Vendor | Cisco Systems |
Product | Unified Communications Manager |
Equipment Name | Friendly name for this CUCM |
AXL Username |
AXL Username |
AXL Password |
AXL Password | |
IP Address / Host Name | IP Address of server |
Site | Free text field, this information will be included in alarm notifications from the VSM Workflow. |
Use Cisco APIs
Select if Using Cisco APIs for advanced options
| Info |
|---|
| Site ID information in the ‘Site’ field will advise your NOC staff of the site where the Microsoft Server is physically located. This is particularly helpful when the customer has multiple sites. |
Web Portal - CUCM Configure Equipment
SNMP
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 QueryCUCM 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 |
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:
Web Portal – CUCM Test Access
Both SSH Both API and SNMP should return success. If not, trouble-shoot troubleshoot the configuration.
| Info |
|---|
| The SSH API test ensures the VSM probe can connect to, and login log in using the account configured. |
| Info |
|---|
| The SNMP test ensures an SNMP query can be run. |
Once testing is successful, click Add.
...