3.2.30. qos¶
Note
requires a Product License.
QoS configuration.
vsr running config# qos
class-mask (config only)¶
Mask applied to marks.
vsr running config# qos
vsr running qos# class-mask <0x0-0xffffffff>
- Default value
0xFFFFFFFF
policer (config only)¶
List of policer templates.
vsr running config# qos policer <string>
|
Policer template name. |
description (config only)¶
A comment to describe the policer template.
vsr running config# qos policer <string>
vsr running policer <string># description <string>
bandwidth (config only) (mandatory)¶
Maximum bandwidth of regular traffic, a.k.a. CIR (Committed Information Rate), in bps. 0 allows no regular traffic.
vsr running config# qos policer <string>
vsr running policer <string># bandwidth BANDWIDTH
|
Rate in bits per second. K/M/G/T multipliers are supported. Example: 1G stands for 1000000000 bps. |
burst (config only)¶
Maximum burst size of shaped traffic, a.k.a. CBS (Committed Burst Size), in bytes. The default value is set to bandwidth / 80 to handle a burst of 100 ms at the targeted bandwidth. If not set or set to 0, the default value is applied.
vsr running config# qos policer <string>
vsr running policer <string># burst BURST
|
Burst size in bytes. K/M/G/T multipliers are supported. Example: 2K stands for 2000 bytes. |
excess-bandwidth (config only)¶
Maximum bandwidth of excess traffic, a.k.a. EIR (Excess Information Rate), in bps. 0 allows no excess traffic.
vsr running config# qos policer <string>
vsr running policer <string># excess-bandwidth EXCESS-BANDWIDTH
|
Rate in bits per second. K/M/G/T multipliers are supported. Example: 1G stands for 1000000000 bps. |
- Default value
0
excess-burst (config only)¶
Maximum burst size of excess traffic, a.k.a. EBS (Excess Burst Size), in bytes. The default value is set to excess-bandwidth / 80 to handle a burst of 100 ms at the targeted bandwidth. If not set or set to 0, the default value is applied.
vsr running config# qos policer <string>
vsr running policer <string># excess-burst EXCESS-BURST
|
Burst size in bytes. K/M/G/T multipliers are supported. Example: 2K stands for 2000 bytes. |
shaper (config only)¶
List of shapers.
vsr running config# qos shaper <string>
|
Shaper name. |
description (config only)¶
A comment to describe the shaper.
vsr running config# qos shaper <string>
vsr running shaper <string># description <string>
bandwidth (config only) (mandatory)¶
Maximum bandwidth of shaped traffic.
vsr running config# qos shaper <string>
vsr running shaper <string># bandwidth BANDWIDTH
|
Rate in bits per second. K/M/G/T multipliers are supported. Example: 1G stands for 1000000000 bps. |
burst (config only)¶
Maximum burst size of shaped traffic. The default value is set to bandwidth / 80 to handle a burst of 100 ms at the targeted bandwidth. If not set or set to 0, the default value is applied.
vsr running config# qos shaper <string>
vsr running shaper <string># burst BURST
|
Burst size in bytes. K/M/G/T multipliers are supported. Example: 2K stands for 2000 bytes. |
layer1-overhead (config only)¶
Number of bytes added by the underlying protocol on each packet.
vsr running config# qos shaper <string>
vsr running shaper <string># layer1-overhead <uint32>
- Default value
0
queue-size (config only)¶
Number of packets that can be saved in the delay queue. If a scheduler is also configured on the interface, this value is not used, the queues of the scheduler are used as delay queues. The value is rounded up to the nearest power of 2.
vsr running config# qos shaper <string>
vsr running shaper <string># queue-size <uint32>
- Default value
256
scheduler (config only)¶
List of schedulers.
vsr running config# qos scheduler <string>
|
Scheduler name. |
description (config only)¶
A comment to describe the scheduler.
vsr running config# qos scheduler <string>
vsr running scheduler <string># description <string>
pq (config only)¶
Priority Queueing description.
vsr running config# qos scheduler <string> pq
nb-queue (config only) (mandatory)¶
Number of Priority Queueing queues available in the scheduler.
vsr running config# qos scheduler <string> pq
vsr running pq# nb-queue <uint32>
default-queue (config only)¶
The scheduler queue on which the default traffic will be directed.
vsr running config# qos scheduler <string> pq
vsr running pq# default-queue <leafref>
queue (config only)¶
List of Priority Queueing queues.
vsr running config# qos scheduler <string> pq queue <uint32>
|
Id of the queue. |
size (config only)¶
Size of the queue in packets.
vsr running config# qos scheduler <string> pq queue <uint32>
vsr running queue <uint32># size <uint32>
- Default value
256
policer (config only)¶
Traffic policer defined in the QoS context applied to incoming traffic.
vsr running config# qos scheduler <string> pq queue <uint32>
vsr running queue <uint32># policer <leafref>
shaper (config only)¶
Traffic shaper defined in the QoS context applied to outgoing traffic.
vsr running config# qos scheduler <string> pq queue <uint32>
vsr running queue <uint32># shaper <leafref>
child-scheduler (config only)¶
Child scheduler.
vsr running config# qos scheduler <string> pq queue <uint32>
vsr running queue <uint32># child-scheduler <leafref>
priority (config only)¶
Custom priority of this queue.
vsr running config# qos scheduler <string> pq queue <uint32>
vsr running queue <uint32># priority <uint32>
class (config only)¶
List of traffic classes bound to this queue.
vsr running config# qos scheduler <string> pq queue <uint32>
vsr running queue <uint32># class <leafref>
|
Class name. |
pb-dwrr (config only)¶
Priority-Based Deficit Weighted Round Robin description.
vsr running config# qos scheduler <string> pb-dwrr
nb-queue (config only) (mandatory)¶
Number of PB-DWRR queues available in the scheduler.
vsr running config# qos scheduler <string> pb-dwrr
vsr running pb-dwrr# nb-queue <uint32>
default-queue (config only)¶
The scheduler queue on which the default traffic will be directed.
vsr running config# qos scheduler <string> pb-dwrr
vsr running pb-dwrr# default-queue <leafref>
queue (config only)¶
List of PB-DWRR queues.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
|
Id of the queue. |
size (config only)¶
Size of the queue in packets.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># size <uint32>
- Default value
256
policer (config only)¶
Traffic policer defined in the QoS context applied to incoming traffic.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># policer <leafref>
shaper (config only)¶
Traffic shaper defined in the QoS context applied to outgoing traffic.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># shaper <leafref>
child-scheduler (config only)¶
Child scheduler.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># child-scheduler <leafref>
quantum (config only)¶
Quantum of the queue. Relevant only if priority is low.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># quantum <uint32>
- Default value
1500
priority (config only)¶
Priority of the queue (low or high).
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># priority PRIORITY
|
Description |
|---|---|
|
Low priority. |
|
High priority. |
- Default value
low
class (config only)¶
List of traffic classes bound to this queue.
vsr running config# qos scheduler <string> pb-dwrr queue <uint32>
vsr running queue <uint32># class <leafref>
|
Class name. |
htb (config only)¶
Hierarchical Token bucket description.
vsr running config# qos scheduler <string> htb
description (config only)¶
A comment to describe the scheduler.
vsr running config# qos scheduler <string> htb
vsr running htb# description <string>
divisor (config only)¶
Divisor used to calculate the default quantum of queues. Default quantum = rate / divisor.
vsr running config# qos scheduler <string> htb
vsr running htb# divisor <uint32>
- Default value
10
default-queue (config only)¶
The scheduler queue on which the default traffic will be directed.
vsr running config# qos scheduler <string> htb
vsr running htb# default-queue <leafref>
queue (config only)¶
HTB root queue. Only one root queue allowed.
vsr running config# qos scheduler <string> htb queue <uint32>
|
ID of the queue. |
description (config only)¶
A comment to describe the queue.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># description <string>
bandwidth (config only) (mandatory)¶
Guaranteed bandwidth of the queue.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># bandwidth BANDWIDTH
|
Rate in bits per second. K/M/G/T multipliers are supported. Example: 1G stands for 1000000000 bps. |
burst (config only)¶
Guaranteed bandwidth maximum burst size. Defaults to bandwidth/80 (100ms of traffic at bandwidth rate).
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># burst BURST
|
Burst size in bytes. K/M/G/T multipliers are supported. Example: 2K stands for 2000 bytes. |
ceiling (config only)¶
Ceiling rate of the queue. Defaults to bandwidth.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># ceiling CEILING
|
Rate in bits per second. K/M/G/T multipliers are supported. Example: 1G stands for 1000000000 bps. |
ceiling-burst (config only)¶
Ceiling rate maximum burst size. Defaults to ceiling/80 (100ms of traffic at ceiling rate).
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># ceiling-burst CEILING-BURST
|
Burst size in bytes. K/M/G/T multipliers are supported. Example: 2K stands for 2000 bytes. |
layer1-overhead (config only)¶
Number of bytes added by the underlying protocol on each packet.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># layer1-overhead <uint32>
- Default value
0
quantum (config only)¶
Quantum of the queue, used to distribute available bandwidth between queues of same priorities, in a weighted round robin fashion. Defaults to rate/divisor.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># quantum <uint32>
size (config only)¶
Size of the queue in packets. The value is rounded up to the nearest power of 2.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># size <uint32>
- Default value
256
priority (config only)¶
Priority of the queue, used to distribute available bandwidth to queues by order of priority.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># priority <1-max>
- Default value
1
policer (config only)¶
Traffic policer defined in the QoS context applied to incoming traffic.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># policer <leafref>
child-queue (config only)¶
List of child HTB queue IDs.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># child-queue <leafref>
child-scheduler (config only)¶
Child scheduler.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># child-scheduler <leafref>
class (config only)¶
List of traffic classes bound to this queue.
vsr running config# qos scheduler <string> htb queue <uint32>
vsr running queue <uint32># class <leafref>
|
Class name. |
sfq (config only)¶
Stochastic Fair Queuing description.
vsr running config# qos scheduler <string> sfq
description (config only)¶
A comment to describe the scheduler.
vsr running config# qos scheduler <string> sfq
vsr running sfq# description <string>
flows (config only)¶
Number of flows in which the traffic is distributed.
vsr running config# qos scheduler <string> sfq
vsr running sfq# flows <1-32768>
- Default value
1024
quantum (config only)¶
Amount of bytes a flow is allowed to dequeue during a round of the round robin process.
vsr running config# qos scheduler <string> sfq
vsr running sfq# quantum <1-9000>
- Default value
1514
limit (config only)¶
Maximum number of packets that may be enqueued. If the limit is exceeded, the flow with the greatest number of enqueued packets is identified, and half of its packets are dropped.
vsr running config# qos scheduler <string> sfq
vsr running sfq# limit <1-32768>
- Default value
10240
class (config only)¶
List of supported classes.
vsr running config# qos class <string>
|
Class name. |
description (config only)¶
A comment to describe the class.
vsr running config# qos class <string>
vsr running class <string># description <string>
mark (config only)¶
Class mark. Optional if cp is true.
vsr running config# qos class <string>
vsr running class <string># mark <0x0-0xffffffff>
cp (config only)¶
Whether this class relates to critical control plane traffic. If unset, match any traffic. If true, only match critical control plane traffic. If false, do not match critical control plane traffic.
vsr running config# qos class <string>
vsr running class <string># cp true|false
selector (config only)¶
List of traffic selectors used by QoS policies.
vsr running config# qos selector <string>{1,32}
|
Traffic selector name. |
description (config only)¶
A comment to describe the traffic selector.
vsr running config# qos selector <string>{1,32}
vsr running selector <string>{1,32}# description <string>
match8bits (config only)¶
8 bit selector.
vsr running config# qos selector <string>{1,32} match8bits
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} match8bits
vsr running match8bits# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} match8bits
vsr running match8bits# mask <0x0-0xff>
offset (config only) (mandatory)¶
The offset in the frame where the value must match.
vsr running config# qos selector <string>{1,32} match8bits
vsr running match8bits# offset <uint16>
match16bits (config only)¶
16 bit selector.
vsr running config# qos selector <string>{1,32} match16bits
value (config only) (mandatory)¶
The 16 bit value to match.
vsr running config# qos selector <string>{1,32} match16bits
vsr running match16bits# value <uint16>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} match16bits
vsr running match16bits# mask <0x0-0xffff>
offset (config only) (mandatory)¶
The offset in the frame where the value must match.
vsr running config# qos selector <string>{1,32} match16bits
vsr running match16bits# offset <uint16>
match32bits (config only)¶
32 bit selector.
vsr running config# qos selector <string>{1,32} match32bits
value (config only) (mandatory)¶
The 32 bit value to match.
vsr running config# qos selector <string>{1,32} match32bits
vsr running match32bits# value <uint32>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} match32bits
vsr running match32bits# mask <0x0-0xffffffff>
offset (config only) (mandatory)¶
The offset in the frame where the value must match.
vsr running config# qos selector <string>{1,32} match32bits
vsr running match32bits# offset <uint16>
ipv4 (config only)¶
IPv4 header selector.
vsr running config# qos selector <string>{1,32} ipv4
match-all (config only)¶
Match all IPv4 traffic.
vsr running config# qos selector <string>{1,32} ipv4
vsr running ipv4# match-all
source (config only)¶
The source address to match.
vsr running config# qos selector <string>{1,32} ipv4
vsr running ipv4# source SOURCE
|
Description |
|---|---|
|
An IPv4 address. |
|
An IPv4 prefix: address and CIDR mask. |
destination (config only)¶
The destination address to match.
vsr running config# qos selector <string>{1,32} ipv4
vsr running ipv4# destination DESTINATION
|
Description |
|---|---|
|
An IPv4 address. |
|
An IPv4 prefix: address and CIDR mask. |
protocol (config only)¶
The protocol to match.
vsr running config# qos selector <string>{1,32} ipv4 protocol
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} ipv4 protocol
vsr running protocol# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} ipv4 protocol
vsr running protocol# mask <0x0-0xff>
tos (config only)¶
The TOS field to match.
vsr running config# qos selector <string>{1,32} ipv4 tos
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} ipv4 tos
vsr running tos# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} ipv4 tos
vsr running tos# mask <0x0-0xff>
dscp (config only)¶
The DSCP field to match.
vsr running config# qos selector <string>{1,32} ipv4 dscp
value (config only) (mandatory)¶
The 8 bit value to match. This matches the 6 most significant bits of the TOS field.
vsr running config# qos selector <string>{1,32} ipv4 dscp
vsr running dscp# value <0-63>
ipv6 (config only)¶
IPv6 header selector.
vsr running config# qos selector <string>{1,32} ipv6
match-all (config only)¶
Match all IPv6 traffic.
vsr running config# qos selector <string>{1,32} ipv6
vsr running ipv6# match-all
source (config only)¶
The source address to match.
vsr running config# qos selector <string>{1,32} ipv6
vsr running ipv6# source SOURCE
|
Description |
|---|---|
|
An IPv6 address. |
|
An IPv6 prefix: address and CIDR mask. |
destination (config only)¶
The destination address to match.
vsr running config# qos selector <string>{1,32} ipv6
vsr running ipv6# destination DESTINATION
|
Description |
|---|---|
|
An IPv6 address. |
|
An IPv6 prefix: address and CIDR mask. |
protocol (config only)¶
The protocol to match.
vsr running config# qos selector <string>{1,32} ipv6 protocol
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} ipv6 protocol
vsr running protocol# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} ipv6 protocol
vsr running protocol# mask <0x0-0xff>
tos (config only)¶
The TC field to match.
vsr running config# qos selector <string>{1,32} ipv6 tos
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} ipv6 tos
vsr running tos# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} ipv6 tos
vsr running tos# mask <0x0-0xff>
dscp (config only)¶
The DSCP field to match.
vsr running config# qos selector <string>{1,32} ipv6 dscp
value (config only) (mandatory)¶
The 8 bit value to match. This matches the 6 most significant bits of the TC field.
vsr running config# qos selector <string>{1,32} ipv6 dscp
vsr running dscp# value <0-63>
tcp (config only)¶
TCP header selector.
vsr running config# qos selector <string>{1,32} tcp
match-all (config only)¶
Match all TCP traffic.
vsr running config# qos selector <string>{1,32} tcp
vsr running tcp# match-all
source-port (config only)¶
The source port to match.
vsr running config# qos selector <string>{1,32} tcp source-port
value (config only) (mandatory)¶
The 16 bit value to match.
vsr running config# qos selector <string>{1,32} tcp source-port
vsr running source-port# value <uint16>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} tcp source-port
vsr running source-port# mask <0x0-0xffff>
destination-port (config only)¶
The destination port to match.
vsr running config# qos selector <string>{1,32} tcp destination-port
value (config only) (mandatory)¶
The 16 bit value to match.
vsr running config# qos selector <string>{1,32} tcp destination-port
vsr running destination-port# value <uint16>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} tcp destination-port
vsr running destination-port# mask <0x0-0xffff>
udp (config only)¶
UDP header selector.
vsr running config# qos selector <string>{1,32} udp
match-all (config only)¶
Match all UDP traffic.
vsr running config# qos selector <string>{1,32} udp
vsr running udp# match-all
source-port (config only)¶
The source port to match.
vsr running config# qos selector <string>{1,32} udp source-port
value (config only) (mandatory)¶
The 16 bit value to match.
vsr running config# qos selector <string>{1,32} udp source-port
vsr running source-port# value <uint16>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} udp source-port
vsr running source-port# mask <0x0-0xffff>
destination-port (config only)¶
The destination port to match.
vsr running config# qos selector <string>{1,32} udp destination-port
value (config only) (mandatory)¶
The 16 bit value to match.
vsr running config# qos selector <string>{1,32} udp destination-port
vsr running destination-port# value <uint16>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} udp destination-port
vsr running destination-port# mask <0x0-0xffff>
icmp (config only)¶
ICMP header selector.
vsr running config# qos selector <string>{1,32} icmp
match-all (config only)¶
Match all ICMP traffic.
vsr running config# qos selector <string>{1,32} icmp
vsr running icmp# match-all
type (config only)¶
The ICMP type to match.
vsr running config# qos selector <string>{1,32} icmp type
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} icmp type
vsr running type# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} icmp type
vsr running type# mask <0x0-0xff>
code (config only)¶
The ICMP code to match.
vsr running config# qos selector <string>{1,32} icmp code
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} icmp code
vsr running code# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} icmp code
vsr running code# mask <0x0-0xff>
icmpv6 (config only)¶
ICMPv6 header selector.
vsr running config# qos selector <string>{1,32} icmpv6
match-all (config only)¶
Match all ICMPv6 traffic.
vsr running config# qos selector <string>{1,32} icmpv6
vsr running icmpv6# match-all
type (config only)¶
The ICMPv6 type to match.
vsr running config# qos selector <string>{1,32} icmpv6 type
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} icmpv6 type
vsr running type# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} icmpv6 type
vsr running type# mask <0x0-0xff>
code (config only)¶
The ICMPv6 code to match.
vsr running config# qos selector <string>{1,32} icmpv6 code
value (config only) (mandatory)¶
The 8 bit value to match.
vsr running config# qos selector <string>{1,32} icmpv6 code
vsr running code# value <uint8>
mask (config only)¶
Mask applied to value.
vsr running config# qos selector <string>{1,32} icmpv6 code
vsr running code# mask <0x0-0xff>
policy (config only)¶
List of QoS policies.
vsr running config# qos policy <string>{1,32}
|
QoS policy name. |
description (config only)¶
A comment to describe the policy.
vsr running config# qos policy <string>{1,32}
vsr running policy <string>{1,32}# description <string>
priority (config only) (mandatory)¶
Priority of the policy (policies are looked up hacked by increasing order of priority).
vsr running config# qos policy <string>{1,32}
vsr running policy <string>{1,32}# priority <uint32>
selector (config only)¶
List of traffic selectors.
vsr running config# qos policy <string>{1,32}
vsr running policy <string>{1,32}# selector <leafref>
action (config only)¶
The policy action.
vsr running config# qos policy <string>{1,32} action
set-mark (config only)¶
Mark the packet.
vsr running config# qos policy <string>{1,32} action
vsr running action# set-mark <0x0-0xffffffff>
restore-connmark (config only)¶
Copy the connection mark (ctmark) to the packet mark (nfmark): if the packet belongs to a connection in the conntrack module and a ctmark is assigned to this connection, then the mark is copied to the packet nfmark. Otherwise the packet nfmark is reset to 0.
vsr running config# qos policy <string>{1,32} action
vsr running action# restore-connmark
redirect (config only)¶
Redirect the packet to QoS-hub interface.
vsr running config# qos policy <string>{1,32} action
vsr running action# redirect REDIRECT
|
An interface name. |
pass (config only)¶
Do not apply any specific QoS processing.
vsr running config# qos policy <string>{1,32} action
vsr running action# pass
set-priority (config only)¶
Set the priority of the packet.
vsr running config# qos policy <string>{1,32} action
vsr running action# set-priority <uint32>