Table Of Contents
Quick Start Guide for CiscoWorks QoS Policy Manager 3.1
1 SUPPLEMENTAL LICENSE AGREEMENT
SUPPLEMENTAL LICENSE AGREEMENT FOR CISCO SYSTEMS NETWORK MANAGEMENT SOFTWARE: CiscoWorks QOS POLICY MANAGER (UNRESTRICTED AND RESTRICTED VERSIONS)
IMPORTANT—READ CAREFULLY: This Supplemental License Agreement ("SLA") contains additional limitations on the license to the Software provided to Customer under the Software License Agreement between Customer and Cisco. Capitalized terms used in this SLA and not otherwise defined herein shall have the meanings assigned to them in the Software License Agreement. To the extent that there is a conflict among any of these terms and conditions applicable to the Software, the terms and conditions in this SLA shall take precedence.
By installing, downloading, accessing or otherwise using the Software, Customer agrees to be bound by the terms of this SLA. If Customer does not agree to the terms of this SLA, Customer may not install, download, or otherwise use the Software. When used below, the term "server" refers to central processor unit.
1. ADDITIONAL LICENSE RESTRICTIONS.
•Device Restricted Version. By purchasing the Restricted version of the QoS Policy Manager Customer may manage up to twenty (20) devices. Customers whose requirements exceed the Restricted version limit of twenty devices must upgrade to the Unrestricted version of the Software.
•Installation and Use. The Software components are provided to Customer solely to install, update, supplement, or replace existing functionality of the applicable Network Management Software product. Customer may install and use following Software components:
–QoS Policy Manager (QPM): May be installed on one (1) server in Customer's network management environment.
–Common Services 1.0: May be installed on one (1) server in Customer's network management environment.
•Reproduction and Distribution. Customer may not reproduce nor distribute software.
2. DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS.
Please refer to the Cisco Systems, Inc. Software License Agreement.
2 QoS Policy Manager Overview
This quick start guide provides basic requirements and procedures for installing, upgrading, and setting up CiscoWorks QoS Policy Manager (QPM) 3.1 so you can get your server up and running as quickly as possible.
Note This guide contains quick start typical installation instructions. For additional installation information, see the installation guides available in PDF format in the Documentation directory on the product CDs. Use Adobe Acrobat Reader 4.0 to read the PDF files.
This section contains:
QoS Policy Manager (QPM) lets you analyze traffic throughput by application or service class, and then leverage that information to configure QoS policies to differentiate traffic and to define the QoS functions to be applied to each type of traffic flow.
By simplifying QoS policy definition and deployment, QPM makes it easier for you to create and manage end-to-end differentiated services in your network, thus making more efficient and economical use of your existing network resources. For example, you can deploy policies that ensure that your mission-critical applications always get the bandwidth required to run your business.
QPM is suitable for large-scale enterprise deployments, and IP telephony deployments, consisting of hundreds or thousands of devices. QPM facilitates management of large networks by providing advanced user authorization capabilities through integration with Cisco Access Control Server (ACS).
QPM runs on the CiscoWorks Common Services 1.0 server, which can be installed as a standalone server, or as an add-on to CD One 5th Edition. CiscoWorks Common Services 1.0 provides the infrastructure required by QPM to run from the CiscoWorks desktop environment, and also provides management of user roles and privileges, allowing you to control who gets access to specific tasks in QPM.
The QPM package contains two CDs:
•Common Services 1.0
The following table provides information about the CDs and lists the contents of each sub-box in the QPM package.
The following new features are added in release 3.1 of QoS Policy Manager:
•QPM 3.1 includes an export utility and an import utility, which enable you to:
–Migrate and upgrade QPM 3.0.x database and configuration information to QPM 3.1.
–Migrate QPM database and configuration information from one QPM 3.1 server to another.
•Support was added for these devices.
–Catalyst 6000 with Sup 720/PFC3 switches
–Catalyst 4006, 4503, and 4504 with Sup III, IV switches
–Catalyst 4507R with Sup IV switch
–Catalyst 2980G switch
–Catalyst 2950LRE switch
•4Q1T-Shape queuing for Catalyst 4006, 4503, 4505 (Sup III, IV) and 4507R (Sup IV)
•Support for IOS software version 12.2S
•The ability to specify FRTS burst and exceed burst sizes as the desired interval (in milliseconds), rather than a set rate, so that policies can be more easily applied to interfaces of differing rates.
•The ability to define a policy's filter condition as a subfilter, so that you use fewer ACLs on a device. This can be helpful if you are reaching the limit on available ACLs on a device.
•The IP Telephony templates have been updated to the latest Cisco recommendations. Additionally, templates have been added to help you deploy policies on ATM to Frame Relay connections.
•QoS analysis reports are now exported in XML format rather than CSV.
•You can now select Kaza2 as an NBAR application.
•QPM user privileges have changed. There are now more user levels that you can use to control and limit access to QPM.
3 Server and Client System Requirements
This section provides QoS Policy Manager server and client requirements:
•Table 1 describes the server requirements for installing the QoS Policy Manager components on Windows 2000 systems.
•Table 2 describes the client system requirements for all platforms.
For maximum performance, it is recommended you use a dedicated server for QPM.
Do not install QPM on a Windows server running any of the following services:
•Primary domain controller
•Backup domain controller
Do not install QPM on the same server as CiscoWorks Management Center for Routers (Router MC).
4 Installation Paths
You might already have another CiscoWorks product installed on your server. As a result, you might not need to install all QPM bundled applications. Review the information in Table 3 to determine what software is required for QoS Policy Manager to successfully operate.
Table 3 Recommended Installation Paths
If You are Installing QoS Policy Manager on a System That... Then You...
Has no other CiscoWorks products
1. Common Services 1.0
2. QoS Policy Manager 3.11
Has QPM 3.0.x with Common Services 1.0
1. Export the QPM 3.0.x database and configuration if you want to use it in your QPM 3.1 installation. See the Installation Guide for CiscoWorks QoS Policy Manager for information about the QPM 3.1 export utility.
2. Uninstall QPM 3.0.x
3. Install QoS Policy Manager 3.11
4. Import the QPM 3.0.x database and configuration as described in Installation Guide for CiscoWorks QoS Policy Manager.
Has QPM 2.x
1. Common Services 1.0
2. QoS Policy Manager 3.11
Note You can install QPM 3.1 without uninstalling QPM 2.x.
Note To use the QPM 2.1.x policy database in QPM 3.1, export the policy database from QPM 2.1.x. See the Installation Guide for CiscoWorks QoS Policy Manager for information about the QPM 2.1 export utility.
Has Common Services 1.0 with or without CD One 5th edition
Has CD One 5th edition without Common Services 1.0
1. Common Services 1.0
2. QoS Policy Manager 3.11
Note If you try to install Common Services on a system that has CD One 4th edition or earlier, the Common Services installation will abort.
Do not install the QPM package CDs.
1 QPM is automatically installed in the Common Services installation folder.
5 Installing Common Services 1.0
Note Common Services 1.0 ships with a 90-day evaluation license that you can use to install the software. If you install Common Services without a license, you will still be able to start QPM. Please refer to the SUPPLEMENTAL LICENSE AGREEMENT for usage restrictions for QPM.
Before you begin:
•Close all running programs.
•Disable any virus scanning or intrusion detection software that might be running on the server. These types of software can interfere with the installation.
•If you are reinstalling Common Services, make sure the target directory is empty or does not exist before beginning the installation.
To install Common Services in a standalone configuration:
Step 1 Insert the Common Services 1.0 CD-ROM into the CD-ROM drive.
The Common Services installation program starts. The Welcome panel of the installation application appears.
If the installation program does not start, run the setup.exe program in the CD's root directory.
Step 2 Click Next. The Software License Agreement panel appears.
Step 3 Read the license agreement. If you accept the conditions, click Yes and proceed with the installation. Otherwise, click No.
Step 4 On the Choose Destination Location panel, the default installation directory, C:\Program Files\CSCOpx, appears in the Destination Folder area. To change the installation directory, click Browse and select an existing folder or create a new folder.
If you are installing Common Services on a FAT32 partition, the installation program prompts you to change directories. You can choose one of the following options:
•Select the Choose another directory option to change the installation directory to a directory that resides on an NTFS partition, and then click Next.
•Select the Use selected directory option to keep your original directory choice then click Next.
•Click Cancel to terminate the installation and convert the target drive to NTFS. See the converting file systems topic in Windows help for more information about converting a FAT32 file system to NTFS.
The System Requirements panel appears.
Step 5 Review the requirements to ensure that the drive specified has enough free space for the installation. If the selected drive does not have enough space, click Back to return to the Choose Destination Location page and select another drive.
Verify that the system has enough memory. If the system does not have enough memory, click Cancel to terminate the installation. You should either install additional memory in the target system or install Common Services on a system that meets the minimum memory requirements.
If your system meets all the system requirements, click Next. The Select license file screen appears.
Step 6 Enter the path to the license file in the License file location field. Click Next.
The system displays a message while validating your license. If the license is valid, the Account Information panel appears.
Step 7 Enter the password you used to log into Windows in the Password and Confirm Password fields. Click Next.
If the two passwords do not match, the system prompts you to enter them again. If the passwords match, the Ports Configuration panel appears.
Step 8 To change the external port numbers used by the Lock Manager (lm.exe) and database (fms.exe) services, enter the new information in the following fields:
•LM Port—The port used by Lock Manager. The default value is 1272. Use the default value unless it conflicts with another application on the server.
•FMS Port—The port used by the Common Services database. The default value is 9652. Use the default value unless it conflicts with another application on the server.
Click Next. The Database Configuration panel appears.
Step 9 Enter the information used by the SQL database component of Common Services:
•Server Port—The port used by the SQL database. The default value is 2638. Use the default value unless it conflicts with another application on the server.
•Password—The password used by the SQL database. The password must be at least 4 characters long.
•Confirm Password—The same value you entered in the Password field.
Click Next. The Apache Server Configuration panel appears.
Step 10 Enter the information used by the Apache server component of Common Services:
•HTTPS Port—The port used by the Apache for Secure Socket Layer (SSL) requests. Use the default value, 443, unless it conflicts with another application on the server.
•Email Address—The email address of the system administrator (required).
•SMTP Server—The DNS name or IP address of your SMTP server.
Step 11 Enter the following information required to generate the local certificate. The local certificate is used for authentication and authorization when logging into the CiscoWorks desktop:
•Country Code—A two-character code for the country where the Common Services server is located.
•State—The name of the state or province where the Common Services server is located.
•City—The name of the city where the Common Services server is located.
•Company—Your company name.
•Organization—The name of the organization or division you work in.
•Domain—The name of the domain the server resides in.
•Certificate Password—A password for the certificate. The password must have a minimum of 4 and a maximum of 10 alphanumeric characters.
•Confirm Password—The same value you entered in the Certificate Password field.
Click Next. The Create Shortcuts panel appears.
Step 12 Select the Create a shortcut... check box to create a shortcut on the Windows desktop.
Click Next. The Verification panel appears.
Step 13 Review your settings. To change any settings, click Back to return to the setting you want to change. Click Next.
Note If you abort the installation during the file copy stage, you must run the uninstall program before installing again.
The Start Copying Files panel appears. During the file copy, the system prompts you at four different times to change passwords for the following components:
•casuser (the user created by Common Services to run the desktop services)
•the "admin" account
•the "guest" account
•the CMF database
Step 14 To accept the default passwords, click No.
Note The default password for the admin account is "admin". The default password for the "guest" account is none (blank). The default passwords for causer and the CMF database are generated by the system and cannot be changed later.
To change a password:
a. Click Yes.
b. Type the password in the Password field.
c. Retype the password in the Confirm field.
d. Click OK.
The installation may take a few minutes to complete while the components are installed and the services are configured. When the installation is complete, the Restart panel appears.
Step 15 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 Common Services or install additional software.
Step 16 Configure the web browser on the client system for use with CiscoWorks.
For information about configuring the web browser on the client system, see the "Preparing to Use CiscoWorks Common Services" chapter in Installing Common Services 1.0 on Windows 2000.
6 Installing QoS Policy Manager
Before you begin:
•Verify that Common Services 1.0 is already installed. QPM is automatically installed in the Common Services installation folder.
•The machine on which you are going to install QPM meets the requirements for running QPM.
To install QPM:
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. The Welcome window opens.
Step 3 Click Next. 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 when you log into QPM. You can change the password through Common Services in the CiscoWorks desktop. Select VPN/Security Management Solution > Administration > Configuration > Database Credentials.
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, your QPM database will be larger, and will need more free disk space 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.
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 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 Installation Guide for CiscoWorks QoS Policy Manager.
QPM permission roles have changed in QPM 3.1. Before you begin to work with QPM, ensure that you have the appropriate permissions, as described in the installation guide.
After setup is complete, verify the QPM installation as described in Verifying the Installation.
7 Verifying the Installation
The CiscoWorks Server desktop is the interface for CiscoWorks network management applications, including QPM.
Before you begin to work with QPM, you should ensure that you have the appropriate permissions. 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).
To verify QPM installation, log into CiscoWorks:
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 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 Installation Guide for CiscoWorks QoS Policy Manager for possible causes and solutions.
8 Where to Go Next
After you have installed the required products and have performed necessary post-installation tasks, you are ready to use QPM to configure and deploy QoS policies. For more information, see these publications:
•Getting Started Guide for QoS Policy Manager—Provides a tutorial to teach you how to navigate in the product and create and deploy QoS policies. Included are sample, virtual devices, so that you can learn without changing the configuration of your actual network. You can access this document:
–In PDF format in the Documentation directory on the QoS Policy Manager product CD.
–From the QPM online help, click Main, and then select QoS Policy Manager > Getting Started with QPM.
–From the CiscoWorks desktop, click Help. Select QoS Policy Manager > Getting Started with QPM.
•User Guide for QoS Policy Manager—Provides usage, reference, and troubleshooting information for QPM. You can access this document:
–In PDF format in the Documentation directory on the QoS Policy Manager product CD.
–From the QPM online help.
–From the CiscoWorks desktop, click Help. Select QoS Policy Manager > Using QPM.
9 Related Documentation
Note Although every effort has been made to validate the accuracy of the information in the printed and electronic documentation, you should also review the documentation on Cisco.com for any updates.
For information about installing, troubleshooting, and using the product, see the sources of information shown in Table 4.
Table 4 Related Documentation
See this document In the product package? On the product CD? 1 On Cisco.com? On the Cisco Doc. CD? 2 In the online help?
Product's known bugs (DDTSs)
Release Notes for QoS Policy Manager
Release Notes for Common Services 1.0 on Windows 2000
Quick start installation
Quick Start Guide for CiscoWorks QoS Policy Manager
Detailed installation and setup information
Installation Guide for QoS Policy Manager (DOC-7815484=)
Installing Common Services 1.0 on Windows 2000
Introduction to QPM with end-to-end scenarios and examples
Getting Started Guide for QoS Policy Manager (DOC-7815533=)
QPM features, tasks, and troubleshooting
User Guide for QoS Policy Manager (DOC-7815532=)
User authentication and database password management through the CiscoWorks desktop
Using Common Services 1.0
Devices and software releases that QPM supports
Select the device support table for QPM 3.1 at this url:
1 Provided as PDF in Documentation folder. Requires Adobe Acrobat 4.0 or later.
3 To access online help for the Getting Started Guide, click Help in the CiscoWorks desktop. In the Help window, click Main. In the Contents tab select QoS Policy Manager > Getting Started with QPM. To open the PDF, select View PDF in the Contents tab.
4 To access online help for the QPM User Guide, click Help in the QPM window. To open the PDF, select View PDF in the Contents tab.
Cisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.
You can access the most current Cisco documentation on the World Wide Web at this URL:
You can access the Cisco website at this URL:
International Cisco web sites can be accessed from this URL:
Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.
Registered Cisco.com users can order the Documentation CD-ROM (product number DOC-CONDOCCD=) through the online Subscription Store:
You can find instructions for ordering documentation at this URL:
You can order Cisco documentation in these ways:
•Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from the Networking Products MarketPlace:
•Registered Cisco.com users can order the Documentation CD-ROM (Customer Order Number DOC-CONDOCCD=) through the online Subscription Store:
•Nonregistered Cisco.com users can order documentation through a local account representative by calling Cisco Systems Corporate Headquarters (California, U.S.A.) at 408 526-7208 or, elsewhere in North America, by calling 800 553-NETS (6387).
You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.
You can email your comments to firstname.lastname@example.org.
You can submit your comments by mail by using the response card behind the front cover of your document or by writing to the following address:
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883
We appreciate your comments.
Obtaining Technical Assistance
Cisco provides Cisco.com, which includes the Cisco Technical Assistance Center (TAC) Website, as a starting point for all technical assistance. Customers and partners can obtain online documentation, troubleshooting tips, and sample configurations from the Cisco TAC website. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC website, including TAC tools and utilities.
Cisco.com offers a suite of interactive, networked services that let you access Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.
•Cisco.com provides a broad range of features and services to help you with these tasks:
•Streamline business processes and improve productivity
•Resolve technical issues with online support
•Download and test software packages
•Order Cisco learning materials and merchandise
•Register for online skill assessment, training, and certification programs
To obtain customized information and service, you can self-register on Cisco.com at this URL:
Technical Assistance Center
The Cisco TAC is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two levels of support are available: the Cisco TAC website and the Cisco TAC Escalation Center. The avenue of support that you choose depends on the priority of the problem and the conditions stated in service contracts, when applicable.
We categorize Cisco TAC inquiries according to urgency:
•Priority level 4 (P4)—You need information or assistance concerning Cisco product capabilities, product installation, or basic product configuration.
•Priority level 3 (P3)—Your network performance is degraded. Network functionality is noticeably impaired, but most business operations continue.
•Priority level 2 (P2)—Your production network is severely degraded, affecting significant aspects of business operations. No workaround is available.
•Priority level 1 (P1)—Your production network is down, and a critical impact to business operations will occur if service is not restored quickly. No workaround is available.
Cisco TAC Website
You can use the Cisco TAC website to resolve P3 and P4 issues yourself, saving both cost and time. The site provides around-the-clock access to online tools, knowledge bases, and software. To access the Cisco TAC website, go to this URL:
All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC website. Some services on the Cisco TAC website require a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to this URL to register:
If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC website, you can open a case online at this URL:
If you have Internet access, we recommend that you open P3 and P4 cases through the Cisco TAC website so that you can describe the situation in your own words and attach any necessary files.
Cisco TAC Escalation Center
The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. These classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer automatically opens a case.
To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:
Before calling, please check with your network operations center to determine the level of Cisco support services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). When you call the center, please have available your service agreement number and your product serial number.
Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online and printed sources.
•The Cisco Product Catalog describes the networking products offered by Cisco Systems as well as ordering and customer support services. Access the Cisco Product Catalog at this URL:
•Cisco Press publishes a wide range of networking publications. Cisco suggests these titles for new and experienced users: Internetworking Terms and Acronyms Dictionary, Internetworking Technology Handbook, Internetworking Troubleshooting Guide, and the Internetworking Design Guide. For current Cisco Press titles and other information, go to Cisco Press online at this URL:
•Packet magazine is the Cisco monthly periodical that provides industry professionals with the latest information about the field of networking. You can access Packet magazine at this URL:
•Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in the design, development, and operation of public and private internets and intranets. You can access the Internet Protocol Journal at this URL: