Using QoS Policy Manager 2.0
QPM-PRO Command Reference
Download this chapter
QPM-PRO Command ReferenceQPM-PRO Command Reference
give_us_feedback

Table of Contents

QPM-PRO Command Reference
Policy Manager Command Reference
 Distribution Manager Command Reference
 QPM-PRO Abstract Actions Translated to Device Commands

QPM-PRO Command Reference

These sections provide a quick reference for QPM-PRO menu commands, tool bar buttons, and policy action translations:

Policy Manager Command Reference


Table A-1: Policy Manager Command Reference
Menu Command Toolbar Button Description

File

New>Database

Creates a new QoS database.

File

New>Device

None

Adds a device to the QoS database.

File

New>Interface

None

Adds an interface for the selected device to the QoS database.

To add an interface to an existing device, it is easier to select the device and select Devices>Device>Properties, and click the Detect Interfaces button in the Device Properties window. QPM-PRO queries the device for a list of interfaces and displays them in the Detect Interfaces window. You can select the interfaces you want to add from this window.

File

New>Device Group

None

Creates a device group, which is a grouping of interfaces to which you want to apply the same policies.

File

New>Policy

Creates a new QoS policy for the selected interface, device, or device group.

File

Open

Opens a QoS database.

File

Save

Saves the currently open database without changing its file name.

File

Save As

None

Saves the currently open database using a different file name.

File

Description

None

Adds a description to the currently open database.

File

Close

None

Closes Policy Manager without closing Distribution Manager.

File

Exit

None

Closes Policy Manager and Distribution Manager.

Edit

Cut

None

Copies the selected policy to the Windows clipboard and removes it from the interface, device, or device group.

Edit

Copy

None

Copies the selected policy to the Windows clipboard without removing it from the interface, device, or device group.

Edit

Paste

None

Pastes the policy in the clipboard to the selected interface, device, or device group if the policy's action is supported on that item.

Edit

Delete

None

Deletes the selected element in the Policy Manager window.

View

Tool Bar

None

Displays (when checked) or hides the tool bar, which contains shortcut buttons for some menu commands.

View

Status Bar

None

Displays (when checked) or hides the status bar tray at the bottom of the main window.

View

Properties Preview

None

Displays (when checked) or hides the preview pane at the bottom right of the main Policy Manager window. The summary shows details of the selected database, policy, device, device group, or interface.

View

Device Name

None

Displays (when checked) the device names instead of their IP addresses.

Devices

Device>New

None

Adds a device to the QoS database, so that you can manage policies on that device through Policy Manager.

Devices

Device>View Configuration

None

Displays the selected device's settings, including SNMP communities and Cisco IOS software version numbers.

Devices

Device>Delete

None

Removes the selected device from the QoS database.

Devices

Device> Find

Finds and highlights the specified device in the tree view.

Devices

Device>Properties

None

Displays the selected device's properties as defined in the QoS database.

Devices

Interface>New

None

Adds an interface for the selected device to the QoS database. It is easier to have QPM-PRO detect the device's interfaces by clicking Detect Interfaces when viewing the device's properties for previously-defined devices (Devices>Device>Properties), or when adding a new device.

Devices

Interface>Delete

None

Removes the selected interface from the QoS database.

Devices

Interface>Properties

None

Displays the interface settings for the selected interface.

Devices

Device Group>New

None

Creates a device group, which is a grouping of interfaces to which you want to apply the same policies.

Devices

Device Group>Add/Remove Members

None

Adds interfaces to the selected device group, or removes them from the selected device group.

Devices

Device Group>Delete

None

Deletes the selected device group from the QoS database.

Device

Device Group>Properties

None

Displays the device group properties for the selected device group.

Devices

Policy>New QoS Policy

Creates a new QoS policy for the selected device, interface or device group.

Devices

Policy>New Access Control Policy

Creates a new Access Control policy for the selected device, interface or device group.

Devices

Policy>Disable

Policy>Enable

None

Disables the selected policy without deleting it from the database, or enables the selected policy, depending on the status of the policy. However, the policy is not disabled or enabled on the device until you save and distribute the database.

Devices

Policy>Delete

None

Deletes the selected policy from the database. However, the policy is not deleted from the device until you save and distribute the database.

Devices

Policy>Properties

None

Displays the selected policy's properties.

Devices

Import

None

Imports devices from an inventory list exported from Cisco Resource Manager (CRM) or CiscoWorks2000 Resource Manager Essentials.

Tools

Distribution Manager

Starts the Distribution Manager application, which you use to distribute policies to network devices.

Tools

Reports>All Policies

None

Displays a report of all the policies defined in the open database.

Tools

Reports>Device Policies

None

Displays a report of the policies defined for the selected device.

Tools

Reports>Device Group Policies

None

Displays a report of the policies defined for the selected device group.

Tools

Reports>Interface Policies

None

Displays a report of the policies defined for the selected interface.

Tools

Reports>Upload

None

Displays a report of the errors that occurred when uploading the QoS configuration from a device. QPM-PRO creates a separate report for each database, and after each upload operation, the list of errors is added to the report.

Tools

Reset Upload Report

None

Deletes the contents of the upload report for the currently open database.

Tools

Application Services

Creates or edits application service aliases. Application services are a defined set of characteristics that identify the source of traffic, so that you can more easily write policies that target the defined traffic.

Tools

Host Groups

Creates or edits host groups. Host groups are collections of hosts or subnets that you can use when creating QoS statements, so that you do not have to retype long lists for multiple statements.

Tools

DNS Resolution>Resolve Unresolved Host Names

None

Resolves only those host names that have not previously been resolved. Does not check previously resolved host names to determine if the IP address is correct.

Tools

DNS Resolution>Resolve All Host Names

None

Resolves all host names, even those that have previously been resolved. This ensures that the QoS database contains all current IP addresses for the hosts on the network.

Tools

Telnet

Starts Telnet and attempts to connected to the selected device, if any.

Tools

User Manager

Opens Windows NT or Windows 2000 User Manager, so that you can change the membership in the QPM-PRO user and guest groups. These groups manage user authentication for QPM-PRO, and are defined as local groups on the machine running the QoS Manager service.

Help

Topics

Opens the online help.

Help

About

None

Displays the version and copyright information for the program.

(None)

(None)

Moves the selected policy up in the list of policies.

(None)

(None)

Moves the selected policy down in the list of policies.

(None)

(None)

Filter box

Filters which policy statements are displayed based on your selection.


Distribution Manager Command Reference


Table A-2: Distribution Manager Command Reference
Menu Command Toolbar Button Description

File

Close

None

Closes Distribution Manager without closing Policy Manager.

File

Exit

None

Closes Distribution Manager and Policy Manager.

View

Toolbar

None

Displays (when checked) or hides the toolbar, which contains shortcut buttons for some menu commands.

View

Log

None

Displays (when checked) the log pane at the bottom of the main window.

View

Status Bar

None

Displays (when checked) or hides the status bar tray at the bottom of the main window.

Devices

Create Job

None

Creates a distribution job. You are prompted to select the QoS database that contains the configuration that you want to deploy to the network.

Devices

Apply

Applies the job the first valid Not-Applied job (created with the Devices>Create Job command) in the tree view to the network, if there is one. If there is no valid Not-Applied job, QPM-PRO asks you to select the database from which to create the job, and then applies the job without allowing you to inspect the job contents. The job contains the configuration commands required to deploy your QoS policies and settings to the network.

Use the Devices>Create Job command to create a job that you can inspect before applying it.

Devices

Apply to All

Generates an apply process to all the devices of the selected job, regardless of their status (Not-Applied, Unchanged, and so on). The status of each device is changed to Not-Applied, and then the deployment process starts. Because the deployment is incremental, if nothing has been changed on the device and the database has not been changed, no configuration will be deployed.

Apply to All has the same behavior as Apply.

Devices

Stop

Stops the deployment of the current job to the network. The job is stopped after the changes to the device currently being configured are complete.

Devices

Resume

Resumes the deployment of the job that you previously stopped.

Devices

View Commands

None

Displays the commands that will be used to configure the device selected in the list pane.

Devices

View Backup Configuration File

None

Displays the configuration that has been deployed on the selected device.

Devices

View Full Deployment File

None

Displays the contents of the full deployment file that is created after deployment to file. This file contains the complete device configuration after deployment, and can be sent via TFTP to configure the device.

Devices

View Incremental Deployment File

View Job Logging

None

Displays the contents of the incremental deployment file that is created after deployment to file. This file contains the incremental commands that need to be sent to the device to update its configuration.

Devices

Verify Device Configuration

Verifies if the policies in the most recently distributed job match the configuration on the devices. There might be cases where CLI changes were made on the device, creating a mismatch between the database and the device configuration.

This function has the same behavior as Apply and Apply to All. If a Not-Applied job exists this job is verified, otherwise a new job is created and verified.

The verification process contains two steps, DNS resolution check, and device configuration check.

Devices

Restore to Current

Restores the previously created job as the current database. You will be prompted to create a job for the current database, if it has not been saved as a job.

Devices

Restore to Current and Apply

Restores the previously created job as the current database and applies it to the network.

Devices

Options

None

Opens the Options dialog, which allows you to configure some characteristics of Distribution Manager operation.

Tools

Policy Manager

Starts the Policy Manager application, which lets you create and edit policy statements.

Tools

Reports>All Jobs

None

Displays the summary information for each job, along with the device details for each job.

Tools

Reports>System Log

None

Displays the system log, which contains messages concerning the functioning of Distribution Manager.

Tools

Reports>Device Log

None

Displays the log of the selected device, which contains Telnet and device messages produced while the device was being configured.

Tools

Reports>Job Log

None

Displays the log of the selected job, which contains Telnet and device messages produced while the job was being applied to the network.

Tools

User Manager

Opens Windows NT or Windows 2000 User Manager, so that you can change the membership in the QPM-PRO user and guest groups. These groups manage user authentication for QPM-PRO, and are defined as local groups on the machine running the QoS Manager service.

Help

Topics

Opens the online help.

Help

About

None

Displays the version and copyright information for the program.


QPM-PRO Abstract Actions Translated to Device Commands

QPM-PRO uses device commands to configure your QoS policies and configurations on the devices. These are the same commands you can use on the device's command line interface (CLI), and they are described in the device's documentation.

This section shows the command sequences used to configure each type of abstract policy action that you can create using QPM-PRO. You can use this information to help you understand how QPM-PRO configures your devices. See the device's documentation for complete information on the commands and their parameters. (See More Information About Quality of Service for a partial list of product documentation.)

These sections show the full command translation, including optional parameters. If you do not configure an optional setting, the associated command or parameter is not included in the command sequence QPM-PRO uses to configure the device.

Note   The notation in the translation is bold for the router's key words, italic for variables. Some of the variables are parameters you enter into QPM-PRO. Other variables are managed by QPM-PRO, for example, the ACL number.

These sections describe QPM-PRO abstract actions:

CBWFQ Configuration

When you select CBWFQ for an interface's QoS property, and create CBWFQ policies on the interface, QPM-PRO uses this command sequence to configure the device:

1. access-list ACLNum filter

2. class-map [match all | match any] classname

a. match access-group ACLNum

b. match ip dscp dscp

c. match ip precedence precedence

d. match ip rtp low_port range

e. match protocol protocol [ parametername [value ]]

3. policy-map policy-map-name

4. class classname

a. bandwidth bandwidth

b. queue-limit queue-limit

c. random-detect (see the "WRED Configuration" section for the random-detect commands)

d. fair queue queue-limit individual-queue-limit

e. priority [bandwidth]

f. set ip precedence precedence

g. set ip dscp dscp

h. shape average shape-rate [shape-bcshape-be]

i. shape peak shape-rate [shape-bcshape-be]

j. shape adaptive shape-adaptive-rate

k. shape fecn-adapt

l. police police-rate [police-bc police-be] conform-action action exceed-action action

5. class class-default

a. bandwidth bandwidth

b. queue-limit queue-limit

c. random-detect (see the "WRED Configuration" section for the random-detect commands)

d. fair-queue number-of-queues
or
fair queue queue-limit individual-queue-limit

e. priority

6. interface interfacename

7. service-policy output policy-map-name

Note   Some commands are for CBWFQ on a device that supports NBAR or IPRTP.

WFQ Configuration

When you select WFQ for an interface's QoS property, QPM-PRO uses this command sequence to configure the device.

1. interface interfacename

2. fair-queue

WFQ with FRTS Configuration

When you select WFQ for an interface's QoS property, and you enable Frame Relay traffic shaping (FRTS) on an interface, QPM-PRO uses this command sequence to configure the device:

1. map-class frame-relay classname

2. frame-relay fair-queue congestive-discard-threshold number-dynamic-conversation-queues number-reservable-conversation-queues max-buffer-size-for-fair-queues

3. interface interfacename

WFQ on VIP Cards (DWFQ with QoS Group) Configuration

When you select WFQ or FQ for an interface's QoS property, and that interface is on a VIP card, QPM-PRO uses this command sequence to configure the device:

1. access-list ACLNum condition

2. rate-limit input access-group ACLNum rate bc be conform-action set-qos-transmit qos-group no exceed-action set-qos-transmit qos-group no

3. interface interfacename

4. fair-queue qos-group

5. fair-queue qos-group qos-group weight weight

6. fair-queue qos-group qos-group limit limit

7. fair-queue aggregate-limit aggregate-packet

8. fair-queue individual-limit individual-packet

WRED Configuration

When you select WRED for an interface's QoS property, or select WRED for the drop mechanism for a CBWFQ policy or interface QoS property, QPM-PRO uses this command sequence to configure the device:

1. interface interfacename

2. random-detect weight

3. random-detect precedence <precedence| rsvp> min-threshold max-threshold probability-denominator

When you use advanced WRED the following commands are also available:

  • random-detect

  • random-detect exponential-weighting-constant weight

FRTS Configuration

When you enable Frame Relay traffic shaping (FRTS) on an interface, QPM-PRO uses this command sequence to configure the device:

1. map-class frame-relay classname

2. frame-relay cir cir

3. frame-relay bc bc

4. frame-relay be be

5. frame-relay adaptive-shaping becn

6. frame-relay ip rtp header-compression [passive]

7. frame-relay ip rtp priority low range bandwidth

8. no frame-relay adaptive shaping

9. no frame-relay becn-response-enable

10. interface interfacename

a. frame-relay class classname

b. frame-relay traffic-shaping

If you are using FRTS with CBWFQ, the following command is also available:

  • service-policy [input | output] policyname

FRTS with FRF.12 (Voice Configuration) Configuration

When you enable Frame Relay traffic shaping (FRTS) on an interface, and configure the voice fields, QPM-PRO uses this command sequence to configure the device:

1. map-class frame-relay classname

2. frame-relay fragment fragment-size

3. frame-relay voice bandwidth bps-reserved

4. interface interfacename

5. frame-relay class classname

6. frame-relay traffic-shaping

Priority Queuing Configuration

When you select Priority Queuing for an interface's QoS property, and create priority queuing policies on the interface, QPM-PRO uses this command sequence to configure the device (except for Frame Relay interfaces on which you have enabled FRTS):

1. access-list ACLNum filter

2. priority-list priorityNum protocol ip level list ACLNum

3. priority-list priorityNum default level

4. priority-list priorityNum queue-limit high-limit medium-limit normal-limit low-limit

5. interface interfacename

6. priority-group priorityNum

If the interface is Frame Relay using FRTS, QPM-PRO uses this command sequence to configure the device:

1. map-class frame-relay classname

2. frame-relay priority-group priorityNum

3. interface interfacename

4. frame-relay class classname

Custom Queuing Configuration

When you select Custom Queuing for an interface's QoS property, and create custom queuing policies on the interface, QPM-PRO uses this command sequence to configure the device (except for Frame Relay interfaces on which you have enabled FRTS):

1. access-list ACLNum filter

2. queue-list qListNum protocol ip qNum list ACLNum

3. queue-list aListNum queue qNum byte-count bytes limit limit

4. queue-list qListNum default qNum

5. interface interfacename

6. custom-queue-list qListNum

If the interface is Frame Relay using FRTS, QPM-PRO uses this command sequence to configure the device:

1. map-class frame-relay classname

2. frame-relay custom-queue-list qListNum

3. interface interfacename

4. frame-relay class classname

FIFO Queueing Configuration

When you select FIFO for an interface's QoS property, QPM-PRO uses this command sequence to configure the device:

1. interface interfacename

2. no fair-queue

NBAR Port Map Configuration

When you enable NBAR port mapping on an interface, QPM-PRO uses this command sequence to configure the device:

1. ip nbar port-map protocol tcp|udp portnumbers

RSVP Configuration

When you enable resource reservation protocol (RSVP) on an interface, QPM-PRO uses this command sequence to configure the device:

1. ip rsvp bandwidth [ interface-kbps [ single-flow-kbps ] ]

2. ip rsvp udp-multicast

IP RTP Priority Configuration

When you enable IP RTP priority on an interface, QPM-PRO uses this command sequence to configure the device:

1. ip rtp priority start-port port-range bandwidth

CRTP Configuration

When you enable CRTP on an interface, QPM-PRO uses this command sequence to configure the device:

1. interface interfacename

2. ip rtp header-compression [passive]

LFI Configuration

When you enable LFI on an interface, QPM-PRO uses this command sequence to configure the device:

1. interface interfacename

2. ppp multilink interleave

3. ppp multilink fragment-delay delay

Shaping Policies (GTS)

When you create shaping policies on an interface, QPM-PRO uses this command sequence to configure the device:

1. access-list ACLNum filter

2. interface interfacename

3. traffic-shape group ACLNum rate [bc be]

Limiting Policies (CAR)

When you create limiting policies on an interface, QPM-PRO uses this command sequence to configure the device:

1. access-list ACLNum filter

2. interface interfacename

3. rate-limit input | output access-group ACLNum rate bc be conform-action transmit | continue | set-prec-transmit precedence | set-dscp-transmit dscp | set-prec-continue precedence | set-dscp-continue dscp exceed-action drop

Weighted Round-Robin (WRR) Policies

When you create queue weight policies on a layer 3 switch, QPM-PRO uses this command sequence to configure the device:

1. qos switching

2. qos mapping [source Fastethernet name ] [ destination Fastethernet name ] precedence precedence wrr-weight weight

Router Coloring Policies (PBR and CAR)

When you create coloring policies on an interface, QPM-PRO uses a different command sequence depending on whether the device supports committed access rate (CAR) classification.

For devices that do support CAR (typically those running IOS software releases 11.1cc and 12.0), QPM-PRO uses this command sequence to configure the device:

1. access-list ACLNum filter

2. interface interfacename

3. rate-limit input access-group ACLNum rate bc be conform-action set-prec-transmit precedence exceed-action set-prec-transmit precedence

4. rate-limit input|output access-group ACLNum rate bc be conform-action set-prec-transmit precedence | set-dscp-transmit dscp exceed-action set-prec-transmit precedence | set-dscp-transmit dscp

For devices that do not support CAR, QPM-PRO uses this command sequence to configure the device:

1. access-list ACLNum filter

2. route-map tag

3. match ip address ACLNum

4. set ip precedence precedence

5. interface interfacename

6. ip policy route-map tag

LocalDirector Coloring Policies

When you create coloring policies on a LocalDirector, QPM-PRO uses this command sequence to configure the device:

1. color virtualIp : portNo : bindId : protocolName precedence

Catalyst 5000 Coloring Policies

When you create coloring policies on a Catalyst 5000 family switch, QPM-PRO uses this command sequence to configure the device:

1. set qos enable

2. set qos ip-filter precedence protocol source source-port destination destination-port

Catalyst 6000 Coloring Policies

When you create coloring policies on a Catalyst 6000 family switch, QPM-PRO uses this command sequence to configure the device:

1. set port qos module/port port-based

2. set qos acl ip acl-name dscp dscp protocol source eq port port destination eq port port

3. commit qos acl acl-name

4. set qos acl map acl-name module/port

Note   When you enter precedence, the DSCP value is calculated as precedence*8.

Catalyst 6000 Limiting Policies

When you create limiting (policing) policies on a Catalyst 6000 family switch, QPM-PRO uses this command sequence to configure the device:

1. set port qos module/port port-based

2. set qos policer aggregate|micro-flow policer-name rate rate burst burst drop

3. set qos acl ip acl-name dscp dscp aggregate|micro-flow policer-name protocol source eq port port destination eq port port

4. set qos acl ip acl-name trust aggregate|micro-flow policer-name protocol source eq port port destination eq port port

5. commit qos acl acl-name

6. set qos acl map acl-name module/port

Catalyst 6000 2Q2T Queuing Configuration

When you configure 2Q2T queuing on a Catalyst 6000 family switch, QPM-PRO uses this command sequence to configure the device:

1. set qos enable

2. set qos map 2q2t tx queue-number threshold-number cos precedence

3. set qos drop-threshold 2q2t tx queue queue-number threshold-1 threshold-2

4. set qos wrr 2q2t queue-weight-1 queue-weight-2

5. set qos txq-ratio 2q2t queue-ratio-1 queue-ratio-2

Catalyst 6000 1P2Q2T Queuing Configuration

1. set qos enable

2. set qos map 1p2q2t tx queue-number threshold-number cos precedence

3. set qos wred 1p2q2t tx queue queue-number threshold-1 threshold-2

4. set qos wrr 1p2q2t queue-weight-1 queue-weight-2

5. set qos txq-ratio 1p2q2t ratio-1 ratio-2 ratio-3

Catalyst 6000 Port Trust Configuration

When you configure the trust state on a Catalyst 6000 family switch port, QPM-PRO uses this command sequence to configure the device:

1. set port qos module|port trust trust