10.4. Shaper QoS Policy Command Reference

10.4.1. Command Hierarchies

Configuration Commands
Operational Commands
Show Commands

10.4.1.1. Configuration Commands

config

— qos

— shaper-policy policy-name [create]

— no shaper-policy policy-name

— description description-string

— no description

— shaper-group shaper-group-name [create]

— no shaper-group shaper-group-name

— rate pir-rate [cir cir-rate]

— no rate

— [no] unshaped-sap-shaper-group shaper-group-name

10.4.1.2. Operational Commands

config

— qos

— copy shaper-policy src-name dst-name [overwrite]

10.4.1.3. Show Commands

show

— qos

— shaper-policy [shaper-policy-name] [detail]

10.4.2.1. Configuration Commands

Generic Commands
Shaper QoS Policy Commands

10.4.2.1.1. Generic Commands

description

Syntax

description description-string

no description

Context

config>qos>shaper-policy

Description

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

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

Default

n/a

Parameters

description-string—

a text string describing the entity. Allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

10.4.2.1.2. Shaper QoS Policy Commands

shaper-policy

Syntax

shaper-policy policy-name [create]

no shaper-policy policy-name

Context

config>qos

Description

This command enables the context to configure a shaper QoS policy.

For hybrid ports, the shaper policy is independently assigned to access or network egress traffic. When the Ethernet port mode is changed to hybrid mode, the default policy is assigned to access and network traffic. To change an access or network policy, use the commands config>port>ethernet>access>egress>shaper-policy and config>port>ethernet> network>egress>shaper-policy.

For access ingress per-customer aggregate shaping, the shaper policy is assigned to an Ethernet MDA, and SAPs on that Ethernet MDA must be bound to a shaper group within the shaper policy bound to that Ethernet MDA. To assign a shaper policy to an adapter card, use the command config>card>mda>access>ingress>shaper-policy.

For access egress per-customer aggregate shaping, the shaper policy is assigned to a port, and SAPs on that port must be bound to a shaper group within the shaper policy bound to that port. To assign a shaper policy on egress, use the command config>port>ethernet> access>egress>shaper-policy.

The default shaper policy cannot be deleted. Table 66 displays the default shaper policy parameters.

Table 66: Shaper Policy Defaults

Field	Default
description	“Default Shaper QoS policy.”
shaper-group	“default”
description	“Default Shaper Group.”
pir-rate	max
cir-rate	0

The no form of this command removes the configured shaper-policy.

Default

shaper-policy “default”

Parameters

policy-name—

the name of the shaper policy. To access the default shaper policy, enter “default”.

Values—

Valid names consist of any string up to 32 characters long composed of printable, 7-bit ASCII characters.

If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

create—

keyword used to create a shaper policy

shaper-group

Syntax

shaper-group shaper-group-name [create]

no shaper-group shaper-group-name

Context

config>qos>shaper-policy

Description

This command creates and configures a shaper group. A shaper group is a dual-rate aggregate shaper used to arbitrate shaped and unshaped traffic for SAPs (access) and for VLANs (network).

The default shaper group cannot be deleted.

The no form of this command removes the configured shaper-group.

Default

shaper-group “default”

Parameters

shaper-group-name—

the name of the shaper group. To access the default shaper group, enter “default”.

create—

keyword used to create a shaper group

rate

Syntax

rate pir-rate [cir cir-rate]

no rate

Context

config>qos>shaper-policy>shaper-group

Description

This command sets the PIR and CIR for the shaper group. When the PIR or CIR is set to max, the corresponding aggregate shaper rate is capped at the egress-rate configured on the port (config>port>ethernet>egress-rate).

The no form of this command restores the pir-rate and cir-rate to the default values.

Default

pir-rate: max cir-rate: 0

Parameters

cir-rate—

the CIR for the shaper group

Values—

0 to 100000000, or max (kbps)

pir-rate—

the PIR for the shaper group

Values—

1 to 100000000, or max (kbps)

unshaped-sap-shaper-group

Syntax

[no] unshaped-sap-shaper-group shaper-group-name

Context

config>qos>shaper-policy

Description

This command assigns a shaper group to the unshaped SAPs assigned to the shaper policy. An unshaped shaper group is a dual-rate aggregate shaper used to arbitrate unshaped traffic for SAPs (access).

There can be only one unshaped SAP shaper group per shaper policy. The unshaped SAP shaper group must already exist within the shaper policy before it can be chosen for the unshaped-sap-shaper-group.

The no form of this command removes the configured unshaped-sap-shaper-group.

Default

shaper-group “default”

Parameters

shaper-group-name—

the name of the unshaped SAP shaper group. To access the default shaper group, enter “default”.

10.4.2.2. Operational Commands

copy

Syntax

copy shaper-policy src-name dst-name [overwrite]

Context

config>qos

Description

This command copies existing QoS policy entries for a QoS policy to another QoS policy.

This 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.

Parameters

shaper-policy src-name dst-name—

indicates that the source policy ID and the destination policy ID are shaper policy IDs. Specify the source policy ID that the copy command will attempt to copy from and specify the destination policy ID to which the command will copy a duplicate of the policy.

overwrite—

specifies that the existing destination policy is to be replaced. Everything in the existing destination policy will be overwritten with the contents of the source policy. If overwrite is not specified, an error will occur.

10.4.2.3. Show Commands

Note:

The following command outputs are examples only; actual displays may differ depending on supported functionality and user configuration.

shaper-policy

Syntax

shaper-policy [shaper-policy-name] [detail]

Context

show>qos

Description

This command displays shaper policy information.

Parameters

shaper-policy-name—

the name of the shaper policy

detail—

displays detailed information about the shaper policy

Output

The following output is an example of shaper policy information, and Table 67 describes the fields.

Output Example

*A:7705custDoc:Sar18>show>qos# shaper-policy

===============================================================================

Shaper Policies

===============================================================================

Policy-Id Description

-------------------------------------------------------------------------------

default Default Shaper QoS policy.

shaper_policy_1

shaper_policy_2

===============================================================================

*A:7705custDoc:Sar18>show>qos#

*A:7705:Dut-C# show qos shaper-policy 5

===============================================================================

QoS Shaper Policy

===============================================================================

-------------------------------------------------------------------------------

Shaper Policy (5)

-------------------------------------------------------------------------------

Policy : 5

Description : Description for Shaper Policy id # 5

-------------------------------------------------------------------------------

Shaper Group Name PIR CIR

-------------------------------------------------------------------------------

default max 0

===============================================================================

*A:7705:Dut-C# show qos shaper-policy 5 detail

===============================================================================

QoS Shaper Policy

===============================================================================

-------------------------------------------------------------------------------

Shaper Policy (5)

-------------------------------------------------------------------------------

Policy : 5

Description : Description for Shaper Policy id # 5

-------------------------------------------------------------------------------

Shaper Group Name PIR CIR

-------------------------------------------------------------------------------

default max 0

-------------------------------------------------------------------------------

Policy Associations

-------------------------------------------------------------------------------

Object Type Object Id Direction

-------------------------------------------------------------------------------

Port 1/10/7 access egress

Port 1/10/8 network egress

===============================================================================

*A:7705custDoc:Sar18>show>qos#

Table 67: Shaper Policy Field Descriptions

Label	Description
Policy	The ID that uniquely identifies the policy
Description	A text string that helps identify the policy’s context in the configuration file
Shaper Group Name	The name of the shaper group
PIR	The peak information rate for the shaper
CIR	The committed information rate for the shaper
Policy Associations
Object Type	The type of object using the specified shaper policy
Object Id	The identifier of the object using the specified shaper policy
Direction	The direction of traffic to which the shaper policy applies