Installation Guide for CiscoWorks QoS Policy Manager 3.1 - Installing and Uninstalling QPM [CiscoWorks QoS Policy Manager]

Table Of Contents

Installing and Uninstalling QPM

Installing QPM

Working with ACS Device Groups and User Permissions

Setup for Working with ACS Device Groups and User Permissions

Updating QPM 3.1 User Permissions in ACS

Verifying QPM Installation

Troubleshooting QPM Installation

Troubleshooting Problems During Installation

Troubleshooting Problems Starting Common Services 1.0

Troubleshooting Problems Starting QPM

Obtaining Information for Troubleshooting and Cisco Technical Support

Obtaining System Status Information for Troubleshooting

Obtaining Debug Information for Cisco Technical Support

Uninstalling QPM

Installing and Uninstalling QPM

This chapter contains the following topics:

•Installing QPM

•Working with ACS Device Groups and User Permissions

•Verifying QPM Installation

•Troubleshooting QPM Installation

•Uninstalling QPM

Installing QPM

QPM is automatically installed in the CiscoWorks Common Services 1.0 installation folder.

The installation process also copies the QPM 3.1 export and import utilities to the QPM server. For more information about these utilities, see Chapter 3, "Migrating QPM Information."

Before You Begin

•Ensure that CiscoWorks Common Services 1.0 is installed on your computer before you begin to install QPM.

CiscoWorks Common Services 1.0 ships with a 90-day evaluation license that you can use to install the software. If you install CiscoWorks Common Services 1.0 without a license, you will still be able to start QPM. Please refer to the Supplemental License Agreement in the Quick Start Guide for QoS Policy Manager for usage restrictions for QPM.

•If you are upgrading from QPM 3.0.x, see Installation Sequence to Upgrade from QPM 3.0.x, page 1-4.

Procedure

Step 1 Insert the QoS Policy Manager CD-ROM into your CD-ROM drive.

Note We do not recommend installing QPM from a network CD-ROM drive.

Step 2 Select Start > Run, and enter d:\QPM-K9.exe, where d is your CD-ROM drive.

If QPM 3.0.x is already installed on the computer, installation will not proceed, and the following message appears:
QPM has detected QPM version 3.0.x already installed on this machine. 
Use the following installation sequence to upgrade from QPM 3.0.x: 
1. (Recommended) Export QPM database and configuration information 
from QPM 3.0.x using the export.exe utility on the QPM 3.1 
installation CD.
2. (Required) Uninstall QPM 3.0.x.
3. (Required) Install QPM 3.1.
4. (Optional) Import QPM 3.0.x data into QPM 3.1 using the import.exe 
utility on the QPM 3.1 installation CD.
For more information about the export and import utilities, see Chapter 3, "Migrating QPM Information."

If QPM 3.0 is not installed on the computer, the Welcome window opens.

Step 3 Click Next to continue. The Select Program Folder window opens.

Step 4 In the Select Program Folder window, specify or select a program group, if you do not want to use the default name. Click Next.

Step 5 Enter the password for the QoS Policy Manager Database, and confirm your password. The QPM database password is required internally by the system to ensure database security. You do not need to use the password. You can change the password through Common Services 1.0 in the CiscoWorks desktop. Select VPN/Security Management Solution > Administration > Configuration > Database Credentials.

Click Next.

Step 6 In the Setup Type window, enter the percentage of disk space to keep free for backup purposes on the current partition. If you intend to perform QPM monitoring tasks, we recommend that you keep a larger amount of disk space free for backup purposes. When you run out of available disk space, QPM notifies you and you can compact your database using the QPM Rebuild Database utility on the QPM server. Before using this utility you must back up your QPM database.

Click Next.

Step 7 Review your selections in the Start Copying Files window. If you want to make changes, click Back until you come to the window that has selections you want to change.

When you have the selections you want, click Next to start installing QPM on your system. This process takes a few minutes.

After QPM is installed, the Wizard Complete window opens.

Step 8 Select whether you want to restart your computer now or later, and click Finish to complete the setup. You must restart your computer before you begin to work with QPM.

The QPM services start automatically whenever you start your computer.

Note Remove the QPM CD-ROM before you restart your computer.

Step 9 If you intend to work with ACS device groups and user permissions, configure settings in ACS and CiscoWorks as described in Working with ACS Device Groups and User Permissions. For more information about QPM user permissions, see Appendix A, "QPM User Permissions."

Step 10 After setup is complete, verify the QPM installation. See Verifying QPM Installation for details.

If you encounter problems starting QPM, see Troubleshooting QPM Installation.

Working with ACS Device Groups and User Permissions

The following topics describe how to configure CiscoWorks Common Services 1.0 to use ACS authorization and authentication on a new QPM 3.1 installation, and after upgrading from QPM 3.0.x.

•Setup for Working with ACS Device Groups and User Permissions

•Updating QPM 3.1 User Permissions in ACS

Setup for Working with ACS Device Groups and User Permissions

If you want to use ACS device groups and permissions for QPM, ACS 3.1 must be installed on the network.

To work with ACS device groups and user permissions, you must register the QPM server with ACS and configure CiscoWorks Common Services 1.0 to use ACS authorization and authentication.

Step

Task

Procedure

Step 1

Define the QPM server in ACS.

1. In ACS, select Network Configuration.

2. Add the QPM server to a device group, or add it as an individual device, depending on the ACS setup.

3. Enter the ACS shared key in the Key field.

Step 2

Define the Login Module in CiscoWorks as TACACS+.

1. In the CiscoWorks desktop, select Server Configuration > Setup > Security > Select Login Module.

2. Select TACACS+, if it is not already selected. Click Next.

3. Enter the ACS server name. You do not need to enter a key.

4. Click Finish.

Step 3

Synchronize CiscoWorks Common Services 1.0 with the ACS server configuration.

1. In the CiscoWorks desktop, select
VPN/Security Management Solution > Administration > Configuration > AAA Server.

2. In the AAA Server Information dialog box, click Synchronize.

3. Add Login details. Enter the ACS shared key that you defined for QPM server in ACS.

4. Click Register.

5. Select qpm, and click the Add button, to add the QPM permission roles in ACS. Click OK.

6. Click Finish.

Step 4

Define usernames, device groups and user groups in ACS.

1. In ACS, select User Setup to define usernames.

2. Select Group Setup to define permissions for device groups.

Note You can define permissions for all network device groups, or per device group. This means that roles can be defined for all devices, or per network device group.

Note To change the authorization and authentication mode back to CiscoWorks permissions, you must configure CiscoWorks Common Services 1.0 to use local authorization and authentication. For details of this procedure, see the user guide or online help for CiscoWorks Common Services 1.0.

For more information about configuring ACS authorization authentication, see the user guide or online help for CiscoWorks Common Services 1.0.

Updating QPM 3.1 User Permissions in ACS

The user permissions for QPM 3.1 have been changed. See ACS User Permissions, page A-5 for details of the new permissions.

If QPM 3.0.x was previously installed on the QPM 3.1 server, and you worked with ACS device groups and user permissions, you must update ACS with the new QPM 3.1 user permissions.

Note If QPM 3.1 is installed on a different server from QPM 3.0.x, follow the procedure in Setup for Working with ACS Device Groups and User Permissions.

Step

Task

Procedure

Step 1

Remove the old QPM permission roles from the ACS server.

1. In the ACS server select Shared Profile Components > CiscoWorks QPM.

2. Select each QPM user role and delete.

Step 2

Unregister the old QPM permission roles in CiscoWorks.

1. In the CiscoWorks desktop, login with username admin and password admin.

2. Select VPN/Security Management Solution > Administration > Configuration > AAA Server.

3. In the AAA Server Information dialog box, click Unregister.

4. Log out of the CiscoWorks desktop.

Step 3

Add the new QPM permission roles to ACS

1. Log into CiscoWorks with username admin and password admin.

2. Select VPN/Security Management Solution > Administration > Configuration > AAA Server.

3. In the AAA Server Information dialog box, click Synchronize.

4. Add Login details. Enter the ACS shared key that you defined for QPM server in ACS.

5. Click Register.

6. Select qpm, and click the Add button, to add the QPM permission roles in ACS. Click OK.

7. Click Finish.

8. Log out of CiscoWorks.

Step 4

Define usernames, device groups and user groups in ACS.

1. In ACS, select User Setup to define usernames.

2. Select Group Setup to define permissions for device groups.

Note You can define permissions for all network device groups, or per device group. This means that roles can be defined for all devices, or per network device group.

Verifying QPM Installation

QoS Policy Manager is accessed from the CiscoWorks desktop.

Procedure

Step 1 In your web browser, start CiscoWorks. The default URL is http://<QPMinstall>:1741, where <QPMinstall> is the name of the computer with the QPM installation.

The CiscoWorks desktop is displayed.

Note The first time you start CiscoWorks on a CiscoWorks server or a client machine, the Java Runtime Environment is automatically installed.

Step 2 Verify on the front page that Java, JavaScript, and cookies are enabled. If they are not enabled, change your browser preferences to enable them, then continue to the next step.

Step 3 Log into CiscoWorks with your username and password.

The CiscoWorks navigation tree appears in the left pane.

Step 4 Click QoS Policy Manager in the navigation tree.

Step 5 Click QPM under the QoS Policy Manager drawer.

A Security Alert window opens. Click Yes to proceed.

QPM opens in a separate browser window.

If you encounter problems starting QPM, see Troubleshooting QPM Installation, for possible causes and solutions.

Troubleshooting QPM Installation

The following topics can help you troubleshoot problems you might encounter while installing QPM, or starting QPM:

•Troubleshooting Problems During Installation

•Troubleshooting Problems Starting Common Services 1.0

•Troubleshooting Problems Starting QPM

•Obtaining System Status Information for Troubleshooting

Troubleshooting Problems During Installation

Problem—Installation process fails. An error message appears telling you that you cannot install QPM because the "qpm" installation subdirectory already exists under the Common Services installation directory.

Explanation—The "qpm" installation directory was not completely deleted during a previous uninstall operation.

Recommended Action—Delete the "qpm" installation directory and start the installation process again. If some of the files are locked and cannot be deleted, restart the computer, and then delete.

Troubleshooting Problems Starting Common Services 1.0

Common Services 1.0 might not start for any of the following reasons:

•Terminal Services is Enabled

•Port Conflict

•Changing Windows Account

Terminal Services is Enabled

Problem—If Terminal Services is enabled, Common Services 1.0 will not work. If you installed Common Services 1.0 on a machine where Terminal Services was enabled, and then disabled before you uninstalled Common Services 1.0, Common Services 1.0 might still not work.

Recommended Action—Do not enable Terminal Services before or after installation of Common Services 1.0.

Port Conflict

Problem—You cannot start Common Services 1.0 because port 1741, which is used by Common Services 1.0, is in use by another application.

Recommended Action—Try the following:

•Restart the QPM server.

•To run CiscoWorks, enter http://<QPMinstall>:1741/login.html, where <QPMinstall> is the name or IP address of the QPM server.

Changing Windows Account

Problem—If you install Common Services 1.0 and QPM using a specific admin account/password, everything works as planned. However, if you change the password to this Windows account, then installed services fail to start.

Recommended Action—Change the password for all services to match the current password of the account which they were installed. Common Services 1.0 includes Tomcat, fms, lm, and da-framework services.

Troubleshooting Problems Starting QPM

QPM might not start for any of the following reasons:

•QPM Server Does Not Meet System Requirements

•Old Version of Java Plug-In

•Incorrect User Permissions

•Changed Database Password

•Unknown Cause

QPM Server Does Not Meet System Requirements

Problem—QPM startup and performance might be slow, or QPM might not work at all.

Recommended Action—Install QPM on a server that meets system requirements.

Old Version of Java Plug-In

Problem—QPM might not start if there is a older version of the Java plug-in than the one required by QPM.

Recommended Action—Uninstall the old Java plug-in. When you start CiscoWorks, it automatically installs the new Java plug-in.

Incorrect User Permissions

Problem—Many buttons in the user interface are grayed out because you might not have the correct user permissions to perform those tasks.

Recommended Action—Verify your user permissions in the CiscoWorks desktop (Server Configuration > Setup > Security), or in ACS (depending on the method you are using for user authentication). For more information about working with ACS user permissions, see Working with ACS Device Groups and User Permissions.

Note You might also encounter display problems if the browser version on the client system does not meet the client system requirements.

Changed Database Password

Problem—If you change the QPM database password and then try to start QPM without restarting the QPM server, the connection to the database is lost.

Recommended Action—Restart the QPM server after changing the QPM database password.

Unknown Cause

Recommended Action—Restart the QPM server.

Obtaining Information for Troubleshooting and Cisco Technical Support

The following topics describe how to obtain information for troubleshooting and Cisco Technical Support:

•Obtaining System Status Information for Troubleshooting

•Obtaining Debug Information for Cisco Technical Support

Obtaining System Status Information for Troubleshooting

If QPM does not run after installation, or if unusual exceptions occur or error windows are displayed while running QPM, you can obtain system status information by running the QPM Diagnostic Tool on the QPM server. This tool generates a report in a browser window of the system status with its diagnostics and suggests possible solutions where applicable.

If you want to send the diagnostics results to a TAC representative, you can run the MDCSupport.exe command-line utility, which collects configuration and system information in a zip file called MDCSupportInformation.zip. This zip file includes any problems that occurred during the installation or the running of QPM. You can send this file to the Cisco Technical Assistance Center (TAC) support staff to assist in diagnosing the problems.

Procedure

Step 1 On the QPM server, select Start > Programs > Cisco Systems > QoS Policy Manager > Diagnostic Tool.

A report is generated and displayed in a browser window for you to view.

Step 2 To send the diagnostics results to a TAC representative:

a. At the command line, enter MDCSupport.exe and press Enter.

A zip file named MDCSupportInformation.zip is created under c:\Program Files\CSCOpx\MDC\etc.

b. Email this file to the TAC representative.

Obtaining Debug Information for Cisco Technical Support

If Cisco Technical Support requests that you gather additional debug information in the trace files, you can set the QPM trace logging mode to collect the information. Because collecting debug information will reduce the performance of your server, and the collected data can only be interpreted by Cisco, do not collect debug information unless requested. After you have collected the information, reset the logging mode to only collect informational messages.

Procedure

Step 1 From the QPM-install-directory\CSCOpx\MDC\qpm\bin directory (where QPM-install-directory is the directory in which you installed QPM), enter this command to begin collecting debug information:

setqpmloggermode -debug

Step 2 When sufficient debug information has been collected, send these files to your Cisco Technical Support representative (paths are relative to the QPM installation directory):

•CSCOpx\MDC\log\jonas_last_run.trace

•CSCOpx\MDC\log\tomcat_last_run.trace

•CSCOpx\MDC\log\pdp_last_run.trace

Step 3 Reset the logging mode so that only informational messages are collected (the default behavior):

setqpmloggermode -info

Uninstalling QPM

You can uninstall QPM directly from the QPM setup or from the CiscoWorks Common Services 1.0 setup. If you are uninstalling only QPM, it is easier to uninstall from the QPM setup. If you want to uninstall QPM and CiscoWorks Common Services 1.0, use the CiscoWorks Common Services 1.0 setup to uninstall both applications in a single procedure.

Note Uninstalling QPM does not remove your deployed policies from the network devices.

Procedure from QPM Setup

Step 1 Select Start > Settings > Control Panel > Add/Remove Programs. The Add/Remove Programs window opens.

Step 2 Select QoS Policy Manager 3.1, and click Change/Remove.

The QPM uninstallation process starts, and QPM is removed from your computer.

Step 3 Restart your computer.

Step 4 Ensure that the QPM directory under the CiscoWorks Common Services 1.0 installation directory has been completely deleted.

Note You cannot reinstall QPM if the QPM installation directory exists.

Procedure from CiscoWorks Common Services 1.0 Setup

Step 1 Select Start > Settings > Control Panel > Add/Remove Programs. The Add/Remove Programs window opens.

Step 2 Select CiscoWorks2000, and click Change/Remove.

Step 3 In the Uninstallation dialog box, clear the check boxes for the applications you do not want to uninstall. Leave QoS Policy Manager selected. Click Next.

The QPM uninstallation process starts, and QPM is removed from your computer.

Step 4 Restart your computer.

Step 5 Ensure that the QPM directory under the CiscoWorks Common Services 1.0 installation directory has been completely deleted.

Note You cannot reinstall QPM if the QPM installation directory exists.