12.2. Service Egress Policy Command Reference

12.2.1. Command Hierarchies

12.2.1.1. Configuration Commands

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
[no] remark policy-id
[no] remarking
scope {exclusive | template}

12.2.1.2. Copy Commands

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

12.2.1.3. Show Commands

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

12.2.2. Command Descriptions

12.2.2.1. Configuration Commands

12.2.2.1.1. Generic Commands

description

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

Supported on all 7210 SAS platforms as described in this document

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.

12.2.2.1.2. SAP Egress Policy Commands

sap-egress

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

Supported on all 7210 SAS platforms as described in this document

Description 

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

When the policy is created, by default only one queue is created. The user can create up to eight queues and associate each queue to different FCs on the SAPs to which this sap-egress policy is attached. A 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

 

create—
Keyword to create a SAP-egress policy.

queue

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

Supported on all 7210 SAS platforms as described in this document

Description 

This command enables the context to configure queue parameters.

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

 

create—
Keyword to create a network queue policy.

adaptation-rule

Syntax 
adaptation-rule [cir adaptation-rule] [pir adaptation-rule]
no adaptation-rule
Context 
config>qos>sap-egress>queue
Supported Platforms 

Supported on all 7210 SAS platforms as described in this document

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. Table 22 lists the 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. Table 22 lists the 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-mgmt

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

Supported on all 7210 SAS platforms as described in this document

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>queue
Supported Platforms 

Supported on all 7210 SAS platforms as described in this document

Description 

The queue-mode determines whether the queue operates in strict or weighted mode.

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

Default 

weighted

Parameters 
strict —
Specifies that the scheduler schedules the queue in order of its priority in the two passes, the CIR loop and the PIR loop.
weighted —
Specifies that the scheduler examines these queues in two passes: CIR loop and PIR loop. In the CIR loop, the scheduler distributes the available bandwidth to all the strict and then weighted queues in a round-robin manner up to the configured CIR. 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 

Supported on all 7210 SAS platforms as described in this document

Description 

This command defines the administrative PIR and the administrative 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 queues created with the queue ID by association with the QoS policy to the default PIR (max) and CIR (0) parameters.

Default 

rate cir 0 pir max

Parameters 
cir cir-rate-in-kbps
Specifies the administrative CIR, 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, 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
Supported Platforms 

Supported on all 7210 SAS platforms as described in this document

Description 

This command configures the weight of the queue.

The configured weight determines the proportion of available bandwidth that is given to this queue in comparison to other queues contending for bandwidth at the same priority level.

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

Default 

1

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

 

remark

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

Supported on all 7210 SAS platforms as described in this document

Description 

This command specifies the remarking policy ID to use for marking packets on service egress (also knows 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 a remarking policy of the type dot1p, or dot1p-lsp-exp-shared is allowed to be used when the remark policy is associated with sap-egress. Table 48 describes the different remark policies supported on the node and their use.

Note:

SAP-based marking per SAP and port-based marking per access port are supported on all 7210 SAS platforms as described in this document, and functionality is configurable. See Access Egress QoS Policies on 7210 SAS-R6 and 7210 SAS-R12 for more information.

The no form of this command removes the explicit association of the remark policy and associates the default remark policy. This means that 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 
remarking
no remarking
Context 
config>qos>sap-egress
Supported Platforms 

Supported on all 7210 SAS platforms as described in this document

Description 

This command enables the system to remark egress packets sent out of services egress (also known as 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 the SAP-egress QoS policy is used to determine the FC-to-dot1p mapping to use for marking packets sent out of access ports.

See Remark Policies and Table 48 for more information about the remark policy that can be used to configure FC-to-priority bit markings in different QoS policies associated with different service entities.

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 

Supported on all 7210 SAS platforms as described in this document

Description 

This command configures the scope as exclusive or template.

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. 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 becomes available for assignment to another exclusive interface.
template—
Specifies that the policy can be applied to multiple interfaces or ports on the router.

12.2.2.2. Operational Commands

copy

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

Supported on all 7210 SAS platforms as described in this document

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 by using the overwrite keyword.

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

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

 

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

 

overwrite—
Specifies that the information in the destination policy is overwritten by the information in the source policy.

12.2.2.3. Show Commands

sap-egress

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

Supported on all 7210 SAS platforms as described in this document

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 46 describes the output fields.

Sample Output
A:SAS>config>qos# show qos sap-egress 1 detail 
 
===============================================================================
QoS Sap Egress
===============================================================================
-------------------------------------------------------------------------------
Sap Egress Policy (1)
-------------------------------------------------------------------------------
Scope                     : Template          
Remark                    : False             Remark Pol Id        : 2
Accounting                : frame-based       
Description    : Default SAP egress QoS policy.
-------------------------------------------------------------------------------
Queue Rates and Rules
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
QueueId        CIR          CIR Adpt Rule        PIR          PIR Adpt Rule
-------------------------------------------------------------------------------
Queue1          0              closest            max            closest  
Queue2          0              closest            max            closest  
Queue3          0              closest            max            closest  
Queue4          0              closest            max            closest  
Queue5          0              closest            max            closest  
Queue6          0              closest            max            closest  
Queue7          0              closest            max            closest  
Queue8          0              closest            max            closest  
-------------------------------------------------------------------------------
Parent Details
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
QueueId          Port       CIR Level      PIR Weight
-------------------------------------------------------------------------------
Queue1          True             1             1  
Queue2          True             1             1  
Queue3          True             1             1  
Queue4          True             1             1  
Queue5          True             1             1  
Queue6          True             1             1  
Queue7          True             1             1  
Queue8          True             1             1  
-------------------------------------------------------------------------------
High Slope
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
QueueId        State      Start-Avg(%)   Max-Avg(%)   Max-Prob(%) 
-------------------------------------------------------------------------------
Queue1          Down            70           90            75 
Queue2          Down            70           90            75 
Queue3          Down            70           90            75 
Queue4          Down            70           90            75 
Queue5          Down            70           90            75 
Queue6          Down            70           90            75 
Queue7          Down            70           90            75 
Queue8          Down            70           90            75 
-------------------------------------------------------------------------------
Low Slope
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
QueueId        State      Start-Avg(%)   Max-Avg(%)   Max-Prob(%) 
-------------------------------------------------------------------------------
Queue1          Down            50           75            75 
Queue2          Down            50           75            75 
Queue3          Down            50           75            75 
Queue4          Down            50           75            75 
Queue5          Down            50           75            75 
Queue6          Down            50           75            75 
Queue7          Down            50           75            75 
Queue8          Down            50           75            75 
-------------------------------------------------------------------------------
Burst Sizes and Time Average Factor   
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
QueueId         CBS            MBS       Time Average Factor        Queue-Mgmt
-------------------------------------------------------------------------------
Queue1          def               def              7           default
Queue2          def               def              7           default
Queue3          def               def              7           default
Queue4          def               def              7           default
Queue5          def               def              7           default
Queue6          def               def              7           default
Queue7          def               def              7           default
Queue8          def               def              7           default
-------------------------------------------------------------------------------
Associations
-------------------------------------------------------------------------------
Service-Id                : 1 (Epipe)         Customer-Id          : 1
 - SAP : 1/1/1:1                   
Service-Id                : 101 (Epipe)       Customer-Id          : 1
 - SAP : 1/1/2:101                 
 
-------------------------------------------------------------------------------
Mirror SAPs
-------------------------------------------------------------------------------
No Mirror SAPs Found.
===============================================================================
A:SAS>config>qos#                                                        
Table 46:  Output Fields: SAP Egress QoS Policy 

Label

Description

Policy-Id

Displays 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 — Specifies that this policy can be applied only to a single access egress port

Template — Specifies that this policy can be applied to multiple access ports on the router

Description

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

Queue Rates and Rules

QueueId

Displays the queue identifier associated with the SAP-egress QoS policy

Explicit/Default

Explicit — Specifies the egress dot1p bits marking for fc-name, if explicitly configured

Default —Specifies the default dot1p value according to FC-Dot1p marking map as listed in Table 16, if explicit values are not configured

CIR

Specifies the administrative CIR parameters for the queue

The CIR defines the rate at which the system prioritizes the queue over other queues competing for the same bandwidth.

CIR Adpt Rule

min — The operational CIR for the queue is equal to or greater than the administrative rate specified using the rate command

max — The operational CIR for the queue is less than or equal to the administrative rate specified using the rate command

closest — The operational CIR for the queue is the rate closest to the rate specified using the rate command without exceeding the operational PIR

PIR

Specifies the administrative PIR parameters for the queue

The PIR defines the maximum rate that the queue can transmit packets through the access port.

PIR Adpt Rule

min — The operational PIR for the queue is equal to or greater than the administrative rate specified using the rate command

max — The operational PIR for the queue is less than or equal to the administrative rate specified using the rate command

closest — The operational PIR for the queue is the rate closest to the rate specified using the rate command

Parent Details

QueueId

Displays the queue identifier associated with the SAP-egress QoS policy

Port

Indicates whether the parent scheduler is a port scheduler

CIR Level

Displays the priority of the queue in the CIR loop

PIR Weight

Displays the weight of the queue used in the PIR loop

High Slope/Low slope

QueueId

Displays the queue identifier associated with the SAP-egress QoS policy

State

Displays the state of the queue

The state of the queue can be either “Up” or “Down”.

Start Avg

Specifies the low priority or high priority RED slope position for the shared buffer average utilization value, where the packet discard probability starts to increase above zero

Max Avg

Specifies the percentage of the shared buffer space for the buffer pool at which point the drop probability becomes “1”

This parameter is expressed as a decimal integer.

Max Prob

Specifies the high-priority RED slope position for the maximum non-one packet discard probability value before the packet discard probability rises directly to one

Burst Sizes and Time Average Factor

QueueId

Displays the queue identifier associated with the SAP-egress QoS policy

CBS

Displays the configured CBS value

MBS

Displays the configured MBS value

Time Average Factor

Displays the value of the time average factor in use

Queue-Mgmt

Displays the queue management policy in use

Service Associations

Service-Id

The unique service ID number that identifies the service in the service domain

Customer-Id

Specifies the customer ID that identifies the customer to the service

SAP

Specifies the SAP within the service where the SAP-egress policy is applied