User Guide for CiscoWorks QoS Policy Manager 4.1 - Chapter 12 Integrating NCM with QPM [CiscoWorks QoS Policy Manager]

Table Of Contents

NCM Integration in QPM

Configuring QPM Adapter in NCM

Location of QPM Adapters

Configuring QPM Adapter

Integrating QPM Devices with NCM

Global Integration

Device Group Integration

Device Integration

Viewing NCM Event Notifications in QPM

Performing Actions Based on NCM Event Notifications

NCM Integration in QPM

Cisco Network Compliance Manager (NCM) provides an enterprise class solution that tracks and regulates configuration and software changes across routers, switches, firewalls, load balancers, and wireless access points. NCM provides visibility into network changes, enabling you to identify and correct trends that could lead to problems, while mitigating compliance issues, security hazards, and disaster recovery risks.

You can integrate QPM with NCM to obtain event notifications in QPM, for the following changes on the device:

•Device configuration change

•Image upgrade

The event notifications from NCM to QPM helps you to understand the configuration change or image upgrade on the devices, and synchronize those device level changes with QPM. This helps you to effectively use the provisioning and monitoring features on all managed devices in QPM.

This chapter describes how you can integrate NCM with QPM, and receive event notifications in QPM.

This chapter contains the following sections:

•Configuring QPM Adapter in NCM

•Integrating QPM Devices with NCM

•Viewing NCM Event Notifications in QPM

•Performing Actions Based on NCM Event Notifications

Configuring QPM Adapter in NCM

NCM sends events to QPM when a configuration change or an image upgrade occurs on a device. To receive events from NCM Server, you should include a QPM module (called QPM Adapter) in the NCM Server.

After you include the QPM Adapter, you must perform some simple configuration steps in NCM to complete the QPM Adapter integration with NCM Server.

Since QPM Adapters are meant to be included on the NCM servers, they are available for all the three NCM supported platforms-Windows, Solaris, and Linux.

Location of QPM Adapters

After you install QPM on Windows, you can find the QPM Adapters at install\CSCOpx\MDC\qpm\config
where install is the QPM installation folder.

After you install QPM on Solaris, you can find the QPM Adapters at
/opt/CSCOpx/MDC/qpm/configwhere /opt/CSCOpx is the default QPM installation directory.

The following QPM Adapters are available at both the locations mentioned above:

•qpm-ncmadapter-win.zip—For NCM on Windows

•qpm-ncmadapter-sol.tar—For NCM on Solaris

•qpm-ncmadapter-lnx.tar—For NCM on Linux

You should copy any of these files to a location on the NCM server, based on the supported platform.

Configuring QPM Adapter

To configure QPM Adapter in NCM server:

Step 1 Copy the corresponding QPM Adapter from the QPM server to the NCM server, based on the platform on which NCM Server is running.

Step 2 Extract the QPM Adapter (unzip or untar) to a known location in the NCM server.

Step 3 Create a new device group called QPM in the NCM Server. To do this:

a. Login to NCM by providing valid login credentials.

b. Go to Devices > New Device Group.

The New Group page opens.

c. Enter QPM as the Group Name. Leave the values in other fields as default.

d. Click Save.

A new device group with name QPM is created.

Step 4 Create a new Event Notification and Response Rule in the NCM Server to send events to QPM Server. To do this:

a. In NCM, go to Admin > Event Notification and Response Rules.

The Event Notification and Response Rules page appears.

b. Click the New Event Notification & Response Rule link at top-right corner of this page.

The New Event Notification & Response Rule page appears.

Step 5 In the New Event Notification & Response Rule page, perform the following steps:

a. In the Add Email and Event Rule named field, enter Send events to QPM Server. This will be the name of the rule.

b. Choose Run Task from the To take this action list box.

c. Select Device Configuration Change and Device Software Change in the When the following events occur field. When these events occur on the devices in the device group, notification is sent to QPM Server.

d. Click the Active radio button for the Rule Status.

e. In the On devices in these groups field, select the new QPM device group name alone. This ensures that the events will be sent only for those devices in QPM device group.

f. Choose Run External Application in the Run this task list box.

The New Task - Run External Application page appears.

Step 6 In the New Task - Run External Application page, do the following:

a. In the Task Name field, enter QPM Adapter.

b. In the Run field:

–Enter the following command for NCM on Windows

QPM_ADAPTER_INSTALLPATH\dispatchevents.bat -qip QPM_SERVER_IP_ADDRESS -nip $LocalHostAddress$ -dip $IPAddress$ -did $DeviceID$ -cid $DataID$ -eid $EventID$ -et "$EventType$" -ed "$EventDate$" -nu $UserName$ -np $Password$

–Enter the following command for NCM on Solaris or Linux

sh QPM_ADAPTER_INSTALLPATH\dispatchevents.sh -qip QPM_SERVER_IP_ADDRESS -nip $LocalHostAddress$ -dip $IPAddress$ -did $DeviceID$ -cid $DataID$ -eid $EventID$ -et "$EventType$" -ed "$EventDate$" -nu $UserName$ -np $Password$

Replace QPM_ADAPTER_INSTALLPATH with the location where the QPM Adapter is extracted in NCM Server.

Replace QPM_SERVER_IP_ADDRESS with the IP address of the QPM Server.

c. In the Start In field, enter the location where the QPM Adapter is extracted in NCM Server.

d. Leave the other fields in this page with their default values.

e. Click Done.

The Event Notification and Response Rule page appears.

Step 7 In the Event Notification and Response Rule page, click Save Rule.

The newly added rule appears in the Event Notification and Response Rules list in NCM.

Integrating QPM Devices with NCM

After you configure the QPM Adapter and create the notification rule in NCM, you should integrate the devices in the QPM inventory with NCM. The following sections describe this process:

•Global Integration

•Device Group Integration

•Device Integration

Global Integration

For QPM to receive events from NCM, you should globally integrate the QPM server with NCM server.

To integrate QPM server with NCM globally:

Step 1 In QPM, go to Administration > NCM Integration

The Network Compliance Manager Integration page appears.

Step 2 Check the Enable NCM Integration check box

Step 3 Enter the hostname or IP address of the NCM server where you have configured the QPM Adapter

Step 4 Enter the username and password for the NCM server.

Step 5 Click Save and Register.

Device Group Integration

By default, all the device groups in QPM are enabled to integrate with NCM. You need not perform any steps to integrate them with NCM.

To disable the NCM integration of the device groups:

Step 1 In QPM, go to Devices > Device Groups.

The Device Groups page appears.

Step 2 In the object selector, click the name of the device group you want to unregister with NCM.

The Device Group Properties page appears.

Step 3 Under the NCM Group Settings area, uncheck the Enable NCM Integration check box.

Step 4 Click Save.

The device group is no longer integrated with NCM, even if you have integrated QPM with NCM globally.

Device Integration

By default, all the devices in QPM are enabled to integrate with NCM. You need not perform any steps to integrate them with NCM.

To disable the NCM integration of the devices:

Step 1 In QPM, go to Devices > Device Management > Device Summary.

The Device Summary page appears.

Step 2 In the object selector, click the name of the device you want to unregister with NCM.

The properties of the device appears in the content area.

Step 3 In the NCM Settings area, uncheck the Enable NCM Integration check box.

Step 4 Click Save.

The device is no longer integrated with NCM, even if you have integrated QPM with NCM globally.

Viewing NCM Event Notifications in QPM

After you enable NCM integration globally, QPM starts receiving events related to any device configuration change or device image upgrade, and displays the events.

Note QPM displays events from NCM, only if the events are sent from devices that are present in the currently active device group in QPM.

To view the Historical events (for a scheduled time period in the past) from NCM:

Step 1 In QPM, go to Monitoring > NCM Events > Historical.

The Historical Event Properties page appears.

Step 2 Check the check boxes corresponding to the devices for which you want to view the events.

Step 3 Enter the Start Time and End Time for the period in which you want to view the events from the selected devices.

Step 4 Click Submit.

The Historical Events page appears, showing events related to device configuration change and image upgrade, if any, on the selected devices, for the selected period.

To view the Live events (events for the day) from NCM:

Step 1 In QPM, go to Monitoring > NCM Events > Live.

Step 2 The Live Event Properties page appears.

Step 3 Check the check boxes corresponding to the devices for which you want to view the events.

Step 4 Click Submit.

The Live Events page appears, showing the events related to device configuration change or image upgrade, if any, on the selected devices, on the current date.

Step 5 Choose the appropriate options under Refresh Rate, to refresh the page to view the latest events.

Performing Actions Based on NCM Event Notifications

The Historical Events page and the Live Events page in QPM, not only shows you the events, but also provides you with the launch points to take appropriate actions for any device configuration change or image upgrade on the devices.

You can rediscover the devices, import the updated policy from the devices, or restore the policy on the devices through QPM.

These actions depend on the following categories to which the selected devices are associated:

•Devices added to QPM, but their QoS configuration not managed from QPM

•Devices added to QPM and their QoS configuration managed from the Current Policy Group in QPM

•Devices added to QPM, but their QoS configuration not managed from Current Policy Group in QPM

Devices added to QPM, but their QoS configuration not managed from QPM

These are devices that can only be monitored from QPM. Events from these devices are shown with * appended to their device name/IP address.

When there are events from devices in this category, you must:

1. Check the check box corresponding to the devices (marked with *)

2. Click Rediscover to rediscover the devices.

After the rediscovery is complete, you can monitor the devices based on the new configuration or image upgrade.

The other options in the event table, namely—Import, Deploy, and the Policy Group list box—are not applicable to the events from these devices (marked with *).

Devices added to QPM and their QoS configuration managed from the Current Policy Group in QPM

These are devices that can be monitored and provisioned from QPM. Events from these devices are shown without any * or ** appended to their device names/IP address

When there are events from devices in this category, you can check the check box corresponding to the devices (without any * or **), and perform any of the following actions:

•Click Rediscover to rediscover the devices. After the rediscovery is complete, you can monitor the devices based on the new configuration or image upgrade.

•Click Import to import the updated policy configuration from the device to QPM.

•Click Deploy to restore the device configuration from QPM to the device. This overrides the changes made on the device.

Devices added to QPM, but their QoS configuration not managed from Current Policy Group in QPM

Events from these devices are shown with ** appended to their device name/IP address.

Note The policy group acts like a filter for events from devices. You can choose the correct policy group (for the device's policy) from the Policy Group list box. The events table is updated to remove the ** appended to the device name/IP address

When there are events from devices in this category (devices with **), you can:

•Click Import to import the updated policy configuration from the device to QPM

•Click Deploy to restore the device configuration from QPM to the device. This overrides the changes made on the device.

Note When you invoke the Import or Deploy action through the NCM events page, the active policy group in QPM is set to the one selected in this page.

	User Guide for CiscoWorks QoS Policy Manager 4.1
	Chapter 12 Integrating NCM with QPM
User Guide for CiscoWorks QoS Policy Manager 4.1 Preface Chapter 1 Introduction Chapter 2 Planning for Quality of Service Chapter 3 Getting Started Chapter 4 Managing Devices Chapter 5 Working with Policy Groups Chapter 6 Working with Macros Chapter 7 Configuring QoS for IP Telephony Chapter 8 Working with Policies, Properties, and Traffic Rules Chapter 9 Deploying QoS Policies Chapter 10 Monitoring: Using QoS Analysis Chapter 11 Using Administration Features Chapter 12 Integrating NCM with QPM Chapter 13 Integrating CUOM with QPM Chapter 14 Troubleshooting QPM Appendix A Devices Drawer Reference Appendix B Provision Tab Reference: Macros and Policy Creation Appendix C Provision Tab Reference: Policy Preview and Deployment Appendix D Monitor Tab Reference Appendix E Administration Tab Reference Appendix F CLI Command Reference for QPM Actions Appendix G QPM FAQs Index	Download this chapter Chapter 12 Integrating NCM with QPM Download the complete book User Guide for CiscoWorks QoS Policy Manager 4.1 (PDF - 8 MB) Table Of Contents NCM Integration in QPM Configuring QPM Adapter in NCM Location of QPM Adapters Configuring QPM Adapter Integrating QPM Devices with NCM Global Integration Device Group Integration Device Integration Viewing NCM Event Notifications in QPM Performing Actions Based on NCM Event Notifications NCM Integration in QPM Cisco Network Compliance Manager (NCM) provides an enterprise class solution that tracks and regulates configuration and software changes across routers, switches, firewalls, load balancers, and wireless access points. NCM provides visibility into network changes, enabling you to identify and correct trends that could lead to problems, while mitigating compliance issues, security hazards, and disaster recovery risks. You can integrate QPM with NCM to obtain event notifications in QPM, for the following changes on the device: •Device configuration change •Image upgrade The event notifications from NCM to QPM helps you to understand the configuration change or image upgrade on the devices, and synchronize those device level changes with QPM. This helps you to effectively use the provisioning and monitoring features on all managed devices in QPM. This chapter describes how you can integrate NCM with QPM, and receive event notifications in QPM. This chapter contains the following sections: •Configuring QPM Adapter in NCM •Integrating QPM Devices with NCM •Viewing NCM Event Notifications in QPM •Performing Actions Based on NCM Event Notifications Configuring QPM Adapter in NCM NCM sends events to QPM when a configuration change or an image upgrade occurs on a device. To receive events from NCM Server, you should include a QPM module (called QPM Adapter) in the NCM Server. After you include the QPM Adapter, you must perform some simple configuration steps in NCM to complete the QPM Adapter integration with NCM Server. Since QPM Adapters are meant to be included on the NCM servers, they are available for all the three NCM supported platforms-Windows, Solaris, and Linux. Location of QPM Adapters After you install QPM on Windows, you can find the QPM Adapters at install\CSCOpx\MDC\qpm\config where install is the QPM installation folder. After you install QPM on Solaris, you can find the QPM Adapters at `/opt/CSCOpx/MDC/qpm/config`where `/opt/CSCOpx` is the default QPM installation directory. The following QPM Adapters are available at both the locations mentioned above: •qpm-ncmadapter-win.zip—For NCM on Windows •qpm-ncmadapter-sol.tar—For NCM on Solaris •qpm-ncmadapter-lnx.tar—For NCM on Linux You should copy any of these files to a location on the NCM server, based on the supported platform. Configuring QPM Adapter To configure QPM Adapter in NCM server: Step 1 Copy the corresponding QPM Adapter from the QPM server to the NCM server, based on the platform on which NCM Server is running. Step 2 Extract the QPM Adapter (unzip or untar) to a known location in the NCM server. Step 3 Create a new device group called QPM in the NCM Server. To do this: a. Login to NCM by providing valid login credentials. b. Go to Devices > New Device Group. The New Group page opens. c. Enter QPM as the Group Name. Leave the values in other fields as default. d. Click Save. A new device group with name QPM is created. Step 4 Create a new Event Notification and Response Rule in the NCM Server to send events to QPM Server. To do this: a. In NCM, go to Admin > Event Notification and Response Rules. The Event Notification and Response Rules page appears. b. Click the New Event Notification & Response Rule link at top-right corner of this page. The New Event Notification & Response Rule page appears. Step 5 In the New Event Notification & Response Rule page, perform the following steps: a. In the Add Email and Event Rule named field, enter `Send events to QPM Server`. This will be the name of the rule. b. Choose Run Task from the To take this action list box. c. Select Device Configuration Change and Device Software Change in the When the following events occur field. When these events occur on the devices in the device group, notification is sent to QPM Server. d. Click the Active radio button for the Rule Status. e. In the On devices in these groups field, select the new QPM device group name alone. This ensures that the events will be sent only for those devices in QPM device group. f. Choose Run External Application in the Run this task list box. The New Task - Run External Application page appears. Step 6 In the New Task - Run External Application page, do the following: a. In the Task Name field, enter QPM Adapter. b. In the Run field: –Enter the following command for NCM on Windows QPM_ADAPTER_INSTALLPATH\dispatchevents.bat -qip QPM_SERVER_IP_ADDRESS -nip $LocalHostAddress$ -dip $IPAddress$ -did $DeviceID$ -cid $DataID$ -eid $EventID$ -et "$EventType$" -ed "$EventDate$" -nu $UserName$ -np $Password$ –Enter the following command for NCM on Solaris or Linux sh QPM_ADAPTER_INSTALLPATH\dispatchevents.sh -qip QPM_SERVER_IP_ADDRESS -nip $LocalHostAddress$ -dip $IPAddress$ -did $DeviceID$ -cid $DataID$ -eid $EventID$ -et "$EventType$" -ed "$EventDate$" -nu $UserName$ -np $Password$ Replace QPM_ADAPTER_INSTALLPATH with the location where the QPM Adapter is extracted in NCM Server. Replace QPM_SERVER_IP_ADDRESS with the IP address of the QPM Server. c. In the Start In field, enter the location where the QPM Adapter is extracted in NCM Server. d. Leave the other fields in this page with their default values. e. Click Done. The Event Notification and Response Rule page appears. Step 7 In the Event Notification and Response Rule page, click Save Rule. The newly added rule appears in the Event Notification and Response Rules list in NCM. Integrating QPM Devices with NCM After you configure the QPM Adapter and create the notification rule in NCM, you should integrate the devices in the QPM inventory with NCM. The following sections describe this process: •Global Integration •Device Group Integration •Device Integration Global Integration For QPM to receive events from NCM, you should globally integrate the QPM server with NCM server. To integrate QPM server with NCM globally: Step 1 In QPM, go to Administration > NCM Integration The Network Compliance Manager Integration page appears. Step 2 Check the Enable NCM Integration check box Step 3 Enter the hostname or IP address of the NCM server where you have configured the QPM Adapter Step 4 Enter the username and password for the NCM server. Step 5 Click Save and Register. Device Group Integration By default, all the device groups in QPM are enabled to integrate with NCM. You need not perform any steps to integrate them with NCM. To disable the NCM integration of the device groups: Step 1 In QPM, go to Devices > Device Groups. The Device Groups page appears. Step 2 In the object selector, click the name of the device group you want to unregister with NCM. The Device Group Properties page appears. Step 3 Under the NCM Group Settings area, uncheck the Enable NCM Integration check box. Step 4 Click Save. The device group is no longer integrated with NCM, even if you have integrated QPM with NCM globally. Device Integration By default, all the devices in QPM are enabled to integrate with NCM. You need not perform any steps to integrate them with NCM. To disable the NCM integration of the devices: Step 1 In QPM, go to Devices > Device Management > Device Summary. The Device Summary page appears. Step 2 In the object selector, click the name of the device you want to unregister with NCM. The properties of the device appears in the content area. Step 3 In the NCM Settings area, uncheck the Enable NCM Integration check box. Step 4 Click Save. The device is no longer integrated with NCM, even if you have integrated QPM with NCM globally. Viewing NCM Event Notifications in QPM After you enable NCM integration globally, QPM starts receiving events related to any device configuration change or device image upgrade, and displays the events. Note QPM displays events from NCM, only if the events are sent from devices that are present in the currently active device group in QPM. To view the Historical events (for a scheduled time period in the past) from NCM: Step 1 In QPM, go to Monitoring > NCM Events > Historical. The Historical Event Properties page appears. Step 2 Check the check boxes corresponding to the devices for which you want to view the events. Step 3 Enter the Start Time and End Time for the period in which you want to view the events from the selected devices. Step 4 Click Submit. The Historical Events page appears, showing events related to device configuration change and image upgrade, if any, on the selected devices, for the selected period. To view the Live events (events for the day) from NCM: Step 1 In QPM, go to Monitoring > NCM Events > Live. Step 2 The Live Event Properties page appears. Step 3 Check the check boxes corresponding to the devices for which you want to view the events. Step 4 Click Submit. The Live Events page appears, showing the events related to device configuration change or image upgrade, if any, on the selected devices, on the current date. Step 5 Choose the appropriate options under Refresh Rate, to refresh the page to view the latest events. Performing Actions Based on NCM Event Notifications The Historical Events page and the Live Events page in QPM, not only shows you the events, but also provides you with the launch points to take appropriate actions for any device configuration change or image upgrade on the devices. You can rediscover the devices, import the updated policy from the devices, or restore the policy on the devices through QPM. These actions depend on the following categories to which the selected devices are associated: •Devices added to QPM, but their QoS configuration not managed from QPM •Devices added to QPM and their QoS configuration managed from the Current Policy Group in QPM •Devices added to QPM, but their QoS configuration not managed from Current Policy Group in QPM Devices added to QPM, but their QoS configuration not managed from QPM These are devices that can only be monitored from QPM. Events from these devices are shown with * appended to their device name/IP address. When there are events from devices in this category, you must: 1. Check the check box corresponding to the devices (marked with ) 2. Click Rediscover* to rediscover the devices. After the rediscovery is complete, you can monitor the devices based on the new configuration or image upgrade. The other options in the event table, namely—Import, Deploy, and the Policy Group list box—are not applicable to the events from these devices (marked with ). Devices added to QPM and their QoS configuration managed from the Current Policy Group in QPM These are devices that can be monitored and provisioned from QPM. Events from these devices are shown without any or ** appended to their device names/IP address When there are events from devices in this category, you can check the check box corresponding to the devices (without any * or ), and perform any of the following actions: •Click Rediscover to rediscover the devices. After the rediscovery is complete, you can monitor the devices based on the new configuration or image upgrade. •Click Import to import the updated policy configuration from the device to QPM. •Click Deploy to restore the device configuration from QPM to the device. This overrides the changes made on the device. Devices added to QPM, but their QoS configuration not managed from Current Policy Group in QPM Events from these devices are shown with appended to their device name/IP address. Note The policy group acts like a filter for events from devices. You can choose the correct policy group (for the device's policy) from the Policy Group list box. The events table is updated to remove the appended to the device name/IP address When there are events from devices in this category (devices with ), you can: •Click Import to import the updated policy configuration from the device to QPM •Click Deploy to restore the device configuration from QPM to the device. This overrides the changes made on the device. Note When you invoke the Import or Deploy action through the NCM events page, the active policy group in QPM is set to the one selected in this page.
	© 1992-2009 Cisco Systems, Inc. All rights reserved. Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks of Cisco Systems, Inc.