18.3. Access-Ingress QoS Policy Command Reference

18.3.1. Command Hierarchies

18.3.1.1. Access-Ingress QoS Configuration Commands

config
— qos
access-ingress policy-id [create]
— no access-ingress policy-id
counter-mode {in-out-profile-count | forward-drop-count}
— no counter-mode
description description-string
default-fc fc-name profile {in | out}
— no default-fc
dot1p-classification description-string
dscp-classification description-string
fc fc-name [create]
— no fc fc-name
meter meter-id
— no meter
multicast-meter meter-id
meter meter-id [create] [multi-point]
— no meter meter-id
adaptation-rule [cir adaptation-rule] [pir adaptation-rule]
cbs size [kbits | bytes | kbytes]
— no cbs
color-mode {color-aware | color-blind}
— no color-mode
mbs size [kbits | bytes | kbytes]
— no mbs
mode mode
— no mode
rate [cir cir-rate] [pir pir-rate]
— no rate
num-qos-classifiers num-resources
table-classification-criteria table-classification-criteria

18.3.2. Command Descriptions

18.3.2.1. Generic Commands

access-ingress

Syntax 
access-ingress policy-id [create]
no access-ingress policy-id
Context 
config>qos
Supported Platforms 

7210 SAS-Mxp

Description 

This command enables the context to create or edit an access ingress QoS policy, which is used when the access-ingress-qos-mode command is set to port-mode. Refer to the 7210 SAS-M, T, R6, R12, Mxp, Sx, S Interface Configuration Guide for more information about the access-ingress-qos-mode command.

The no form of this command reverts to the default value.

Default 

access-ingress 1

Parameters 
policy-id—
Specifies the access-ingress policy ID.
Values—
1 to 65535

 

create—
Keyword to create an access-ingress policy. The create keyword requirement can be enabled or disabled in the environment>create context.

description

Syntax 
description description-string
no description
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command creates a text description stored in the configuration file for a configuration context. The text string is stored in the configuration file and identifies the context in the file.

The no form of this command removes the description string for the configuration context.

Parameters 
description-string—
Specifies a text string that describes the entity. Allowed values are any string up to 80 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

18.3.2.2. Access Ingress QoS Policy Commands

counter-mode

Syntax 
counter-mode {in-out-profile-count | forward-drop-count}
no counter-mode
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command allows the user to set the counter mode for the counters associated with access port ingress meters (also known as policers). A pair of counters is available with each meter. These counters count different events based on the counter mode value.

The no form of this command reverts to the default value.

Default 

counter-mode in-out-profile-count

Parameters 
in-out-profile-count—
Specifies that the in-profile and out-profile packets and octets are counted per meter.
fwd-drop-count—
Specifies that the forwarded and dropped packets and octets are counted per meter.

default-fc

Syntax 
default-fc fc-name profile {in | out}
no default-fc
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command defines or edits the default forwarding class to be assigned to packets that do not match the explicitly configured classification entries. See the table-classification-criteria command for more information about configuring the default FC.

The no form of this command reverts to the default value.

Default 

default-fc be profile out

Parameters 
fc-name
Specifies the forwarding class name.
Values—
be, l2, af, l1, h2, ef, h1, nc

 

profile {in | out}
Specifies whether packets are in-profile or out-of-profile. All packets that are assigned to this forwarding class are considered in or out of profile based on which keyword is configured. A value of in defines the packet as being in-profile and a value of out defines the packet as being out-of-profile.

dot1p-classification

Syntax 
dot1p-classification policy-id
no dot1p-classification
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command associates a dot1p classification policy with an access-ingress QoS policy. See IP DSCP and Dot1p Classification Policy Support for more information about dot1p classification policies.

The no form of this command reverts to the default value.

Default 

dot1p-classification 1

Parameters 
policy-id—
Specifies the dot1p classification policy ID.
Values—
1 to 65535

 

dscp-classification

Syntax 
dscp-classification policy-id
no dscp-classification
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command associates a DSCP classification policy with an access-ingress QoS policy. See IP DSCP and Dot1p Classification Policy Support for more information about dot1p classification policies.

The no form of this command reverts to the default value.

Default 

dscp-classification 1

Parameters 
policy-id—
Specifies the DSCP classification policy ID.
Values—
1 to 65535

 

fc

Syntax 
fc fc-name [create]
no fc fc-name
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command creates a class instance of the forwarding class. After the fc-name is created, classification actions can be applied to the forwarding class and it can be used in classification criteria configured in the DSCP and dot1p classification policies.

The no form of this command removes all explicit meter mappings for fc-name forwarding types. The meter mappings revert to the default meters for fc-name.

Default 

Undefined forwarding classes default to the configured parameters in the default policy policy-id 1.

Parameters 
fc-name—
Specifies the case-sensitive, system-defined FC name for which policy entries will be created.
Values—
be, l2, af, l1, h2, ef, h1, nc

 

create—
Keyword to create the forwarding class. The create keyword requirement can be enabled or disabled in the environment>create context.

meter

Syntax 
meter meter-id
no meter
Context 
config>qos>access-ingress>fc
Supported Platforms 

7210 SAS-Mxp

Description 

This command overrides the default unicast forwarding type meter mapping for fc fc-name. The specified meter ID must exist within the policy as a non-multipoint meter before the mapping can be made. After the FC mapping is applied, the meter ID is used to forward all unicast traffic that uses this policy on the port.

The no form of this command reverts the unicast (point-to-point) meter ID to the default meter for the FC.

Default 

meter 1

Parameters 
meter-id—
Specifies the meter ID, which must be an existing, non-multipoint meter defined in the config>qos>access-ingress context.
Values—
1 to 16

 

multicast-meter

Syntax 
multicast-meter meter-id
no multicast-meter
Context 
config>qos>access-ingress>fc
Supported Platforms 

7210 SAS-Mxp

Description 

This command overrides the default multicast forwarding type meter mapping for fc fc-name. The specified meter ID must exist within the policy as a multipoint meter before the mapping can be made. After the FC mapping is applied, the meter ID is used to forward all multicast traffic that uses this policy on the port.

The no form of this command reverts the multicast forwarding type meter-id to the default meter for the FC.

Default 

multicast-meter 9

Parameters 
meter-id—
Specifies the multicast meter, which must be an existing, multipoint meter defined in the config>qos>access-ingress context.
Values—
1 to 16

 

meter

Syntax 
meter meter-id [create] [multi-point]
no meter meter-id
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command enables the context to configure an access-ingress QoS policy meter (also known as a policer). The meter command allows the creation of unicast and multipoint meters.

A meter can be shared by multiple FCs, but the unicast and multicast traffic of an FC cannot share the same meter. That is, two or more FCs can share the same unicast and multicast meter for unicast and multicast traffic, but a minimum of 2 meters are required; one for unicast traffic and another for multicast traffic.

Multipoint meters receive ingress packets destined for multiple destinations, and handle traffic bound to these destinations. In non-multipoint services, such as Epipe services, all traffic is considered unicast due to the nature of the service type. Multicast and broadcast-destined traffic in an Epipe service is not mapped to a multipoint service meter.

The no form of this command removes the meter ID from the access-ingress QoS policy and from existing ports that use the policy. If any forwarding class forwarding types are mapped to the meter, they revert to their default meters. When a meter is removed, pending accounting information for each port meter created when the meter is defined in the policy is discarded.

Default 

meter 1 (for unicast traffic)

meter 9 multipoint (for traffic other than unicast traffic)

Parameters 
meter-id—
Specifies the meter ID that uniquely identifies the meter within the policy. This is a required parameter and must be specified each time the meter command is run.
Values—
1 to 16

 

multipoint—
Specifies that the defined meter-id is for multipoint forwarded traffic only. This meter-id can only be explicitly mapped to the forwarding class multicast, broadcast, or unknown unicast ingress traffic. Attempting to map forwarding class unicast traffic to a multipoint meter causes the system to generate an error and the current unicast traffic meter mapping is unchanged.

A meter must be defined as multipoint when it is created using the create keyword. Applying the keyword after the meter is created is not allowed. Attempting to modify the command to include the multipoint keyword will cause the system to generate an error and the command will not execute.

The multipoint keyword can be entered in the command line on a pre-existing multipoint meter to edit meter-id parameters.

create—
Keyword to create a meter.

adaptation-rule

Syntax 
adaptation-rule [cir adaptation-rule] [pir adaptation-rule]
no adaptation-rule
Context 
config>qos>access-ingress>meter
Supported Platforms 

7210 SAS-Mxp

Description 

This command defines the method used by the system to derive the operational CIR and PIR rates when the meter is provisioned in hardware. For the cir and pir parameters, the system attempts to find the best operational rate depending on the defined constraint.

The no form of this command removes any explicitly defined constraints used to derive the operational CIR and PIR created by the application of the policy. When a specific adaptation-rule is removed, the default constraints for rate and cir apply.

Default 

adaptation-rule cir closest pir closest

Parameters 
cir adaptation-rule
Specifies the adaptation rule and defines the constraints enforced to adapt the CIR rate defined using the meter meter-id rate command. The cir parameter requires a qualifier that defines the constraint used to derive the operational CIR rate for the meter. When the cir command is not specified, the default constraint applies. The max (maximum), min (minimum), and closest qualifiers are mutually exclusive. See Table 28 for information about supported hardware step-size rates.
Default—
closest
Values—
max — Specifies that the operational CIR value is equal to or less than the specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.
min — Specifies that the operational CIR value is equal to or greater than the specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.
closest — Specifies that the operational CIR value is equal to the closest specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.

 

pir adaptation-rule
Specifies the adaptation rule and defines the constraints enforced to adapt the PIR rate defined using the meter meter-id rate command. The pir parameter requires a qualifier that defines the constraint used to derive the operational PIR rate for the meter. When the rate command is not specified, the default constraint applies. The max (maximum), min (minimum), and closest qualifiers are mutually exclusive. See Table 28 for information about supported hardware step-size rates.
Default—
closest
Values—
max — Specifies that the operational PIR value is less than or equal to the specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.
min — Specifies that the operational PIR value is equal to or greater than the specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.
closest — Specifies that the operational CIR value is equal to the closest specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.

 

cbs

Syntax 
cbs size [kbits | bytes | kbytes]
no cbs
Context 
config>qos>access-ingress>meter
Supported Platforms 

7210 SAS-Mxp

Description 

This command provides a mechanism to override the default committed burst size (CBS) for the meter. The size parameter specifies the maximum burst size that can be transmitted by the source while still complying with the CIR. If the transmitted burst is lower than the CBS value, the packets are marked as in-profile by the meter to indicate that the traffic is complying meter configured parameters.

The no form of this command reverts the CBS size to the default value.

Default 

32 kbits

Parameters 
size—
Specifies the size as an integer expression of the number of kilobits or kilobytes or bytes reserved for the meter. For example, if a value of 100 kbits is required, enter the value 100. The bucket size is rounded off to the next highest 4096 bytes boundary. The value can be specified in kilobits, kilobytes, or bytes.
Values—
kbits — 4 to 2146959, default
bytes — 512 to 274810752, default
kbytes — 1 to 268369, default

 

color-mode

Syntax 
color-mode {color-aware | color-blind}
no color-mode
Context 
config>qos>access-ingress>meter
Supported Platforms 

7210 SAS-Mxp

Description 

This command specifies whether the meter will operate in the color-aware or color-blind mode.

In color-blind mode, the profile and color assigned to the packet on ingress is ignored. The CIR and PIR rate configured for the meter is used to determine the final color and profile for the packet. If the packet is within the CIR, then the final profile and color assigned to the packet is in-profile and green. If the packet exceeds the CIR and is within the PIR, then the final profile and color assigned to the packet is out-of-profile and yellow. Packets that exceed the PIR rate are dropped.

In color-aware mode, the meter uses the profile assigned to the packet on ingress. The ingress profile can be assigned to the packet using either dot1p, DEI configured with dot1p, or IP DSCP values from the packet header.

In color-aware mode, the following behavior is expected.

  1. If the packet is pre-colored as an “in-profile” packet (also called “green” packets), depending on the burst size of the packet, the meter can mark the packet in-profile or out-profile.
  2. If the packet is pre-colored as an “out-profile” packet (which are also called “yellow” packets), even if the packet burst is less than the current available CBS, it would not be marked as in-profile and remain as out-profile.
  3. If the packet burst is higher than the MBS, it is marked as “red” and dropped by the meter at ingress.

The no form of this command reverts to the default mode.

Default 

color-mode color-aware

Parameters 
color-aware—
Specifies that the meter will operate in color-aware mode.
color-blind—
Specifies that the meter will operate in color-blind mode.

mbs

Syntax 
mbs size [kbits | bytes | kbytes]
no mbs
Context 
config>qos>access-ingress>meter
Supported Platforms 

7210 SAS-Mxp

Description 

This command provides a mechanism to override the default MBS for the meter. The Maximum Burst Size (MBS) value specifies the maximum burst size that can be transmitted by the source while still complying with the CIR. If the transmitted burst is lower than the configured MBS value, the packets are marked as in-profile by the meter to indicate that the traffic is complying meter configured parameters.

The no form of this command reverts the MBS size to the default value.

Default 

512kbits

Parameters 
size—
Specifies the size as integer expression of the number of kilobits reserved for the meter. For example, if a value of 100 KBits is required, enter the value 100. The bucket size is rounded off to the next highest 4096 bytes boundary.
Values—
kbits — 4 to 2146959, default
bytes — 512 to 274810752, default
kbytes — 1 to 268369, default

 

mode

Syntax 
mode {trtcm1 | trtcm2 | srtcm}
no mode
Context 
config>qos>access-ingress>meter
Supported Platforms 

7210 SAS-Mxp

Description 

This command defines the mode of the meter. The mode can be configured as trtcm1, trtcm2, or srtcm. The mode command can be run at any time.

The no form of this command reverts to the default mode.

Default 

mode trtcm1

Parameters 
trtcm1—
Keyword to implement the policing algorithm defined in RFC2698. Meters a packet stream and marks its packets either green, yellow, or red. A packet is marked red if it exceeds the PIR. Otherwise, it is marked either yellow or green depending on whether it exceeds or does not exceed the CIR. The trTCM1 is useful, for example, for ingress policing of a service, where a peak rate needs to be enforced separately from a committed rate.
trtcm2—
Keyword to implement the policing algorithm defined in RFC4115. Meters a packet stream and marks its packets either green, yellow, or red. A packet is marked red if it exceeds the PIR. Otherwise, it is marked either yellow or green depending on whether it exceeds or does not exceed the CIR. The trtcm2 is useful, for example, for ingress policing of a service, where a peak rate needs to be enforced separately from a committed rate.
srtcm—
Keyword to implement the policing algorithm defined in RFC2697. Meters a packet stream and marks its packets either green, yellow, or red. Marking is based on a CIR and two associated burst sizes, a CBS and an MBS. A packet is marked green if it does not exceed the CBS, yellow if it exceeds the CBS but not the CIR, and red otherwise. The srTCM is useful, for example, for ingress policing of a service, where only the length, not the peak rate, of the burst determines service eligibility.

rate

Syntax 
rate cir cir-rate-in-kbps [pir pir-rate-in-kbps]
no rate
Context 
config>qos>access-ingress>meter
Supported Platforms 

7210 SAS-Mxp

Description 

This command defines the administrative PIR and CIR parameters for the meter.

The rate command can be run at any time, altering the PIR and CIR rates for all meters created through the association of the network QoS policy with the meter ID.

The no form of this command reverts all meter instances created using this meter ID to the default PIR (max) and CIR parameters (0).

Note:

The value of rates are represented as 1000 kilobits per second and bursts are represented as 1024 kilobits.

Default 

rate 0 pir max

Parameters 
cir cir-rate-in-kbps—
Specifies the administrative CIR rate, in kilobits, for the meter. The cir parameter overrides the default administrative CIR used by the meter. When the rate command has not been executed or the cir parameter is not explicitly specified, the default CIR (0) is assumed.

Fractional values are not allowed and must be given as a positive integer.

The actual CIR rate depends on the meter’s adaptation-rule parameters and the hardware.

Values—
0 to 40000000, max

 

Default—
0
pir pir-rate-in-kbps
Specifies the administrative PIR rate, in kilobits, for the meter. When this parameter is configured, a valid PIR setting must be explicitly defined. If the rate command has not been run, the default PIR of max is assumed. If the rate command is run, a PIR setting is optional. The max default specifies the amount of bandwidth in kilobits per second (thousand bits per second). The max value is mutually exclusive to the pir pir-rate-in-kbps value.

Fractional values are not allowed and must be given as a positive integer.

The actual PIR rate depends on the meter’s adaptation-rule parameters and the hardware.

Note:

If the meter mode is configured as trtcm2, the system configures the policer EIR rate based on the PIR rate configured by the user.

Values—
0 to 40000000, max

 

Default—
max

num-qos-classifiers

Syntax 
num-qos-classifiers num-resources
no num-qos-classifiers
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command configures the number of CAM meter or policer resources that are allocated to rate-limit the forwarding class (FC) and classification entries to map the FC and traffic type to the configured meter. The maximum number of meters available for use by the FC defined under the policy is equal to half the value specified for the num-resources parameter. These meters are available for policing unicast or multipoint traffic, and for use by more than one FC.

Note:

  1. A user cannot modify the num-resources parameter when it is in use (that is, when the policy is applied to the port). To modify the meter or policer resources available for the policy, remove the association of the policy with the port, change the parameter to the desired value, and associate the policy with the port again.
  2. See section Resource Allocation for Access Ingress QoS Policies for information about resource allocation for access ingress QoS policies.

The no form of this command reverts to the default value.

Default 

num-qos-classifiers 4

Parameters 
num-resources—
Specifies the number of resources planned for use by the configured access-ingress policy, expressed as a multiple of 2.
Values—
4 to 32

 

table-classification-criteria

Syntax 
table-classification-criteria table-classification-criteria
Context 
config>qos>access-ingress
Supported Platforms 

7210 SAS-Mxp

Description 

This command allows the user to choose the classification policies to classify traffic to an FC when table-based classification is in use.

The following options can be used to configure the classification policy.

  1. If the none option is configured
    1. use default-fc fc-name profile {in | out} (from the access-ingress policy)
  2. If the use-dscp option is configured
    1. use the DSCP classification policy for IP packets
    2. use default-fc fc-name profile {in | out} (from the access-ingress policy) for non-IP packets
  3. If the use-dot1p option is configured
    1. use the dot1p classification policy for all tagged packets (IP and non-IP)
    2. use default-fc fc-name profile {in | out} (from the access-ingress policy) for untagged packets
  4. If the both-dscp-dot1p option is configured
    1. use the DSCP classification policy for IP packets
    2. use the dot1p classification policy for non-IP tagged packets
    3. use default-fc fc-name profile {in | out} (from the access-ingress policy) for non-IP untagged traffic
Default 

table-classification-criteria both-dscp-dot1p

Parameters 
table-classification-criteria—
Specifies the table classification criteria to use.
Values—
use-dscp, use-dot1p, both-dscp-dot1p, none