|   Release Notes   |   ScienceLogic Support   |   Contact Documentation   |   Tips for Using the Online Documentation

 

Configuration and Credentials

Download this manual as a PDF file

The following sections describe how to configure a Cisco Unified Communications Manager (CM) system for monitoring by SL1 using the Cisco: CUCM Unified Communications Manager PowerPack:

Prerequisites for Monitoring CUCM

During the discovery process, SL1 automatically aligns the IP addresses and hostnames for each node in a Cisco Unified CM cluster via DNS.

If you do not have access to DNS for the Cisco Unified CM systems that you want to monitor with SL1, ensure that you know or have access to the following information about each node:

Configuring the ScienceLogic Platform to Monitor CUCM

You can choose from several different possible configurations when using SL1 to monitor Cisco Unified CM:

These various methods are described in this section.

Method 1

In the first scenario, the Data Collector sits in front of the firewall and you define the CallManagers by hostname:

In this scenario, you must have the following ports open for the firewall:

Direction Port Protocol
ScienceLogic Database Server to the Data Collector 7707 TCP
PhoneHome Collector to the Database Server 7706 TCP

 

Method 2

In the second scenario, the Data Collector sits in front of the firewall and you define the CallManagers by IP address. This method requires you to create a host file that includes the CallManager hostname and IP address:

In this scenario, you must have the following ports open for the firewall:

Direction Port Protocol
ScienceLogic Database Server to the Data Collector 7707 TCP
PhoneHome Collector to the Database Server 7706 TCP

 

Method 3

In the third scenario, the Data Collector sits behind the firewall and you define the CallManagers by hostname:

In this scenario, you must have the following ports open for the firewall:

Direction Credential Port Protocol
ScienceLogic Data Collector to the Cisco Unified CM Cluster and CallManagers SNMP 161 UDP
Cisco Unified CM user 8443 TCP

 

Method 4

In the fourth scenario, the Data Collector sits behind the firewall and you define the CallManagers by hostname, with NAT. This method requires you to create a host file that includes the CallManager hostname and the IP address the Data Collector can use to access the device:

In this scenario, you must have the following ports open for the firewall:

Direction Credential Port Protocol
ScienceLogic Data Collector to the Cisco Unified CM Cluster and CallManagers SNMP 161 UDP
Cisco Unified CM user 8443 TCP

 

Method 5

In the final scenario, the Data Collector sits behind the firewall and you define the CallManagers by IP address, with NAT. This method requires you to create a host file that includes the CallManager host name and IP address the Data Collector can use to access the device:

This method is not supported by versions of theCisco: CUCM Unified Communications Manager PowerPack prior to version 109.

In this scenario, you must have the following ports open for the firewall:

Direction Credential Port Protocol
ScienceLogic Data Collector to the Cisco Unified CM Cluster and CallManagers SNMP 161 UDP
Cisco Unified CM user 8443 TCP

Enabling the CUCM AXL Web Service

SL1 can monitor a Cisco Unified CM system by requesting detailed information about the system from the Cisco Unified CM AXL Web Service.

The Cisco Unified CM AXL web service is disabled by default. To enable the AXL web service, perform the following steps:

Image of the Cisco Unified Serviceability page

Image of the Service Activation page

Configuring a CUCM User Account

ScienceLogic recommends that you create a Cisco Unified CM user account that will be used only by SL1 to access the AXL web service. To create a user account in Cisco Unified CM that can access only the AXL web service, perform these two steps:

To create a new Cisco Unified CM user group and user account, perform the following steps:

  1. In a browser window, navigate to the following address:

https://ip-address-of-CM-system:8443/ccmadmin/showHome.do

  1. Log in to the Cisco Unified CM Administration site as an administrator.

  1. In the navigation bar at the top-left of the page, hover over User Management, then select Application User. The Find and List Users page appears:

Image of the Find and List Users page

  1. Click the + Add New button. The Application User Configuration page appears:

Image of the Application User Configuration page

  1. Supply values in the following fields:

  1. Click the Save button.

  1. In the navigation bar at the top-left of the page, hover over User Management, then select User Group. The Find and List User Groups page appears:

Image of the Find and List User Groups page

  1. Click the + Add New button. The User Group Configuration page appears:

  1. In the Name field, type a name for the user group. For example, you could call the user group "AXL Access".
  2. Click the Save button.

  1. Click the Add App Users to Group button. The Find and List Application Users window appears:

  1. Click the Find button. In the list of users, select the checkbox for the user account that you created, then click the Add Selected button at the bottom of the page.

  1. The Find and List Application Users window closes. In the User Group Configuration page, the user account is included in the list of users:

Image of the User Group Configuration page with a new user added

  1. In the Related Links drop-down list at the top-right hand corner of the page, select Assign Role to User Group, and then click the Go button. The User Group Configuration page appears:

Image of the User Group Configuration page

  1. Click the Assign Role to Group button. The Find and List Roles window appears:

Image of the Find and List Roles window

  1. Click the Find button. A list of roles appears:

Image of the Find and List Roles window with a list of roles

  1. Select the checkboxes for the following roles:

  1. Click the Add Selected button at the bottom of the page.

  1. The Find and List Roles window closes. In the User Group Configuration page, the Roles field includes the Standard AXL API Access role:

Image of the User Group Configuration page, with the Standard AXL API Access role

  1. Click the Save button.

Configuring Prime License Manager

If you want to monitor Cisco Unified CM license information from Cisco Prime License Manager (PLM), you must create an administrator user account that SL1 can use to access PLM.

To create an administrator user in PLM:

  1. In a browser window, navigate to the following address:

https://ip-address-of-plm-server/elm-admin/

  1. Log in to the Cisco PLM site as an administrator.
  2. In the Administration drop-down menu, select Administrator Accounts.

  1. Click the Add Administrator button.

Image of the Cisco PLM Administrator Accounts page

  1. In the Add Administrator Account modal page, make entries in the following fields:

Image of the Add Administrator Account dialog

  1. Click OK.

Creating a CUCM Credential

To use the Dynamic Applications in the Cisco: CUCM Unified Communications Manager PowerPack, you must first define a Basic/Snippet Cisco Unified CM credential in SL1. This credential allows SL1 to communicate with the Cisco Unified CM cluster. The Cisco: CUCM Unified Communications Manager PowerPack includes a template you can use to create this Basic/Snippet credential.

To modify the Cisco Unified CM Basic/Snippet Credential template for use with your Cisco Unified CM cluster:

  1. Go to the Credential Management page (System > Manage > Credentials).

  1. Click the wrench icon () for the Cisco CUCM Example credential. The Credential Editor modal window appears:

Image of the Credential Editor modal window

  1. Supply values in the following fields:

The example credential included in older versions of the Cisco: CUCM Unified Communications Manager PowerPack used "80" as the default Port number. If your Cisco Unified CM credential specifies port 80, SL1 will automatically override that value and use port 8443 instead. If your Cisco Unified CM credential specifies any port other than 80, SL1 will use that specified port.

  1. Click the Save As button.

If you are monitoring Cisco Unified CM license information with the Cisco Prime License Manager (PLM) and your PLM administrator username and password are the same as the user account you created to access the AXL web service, then you can use the same credential to access PLM. However, if your PLM administrator user information is different, then repeat these steps to create a credential to access PLM.

If SNMP is enabled on the Cisco Unified CM cluster, then you can also create an optional SNMP credential that will be used only during discovery to classify the cluster device class. If SNMP is not available on the Cisco Unified CM cluster, then you do not need an SNMP credential. For more information on SNMP credentials, see the section on Defining an SNMP Credential.

Testing the CUCM Credential

Manually Creating Host File Entries for CUCM Nodes

During the discovery process, SL1 automatically aligns the IP addresses and hostnames for each CallManager server (node) in a Cisco Unified CM cluster via DNS.

If you do not have access to DNS for the Cisco Unified CM system you want to monitor, you must manually create host file entries in SL1 for each node in the Cisco Unified CM cluster. Each host file entry must contain the IP address and hostname of a node in the Cisco Unified CM cluster.

If you have access to DNS for the Cisco Unified CM system you want to monitor with SL1, you do not need to perform the steps to manually configure host file entries. Continue to the section on Discovering a Cisco Unified CM Cluster.

Repeat the following steps for each node in the Cisco Unified CM cluster.

To create a host file entry:

  1. Go to the Host File Entry Manager page (System > Customize > Host Files).

Image of the Host File Manager modal window

  1. Click the Action menu and choose Create New Entry. The Create New Host File Entry modal page appears.

Image of the Create New Host File Entry modal page

  1. In the Create New Host File Entry modal page, supply values in the following fields:

Server hostnames should be aligned to external IP addresses when supporting Network Address Translation (NAT) environments.

  1. Click the Save button to save the new host entry.