Cisco NCS 540 Series Installation manual

Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco
NCS 540 Series Routers
First Published: 2015-12-23
Last Modified: 2018-08-01
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: [phone]
800 553-NETS (6387)
Fax: [phone]

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of
the UNIX operating system. All rights reserved. Copyright ©1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.
Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com
go trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any
other company. (1721R)
©2017–2018 Cisco Systems, Inc. All rights reserved.

CONTENTS
Preface v
PREFACE
Changes to This Document v
Obtaining Documentation and Submitting a Service Request v
QoS Classification Commands 1
CHAPTER 1
class (policy-map) 2
class-map 4
end-class-map 6
end-policy-map 7
hw-module profile qos ingress-model peering 8
hw-module profile qos max-classmap-size 9
hw-module profile stats qos-enhanced 10
match access-group 11
match cos 13
match dei 15
match dscp 16
match mpls experimental topmost 19
match precedence 21
match protocol 23
match qos-group 25
random-detect discard-class 27
set cos 29
set dei 30
set discard-class 31
set dscp 33
set mpls experimental 34
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
iii

set precedence 35
set qos-group 37
shape average 39
Congestion Management Commands 41
CHAPTER 2
decapsulate gre 42
police rate 43
policy-map 45
priority (QoS) 47
vrf-policy 48
show qos interface 49
show policy-map interface 55
show policy-map targets 60
show policy-map type pbr 62
Congestion Avoidance Commands 63
CHAPTER 3
bandwidth (QoS) 64
bandwidth remaining 66
queue-limit 68
random-detect 71
service-policy (interface) 73
Hierarchical Modular QoS Commands 75
CHAPTER 4
hw-module profile qos hqos-enable 76
hw-module profile qos max-trunks (hw-module profile bundle-scale) 77
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
iv
Contents

Preface
This preface contains these sections:
•Changes to This Document, on page v
•Obtaining Documentation and Submitting a Service Request, on page v
Changes to This Document
This table lists the technical changes made to this document since it was first released.
Table 1: Changes to This Document
SummaryDate
Initial release of this document.December 2015
Republished with documentation updates for Cisco
IOS XR Release 6.0.2 features.
July 2016
Republished with documentation updates for Cisco
IOS XR Release 6.1.x features
November 2016
Republished with documentation updates for Cisco
IOS XR Release 6.1.31 features
May 2017
Republished for Release 6.3.2.March 2018
Republished for Release 6.5.1.July 2018
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service
request, and gathering additional information, see What's New in Cisco Product Documentation.
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's
New in Cisco Product Documentation RSS feed. RSS feeds are a free service.
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
v

Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
vi
Preface
Obtaining Documentation and Submitting a Service Request

QoS Classification Commands
All commands applicable for the Cisco NCS 5500 Series Router are also supported on the Cisco NCS 540
Series Router that is introduced from Cisco IOS XR Release 6.3.2. References to earlier releases in Command
History tables apply to only the Cisco NCS 5500 Series Router.
Note
This chapter describes the commands used for QoS packet classification.
•class (policy-map), on page 2
•class-map, on page 4
•end-class-map, on page 6
•end-policy-map, on page 7
•hw-module profile qos ingress-model peering, on page 8
•hw-module profile qos max-classmap-size, on page 9
•hw-module profile stats qos-enhanced, on page 10
•match access-group, on page 11
•match cos, on page 13
•match dei, on page 15
•match dscp, on page 16
•match mpls experimental topmost, on page 19
•match precedence, on page 21
•match protocol, on page 23
•match qos-group, on page 25
•random-detect discard-class, on page 27
•set cos , on page 29
•set dei, on page 30
•set discard-class, on page 31
•set dscp, on page 33
•set mpls experimental, on page 34
•set precedence, on page 35
•set qos-group, on page 37
•shape average, on page 39
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
1

class (policy-map)
To specify the name of the class whose policy you want to create or change, use the class command in policy
map configuration mode. To remove a class from the policy map, use the no form of this command.
class [type qos] {class-name|class-default}
no class [type qos] {class-name|class-default}
Syntax Description (Optional) Specifies a quality-of-service (QoS) class.type qos
Name of the class for which you want to configure or modify policy.
class-name
Configures the default class.class-default
Command Default No class is specified.
Type is QoS when not specified.
Command Modes Policy map configuration
Command History ModificationRelease
This command was introduced.Release 6.0
Usage Guidelines Within a policy map, the class (policy-map) command can be used to specify the name of the class whose
policy you want to create or change. The policy map must be identified first.
To identify the policy map (and enter the required policy map configuration mode), use the policy-map
command before you use the class (policy-map) command. After you specify a policy map, you can configure
the policy for new classes or modify the policy for any existing classes in that policy map.
The class name that you specify in the policy map ties the characteristics for that class—that is, its policy—to
the class map and its match criteria, as configured using the class-map command.
The class-default keyword is used for configuring default classes. It is a reserved name and cannot be used
with user-defined classes. It is always added to the policy map (type qos) even if the class is not configured.
For example, the following configuration shows that the class has not been configured, but the running
configuration shows ‘class class-default’.
RP/0/RP0/CPU0:router(config)# class-map p2
RP/0/RP0/CPU0:router(config-cmap)# match precedence 2
RP/0/RP0/CPU0:router(config-cmap)# end-class-map
RP/0/RP0/CPU0:router(config)# commit
RP/0/RP0/CPU0:router(config)# policy-map pm2
RP/0/RP0/CPU0:router(config-pmap)# class p2
RP/0/RP0/CPU0:router(config-pmap-c)# set precedence 3
RP/0/RP0/CPU0:router(config-pmap-c)# end-policy-map
RP/0/RP0/CPU0:router(config)# commit
RP/0/RP0/CPU0:router(config)# end
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
2
QoS Classification Commands
class (policy-map)

RP/0/RP0/CPU0:router# show run policy-map pm2
policy-map pm2
class p2
set precedence 3
!
class class-default
!
end-policy-map
!
Task ID OperationsTask
ID
read,
write
qos
Examples This example shows how to create a policy map called policy1, which is defined to shape class1
traffic at 30 percent and default class traffic at 20 percent.
RP/0/RP0/CPU0:router(config)# class-map class1
RP/0/RP0/CPU0:router(config-cmap)# match precedence 3
RP/0/RP0/CPU0:router(config-cmap)# exit
RP/0/RP0/CPU0:router(config)# policy-map policy1
RP/0/RP0/CPU0:router(config-pmap)# class class1
RP/0/RP0/CPU0:routerconfig-pmap-c)# shape average percent 30
RP/0/RP0/CPU0:router(config-pmap-c)# exit
RP/0/RP0/CPU0:router(config-pmap)# class class-default
RP/0/RP0/CPU0:router(config-pmap-c)# shape average percent 20
The default class is used for packets that do not satisfy configured match criteria for class1. Class1
must be defined before it can be used in policy1, but the default class can be directly used in a policy
map, as the system defines it implicitly.
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
3
QoS Classification Commands
class (policy-map)

class-map
To define a traffic class and the associated rules that match packets to the class, use the class-map command
in XR Config mode. To remove an existing class map from the router, use the no form of this command.
class-map [type [traffic | qos]][match-all] [match-any] class-map-name
no class-map [type [traffic | qos]][match-all] [match-any] class-map-name
Syntax Description (Optional) Specifies a quality-of-service (QoS) class-map.type qos
(Optional) Specifies traffic type class-map.traffic
(Optional) Specifies a match on all of the match criteria.match-all
(Optional) Specifies a match on any of the match criteria. This is the default.match-any
Name of the class for the class map. The class name is used for the class map and to
configure policy for the class in the policy map. The class name can be a maximum of
63 characters, must start with an alphanumeric character, and in addition to alphanumeric
characters, can contain any of the following characters: . _ @ $ % + | # : ; - =
class-map-name
Command Default Type is QoS when not specified.
Command Modes XR Config mode
Command History ModificationRelease
This command was introduced.Release 6.0
Usage Guidelines The class-map command specifies the name of the class for which you want to create or modify class map
match criteria. Use of this command enables class map configuration mode in which you can enter any match
command to configure the match criteria for this class. Packets arriving on the interface are checked against
the match criteria configured for a class map to determine if the packet belongs to that class.
These commands can be used in a class map match criteria for the ingress direction:
•match access-group
•match [not] dscp
•match [not] mpls experimental topmost
•match [not] precedence
•match [not] protocol
Task ID OperationsTask
ID
read,
write
qos
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
4
QoS Classification Commands
class-map

Examples This example shows how to specify class1 as the name of a class and defines a class map for this
class. The packets that match the access list 1 are matched to class class1.
RP/0/RP0/CPU0:router(config)# class-map class1
RP/0/RP0/CPU0:router(config-cmap)# match access-group ipv4 1
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
5
QoS Classification Commands
class-map

end-class-map
To end the configuration of match criteria for the class and to exit class map configuration mode, use the
end-class-map command in class map configuration mode.
end-class-map
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes Class map configuration
Command History ModificationRelease
This command was introduced.Release 6.0
Usage Guidelines No specific guidelines impact the use of this command.
Task ID OperationsTask
ID
read,
write
qos
Examples This example shows how to end the class map configuration and exit class map configuration mode:
RP/0/RP0/CPU0:router(config)# class-map class1
RP/0/RP0/CPU0:router(config-cmap)# match access-group ipv4 1
RP/0/RP0/CPU0:router(config-cmap)# end-class-map
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
6
QoS Classification Commands
end-class-map

end-policy-map
To end the configuration of a policy map and to exit policy map configuration mode, use the end-policy-map
command in policy map configuration mode.
end-policy-map
Syntax Description This command has no keywords or arguments.
Command Default No default behavior or values
Command Modes Policy map configuration
Command History ModificationRelease
This command was introduced.Release 6.0
Usage Guidelines No specific guidelines impact the use of this command.
Task ID OperationsTask
ID
read,
write
qos
Examples This example shows how to end the policy map configuration and exit policy map configuration
mode.
RP/0/RP0/CPU0:router(config)# policy-map policy1
RP/0/RP0/CPU0:router(config-pmap)# class class1
RP/0/RP0/CPU0:router(config-pmap-c)# police rate 250
RP/0/RP0/CPU0:router(config-pmap)# end-policy-map
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
7
QoS Classification Commands
end-policy-map

hw-module profile qos ingress-model peering
To enable the peering QoS profile feature, use the hw-module profile qos ingress-model peering command
in the XR Config mode. To disable this feature, use the no form of this command.
hw-module profile qos ingress-model peering [locationnode-id]
Syntax Description Indicates the designated node. The node-id argument is entered in the rack/slot/module
notation.
location node-id
Command Default The peering QoS profile feature is disabled by default, unless enabled by this command.
Command Modes XR Config mode
Command History ModificationRelease
This command was introduced.Release
6.2.1
Usage Guidelines The router must be reloaded for the hw-module command to be functional.
Task ID OperationTask
ID
read,
write
qos
The following example shows how to enable the peering QoS profile feature.
RP/0/RP0/CPU0:router#config
RP/0/RP0/CPU0:router(config)#hw-module profile qos ingress-model peering
RP/0/RP0/CPU0:router(config)#commit
RP/0/RP0/CPU0:router# reload
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
8
QoS Classification Commands
hw-module profile qos ingress-model peering

hw-module profile qos max-classmap-size
To define the maximum number of class-maps per policy, use the hw-module profile qos max-classmap-size
command in the XR Config mode.
hw-module profile qos max-classmap-sizesize
Syntax Description Indicates the maximum number of class-maps permitted per policy. Range is between 4 to 32, in powers
of 2.
size
Command Default Default size is 32.
Command Modes XR Config mode
Command History ModificationRelease
This command was introduced.Release
6.0.0
Usage Guidelines The router must be reloaded for the hw-module command to be functional.
This command only applies to ingress policies and only 4, 8, 16, or 32 classes per policy-map are supported.
Egress policies can support up to 8 classes per policy-map.
Task ID OperationTask
ID
read,
write
qos
The following example shows how to change the maximum number of class-maps to 16.
RP/0/RP0/CPU0:router#config
RP/0/RP0/CPU0:router(config)#hw-module profile qos max-classmap-size 16
RP/0/RP0/CPU0:router(config)#commit
RP/0/RP0/CPU0:router# reload
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
9
QoS Classification Commands
hw-module profile qos max-classmap-size

hw-module profile stats qos-enhanced
To enable the four counter mode in the system, use the hw-module profile stats qos-enhancedcommand in
XR Config mode. To disable this mode, use the no form of the command. In the four counter mode, statistics
for conform,violate, and exceed packets are collected in the hardware and displayed using the show policy-map
command.
hw-module profile stats qos-enhanced
Syntax Description This command has no keywords or arguments.
Command Default The qos-enhanced mode is disabled by default, and therefore only the conform and violate statistics are
available in the two counter mode.
Command Modes XR Config mode
Command History ModificationRelease
This command was introduced.Release
6.2.1
Usage Guidelines The router must be reloaded for the hw-module command to be functional.
Task ID OperationTask
ID
read,
write
qos
The following example shows how to enable the four counter mode on the router.
RP/0/RP0/CPU0:router#config
RP/0/RP0/CPU0:router(config)#hw-module profile stats qos-enhanced
RP/0/RP0/CPU0:router(config)#commit
RP/0/RP0/CPU0:router# reload
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
10
QoS Classification Commands
hw-module profile stats qos-enhanced

match access-group
To identify a specified access control list (ACL) number as the match criteria for a class map, use the match
access-group command in class map configuration mode.
match access-group {ipv4|ipv6}access-group-name
Syntax Description Specifies the name of the IPv4 access group to be matched.ipv4
Specifies the name of the IPv6 access group to be matched.ipv6
ACL whose contents are used as the match criteria against which packets are checked
to determine if they belong to this class.
access-group-name
Command Default By default, if neither IPv6 nor IPv4 is specified as the match criteria for a class map, IPv4 addressing is used.
Command Modes Class map configuration
Command History ModificationRelease
This command was introduced.Release 6.0
Usage Guidelines For class-based features (such as marking and policing), you define traffic classes based on match criteria,
including ACLs and input interfaces. Packets satisfying the match criteria for a class constitute the traffic for
that class.
The match access-group command specifies an ACL whose contents are used as the match criteria against
which packets are checked to determine if they belong to the class specified by the class map.
The match access-group command is supported only in the ingress direction. The maximum allowed entries:
8
To use the match access-group command, you must first enter the class-map command to specify the
name of the class whose match criteria you want to establish. You can specify up to eight IPv4 and IPv6 ACLs
in a match statement.
QoS classification based on the packet length or TTL (time to live) field in the IPv4 and IPv6 headers is not
supported.
When an ACL list is used within a class-map, the deny action of the ACL is ignored and the traffic is classified
based on the specified ACL match parameters.
Task ID OperationsTask
ID
read,
write
qos
Examples This example shows how to specify a class map called map1 and configures map1 to be used as the
match criteria for this class:
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
11
QoS Classification Commands
match access-group

RP/0/RP0/CPU0:router(config)# class-map map1
RP/0/RP0/CPU0:router(config-cmap)# match access-group ipv4 map1
RP/0/RP0/CPU0:router(config-cmap)# match access-group ipv6 map2
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
12
QoS Classification Commands
match access-group

match cos
To identify specified class of service (CoS) values as a match criteria in a class map, use the match cos
command in class map configuration mode. To remove a specified CoS class value from the matching criteria
for a class map, use the no form of this command.
match cos {cos-value [cos-value1 ... cos-value7]}
no match cos {cos-value [cos-value1 ... cos-value7]}
Syntax Description Identifier that specifies the exact value from 0 to 7. Up to eight CoS identifiers can be specified
to match packets.
cos-value
Command Default No match criteria are specified.
Command Modes Class map configuration
Command History ModificationRelease
This command was introduced.Release 6.1.2
Usage Guidelines The match cos command is supported only in the ingress direction.
The match cos command specifies a class of service that is used as the match criteria against which packets
are checked to determine if they belong to the class specified by the class map.
To use the match cos command, you must first enter the class-map command to specify the name of the
class whose match criteria you want to establish. If you specify more than one match cos command in a
class map, the values of subsequent match statements are added to the first match cos command.
Task ID OperationsTask
ID
read,
write
qos
Examples This example shows how to configure the service policy called policy-in and attach service policy
policy-in to an interface HundredGigE 0/0/0/3. In this example, class map cos146 evaluates all
packets of service values of 1, 4, or 6. If the incoming packet has been marked with any of these CoS
values, the traffic is policed at 300 mbps.
RP/0/RP0/CPU0:router(config)# class-map cos146
RP/0/RP0/CPU0:router(config-cmap)# match cos 1 4 6
RP/0/RP0/CPU0:router(config-cmap)# exit
RP/0/RP0/CPU0:router(config)# policy-map policy-in
RP/0/RP0/CPU0:router(config-pmap)# class cos146
RP/0/RP0/CPU0:router(config-pmap-c)# police rate 300 mbps
RP/0/RP0/CPU0:router(config-pmap-police)#exit
RP/0/RP0/CPU0:router(config-pmap-c)# exit
RP/0/RP0/CPU0:router(config-pmap)# exit
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
13
QoS Classification Commands
match cos

RP/0/RP0/CPU0:router(config)# interface HundredGigE 0/0/0/3
RP/0/RP0/CPU0:router(config-if)# service-policy input policy-in
Modular QoS Command Reference for Cisco NCS 5500 Series and Cisco NCS 540 Series Routers
14
QoS Classification Commands
match cos