9.4. Service SAP QoS Policy Command Reference

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.

This command creates or edits the ingress policy. The ingress policy defines the Service Level Agreement (SLA) enforcement that service packets receive as they ingress a SAP; the SAP can be configured on an access port or hybrid port. SLA enforcement is accomplished through the definition of meters or queues (depends on the support available on a platform) that have Forwarding Class (FC), Committed Information Rate (CIR), Peak Information Rate (PIR), Committed Burst Size (CBS), and Maximum Burst Size (MBS) characteristics. The simplest policy defines a single queue/meter that all ingress traffic flows through. Complex policies have multiple meters/queues combined with classification entries that indicate which meter/queue a packet will flow though.

Policies in effect are templates that can be applied to multiple services as long as the scope of the policy is template. Meters defined in the policy are not instantiated until a policy is applied to a service SAP.

Depending on the support available on different 7210 SAS platforms, SAP ingress policies can be defined with either dot1p as the match criteria or IP DSCP as the match criteria or IP headers as the match criteria or MAC headers or both as the match criteria. On the 7210 SAS, the user has an option to use dot1p, IP DSCP, IPv4/IPv6 criteria and MAC criteria.

Only one service ingress policy can be provisioned. The SAP ingress policy with policy-id 1 is a system-defined policy applied to services when no other policy is explicitly specified. The system SAP ingress policy can be modified but not deleted. The no sap-ingress command restores the factory default settings when used on policy-id 1. See Default SAP-Ingress Policy for more information on the default SAP Ingress policy for different platforms.

Any changes made to the existing policy, using any of the sub-commands are applied immediately to all services where this policy is applied. For this reason, when many changes are required on a policy, it is recommended that the policy be copied to a work area policy ID. That work-in-progress policy can be modified until complete and then written over the original policy ID. Use the config qos copy command to maintain policies in this manner.

Note: A SAP ingress policy with multiple criteria can be associated with the SAP. The system defines a match-order to match against the classification rules specified in the policy. Please see the QoS overview section to know more about the match order. Before using IPv4, IPv6 and MAC match criteria, resources must be allocated using the CLI command config>system>resource-profile>ingress-internal-tcam>qos-sap-ingress-resource. Refer to the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Basic System Configuration Guide for information about resource allocation. See Service Ingress QoS Policies for more information about this CLI command. Service ingress only queues with shapers are supported.

The no form of this command deletes the SAP ingress policy. A policy cannot be deleted until it is removed from all services where it is applied. The system default SAP ingress policy is a special case; the no command restores the factory defaults to policy ID 1.

This command associates a dot1p classification policy, which contains entries used to map traffic received on a hybrid port or SAP to a forwarding class and profile state, based on the dot1p bits in the packet.

When it is defined in a service ingress QoS policy and associated with an access SAP ingress, a packet received on the SAP is used to match with the dot1p values defined in this policy. If a match is found, the corresponding forwarding class and profile are assigned to the packet.

The no form of this command disables use of dot1p classification policy.

This command associates an IP DSCP classification policy, which contains entries used to map traffic received on a SAP to a forwarding class and profile state, based on the IP DSCP bits in the packet.

When it is defined in a service ingress QoS policy and associated with an access SAP ingress, a packet received on the SAP is used to match with the IP DSCP values defined in this policy. If a match is found, the corresponding forwarding class and profile are assigned to the packet.

The no form of this command disables use of DSCP classification policy.

This command configures the Service Ingress QoS policy scope as exclusive or template.

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

This command configures the default forwarding class for the policy. In the event that an ingress packet does not match a higher priority (more explicit) classification command, the default forwarding class will be associated with the packet. Unless overridden by an explicit forwarding class classification rule, all packets received on an ingress SAP using this ingress QoS policy will be classified to the default forwarding class.

The default forwarding class is best effort (be). The default-fc settings are displayed in the show configuration and save output regardless of inclusion of the detail keyword.

This command enables DEI based classification. When enabled, the packet classified to this FC the DEI bit is used to determine the ingress profile for the packet. Packets received with DEI bit set to zero are treated as in-profile and packets with DEI bit set to one are treated as out-of-profile packets.

When DEI based classification is enabled, it overrules the profile values specified in the classification entry used to assign the FC.

The no form of this command disables use of DEI bit for classification of packets.

The fc command creates a class instance of the forwarding class fc-name. Once the fc-name is created, classification actions can be applied and can be used in match classification criteria.

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

This command overrides the default multicast forwarding type queue mapping for fc fc-name. The specified queue ID must exist within the policy as a multipoint queue before the mapping can be made. Once the forwarding class mapping is executed, all broadcast, unknown unicast, and multicast (BUM) traffic on a SAP or a access-uplink port using this policy is forwarded using the queue ID.

The no form of this command removes the association of the FC and the queue. Once the no form is executed, the BUM traffic uses the default multicast forwarding type queue.

This command enables the context to create or edit policy entries that specify IP criteria used to match supported fields from the IP packet header, including IP DSCP.

IP criteria-based SAP ingress policies are used to select the forwarding class for matched traffic.

The 7210 SAS implementation will exit on the first match found and execute the actions in accordance with the accompanying action command. For this reason entries must be sequenced correctly from most to least explicit.

Note: Before associating a SAP ingress policy configured to use IPv4 criteria with a SAP, resources must be allocated to it. Refer to the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Basic System Configuration Guide for more information about this CLI command and resource allocation.

The no form of this command deletes all the entries specified under this node. Once IP criteria entries are removed from a SAP ingress policy, the IP criteria is removed from all services where that policy is applied.

This command enables the context to create or edit policy entries that specify IPv6 criteria such as IP quintuple lookup or DiffServ code point.

IPv6 criteria-based SAP ingress policies are used to select the forwarding class for matched traffic.

The 7210 SAS implementation will exit on the first match found and execute the actions in accordance with the accompanying action command. For this reason entries must be sequenced correctly from most to least explicit.

Note: Before associating a SAP ingress policy configured to use IPv6 criteria with a SAP, resources must be allocated to it. Refer to the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Basic System Configuration Guide for more information about this CLI command and resource allocation.

The no form of this command deletes all the entries specified under this node. Once ipv6-criteria entries are removed from a SAP ingress policy, the ipv6-criteria is removed from all services where that policy is applied.

This command enables the context to create or edit policy entries that specify MAC criteria.

The MAC criteria-based SAP ingress policies are used to select the forwarding class for matched traffic.

The 7210 SAS implementation will exit on the first match found and execute the actions in accordance with the accompanying action command. For this reason entries must be sequenced correctly from most to least explicit.

Note: Before associating a SAP ingress policy configured to use MAC criteria with a SAP, resources must be allocated to it. Refer to the 7210 SAS-D, Dxp, K 2F1C2T, K 2F6C4T, K 3SFP+ 8C Basic System Configuration Guide for more information about this CLI command and resource allocation.

The no form of this command deletes all the entries specified under this node. Once mac-criteria entries are removed from a SAP ingress policy, the mac-criteria is removed from all services where that policy is applied.

This command overrides the default unicast forwarding type queue mapping for fc fc-name. The specified queue ID must exist within the policy as a non-multipoint queue before the mapping can be made. Once the forwarding class mapping is executed, all unicast traffic (this includes all traffic, even broadcast and multicast for services) on a SAP or an access-uplink port using this policy is forwarded using the queue ID.

The no form of this command sets the unicast (point-to-point) queue ID back to the default queue for the forwarding class (queue 1).

This command overrides the default multicast forwarding type queue mapping for fc fc-name. The specified meter-id must exist within the policy before the mapping can be made. Once the forwarding class mapping is executed, all broadcast, unknown unicast, and multicast (BUM) traffic on an access SAP using this policy is forwarded using the meter ID.

The default multicast forwarding type queue is the default unicast queue (queue 1). In other words, if no multicast meter is assigned to a FC, it uses default queue 1.

The no form of this command removes the association of the FC and the meter. Once the no form is executed, the BUM traffic uses the default multicast forwarding type queue (queue 1).

This command overrides the default unicast forwarding type queue mapping for fc fc-name. The specified meter-id must exist within the policy before the mapping can be made. Once the forwarding class mapping is executed, all unicast traffic (this includes all traffic, even broadcast and multicast for services) on an access SAP using this policy is forwarded using the meter ID.

The no form of this command sets the unicast (point-to-point) traffic type back to the default queue for the forwarding class (queue 1).

This mandatory command associates the forwarding class with specific IP or MAC criteria entry ID. The action command supports setting the forwarding class parameter. Packets that meet all match criteria within the entry have their forwarding class overridden based on the parameters included in the action parameters.

The action command must be executed for the match criteria to be added to the active list of entries.

Each time action is executed on a specific entry ID, the previous entered values for fc fc-name is overridden with the newly defined parameters.

The no form of this command removes the entry from the active entry list. Removing an entry on a policy immediately removes the entry from all SAPs using the policy. All previous parameters for the action is lost.

This command enables the context to create or edit an IP or MAC criteria entry for the policy. Multiple entries can be created using unique entry-id numbers.

The list of flow criteria is evaluated in a top down fashion with the lowest entry ID at the top and the highest entry ID at the bottom. If the defined match criteria for an entry within the list matches the information in the egress packet, the system stops matching the packet against the list and performs the matching entries reclassification actions. If none of the entries match the packet, the IP flow reclassification list has no effect on the packet.

An entry is not populated in the list unless the action command is executed for the entry. An entry that is not populated in the list has no effect on egress packets. If the action command is executed without any explicit reclassification actions specified, the entry is populated in the list allowing packets matching the entry to exit the list, preventing them from matching entries lower in the list. Since this is the only flow reclassification entry that the packet matched and this entry explicitly states that no reclassification action is to be performed, the matching packet will not be reclassified.

The no form of this command removes the specified entry from the policy. Entries removed from the policy are immediately removed from all services where that policy is applied.

This command creates a context to configure match criteria for SAP ingress QoS policy match criteria. When the match criteria have been satisfied, the action associated with the match criteria is executed.

If more than one match criteria (within one match statement) are configured then all criteria must be satisfied (AND function) before the action associated with the match will be executed.

A match context can consist of multiple match criteria, but multiple match statements cannot be entered per entry.

The no form of this command removes the match criteria for the entry-id.

This command enables the context to create and edit match MAC criteria for ingress SAP QoS policy match criteria. When the match criteria have been satisfied the action associated with the match criteria is executed.

If more than one match criteria (within one match statement) are configured then all criteria must be satisfied (and function) before the action associated with the match will be executed.

A match context can consist of multiple match criteria, but multiple match statements cannot be entered per entry.

The no form of this command removes the match criteria for the entry-id.

This command enables the context to configure match criteria for ingress SAP QoS policy match IPv6 criteria. When the match criteria have been satisfied the action associated with the match criteria is executed.

If more than one match criteria (within one match statement) are configured, then all criteria must be satisfied (and function) before the action associated with the match is executed.

A match context can consist of multiple match criteria, but multiple match statements cannot be entered per entry.

The no form of this command removes the match criteria for the entry-id.

This command configures a destination MAC address or range to be used as a Service Ingress QoS policy match criterion.

The no form of this command removes the destination mac address as the match criterion.

This command configures an Ethernet type II value for use as a service ingress QoS policy match criterion.

The Ethernet type field is a two-byte field used to identify the protocol carried by the Ethernet frame. For example, 0800 is used to identify IPv4 packets.

The Ethernet type field is used by the Ethernet version-II frames. IEEE 802.3 Ethernet frames use the dsap, ssap or snap-pid fields as match criteria; the Ethernet type field is not used.

The snap-pid, etype, ssap, and dsap fields are mutually exclusive and cannot be part of the same match criteria.

The dataplane processes a maximum of two VLAN tags in a received packet. The Ethertype used in the MAC matching criteria for ACLs is the Ethertype that is found in the packet after processing single-tagged frames, double-tagged frames, and no-tag frames

The packet is considered to have no tags if at least one of the following criteria is true:

The packet is considered to have a single tag if at least one of the following criteria is true:

The packet is considered to have double tags if at least one of the following criteria is true:

The no form of this command removes the previously entered etype field as the match criteria.

This command configures the dot1p value to be used as a service ingress QoS policy match criterion to match against the dot1p value in the inner tag (the one that follows the outermost tag in the packet) of the received packet.

The no form of this command removes the previously entered dot1p value as the match criteria.

This command configures the VLAN value to be used as a service ingress QoS policy match criterion to match against the VLAN value in the inner tag (the one that follows the outermost tag in the packet) of the received packet.

The no form of this command removes the previously entered VLAN tag value as the match criteria.

This command configures the dot1p value to be used as a service ingress QoS policy match criterion to match against the dot1p value in the outermost tag of the received packet.

The no form of this command removes the previously entered dot1p value as the match criteria.

This command configures the VLAN value to be used as a service ingress QoS policy match criterion to match against the VLAN value in the outermost tag in the packet of the received packet.

The no form of this command removes the previously entered VLAN tag value as the match criteria.

This command configures a source MAC address or range to be used as a service ingress QoS policy match criterion.

The no form of this command removes the source mac as the match criteria.

This command enables the context to create a queue and modify queue parameters associated with a particular queue. The queue-ID to FC map is user-defined.

The 7210 SAS-K 2F1C2T and 7210 SAS-K 2F6C4T support two, four, six, or eight queues per SAP. The 7210 SAS-K 3SFP+ 8C supports four or eight queues per SAP

The no form of this command removes the queue.

This command enables the context to modify meter parameters associated with a particular meter. The queue-ID to FC map is user-defined.

The no form of this command remove the meter definition.

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 cir and pir apply.

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.

This command specifies the CBS value (minimum depth of the queue).

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

This command specifies the CBS value of the meter. The committed burst 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 out-profile by the meter to indicate that the traffic is complying with the meter-configured CIR rate.

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

This command specifies the MBS value (maximum depth of the queue).

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

This command specifies the MBS value of the meter. The maximum burst size parameter specifies the maximum burst size that can be transmitted by the source while still complying with the PIR. If the transmitted burst is lower than the MBS value, the packets are marked as out-profile by the meter to indicate that the traffic is complying with the meter-configured PIR rate.

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

This command defines the queue priority. The queue priority is used by the scheduler to determine the order of service in both the within-cir loop and within-pir loop. Higher priority queues are serviced before lower priority queues.

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

This command defines the mode of the meter. The mode can be configured as Two Rate Three Color Marker (trTCM) or Single Rate Three Color Marker (srTCM). The mode command can be executed at any time.The no form of this command sets it to default mode.

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

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

This command defines the administrative Peak Information Rate (PIR) and the administrative Committed Information Rate (CIR) parameters for the meter. The PIR defines the maximum rate at which the meter can admit the packet into the system for forwarding. Defining a PIR does not necessarily guarantee that the queue can transmit at the intended rate. The actual rate sustained by the flow can be limited by oversubscription factors or available egress bandwidth.

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.

The no form of this command returns all meters created with the meter-id by association with the QoS policy to the default PIR and CIR parameters (max, 0).