8.4. ATM QoS Policy Command Reference

8.4.1. Command Hierarchies

8.4.1.1. Configuration Commands

config
— qos
[no] atm-td-profile traffic-desc-profile-id [create]
description description-string
[no] policing
service-category service-category
[no] shaping
traffic [sir sir-val] [pir pir-val] [mir mir-val] [mbs mbs-val] [cdvt cdvt-val]
— no traffic

8.4.1.2. Operational Commands

config
— qos
copy atm-td-profile src-prof dst-prof [overwrite]

8.4.1.3. Show Commands

show
— qos
atm-td-profile [traffic-desc-profile-id] [detail]
— service
sap-using [ingress | egress] atm-td-profile td-profile-id
sap-using [ingress | egress] qos-policy qos-policy-id

8.4.2. Command Descriptions

8.4.2.1. Configuration Commands

8.4.2.1.1. Generic Commands

description

Syntax 
description description-string
no description
Context 
config>qos>atm-td-profile
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 excluding double quotes. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

8.4.2.1.2. ATM QoS Policy Commands

atm-td-profile

Syntax 
[no] atm-td-profile traffic-desc-profile-id [create]
Context 
config>qos
Description 

This command is used to configure an ATM traffic descriptor profile as per ATM Forum Traffic Management Specification Version 4.1.

Traffic descriptor profiles are used to:

  1. define traffic management capabilities for ATM PVCCs
  2. calculate the total bandwidth consumed on a given port by all ATM PVCCs. The bandwidth taken by a PVCC is equal to:
  3. PIR for CBR PVCCs
  4. SIR for rt-vbr and nrt-vbr PVCCs
  5. MIR for UBR PVCC
  6. define ATM-level scheduling

The default traffic descriptor is preconfigured and non-modifiable. It cannot be deleted. All other traffic descriptor profiles must be explicitly created before use. The create keyword must follow each new profile configuration.

Any changes made to the existing profile, using any of the sub-commands, are applied immediately to all objects where this profile is applied (a small traffic interruption in data traffic will occur during the data plane reprogramming with the newly modified profile).

When many changes are required on a profile, it is recommended that the profile be copied to a work area profile ID. That work-in-progress profile can be modified until complete and then written over the original profile-id. Use the config>qos>copy command to maintain profiles in this manner.

The weight assigned to each non-shaped PVCC in the Deficit Round Robin Scheduler depends on the service category and traffic rates (see the traffic command for more details).

The no form of the command deletes a given traffic profile. The profile to be deleted must not be associated with any object (for example a SAP). If this condition is not met, the command will return an error.

Default 

1 — the default traffic descriptor (UBR, no traffic, no shaping)

Parameters 
traffic-desc-profile-id—
the index identifier for a traffic descriptor profile
Values—
1 to 1000

 

create—
keyword used to create an ATM traffic descriptor profile

descriptor-type

Syntax 
descriptor-type type
Context 
config>qos>atm-td-profile
Description 

This command is used to specify the type of ATM traffic descriptor profile as per ATM Forum Traffic Management Specification Version 4.1.

Default 

Table 54 defines descriptor-type default values based on service category.

Table 54:  Service Category Descriptor Type Default Values 

Service Category

Default Descriptor Type

CBR

P0_1

UBR

P0_1

UBR with MIR

P0_1

rt-VBR or nrt-VBR

P0_1and S0_1

Parameters 
type—
the ATM traffic descriptor profile type
Values—
P0_1, P0_1andS0_Tag, P0_1andS0, P0_1andS0_1
The descriptor-type command defines interpretation of traffic parameters that are specified for this profile. Table 55 details these rules.
Note:

Setting descriptor-type to a value not compatible with the service category (as defined in Table 54) results in an error message.

Table 55:  Traffic Descriptor Type Command Parameters 

Descriptor-type Value

Rates Interpretation

Applicable Service Categories

P0_1

PIR in kb/s; applies to CLP=0 and CLP=1 cell flows

MIR in kb/s; applies to CLP=0 and CLP=1 cell flows

CBR, UBR, UBR with MIR

P0_1and S0

PIR in kb/s; applies to CLP=0 and CLP=1 cell flows; non-conforming CLP=0 cell flows are discarded

SIR in kb/s; applies to CLP=0 cell flows only

rt-VBR and nrt-VBR

P0_1andS0_Tag

PIR in kb/s; applies to CLP=0 and CLP=1 cell flows; non-conforming CLP=0 cell flows are tagged to CLP=1 cell flows

SIR in kb/s; applies to CLP=0 cell flows only

rt-VBR and nrt-VBR

P0_1and S0_1

PIR in kb/s; applies to CLP=0 and CLP=1 cell flows

SIR in kb/s; applies to CLP=0 cell flows only

rt-VBR and nrt-VBR

 

policing

Syntax 
[no] policing
Context 
config>qos>atm-td-profile
Description 

This command determines whether ingress traffic is policed. Policing is valid for CBR, rt-VBR, nrt-VBR, and UBR. This policing is cell-based.

Default 

disabled

service-category

Syntax 
service-category service-category
Context 
config>qos>atm-td-profile
Description 

This command is used to configure an ATM service category attribute of an ATM traffic descriptor profile.

Default 

ubr

Parameters 
service-category—
Table 56 describes the supported ATM service categories on the 16-port T1/E1 ASAP Adapter card, 32-port T1/E1 ASAP Adapter card, 4-port DS3/E3 Adapter card, 4-port OC3/STM1 Clear Channel Adapter card, and 2-port OC3/STM1 Channelized Adapter card.
Table 56:  ATM Service Categories 

Service Category

Description

CBR

Constant Bit Rate

rt-VBR

Real-time Variable Bit Rate

nrt-VBR

Non-real-time Variable Bit Rate

UBR

Unspecified Bit Rate without Minimum Desired Cell Rate (defined by specifying service category to be ubr, and MIR of 0)

UBR (with MIR)

Unspecified Bit Rate with non-zero Minimum Desired Cell Rate (defined by specifying service category to be ubr, and MIR > 0)

Changing the service category of a profile will reset all traffic attributes to their defaults (see the traffic command) and will cause reprogramming of the data path (with a small impact on user traffic) and a reset of VC statistics for all VCs using this traffic descriptor profile.

shaping

Syntax 
[no] shaping
Context 
config>qos>atm-td-profile
Description 

This command determines whether egress shaping should occur. Shaping is only applied in the egress direction.

Default 

The default is determined by the service category. Table 57 describes default shaping values.

Table 57:  Default Shaping Values 

Applicable Service Category

Default Shaping Value

Comments

UBR

Disabled

Shaping cannot be enabled

CBR

Enabled

Shaping cannot be disabled

rt-VBR

Enabled

Shaping cannot be disabled

nrt-VBR

Enabled

Shaping cannot be disabled

traffic

Syntax 
traffic [sir sir-val [pir pir-val] [mir mir-val] [mbs mbs-val] [cdvt cdvt-val]
no traffic
Context 
config>qos>atm-td-profile
Description 

This command is used to configure traffic attributes of an ATM traffic profile as per ATM Forum Traffic Management Specification Version 4.1.

The traffic parameters of a traffic descriptor that are configurable depend on the service category of this traffic descriptor profile. (See the service-category command.)

Table 58 defines which traffic descriptor parameters are applicable for what service category and what the configuration rules are between the parameters. “Y” indicates that the parameter can be configured for a given service category and will be defaulted if not provided, and an “N/A” indicates that the parameter cannot be configured for a given service category (an error will be returned). If an applicable parameter is not specified, the current value will be preserved.

Table 58:  Service Category Traffic Descriptor Parameters 

Service Category

SIR

PIR

MBS

MIR

CDVT

CBR

N/A

Y

N/A

N/A

Y

rt-VBR

Y

Y (must be ≥ SIR)

Y

N/A

Y

nrt-VBR

Y

Y (must be ≥ SIR)

Y

N/A

Y

UBR

N/A

Y

N/A

N/A

Y

UBR with MIR

N/A

Y (must be ≥ MIR

N/A

Y (non-zero MIR specified)

Y

When a traffic descriptor profile is used to define egress scheduling, the following describes how traffic rates are used to derive scheduling weight:

The scheduling weight applies only to unshaped nrt-VBR and UBR. The scheduling weight is a value from 1 to 8. The scheduling weight is determined by the SIR value for nrt-VBR, and by the MIR value for UBR. The conversion from SIR/MIR to weight is as follows:

  1. Rate < 64K weight = 1
  2. Rate < 128K weight = 2
  3. Rate < 256K weight = 3
  4. Rate < 512K weight = 4
  5. Rate < 1024K weight = 5
  6. Rate < 1536K weight = 6
  7. Rate < 1920K weight = 7

Everything above 1920K will be assigned a weight of 8.

Since the 7705 SAR operates in cells/second with one cell granularity, PIR and SIR values programmed need to be converted to cells/second. When converting values to be used for the scheduler, the result is rounded up to the next cell when required by conversion.

When any of SIR, PIR, or MIR is greater than the physical maximum port/channel capacity for a given PVCC, then the maximum physical port/channel capacity is used in bandwidth accumulation and when configuring the hardware for that PVCC.

Hardware-enforceable MBS is in the inclusive range of 3 to 256 000 cells on all 7705 SAR ATM-capable adapter cards. Assigning an atm-td-profile with an MBS value outside of this range to a SAP is blocked. As well, once an atm-td-profile is assigned to a SAP, the CLI will block any change of the MBS value to a value outside of this range.

The no form of the command restores traffic parameters to their defaults for a given service category.

Default 

Table 59 shows the ATM traffic parameter defaults.

Table 59:  ATM Traffic Parameter Defaults 

Service Category

Traffic Parameter Defaults

CBR:

PIR

0

CDVT

250

rt-VBR and nrt-VBR

PIR

4294967295

SIR

0

MBS

32

CDVT

250

UBR (note by default UBR is without MIR)

PIR

0

CDVT

250

Parameters 
sir-val—
the Sustained Information Rate (including cell overhead) in kb/s
Values—
0 to 4294967295

 

pir-val—
the Peak Information Rate (including cell overhead) in kb/s
Values—
0 to 4294967295
 

 

mir-val—
the Minimum Desired Information Rate (including cell overhead) in kb/s
Values—
0 to 4294967295

 

mbs-val—
the Maximum Burst Size in cells
Values—
0 to 4294967295 (this range applies if the atm-td-profile is not assigned to a SAP)
3 to 256000 (this range applies if the atm-td-profile is assigned to a SAP, as described above)

 

cdvt-val—
the Cell Delay Variation Tolerance (CDVT) in microseconds
Default—
CBR/RT-VBR/NRT-VBR/UBR = 250
Values—
0 to 4294967295

 

8.4.2.2. Operational Commands

copy

Syntax 
copy atm-td-profile src-prof dst-prof [overwrite]
Context 
config>qos
Description 

This command copies the source ATM traffic descriptor profile into the destination ATM profile. If the destination profile was already defined, the keyword overwrite must be appended for the copy to complete.

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

Parameters 
src-prof dst-prof —
indicates that the source profile ID and the destination profile ID are atm-td-profile IDs. Specify the source ID that the copy command will copy and specify the destination ID to which the command will duplicate the profile.
Values—
1 to 1000

 

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

ALU-48>config>qos# copy atm-td-profile 2 10

MINOR: CLI destination (10) exists use {overwrite}.

ALU-48>config>qos# copy atm-td-profile 2 10 overwrite

ALU-48>config>qos#

8.4.2.3. Show Commands

Note:

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

atm-td-profile

Syntax 
atm-td-profile [traffic-desc-profile-id] [detail]
Context 
show>qos
Description 

This command displays ATM traffic descriptor profile information.

Parameters 
traffic-desc-profile-id—
displays the ATM traffic descriptor profile
Values—
1 to 1000

 

detail—
displays detailed policy information including policy associations
Output 

The following output is an example of ATM traffic descriptor profile information, and Table 60 describes the fields.

Output Example
*A:ALU-1>show>qos# atm-td-profile 3 detail
===============================================================================
Traffic Descriptor Profile (3)
===============================================================================
-------------------------------------------------------------------------------
TDP-id Description
       Service Cat SIR         PIR         MIR         MBS         CDVT
-------------------------------------------------------------------------------
3      ATM TD profile3
       RT-VBR      500         500         -           500         500
-------------------------------------------------------------------------------
TDP details
-------------------------------------------------------------------------------
Shaping            : enabled
Policing           : enabled
Descriptor-Type    : P0_1andS0_1
-------------------------------------------------------------------------------
Entities using TDP-3
-------------------------------------------------------------------------------
===============================================================================
*A:ALU-1>show>qos#
Table 60:  ATM Traffic Descriptor Profile Command Output 

Label

Description

Maximum Supported Profiles

The maximum number of ATM traffic descriptor profiles that can be configured on this system

Currently Configured Profiles

The number of currently configured ATM traffic descriptor profiles on this system

TDP-Id

The ID that uniquely identifies the traffic descriptor policy

Description

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

Service Category

The ATM service category

SIR

The sustained cell rate in kb/s

PIR

The peak cell rate in kb/s

MIR

The Minimum Desired Cell Rate in kb/s

MBS

The maximum burst size in cells

CDVT

The Cell Delay Variation Tolerance, in microseconds

Shaping

Whether shaping is enabled or disabled for the traffic descriptor profile

Policing

Whether policing is enabled or disabled for the traffic descriptor profile

Descriptor Type

The descriptor type for the ATM TD profile

Entities using TDP-ID

The number of entities using the ATM traffic descriptor

-

The parameter is not applicable for the configured service category

sap-using

Syntax 
sap-using [ingress | egress] atm-td-profile td-profile-id
sap-using [ingress | egress] qos-policy qos-policy-id
Context 
show>service
Description 

This command displays SAP information.

If no optional parameters are specified, the command displays a summary of all defined SAPs.

The optional parameters restrict output to only SAPs matching the specified properties.

Parameters 
ingress—
specifies matching an ingress policy
egress—
specifies matching an egress policy
qos-policy-id
identifies the ingress or egress QoS policy for which to display matching SAPs or SAP aggregation groups. SAP aggregation groups are supported only on ATM VLLs.
Values—
1 to 65535, or qos-policy-name (up to 64 characters)

 

td-profile-id
displays SAPs using the specified traffic description
Output 

The following output is an example of SAP information using the atm-td-profile parameter, and Table 61 describes the fields.

Output Example
*A:ALU-1>show>service# sap-using egress atm-td-profile 3
===============================================================================
Service Access Point Using ATM Traffic Profile 3
===============================================================================
PortId                          SvcId      Ing.  Ing.    Egr.  Egr.   Adm  Opr
                                           QoS   Fltr    QoS   Fltr
-------------------------------------------------------------------------------
No Matching Entries

The following output shows an example of SAPs and SAP aggregation groups that use the same QoS policy. SAPs that are members of a SAP aggregation group are not listed by their port identifiers but are listed under their respective group names. Table 61 describes the fields.

Output Example
*B:A:179_121# show service sap-using ingress qos-policy 1 
===============================================================================
Service Access Points Using Ingress Qos Policy 1
===============================================================================
PortId                         SvcId      Ing.  Ing.    Egr.  Egr.   Adm  Opr 
                                          QoS   Fltr    QoS   Fltr            
-------------------------------------------------------------------------------
1/1/3.1:0/100                   100        1     none    1     none   Up   Down
1/1/3.1:3/100                   100        1     none    1     none   Up   Down
1/2/5:200                       200        1     none    1     none   Up   Up  
1/1/9.1:3/300                   300        1     none    1     none   Up   Up  
bundle-ima-1/1.1:6/601          2001       1     none    1     none   Up   Up  
bundle-ima-1/1.1:6/602          2002       1     none    1     none   Up   Up
------------------------------------------------------------------------------- 
Number of SAPs: 6  
-------------------------------------------------------------------------------
==============================================================================
SAP Aggregation Groups Using Ingress Qos Policy 1
===============================================================================
Group Name                     SvcId      Ing.  Ing.    Egr.  Egr.   Adm  Opr
                                          QoS   Fltr    QoS   Fltr            
------------------------------------------------------------------------------- 
“Group Name 1”                   2003      1     n/a    1      n/a    n/a  n/a 
sap:1/1/9.1:3/301                          atm          1524   1524   Up   Up
sap:1/1/9.1:3/302                          atm          1524   1524   Up   Up
sap:1/1/9.1:3/303                          atm          1524   1524   Up   Up 
“Group Name 2”                   2004      1     n/a    1      n/a    n/a  n/a  
sap:1/1/9.1:3/304                          atm          1524   1524   Up   Up
sap:1/1/9.1:3/305                          atm          1524   1524   Up   Up
sap:1/1/9.1:3/306                          atm          1524   1524   Up   Up
-------------------------------------------------------------------------------
Number of SAP Aggregation Groups:2
-------------------------------------------------------------------------------
Table 61:  SAP Command Output 

Label

Description

Service Access Points Using ATM Traffic Profile n

Service Access Points Using Ingress Qos Policy n

PortId

The ID of the access port where the SAP is defined

SvcId

The service identifier

Ing.QoS

The SAP ingress QoS policy number specified on the ingress SAP

Ing.Fltr

The SAP ingress filter number specified on the ingress SAP

Egr.QoS

The SAP egress QoS policy number specified on the egress SAP

Egr.Fltr

The SAP egress filter number specified on the egress SAP

Adm

The administrative state of the SAP

Opr

The operational state of the SAP

Number of SAPs

The number of individual SAPs that use the specified QoS policy

SAP Aggregation Groups Using Ingress Qos Policy n

Group Name

The SAP aggregation group name identifier

SvcId

The service identifier for the group

Ing.QoS

The ingress QoS policy number specified on the ingress SAP aggregation group

Ing.Fltr

The SAP ingress filter number specified on the ingress SAP

Egr.QoS

The egress QoS policy number specified on the egress SAP aggregation group

Egr.Fltr

The SAP egress filter number specified on the egress SAP

Adm

The administrative state of the SAP in the SAP aggregation group

Opr

The operational state of the SAP in the SAP aggregation group

Number of SAP Aggregation Groups

The number of SAP aggregation groups that use the specified QoS policy