11.2. Service Egress Policy Command Reference

11.2.1. Command Hierarchies

11.2.1.1. Configuration Commands for 7210 SAS-Mxp

config
— qos
sap-egress policy-id [create]
— no sap-egress policy-id
[no] description description-string
queue queue-id
[no] adaptation-rule [pir adaptation-rule] [cir adaptation-rule]
queue-mgmt name
— no queue-mgmt
queue-mode queue-mode
— no queue-mode
[no] rate cir cir-rate pir pir-rate
weight weight
— no weight
scope {exclusive | template}
— no scope
[no] remark policy-id
[no] remarking

11.2.1.2. Operational Commands

config
— qos
copy sap-egress src-pol dst-pol [overwrite]

11.2.1.3. Show Commands

show
— qos
sap-egress [policy-id] [detail | association]

11.2.2. Command Descriptions

11.2.2.1. Configuration Commands

11.2.2.1.1. Generic Commands

description

Syntax 
description description-string
no description
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command creates a text description stored in the configuration file for a configuration context.

The description command associates a text string with a configuration context to help identify the context in the configuration file.

The no form of this command removes any description string from the context.

Parameters 
description-string—
Specifies a text string describing 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.

11.2.2.1.2. SAP Egress Queue QoS Policy Commands

adaptation-rule

Syntax 
adaptation-rule [cir adaptation-rule] [pir adaptation-rule]
no adaptation-rule
Context 
config>qos>sap-egress>queue
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 queue 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 cir and pir apply.

Default 

adaptation-rule pir closest cir closest

Parameters 
cir adaptation-rule—
Specifies the adaptation rule and defines the constraints enforced when adapting the CIR rate defined using the queue queue-id rate command. The cir parameter requires a qualifier that defines the constraint used to derive the operational CIR rate for the queue. When the cir parameter 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 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 CIR value is greater 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.
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 when adapting the PIR rate defined using the queue queue-id rate command. The pir parameter requires a qualifier that defines the constraint used when deriving the operational PIR rate for the queue. When the pir 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 greater 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.
closest — Specifies that the operational PIR 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.
 

 

queue

Syntax 
queue queue-id create
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command enables the context to modify Queue parameters associated with a particular queue.

Parameters 
queue-id—
Specifies the ID of the queue.
Values—
1 to 8

 

create—
Keyword to create a network queue policy.

sap-egress

Syntax 
sap-egress policy-id [create]
Context 
config>qos
Supported Platforms 

7210 SAS-Mxp

Description 

This command enables the context to configure a SAP Egress policy. The SAP egress policy determines the QoS treatment to packets at service egress.

When the policy is created, by default, 8 queues (1 to 8) are created and associated to different FCs on the SAPs to which this sap-egress policy is attached. SAP egress policy allows the user to define the queue parameters for the eight queues.

Default 

1

Parameters 
policy-id—
Specifies the ID of the SAP Egress policy.
Values—
1 to 65535

 

remark

Syntax 
remark policy-id
no remark
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command specifies the remarking policy ID to use for marking packets on service egress (also known as, SAP egress).

The remarking policy ID must be associated with the appropriate sap-egress policy and remarking must be enabled in the sap-egress policy to enable marking of packets sent out of the SAP. Only remarking policy of type dot1p, or dot1p-lsp-exp-shared is allowed to be used when the remark policy is associated with sap-egress. See Summary of Remark Policy and Attachment Points for 7210 SAS-Mxp for more information on remark policies.

Note:

On the 7210 SAS-Mxp, remarking is user configurable and supports SAP-based marking per SAP and port-based marking per access port. For more information about access port-based marking capabilities, see Summary of Remark Policy and Attachment Points for 7210 SAS-Mxp and Access Egress QoS Policies on 7210 SAS-Mxp.

The no form of this command removes the explicit association of the remark policy and associates the default remark policy. If remarking is enabled and no remark policy is executed, the default remark policy is used to mark packets sent out. If no remark policy is executed and remarking is disabled, packets are not remarked.

Parameters 
policy-id—
Specifies the remark policy.
Values—
1 to 65535

 

remarking

Syntax 
no remarking
remarking
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command enables the system to remark egress packets sent out of service egress (also known as Access SAP egress).

When remarking is enabled, the remark policy configured in the QoS policy context is used to determine the FC to QoS bit mapping. For example, when remarking is enabled in the sap-egress QoS policy, the remark policy associated with sap-egress QoS policy is used to determine the FC to dot1p mapping to use for marking packets sent out of access ports.

Refer the remark policy that can be used to configure FC to priority bit markings in different QoS policies associated with different service entities, in the chapter on Remark Policies. See Summary of Remark Policy and Attachment Points for 7210 SAS-Mxp for more information.

The no form of this command disables remarking.

Default 

no remarking

scope

Syntax 
scope {exclusive | template}
no scope
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command configures the scope as exclusive or template. The policy’s scope cannot be changed if the policy is applied to an interface multiple ports.

The no form of this command reverts the scope of the policy to the default.

Default 

template

Parameters 
exclusive—
Specifies that the policy can only be applied to one interface or port. If a policy with an exclusive scope is assigned to a second interface, an error message is generated. If the policy is removed from the exclusive interface, it will become available for assignment to another exclusive interface. The system default policies cannot be put into the exclusive scope. An error will be generated if scope exclusive is executed in any policies with a policy-id equal to default QoS policies are configured with template scope. An error is generated if you try to modify the scope parameter from template to exclusive scope on default policies.
template—
Specifies that the policy can be applied to multiple interfaces or ports on the router.

queue-mgmt

Syntax 
[no] queue-mgmt name
Context 
config>qos>sap-egress>queue
Supported Platforms 

7210 SAS-Mxp

Description 

This command associates the specified queue management policy with this queue.

The queue management policy is used to specify the queue buffer parameters and queue slope policy parameters.

The no form of this command associates the default SAP egress queue management policy with this queue.

Parameters 
name—
Specifies the name of the queue management policy, up to 32 characters.

queue-mode

Syntax 
[no] queue-mode queue-mode
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command determines whether the queue operates in strict or weighted mode.

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

Default 

weighted

Parameters 
queue-mode—
Specifies the queue mode.

strict — If a queue is configured in strict mode, the scheduler schedules the queue in order of their priority in the 2 passes, the CIR loop and the PIR loop.

weighted — If a queue is configured in weighted mode, then the scheduler examines these queues in 2 passes - CIR loop and a PIR loop. In the CIR loop, it distributes the available bandwidth to all the strict and then weighted queues in round-robin up to the configured CIR rate. It examines the weighted queues in the PIR loop, after examining all the strict queues and distributes the available bandwidth, if any, in the proportion of the configured weights.

rate

Syntax 
rate cir cir-rate-in-kbps [pir pir-rate-in-kbps]
no rate
Context 
config>qos>sap-egress>queue
Supported Platforms 

7210 SAS-Mxp

Description 

This command defines the administrative Peak Information Rate (PIR) and the administrative Committed Information Rate (CIR) parameters for the queue. The PIR defines the maximum rate that the queue can transmit packets through the port. Defining a PIR does not necessarily guarantee that the queue can transmit at the intended rate. The actual rate sustained by the queue can be limited by oversubscription factors or available egress bandwidth. The CIR defines the rate at which the system prioritizes the queue over other queues competing for the same bandwidth.

The rate command can be executed at anytime, altering the PIR and CIR rates for all queues created on the access ports.

The no form of this command reverts all queues created with the queue ID by association with the QoS policy to the default PIR (max) and CIR (0) parameters.

Default 

rate 0 pir max

Parameters 
cir cir-rate-in-kbps—
Specifies the administrative CIR rate, in kilobits, for the queue. The cir parameter overrides the default administrative CIR used by the queue. If the rate command is not executed or the cir parameter is not explicitly specified, the default CIR value is used.
Values—
0 to 10000000, max

 

Default—
0
pir pir-rate-in-kbps—
Specifies the administrative PIR rate, in kilobits, for the queue. When the rate command is executed, a PIR setting is optional. If the rate command is not executed, the default PIR of maximum value is used. 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-rate value.
Values—
1 to 10000000, max

 

Default—
max

weight

Syntax 
[no] weight weight
Context 
config>qos>sap-egress>queue
Supported Platforms 

7210 SAS-Mxp

Description 

This command configures the weight of the queue when the queue-mode is set to weighted.

For queues configured in weighted mode, the CIR of the queues are met if bandwidth is available and the configured weights are considered in the PIR loop. The configured weight determines the proportion of available bandwidth that is given to this queue in comparison to other queues configured in weighted mode.

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

Default 

1

Parameters 
weight—
Specifies the value for the weight parameter. The value is an integer value which specifies the proportion of available bandwidth to be allocated to this queue relative to other queues.
Values—
1 to 15

 

scope

Syntax 
scope {exclusive | template}
no scope
Context 
config>qos>sap-egress
Supported Platforms 

7210 SAS-Mxp

Description 

This command configures the scope as exclusive or template. The policy’s scope cannot be changed if the policy is applied to an interface multiple ports.

The no form of this command reverts the scope of the policy to the default.

Default 

template

Parameters 
exclusive—
Specifies that the policy can only be applied to one interface port. If a policy with an exclusive scope is assigned to a second interface an error message is generated. If the policy is removed from the exclusive interface, it will become available for assignment to another exclusive interface. The system default policies cannot be put into the exclusive scope. An error will be generated if scope exclusive is executed in any policies with a policy ID equal to 1.
template—
Specifies that the policy can be applied to multiple interface ports on the router.

Default QoS policies are configured with template scope. An error is generated if you try to modify the scope parameter from template to exclusive scope on default policies.

11.2.2.2. Operational Commands

copy

Syntax 
copy sap-egress src-pol dst-pol [overwrite]
Context 
config>qos
Supported Platforms 

7210 SAS-Mxp

Description 

This command copies the existing SAP egress QoS policy entries to another SAP egress QoS policy.

The copy command is a configuration level maintenance tool used to create new policies using existing policies. It also allows bulk modifications to an existing policy with the use of the overwrite keyword.

If the destination policy already exists, the overwrite keyword must be specified.

Default 

template

Parameters 
src-pol—
Specifies the source policy.
Values—
1 to 65535

 

src-pol—
Specifies the destination policy.
Values—
1 to 65535

 

overwrite—
Keyword to overwrite the information in the destination policy by the information in the source policy.

11.2.2.3. Show Commands

sap-egress

Syntax 
sap-egress [policy-id] [association | detail]
Context 
show>qos
Supported Platforms 

7210 SAS-Mxp

Description 

This command displays sap egress QoS policy information.

Parameters 
policy-id—
Displays the policy ID of the sap-egress policy.
association—
Displays associations related to the specified sap-egress policy.
detail—
Displays detailed policy information including the policy associations.
Output 

The following output is an example of SAP egress QoS policy information, and Table 62 describes the output fields.

Sample Output
A:7210SAS>show>qos# sap-egress
 
===============================================================================
Sap Egress Policies
===============================================================================
 
-------------------------------------------------------------------------------
Policy-id  Remark  Remark        Scope       Name            Description
                  Policy-id
-------------------------------------------------------------------------------
1          False  2          Template   default             Default SAP egress
===============================================================================
A:7210SAS>show>qos#
Table 62:  Output Fields: QoS SAP Egress 

Label

Description

Policy-Id

The ID that uniquely identifies the policy

Remark

True — Remarking is enabled for all the dot1q-tagged packets that egress the ports on which the sap-egress QoS policy is applied and remarking is enabled

False — Remarking is disabled for the policy

Remark Pol Id

Displays the policy ID of the remarking policy

Accounting

Specifies whether the accounting mode is packet-based or frame-based

Scope

Exclusive — Implies that this policy can be applied only to a single access egress port

Template — Implies that this policy can be applied to

multiple access ports on the router

Description

A text string that helps identify the policy’s context in the configuration file