Cisco NX-OS Quality of Service Command Reference, Release 4.0
Cisco NX-OS Quality of Service Commands

Table Of Contents

Cisco NX-OS Quality of Service Commands

bandwidth (QoS)

bandwidth remaining

class (policy map type qos)

class type queuing (policy map type queuing)

class-map type qos

class-map type queuing match-any

clear qos statistics

default (table map)

description

from (table map)

match access-group

match class-map

match cos (class map type qos)

match cos (class map type queuing)

match discard-class

match dscp

match ip rtp

match packet length

match precedence

match protocol

match qos-group

police (QoS)

police aggregate

policy-map type qos

policy-map type queuing

priority (queuing)

qos statistics

qos shared-policer

queue-limit

random-detect

random-detect cos-based

service-policy

set cos (policy map type qos)

set cos (policy map type queuing)

set discard-class

set dscp (QoS)

set precedence (QoS)

set qos-group

set table

shape

show class-map type qos

show class-map type queuing

show policy-map

show policy-map interface

show policy-map interface brief

show policy-map vlan

show qos shared-policer

show queuing interface

show running-config ipqos

show table-map

table-map


Cisco NX-OS Quality of Service Commands


This chapter describes the Cisco NX-OS quality of service (QoS) commands.

bandwidth (QoS)

To allocate a minimum percentage of the interface bandwidth to a queue and configure the bandwidth on both ingress and egress queues, use the bandwidth command. To remove a bandwidth configuration, use the no form of this command.

bandwidth {rate [bps | kbps | mbps | gbps] | percent percent}

no bandwidth {rate [bps | kbps | mbps | gbps] | percent percent}

Syntax Description

rate

Bandwidth rate. The range is from 1 to 10000000000.

bps

(Optional) Specifies the units of bits per second.

kbps

(Optional) Specifies the units of 1000 bits per second.

mbps

(Optional) Specifies the units of megabits per second.

gbps

(Optional) Specifies the units of gigabits per second.

percent

Specifies the percentage of bandwidth of the underlying link rate.

percent

Percent value in the range from 1 to 100.


Defaults

None

Command Modes

Policy map type queuing class configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

You use the system-defined ingress or egress queue class for the type of module to which you want to apply the policy map (see Table 1-1).

Table 1-1 System-Defined Type queuing Class Maps 

Class Map Queue Name
Description
Default CoS Values

1 Gigabit Module Ingress: 2 queues with 4 thresholds per queue

2q4t-in-q1

Ingress queue 1 of 2q4t type

5-7

2q4t-in-q-default

Ingress default queue of 2q4t type

0-4

1 Gigabit Module Egress: 1 strict priority queue and 3 normal queues with 4 thresholds per queue

1p3q4t-out-pq1 1

Egress priority queue of 1p3q4t type

5-7

1p3q4t-out-q2

Egress queue 2 of 1p3q4t type

-

1p3q4t-out-q3

Egress queue 3 of 1p3q4t type

-

1p3q4t-out-q-default

Egress default queue of 1p3q4t type

0-4

10 Gigabit Module Ingress: 8 queues with 2 thresholds per queue

8q2t-in-q1

Ingress queue 1 of 8q2t type

5-7

8q2t-in-q2

Ingress queue 2 of 8q2t type

-

8q2t-in-q3

Ingress queue 3 of 8q2t type

-

8q2t-in-q4

Ingress queue 4 of 8q2t type

-

8q2t-in-q5

Ingress queue 5 of 8q2t type

-

8q2t-in-q6

Ingress queue 6 of 8q2t type

-

8q2t-in-q7

Ingress queue 7 of 8q2t type

-

8q2t-in-q-default

Ingress default queue of 8q2t type

0-4

10 Gigabit Module Egress: 1 strict priority queue and 7 normal queues with 4 thresholds per queue

1p7q4t-out-pq1 1

Egress priority queue of 1p7q4t type

5-7

1p7q4t-out-q2

Egress queue 2 of 1p7q4t type

-

1p7q4t-out-q3

Egress queue 3 of 1p7q4t type

-

1p7q4t-out-q4

Egress queue 4 of 1p7q4t type

-

1p7q4t-out-q5

Egress queue 5 of 1p7q4t type

-

1p7q4t-out-q6

Egress queue 6 of 1p7q4t type

-

1p7q4t-out-q7

Egress queue 7 of 1p7q4t type

-

1p7q4t-out-q-default

Egress default queue of 1p7q4t type

0-4

1 These are either priority or normal queues. If you use the priority keyword in your configuration, these are used as priority queues. Otherwise, they are used as normal queues.



Note After you use this command in a specified policy map, you cannot use the priority or shape command in the same policy map.


This command does not require a license.

Examples

This example shows how to specify a bandwidth rate for a queue:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# class type queuing 1p7q4t-out-pq1
switch(config-pmap-c-que)# bandwidth 10 mbps

This example shows how to remove a bandwidth rate for a queue:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# class type queuing 1p7q4t-out-pq1
switch(config-pmap-c-que)# no bandwidth 10 mbps

Related Commands

Command
Description

bandwidth remaining

Configures the bandwidth remaining on the interface in a queue.

show class-map

Displays class maps.

show policy-map

Displays policy maps and statistics.



bandwidth remaining

To configure the percentage of the bandwidth remaining on the interface after other allocations are configured on both ingress and egress queues, use the bandwidth remaining command. To remove the remaining bandwidth allocation, use the no form of this command.

bandwidth remaining percent {percent}

no bandwidth remaining percent {percent}

Syntax Description

percent

Specifies use of percentage of remaining bandwidth on the underlying link. Valid values are from 0 to 100.


Defaults

None

Command Modes

Policy map type queuing class configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

You use the system-defined ingress or egress queue class for the type of module to which you want to apply the policy map (see Table 1-1). You can use this command in conjunction with the priority command.

See the Cisco Quality of Service Configuration Guide for more information on using this command.

This command does not require a license.

Examples

This example shows how to set the bandwidth remaining for the specified queue:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# class type queuing 1p7q4t-out-pq1
switch(config-pmap-c-que)# bandwidth remaining percent 25

This example shows how to remove the bandwidth remaining for the specified queue:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# class type queuing 1p7q4t-out-pq1
switch(config-pmap-c-que)# no bandwidth remaining percent 25

Related Commands

Command
Description

bandwidth

Allocates a minimum percentage of the interface bandwidth to a queue.

show class-map

Displays class maps.

show policy-map

Displays policy maps and statistics.



class (policy map type qos)

To add a reference to an existing qos class map in a policy map and enter the class mode, use the class command. To remove a class from the policy map, use the no form of this command.

class [type qos] {class-map-name | class-default} [insert-before [type qos] before-class-map-name]

no class {class-map-name | class-default}

Syntax Description

type qos

(Optional) Specifies the component type, which is qos for this class. By default, the type is qos.

class-map-name

Reference to a class map.

class-default

Specifies the reserved class name that matches all traffic not classified in other classes in a policy map.

insert-before before-class-map-name

(Optional) Specifies the position of this class in the policy. If not specified, the class is placed at the end of the classes in the policy. Policy actions in the first class that matches the traffic type are performed.


Defaults

None

Command Modes

Policy map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

Policy actions in the first class that matches the traffic type are performed.

This command does not require a license.

Examples

This example shows how to add a reference to a class map at the end of a policy map:

switch(config)# policy-map my_policy1
switch(config-pmap)# class traffic_class2
switch(config-pmap-c-qos)# 

This example shows how to add a reference to a class map before an existing class map reference in a policy map:

switch(config)# policy-map my_policy1
switch(config-pmap-qos)# class insert-before traffic_class2 traffic_class1
switch(config-pmap-c-qos)# 

This example shows how to add a reference to the class-default class map in a policy map:

switch(config)# policy-map my_policy1
switch(config-pmap-qos)# class class-default
switch(config-pmap-c-qos)# 

This example shows how to remove a class map reference in a policy map:

switch(config)# policy-map my_policy1
switch(config-pmap)# no class traffic_class1
switch(config-pmap)# 

Related Commands

Command
Description

show class-map qos

Displays class maps.

show policy-map

Displays policy maps and statistics.



class type queuing (policy map type queuing)

To add a reference to an existing queuing class map in a policy map and enter the class mode, use the class type queuing command. To remove a class from the policy map, use the no form of this command.

class type queuing class-map-name

no class type queuing class-map-name

Syntax Descriptionno

class-map-name

Reference to a system-defined class map. For a list of the system-defined type queuing class maps, see Table 1-1.


Defaults

None

Command Modes

policy map type queuing configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

Policy actions in the first class that matches the traffic type are performed.

This command does not require a license.

Examples

This example shows how to add a reference to a class map at the end of a type queuing policy map:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# class type queuing 8q2t-in-q4
switch(config-pmap-c-que)# 

This example shows how to add a reference to a class map before an existing class map reference in a type queuing policy map:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# class type queuing 8q2t-in-q4 insert-before type queuing 
8q2t-in-q2
switch(config-pmap-c-que)# 

This example shows how to remove a class map reference in a type queuing policy map:

switch(config)# policy-map type queuing my_policy1
switch(config-pmap-que)# no class type queuing 8q2t-in-q4
switch(config-pmap-que)# 

Related Commands

Command
Description

show class-map queuing

Displays class maps.

show policy-map

Displays policy maps and statistics.



class-map type qos

To create or modify a class map that defines a class of traffic and enter the class-map configuration mode, use the class-map command. To remove a class map, use the no form of this command.

class-map [type qos] {[match-any | match-all] class-map-name | conform-color-in | conform-color-out | exceed-color-in | exceed-color-out}

no class-map [type qos] {class-map-name | [match-any | match-all]}

Syntax Description

type qos

(Optional) Specifies the component type qos for the class map. By default, the class map type is qos.

match-any

Specifies that if the packet matches any of the criteria configured for this class map with the match command, then this class map is applied to the packet.

match-all

Specifies that if the packet matches all the criteria configured for this class map with the match command, then this class map is applied to the packet. This is the default action if match-any is not specified.

class-map-name

Name assigned to the class map. The name class-default is reserved.

conform-color-in

Type qos conform color class map in the input direction. This color-aware class map makes a policer color-aware for conform action.

conform-color-out

Type qos conform color class map in the output direction. This color-aware class map makes a policer color-aware for conform action.

exceed-color-in

Type qos exceed color class map in the input direction. This color-aware class map makes a policer color-aware for exceed action.

exceed-color-out

Type qos exceed color class map in the output direction. This color-aware class map makes a policer color-aware for exceed action.


Defaults

type—qos

Command Modes

Global configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

System-defined queuing class map names cannot be deleted. See the Cisco Quality of Service Configuration Guide for more information on this command.

This command does not require a license.

Examples

This example shows how to create or modify a qos class map:

switch(config)# class-map my_class1
switch(config-cmap-qos)#

This example shows how to remove a qos class map:

switch(config)# no class-map my_class1
switch(config)#

This example shows how to modify a qos color class map:

switch(config)# class-map conform-color-in
switch(config-color-map)#

Related Commands

Command
Description

show class-map qos

Displays class maps.



class-map type queuing match-any

To modify a type queuing class map and enter the class-map configuration mode, use the class-map type queuing match-any command.

class-map type queuing match-any queuing-class-map-name

Syntax Description

queuing-class-map-name

Specifies a system-defined queuing class map name. See Table 1-1 for the list of system-define queuing class maps.


Defaults

None

Command Modes

Global configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

If the packet matches any of the criteria configured for this class map with the match command, then this class map is applied to the packet. Class maps of type queuing support only this option.

Any modification make to the class maps type queuing changes the configuration for all ports of the specified port type on all VDCs.

System-defined queuing class map names cannot be deleted. See the Cisco Quality of Service Configuration Guide for more information on using this command.

This command does not require a license.

Examples

This example shows how to modify a queuing class map:

switch(config)# class-map type queuing match-any 2q4t-in-q1
switch(config-cmap-que)#

Related Commands

Command
Description

show class-map queuing

Displays class maps.

match cos

Defines the class of traffic in type queuing class maps.



clear qos statistics

To clear QoS statistics, use the clear qos statistics command.

clear qos statistics [{interface [ethernet type/slot | port-channel number] | [vlan [vlan-id]} [input | output] [type {qos | queuing}]]

Syntax Description

interface

(Optional) Specifies which interface to clear.

vlan [vlan-id]

(Optional) Specifies a VLAN to clear. Valid values are from 1 to 4094.

input

(Optional) Clears only input statistics.

output

(Optional) Clears only output statistics.

type

(Optional) Specifies the type of statistics to clear.

qos

Specifies clearing qos statistics.

queuing

Specifies clearing queuing statistics.


Defaults

None

Command Modes

Any command mode

Supported User Roles

network-admin
network-operator
vdc-admin
vdc-operator

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

If you do not specify the interface or VLAN, the device clears the counters for all VLANs and interfaces.

This command does not require a license.

Examples

This example shows how to clear all QoS statistics:

switch# clear qos statistics
switch# 

This example shows how to clear all input QoS statistics for VLAN1:

switch# clear qos statistics vlan 1 input
switch# 

Related Commands

Command
Description

qos statistics

Enables or disables QoS statistics.

show qos statistics

Displays QoS statistics.



default (table map)

To specify the default action for mapping input field values to output field values in a table map, use the default command.

default {value | copy}

no default {value | copy}

Syntax Description

value

Default value to use for the output value in the range from 0 to 63.

copy

Specifies that the default action is to copy all equal values to an equal output value.


Defaults

Copies the input value to the output value.

Command Modes

Table map configuration
Default table map configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


4.0(2)

The ignore variable for this command is no longer supported.


Usage Guidelines

The copy keyword is available only in the table map configuration mode. In the default table map configuration mode, the copy keyword is not available because all values must be assigned a mapping.

This command does not require a license.

Examples

This example shows how to remove the default mapping action copy. The resulting default action is ignore:

switch(config)# table-map my_table1
switch(config-tmap)# no default copy
switch(config-tmap)# 

Related Commands

Command
Description

from

Specifies input field to output field mappings in table maps.

show table-map

Displays table maps.



description

To add a description to a class map, policy map, or table map, use the description command. To remove the description, use the no form of this command.

description text

no description text

Syntax Description

text

Description for the class map, policy map, or table map. The description has a maximum of 200 characters.


Defaults

None

Command Modes

Class map type qos configuration
Policy map type qos configuration
Policy map type queuing configuration
Table map configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to add a description to a policy map:

switch(config)# policy-map my_policy1
switch(config-pmap)# description this policy applies to input packets
switch(config-pmap)# 

Related Commands

Command
Description

class-map

Creates or modifies a class map.

policy-map

Creates or modifies a policy map.

table-map

Creates or modifies a table map.



from (table map)

To specify a set of mappings of input field values to output field values in a table map, use the from command.

from source-value to dest-value

Syntax Description

source-value

Specifies the source value in the range from 0 to 63.

dest-value

Specifies the destination value in the range from 0 to 63.


Defaults

To configure the default mapping action for table maps, see the default (table map) command.

Command Modes

Table map configuration
Default table map configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to create a mapping from three source values to the corresponding destination values:

switch(config)# table-map my_table1
switch(config-tmap)# from 0 to 7
switch(config-tmap)# from 1 to 6
switch(config-tmap)# from 2 to 5

Related Commands

Command
Description

default (table map)

Specifies the default action for mapping of input field value to output field value in a table map.

show table-map

Displays table maps.



match access-group

To identify a specified access control list (ACL) group as a match criteria for a class map, use the match access-group command in the class map configuration mode. To remove ACL match criteria from a class map, use the no form of this command.

match access-group name acl-name

no match access-group name acl-name

Syntax Description

access-group name acl-name

Matches on the characteristics in the ACL name specified.


Defaults

None

Command Modes

Class-map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines


Note The permit and deny ACL keywords do not affect the matching of packets.


This command does not require a license.

Examples

This example shows how to create a qos class map that matches characteristics of the ACL my_acl:

switch(config)# class-map class_acl
switch(config-cmap-qos)# match access-group name my_acl

Related Commands

Command
Description

show class-map

Displays class maps.


match class-map

To match on the match commands in a specified class map, use the match class-map command in the class map configuration mode. To remove the match on the specified class map, use the no form of this command.

match [not] class-map class-map-name

no match [not] class-map class-map-name

Syntax Description

not

(Optional) Negates the specified match result.

class-map-name

Matches on the match commands in the specified class-map name.


Defaults

None

Command Modes

Class-map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

This command does not require a license.

Examples

This example shows how to match on the matches specified in class map named my_test:

switch(config)# class-map my_test
switch(config-cmap-qos)# match class-name my_test

Related Commands

Command
Description

show class-map

Displays class maps.


match cos (class map type qos)

To define the class of traffic using the Class of Service (CoS) value in a type qos class map, use the match cos command. To remove the match on the CoS value, use the no form of this command.

match [not] cos cos-list

no match [not] cos cos-list

Syntax Description

not

(Optional) Negates the specified match result.

cos-list

Matches on the specified COS value or list of specified CoS values. Valid values are from 0 to 7.


Defaults

None

Command Modes

Class-map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

To specify a list of values, use one of the following options:

Specify a range of values separated by a dash

Specify a noncontiguous list of values separated by commas


Note Only class maps of type qos support the optional not keyword form of this command. Class maps of type queuing do not support the not keyword.


This command does not require a license.

Examples

This example shows how to match on the CoS value for a type qos class map:

switch(config)# class-map class_acl
switch(config-cmap-qos)# match cos 5-7

Related Commands

Command
Description

show class-map

Displays class maps.


match cos (class map type queuing)

To define the class of traffic in a type queuing class map, use the match cos command. To remove the match configuration, use the no form of these commands.

match cos cos-list

no match cos cos-list

Syntax Description

cos-list

Matches on the specified COS value or list of specified CoS values. Valid values are from 0 to 7.


Defaults

None

Command Modes

Class-map type queuing configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

To specify a list of values, use one of the following options:

Specify a range of values separated by a dash

Specify a noncontiguous list of values separated by commas

Any modifications you make to the class map type queuing changes the configuration for all ports of the specified port type on all VDCs.


Note Only class maps of type qos support the optional not keyword form of this command.


This command does not require a license.

Examples

This example shows how to modify a type queuing class map to match on CoS:

switch(config)# class-map type queuing match-any 8q2t-in-q4
switch(config-cmap-que)# match cos 3
switch(config-cmap-que)# 

Related Commands

Command
Description

show class-map

Displays class maps.


match discard-class

To identify specific discard class values as a match criteria, use the match discard-class command. To remove specified discard class values as a match criteria, use the no form of this command.

match [not] discard-class discard-class-list

no match [not] discard-class discard-class-list

Syntax Description

not

(Optional) Negates the specified match result.

discard-class-list

Matches on the specified discard class value or list of discard class values. Valid values are from 0 to 63.


Defaults

None

Command Modes

Class-map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

The discard-class value is an internal label and is not part of the packet payload or any packet header. The discard-class values have no mathematical significance.

To specify a list of values, use one of the following options:

Specify a range of values separated by a dash

Specify a noncontiguous list of values separated by commas

This command does not require a license.

Examples

This example shows how to match on discard class value 5:

switch(config)# class-map my_test
switch(config-cmap-qos)# match discard-class 5

Related Commands

Command
Description

show class-map

Displays class maps.


match dscp

To identify specific Differentiated Services code point (DSCP) values as a match criteria, use the match dscp command. To remove specified DSCP values as a match criteria, use the no form of this command.

match [not] dscp dscp-list

no match [not] dscp dscp-list

Syntax Description

not

(Optional) Negates the specified match result.

dscp-list

Matches on the specified DSCP value or list of DSCP values. See Table 1-2 for a list of valid DSCP values.


Defaults

None

Command Modes

Class-map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

The standard DSCP values are shown in Table 1-2.

Table 1-2 Standard DSCP Values 

 
List of DSCP Values

af11

AF11 dscp (001010)—decimal value 10

af12

AF12 dscp (001100)—decimal value 12

af13

AF13 dscp (001110)—decimal value 14

af21

AF21 dscp (010010)—decimal value 18

af22

AF22 dscp (010100)—decimal value 20

af23

AF23 dscp (010110)—decimal value 22

af31

AF31 dscp (011010)—decimal value 26

af32

AF40 dscp (011100)—decimal value 28

af33

AF33 dscp (011110)—decimal value 30

af41

AF41 dscp (100010)—decimal value 34

af42

AF42 dscp (100100)—decimal value 36

af43

AF43 dscp (100110)—decimal value 38

cs1

CS1 (precedence 1) dscp (001000)—decimal value 8

cs2

CS2 (precedence 2) dscp (010000)—decimal value 16

cs3

CS3 (precedence 3) dscp (011000)—decimal value 24

cs4

CS4 (precedence 4) dscp (100000)—decimal value 32

cs5

CS5 (precedence 5) dscp (101000)—decimal value 40

cs6

CS6 (precedence 6) dscp (110000)—decimal value 48

cs7

CS7 (precedence 7) dscp (111000)—decimal value 56

default

Default dscp (000000)—decimal value 0

ef

EF dscp (101110)—decimal value 46


To specify a list of values, use one of the following options:

Specify a range of values separated by a dash

Specify a noncontiguous list of values separated by commas

This command does not require a license.

Examples

This example shows how to match on DSCP value af21:

switch(config)# class-map my_test
switch(config-cmap-qos)# match dscp af21

Related Commands

Command
Description

show class-map

Displays class maps.


match ip rtp

To configure a class map to use the Real-Time Protocol (RTP) port as a match criteria, use the match ip rtp command. To remove the RTP port as a match criteria, use the no form of this command.

match [not] ip rtp port-list

no match [not] ip rtp port-list

Syntax Description

not

(Optional) Negates the specified match result.

port-list

Matches on the specified UDP or list of UDP ports that are using RTP. Valid values range from 2000 to 65535.


Defaults

None

Command Modes

Class-map type qos configuration

Supported User Roles

network-admin
vdc-admin

Command History

Release
Modification

4.0

This command was introduced.


Usage Guidelines

To specify a list of values, use one of the following options:

Specify a range of values separated by a dash

Specify a noncontiguous list of values separated by commas

This command does not require a license.

Examples

This example shows how to match on a port using RTP:

switch(config)# class-map my_test
switch(config-cmap-qos)# match ip rtp 2300

Related Commands

Command
Description

show class-map

Displays class maps.


match packet length

To co