User Guide for CiscoWorks QoS Policy Manager 4.1
Chapter 13 Integrating CUOM with QPM

Table Of Contents

Integrating CUOM with QPM

Benefits of Using QPM NB API

Supported WSDLs in QPM for CUOM Integration

Tasks Using WSDLs

QPM Web Services User Authentication

QPM Web Services User Authentication in Default ACS Mode

QPM Web Services User Authentication in Custom ACS mode

Set High and Low Water Mark Threshold Metrics on Device Interfaces

Get High and Low Water Mark Threshold Metrics on Device Interfaces

Verify List of Allowed Metrics for Threshold Configuration

Enable Notification

Verify Retrieval of Events Using QPM WS

Disable Notification

Tasks using NB SNMP Traps


Integrating CUOM with QPM


Cisco Unified Operations Manager (CUOM) is a product from the Cisco Unified Communications Management Suite. It provides a comprehensive and efficient solution for network management as well as for provisioning and monitoring of Cisco Unified Communications deployments.

CUOM monitors and evaluates the current status of the IP communications infrastructure and the underlying transport infrastructure in your network. CUOM uses open interfaces such as Simple Network Management Protocol (SNMP) and Hypertext Transfer Protocol (HTTP) to remotely poll data from different devices in the IP communications deployment.

QPM exposes a subset of its API from Northbound (NB) Web Services interface and NB SNMP interface. This helps you to use CUOM along with QPM to exchange information related to QoS related metrics on routers, gateways, and IP-Phones.

Benefits of Using QPM NB API

QPM NB API allows you to perform the following functions:

Allow north bound applications, such as CUOM to set thresholds on metrics that affected IP telephony traffic as a result of QoS action (queuing, shaping, policing traffic)

Provide access to north bound applications, such as CUOM to view high and low water marks on thresholds for selected QoS Metrics

Trigger or cancel continuous event forwarding of threshold violations to CUOM. QPM uses CISCO-EPM-NOTIFICATION-MIB for SNMP trap forwarding.

Use the following WSDL services in QPM:

QPM Information Service—To retrieve information pertaining to the installed version of QPM.

Threshold Manager Service—Set or get high and low water marks for QoS metrics on device interfaces

Filter Notification Service—Enable or disable notifications for threshold violations

Receive QPM NB notifications (traps) in north bound applications, such as CUOM, with each notification that contains the following information:

Device and the interface for which the threshold crossing is identified

Identity of the policymap/classmap

CBQoS Metric that crossed the threshold

Specific water mark level that is crossed (low or high), and the value

Time stamp of threshold crossing

A WS-based client, such as CUOM, can send WSDL queries to QPM. See Tasks Using WSDLs for more information.

Supported WSDLs in QPM for CUOM Integration

The following three WSDL (Web Service Description Language) files and their operations in QPM are available for CUOM integration:

QpmInformationService

getQpmVersion

QpmThresholdManagerService

setThresholds

getHighWaterMark

getLowWaterMark

getSupportedThresholdMetrics

QpmFilterNotificationService

isNotificationEnabled

getEvents

disableNotifications(string)

disableNotifications

enableNotifications(string)

enableNotifications

clearEvents

You can find these WSDLs at https://machine URL/qpm/servlet/AxisServlet
where machine URL is the URL of the QPM server.

Tasks Using WSDLs

QPM NB API allows CUOM to perform authentication, threshold assignment, and validation tasks. This helps you to use CUOM effectively with QPM. A WS-based client, such as CUOM, can send WSDL queries to QPM.

The following sections describe the tasks you can perform using the three WSDLs:

QPM Web Services User Authentication

QPM Web Services User Authentication in Default ACS Mode

QPM Web Services User Authentication in Custom ACS mode

Set High and Low Water Mark Threshold Metrics on Device Interfaces

Get High and Low Water Mark Threshold Metrics on Device Interfaces

Verify List of Allowed Metrics for Threshold Configuration

Enable Notification

Verify Retrieval of Events Using QPM WS

Disable Notification

QPM Web Services User Authentication

To do this you should go to CUOM and send a query to QpmInformationService.wsdl in QPM.

QPM returns the installed version of QPM including major version, minor version, patch version and DOSUP packages

QPM Web Services User Authentication in Default ACS Mode

To do this:


Step 1 Register QPM with ACS default user roles

Step 2 Send a query to QpmInformationService.wsdl from CUOM.

QPM returns the installed version of QPM including major version, minor version, patch version and DOSUP packages


QPM Web Services User Authentication in Custom ACS mode

To do this:


Step 1 Register QPM with ACS custom user roles

Step 2 Send a query to QpmInformationService.wsdl from CUOM.

QPM returns the installed version of QPM including major version, minor version, patch version and DOSUP packages


Set High and Low Water Mark Threshold Metrics on Device Interfaces

To do this:


Step 1 Go to CUOM and set High Water Mark and Low Water Mark values as the thresholds for a particular QoS metric

Step 2 Send a query to QpmThresholdService.wsdl

QPM accepts these threshold values for the particular metric, and assigns the values.


Get High and Low Water Mark Threshold Metrics on Device Interfaces

To do this, go to CUOM and send a query to QpmThresholdService.wsdl to obtain the High Water Mark and Low Water Mark values (threshold values) assigned to a particular QoS metric in QPM.

QPM returns the configured threshold values for the corresponding metrics.

Verify List of Allowed Metrics for Threshold Configuration

To do this:


Step 1 Define a policy in QPM and deploy it to one of the interfaces

Step 2 Assign any Threshold Set to the interface.

Step 3 Go to CUOM, and request the list of QoS metrics at that interface.

QPM displays the list of metrics for which you are allowed to configure high and low water marks.


Enable Notification

To do this:


Step 1 Go to CUOM and enable notifications at the network or device level.

Step 2 Issue a WS query to QpmEventService.

QPM enables event notification.


Verify Retrieval of Events Using QPM WS

To do this:


Step 1 Add a device. Define a policy and attach it to one of the device's interface.

Step 2 Generate events using QPM.

Step 3 Issue WS query to QpmEventService.

QPM returns event details for that particular device.


Disable Notification

To do this:


Step 1 Go to CUOM and disable notifications at the network or device level.

Step 2 Issue WS query to QpmEventService.

QPM disables event notification.


Tasks using NB SNMP Traps

From QPM, you can receive North Bound SNMP trap notifications in the SNMP MIB browser in CUOM.

To do this:


Step 1 In QPM, define a policy and deploy it on one of the device interfaces.

Step 2 Create a Threshold Set and assign it to the same interface.

Step 3 Update the ems.properties file in QPM, to include the IP address of the CUOM server. This file is located at /opt/CSCOpx/MDC/ems/conf directory in the QPM server.

If events are shown in the QoS Events page in QPM, the same event notifications are received in the SNMP MIB browser in CUOM.

Step 4 Restart the daemon manager.