YANG Models for Quality of Service (QoS)
draft-ietf-rtgwg-qos-model-11
draft-ietf-rtgwg-qos-model-11
Network Working Group A. Choudhary
Internet-Draft Aviatrix Systems
Intended status: Standards Track M. Jethanandani
Expires: 25 January 2024 Kloud Services
E. Aries
Juniper Networks
I. Chen
The MITRE Corporation
24 July 2023
YANG Models for Quality of Service (QoS)
draft-ietf-rtgwg-qos-model-11
Abstract
This document describes a YANG model for configuration and
operational data of Quality of Service (QoS) in network devices.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 25 January 2024.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
Choudhary, et al. Expires 25 January 2024 [Page 1]
Internet-Draft YANG Models for QoS July 2023
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Note to RFC Editor . . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
1.3. Definitions and Acronyms . . . . . . . . . . . . . . . . 4
2. QoS Model Design . . . . . . . . . . . . . . . . . . . . . . 5
3. DiffServ Model Design . . . . . . . . . . . . . . . . . . . . 7
3.1. A Single Rate Three Color Marker . . . . . . . . . . . . 7
3.2. A Two Rate Three Color Marker . . . . . . . . . . . . . . 8
4. YANG Modules . . . . . . . . . . . . . . . . . . . . . . . . 8
4.1. Traffic Policy Module . . . . . . . . . . . . . . . . . . 8
4.2. QoS Action Module . . . . . . . . . . . . . . . . . . . . 14
4.3. DiffServ Module . . . . . . . . . . . . . . . . . . . . . 29
4.4. QoS Operational Module . . . . . . . . . . . . . . . . . 42
4.5. Scheduler Policy Module . . . . . . . . . . . . . . . . . 52
4.6. Queue Policy Module . . . . . . . . . . . . . . . . . . . 56
4.7. IANA QoS Types Module . . . . . . . . . . . . . . . . . . 59
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 67
5.1. URI Registration . . . . . . . . . . . . . . . . . . . . 67
5.2. YANG Module Name Registration . . . . . . . . . . . . . . 68
6. Security Considerations . . . . . . . . . . . . . . . . . . . 69
7. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 70
8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 70
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 70
9.1. Normative References . . . . . . . . . . . . . . . . . . 70
9.2. Informative References . . . . . . . . . . . . . . . . . 71
Appendix A. Complete tree Diagrams . . . . . . . . . . . . . . . 72
A.1. Traffic Policy Module Tree Diagram . . . . . . . . . . . 72
A.2. QoS Action Module Tree Diagram . . . . . . . . . . . . . 73
A.3. DiffServ Module Tree Diagram . . . . . . . . . . . . . . 75
A.4. QoS Operational Module Tree Diagram . . . . . . . . . . . 80
A.5. Scheduler Policy Module Tree Diagram . . . . . . . . . . 82
A.6. Queue Policy Module Tree Diagram . . . . . . . . . . . . 83
Appendix B. Company A and Company B examples . . . . . . . . . . 85
B.1. Example of Company A DiffServ Model . . . . . . . . . . . 85
B.2. Example of Company B DiffServ Model . . . . . . . . . . . 90
Appendix C. Configuration examples . . . . . . . . . . . . . . . 101
C.1. Configuration example for QoS Classifier . . . . . . . . 101
Choudhary, et al. Expires 25 January 2024 [Page 2]
Internet-Draft YANG Models for QoS July 2023
C.2. Configuration example for QoS Policy . . . . . . . . . . 102
C.3. Configuration example for QoS Policing . . . . . . . . . 103
C.4. Configuration example for QoS Queueing . . . . . . . . . 105
C.5. Configuration example for QoS Scheduling . . . . . . . . 108
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 111
1. Introduction
This document defines a YANG 1.1 [RFC7950] model for Quality of
Service (QoS) configuration and statistics parameters. Traffic
Policy module defines the basic building blocks to define a
classifier, policy and target. QoS Action module defines QoS action
related parameters. Traffic policy is augmented to include packet
match and action parameters to define the Differentiated Services
(DiffServ) policy, Queues policy and Scheduler policy. Each of these
policies are defined as separate modules. The DiffServ module is
based on DiffServ architecture, and various references have been made
to available standard architecture documents. QoS statistics
counters are defined in QoS Operational module.
DiffServ is a preferred approach for network service providers to
offer services to different customers based on their network Quality-
of-Service (QoS) objectives. The traffic streams are differentiated
based on DiffServ Code Points (DSCP) carried in the IP header of each
packet. The DSCP markings are applied by upstream node or by the
edge router on entry to the DiffServ network.
The YANG modules in this document conform to the Network Management
Datastore Architecture (NMDA) [RFC8342].
Tree diagrams used in this document follow the notation defined in
YANG Tree Diagrams [RFC8340].
1.1. Note to RFC Editor
Editorial Note: (To be removed by RFC Editor)
This draft contains several placeholder values that need to be
replaced with finalized values at the time of publication. Please
apply the following replacements:
* "XXXX" --> the assigned RFC value for this draft both in this
draft and in the yang modules under the revision statement.
* The "revision" date in model, in the format XXXX-XX-XX, needs to
be updated with the date the draft gets approved.
Choudhary, et al. Expires 25 January 2024 [Page 3]
Internet-Draft YANG Models for QoS July 2023
1.2. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
1.3. Definitions and Acronyms
This document uses definitions and acronyms defined in Definitions of
the Differentiated Services Field (DS Field) in the IPv4 and IPv6
Headers [RFC2474], An Architecture for Differentiated Services
[RFC2475], and other documents. Here are some of them.
* Active Queue Management (AQM): An activity that marks or drops
packets before the queue is full.
* Behavior Aggregate (BA): A DS behavior aggregate.
* Classifier: an entity which selects packets based on the content
of packet headers according to defined rules.
* DS behavior aggregate: A collection of packets with the same DS
codepoint crossing a link in a particular direction.
* DS code point: A specific value of the DSCP portion of the DS
field, used to select a PHB.
* DiffServ: Differentiated Services enhancements to the Internet
protocol are intended to enable scalable service discrimination in
the Internet without the need for per-flow state and signaling at
every hop. A variety of services may be built from a small, well-
defined set of building blocks which are deployed in network
nodes.
* DSCP: Differentiated Services Code Point
* ECN: Explicit Congestion Notification
* Marking: the process of setting the DS codepoint in a packet based
on defined rules; pre-marking, re-marking.
* Metering: the process of measuring the temporal properties (e.g.,
rate) of a traffic stream selected by a classifier. The
instantaneous state of this process may be used to affect the
operation of a marker, shaper, or dropper, and/or may be used for
accounting and measurement purposes.
Choudhary, et al. Expires 25 January 2024 [Page 4]
Internet-Draft YANG Models for QoS July 2023
* MF Classifier: A multi-field (MF) classifier which selects packets
based on the content of some arbitrary number of header fields;
typically some combination of source address, destination address,
DS field, protocol ID, source port and destination port.
* Per-Hop-Behavior (PHB): The externally observable forwarding
behavior applied at a DS-compliant node to a DS behavior
aggregate.
* Policing: the process of discarding packets (by a dropper) within
a traffic stream in accordance with the state of a corresponding
meter enforcing a traffic profile.
* RED: Random Early Detection
* Shaping: the process of delaying packets within a traffic stream
to cause it to conform to some defined traffic profile.
* Traffic-Group: is a metadata stored in a packet buffer.
* WRED: Weighted Random Early Detection
2. QoS Model Design
The overall objective of this model design is to offer a base set of
modules that can then be further augmented to provide other models,
such as Differentiated Services (DiffServ) and Policy Based Routing
(PBR). Those models would augment the base modules defined in this
draft to define their own model. This document defines one such
model, DiffServ. The design also takes into consideration that
vendors might want to extend the model to add their own extensions,
such as to extend Traffic Policy module, to provide constructs of
policy for different QoS functionalities."
------------- ------------ ------------ ------------
| | | | | | | |
| DiffServ | | Queue | | Scheduling | | QoS |
| Policy | | Policy | | Policy | | Oper |
| | | | | | | |
------------- ------------ ------------ ------------
------------- ------------------------------------------
| | | |
| QoS Action | | Traffic Policy |
| | | (Base Policy, Classifier, Target) |
| | | |
------------- ------------------------------------------
Figure 1: QoS Yang Modules Layout
Choudhary, et al. Expires 25 January 2024 [Page 5]
Internet-Draft YANG Models for QoS July 2023
The above diagram depicts the design of the QoS model. It uses
Traffic Policy and QoS Action as base modules, which are augmented by
the remaining modules on the top to define different aspects of QoS.
The Classifier is defined as part of Traffic Policy Module. A
classifier consists of set of filters and an operation that is
performed on those filters. Each filter defines a rule on a
particular packet header or packet metadata field that dictate how
the packet will be classified based on that particular field, e.g.
whether it will be classified based on DSCP, or will be classified
based on source IPv4 address prefix. The operation defines whether
these filters are logically AND or OR. The filters may be based on a
combination of values or range of values of different packet header
fields or packet metadata fields. An example of how these filter
definitions are used can be seen in the DiffServ model. The DiffServ
model augments the filter node in the Classifier to add in DiffServ
specific filter parameters.
One or more packet conditioning functions may be applied to a
classifier which may drop, mark, or delay packets. These are defined
in the QoS Action module. A set of classifiers with corresponding
conditioning functions when arranged in order of priority represent a
QoS policy. These policies are defined in Traffic Policy module.
The QoS Action module defines marking, metering and queuing. QoS
actions are configured in line or referred to in DiffServ, Queuing,
and Scheduling Policy modules.
A Meter meters each packet and passes the packet and the metering
result to the Marker. Meter is modeled based on commonly used
algorithms in industry, A Single Rate Three Color Marker (srTCM)
[RFC2697], A Two Rate Three Color Marker (trTCM) [RFC2698], and A
Single Rate Two Color Marker. Different vendors can extend it with
other types of meters as well. Meter is defined in QoS Action
module.
Queue Policy module allows queues to be referred in a policy. The
match is based on traffic group and action parameters are used as
defined in QoS Action module.
Scheduling Policy module defines a set of scheduling parameters and
associates Queue Policy with it.
Choudhary, et al. Expires 25 January 2024 [Page 6]
Internet-Draft YANG Models for QoS July 2023
QoS counters are defined in QoS Operational module. It includes
counters for Classifiers, Meters and Queues associated with a QoS
policy applied in each direction of traffic. To modularize and for
reusability, grouping have been defined for various counters of
Classifier, Meters and Queues. The target is assumed to be interface
but the groupings can be used for any other target type where QoS
policy is applied.
3. DiffServ Model Design
Definition of the Differentiated Services Field (DS Field) in the
IPv4 and IPv6 Headers [RFC2475] describes the architecture as a
simple model where traffic entering a network is classified and
possibly conditioned at the boundary of the network and assigned a
different Behavior Aggregate (BA). Each BA is identified by a
specific value of DSCP, and is used to select a Per Hop Behavior
(PHB).
The packet classification policy identifies the subset of traffic
which may receive a DiffServ by being conditioned or mapped. Packet
classifiers select packets within a stream based on the content of
some portion of the packet header. There are two types of
classifiers, the BA classifier, and the Multi-Field (MF) classifier
which selects packets based on a value which is combination of one or
more header fields. In the DiffServ Policy module, this is realized
by augmenting the classifier in Traffic Policy module.
Traffic conditioning includes metering, shaping and/or marking. A
Meter is used to measure the traffic against a given traffic profile.
The traffic profile specifies the temporal property of the traffic.
A packet that arrives is first determined to be in or out of the
profile, which will result in the action of marked, dropped or
shaped. This is realized in vendor specific modules based on the
parameters defined in action module. The metering parameters are
augmented to the QoS policy module when metering is defined inline,
and to the metering template when metering profile is referred in
policy module.
3.1. A Single Rate Three Color Marker
This document defines support for A Single Rate Three Color Marker
(srTCM) [RFC2697], which is one of the components in a An
Architecture for Differentiated Services [RFC2475]. The srTCM meters
a traffic stream and marks its packets according to three traffic
parameters, Committed Information Rate (CIR), Committed Burst Size
(CBS), and Excess Burst Size (EBS), to be either green, yellow, or
red. A packet is marked green if it doesn't exceed the CBS, yellow
if it does exceed the CBS, but not the EBS, and red otherwise.
Choudhary, et al. Expires 25 January 2024 [Page 7]
Internet-Draft YANG Models for QoS July 2023
3.2. A Two Rate Three Color Marker
This document defines support for A Two Rate Three Color Marker
(trTCM) [RFC2698], which is one of the components in a An
Architecture for Differentiated Services [RFC2475]. The trTCM meters
a traffic stream and marks its packets according to two rates, Peak
Information Rate (PIR), the Committed Information Rate (CIR), and
their associated burst sizes to either green, yellow, or red. A
packet is marked red if it exceeds the PIR. Otherwise, it is marked
yellow or green depending on whether it exceeds or does not exceed
the CIR.
4. YANG Modules
Modules defined in this draft import definitions from Common YANG
Data Types [RFC6991] and A YANG Data Model for Interface Management
[RFC8343].
4.1. Traffic Policy Module
Traffic Policy module contains list of classifiers identified by a
classifier name. Each classifier MAY contain a list of filters.
This module also contains list of policy objects identified by a
policy name and policy type which MUST be provided. Policy-type is
of type identity and is populated in a vendor specific manner. With
different values of policy types, each vendor MAY define their own
construct of policy for different QoS functionalities. Each vendor
MAY augment classifier entry in a policy definition with a set of
actions.
The module also augments A YANG Data Model for Interface Management
[RFC8343] module to add a target policy. A single policy of a
particular policy-type can be applied on an interface in each
direction of traffic.
Choudhary, et al. Expires 25 January 2024 [Page 8]
Internet-Draft YANG Models for QoS July 2023
module: ietf-traffic-policy
+--rw classifiers
| +--rw classifier* [name]
| +--rw name string
| +--rw description? string
| +--rw filter-operation? qos-types:match-operation-type
| +--rw filter* [type logical-not]
| ...
+--rw policies
+--rw policy* [name type]
+--rw name string
+--rw type identityref
+--rw description? string
+--rw classifier* [name]
...
augment /if:interfaces/if:interface:
+--rw qos-target-policy* [direction type]
+--rw direction identityref
+--rw type identityref
+--rw name string
Figure 2: ietf-traffic-policy abridged tree diagram
<CODE BEGINS> file "ietf-traffic-policy@2023-07-20.yang"
module ietf-traffic-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-traffic-policy";
prefix traffic-policy;
import ietf-interfaces {
prefix if;
}
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Data Models for Quality of Service (QoS).";
}
organization
"IETF Routing Area Working Group.";
contact
"WG Web: <https://datatracker.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:achoudhary@aviatrix.com>
Choudhary, et al. Expires 25 January 2024 [Page 9]
Internet-Draft YANG Models for QoS July 2023
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains a collection of YANG definitions for
configuring QoS Traffic Policies.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial version.";
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
grouping filters {
description
"Filters types in a Classifier entry.";
leaf type {
type identityref {
base qos-types:filter-type;
}
description
"This leaf defines the type of filter.";
}
leaf logical-not {
type boolean;
description
"This is logical-not operator for filter values and/or value
ranges. When true, it indicates filter looks for absence
of values and/or value ranges defined by the filter.";
}
}
Choudhary, et al. Expires 25 January 2024 [Page 10]
Internet-Draft YANG Models for QoS July 2023
grouping generic-classifier-attr {
description
"Generic Classifier attributes like name,
description, operation type.";
leaf name {
type string;
description
"A unique name for Classifier entry.";
}
leaf description {
type string;
description
"Description statement for classifier entry.";
}
leaf filter-operation {
type qos-types:match-operation-type;
description
"match-any or match-all filters.";
}
}
grouping inline-attr {
description
"Attributes of inline classifier in a policy.";
leaf filter-operation {
type qos-types:match-operation-type;
description
"match-any or match-all filters.";
}
list filter {
key "type logical-not";
uses filters;
description
"Filters configured inline in a policy.";
}
}
container classifiers {
description
"List of classifier entries.";
list classifier {
key "name";
Choudhary, et al. Expires 25 January 2024 [Page 11]
Internet-Draft YANG Models for QoS July 2023
description
"Each classifier entry contains a list of filters.";
uses generic-classifier-attr;
list filter {
key "type logical-not";
uses filters;
description
"Filter entries for a classifier.";
}
}
}
container policies {
description
"List of policy templates.";
list policy {
key "name type";
description
"Policy template.";
leaf name {
type string;
description
"A unique name for the policy.";
}
leaf type {
type identityref {
base qos-types:policy-type;
}
description
"The type of policy.";
}
leaf description {
type string;
description
"A description for policy.";
}
list classifier {
key "name";
ordered-by user;
description
"Classifier configuration in a policy.";
Choudhary, et al. Expires 25 January 2024 [Page 12]
Internet-Draft YANG Models for QoS July 2023
leaf name {
type string;
description
"A unique name for classifier entry.";
}
container inline {
presence "This container is present for when the device
is configured for inline classification.";
uses inline-attr;
description
"Container for when an inline classification
is desired.";
}
list action {
key "type";
ordered-by user;
description
"List of action for a Classifier.";
leaf type {
type identityref {
base qos-types:action-type;
}
description
"Type of action.";
}
}
}
}
}
augment "/if:interfaces/if:interface" {
description
"Augments Interface module to add Target Entry.";
list qos-target-policy {
key "direction type";
description
"Policy target for inbound or outbound direction.";
leaf direction {
type identityref {
base qos-types:direction;
}
description
Choudhary, et al. Expires 25 January 2024 [Page 13]
Internet-Draft YANG Models for QoS July 2023
"Direction of the traffic flow either inbound or
outbound.";
}
leaf type {
type identityref {
base qos-types:policy-type;
}
description
"Policy type.";
}
leaf name {
type string;
mandatory true;
description
"A unique name for the Policy.";
}
}
}
}
<CODE ENDS>
Figure 3: ietf-traffic-policy module
4.2. QoS Action Module
QoS Action module includes actions such marking, metering, or
queuing. Metering, marking, queuing, and scheduling actions are
realized by augmenting the Traffic Policy module. Marking sets
DiffServ codepoint value in the classified packet.
module: ietf-qos-action
+--rw meters
| +--rw meter* [name]
| +--rw name string
| +--rw (meter-types)?
| ...
+--rw queues
+--rw queue* [name]
+--rw name string
+--rw queue
...
Figure 4: ietf-qos-actions abridged tree diagram
Choudhary, et al. Expires 25 January 2024 [Page 14]
Internet-Draft YANG Models for QoS July 2023
<CODE BEGINS>
file "ietf-qos-action@2023-07-20.yang"
module ietf-qos-action {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-qos-action";
prefix qos-action;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Model for QoS";
}
organization
"IETF Routing Area Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:achoudhary@aviatrix.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains a collection of YANG definitions for
configuring QoS actions.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
Choudhary, et al. Expires 25 January 2024 [Page 15]
Internet-Draft YANG Models for QoS July 2023
description
"Initial version";
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
grouping rate-value-unit {
leaf value {
type uint64;
description
"Value for the rate that is configured, either in
bits-per-second or percentage.";
}
leaf unit {
type identityref {
base qos-types:rate-unit-type;
}
default qos-types:bits-per-second;
description
"The unit for the value above, either in bits-per-second or
percentage.";
}
description
"Grouping for configuration of value and unit.";
}
grouping meter-action {
description
"Configuration of meter actions.";
leaf action-type {
type identityref {
base qos-types:meter-action-type;
}
description
"Action type for metering.";
}
leaf dscp-mark {
type inet:dscp;
must "../action-type = 'qos-types:action-mark'" {
error-message
"DSCP must be marked when action-type is action-mark.";
}
description
"DSCP marking";
}
Choudhary, et al. Expires 25 January 2024 [Page 16]
Internet-Draft YANG Models for QoS July 2023
leaf traffic-group-mark {
type string;
must "../action-type = 'qos-types:action-mark'" {
error-message
"Traffic-group must be marked when action-type is
action-mark.";
}
description
"A unique name to mark as a traffic group.";
}
}
grouping single-rate-two-color-meter {
container single-rate-two-color-meter {
description
"A container for Basic Single Rate Two Color Marker.";
leaf committed-information-rate {
type uint64;
units "bytes-per-second";
description
"The value for Committed Information Rate (CIR).";
}
leaf committed-burst-size {
type uint64;
units "bytes";
description
"The value for Committed Burst Size (CBS).";
}
container conform-action {
uses meter-action;
description
"A packet is marked conforming, or green if it does not
exceed CIR.";
}
container exceed-action {
uses meter-action;
description
"A packet is marked exceeding, or yellow if it does
exceed CIR.";
}
}
description
"A Basic Single Rate Two Color Meter.";
}
Choudhary, et al. Expires 25 January 2024 [Page 17]
Internet-Draft YANG Models for QoS July 2023
grouping single-rate-three-color-meter {
container single-rate-three-color-meter {
description
"Container that defines the Single Rate Three Color Meter
(srTCM).";
leaf committed-information-rate {
type uint64;
units "bytes-per-second";
description
"The value for Committed Information Rate (CIR).";
reference
"RFC 2697: A Single Rate Three Color Marker.";
}
leaf committed-burst-size {
type uint64;
units "bytes";
description
"The value for Committed Burst Size (CBS).";
reference
"RFC 2697: A Single Rate Three Color Marker.";
}
leaf excess-burst-size {
type uint64;
units "bytes";
description
"The value for Excess Burst Size (EBS).";
reference
"RFC 2697: A Single Rate Three Color Marker.";
}
container conform-action {
uses meter-action;
description
"A packet is marked conforming, or green if it does not
exceed CBS.";
reference
"RFC 2697: A Single Rate Three Color Marker.";
}
container exceed-action {
uses meter-action;
description
"A packet is marked exceeding, or yellow if it does
exceed CBS, but not the EBS.";
reference
Choudhary, et al. Expires 25 January 2024 [Page 18]
Internet-Draft YANG Models for QoS July 2023
"RFC 2697: A Single Rate Three Color Marker.";
}
container violate-action {
uses meter-action;
description
"A packet is marked violating, or red if it is exceeds
both CBS and EBS.";
reference
"RFC 2697: A Single Rate Three Color Marker.";
}
}
description
"Singe Rate Three Color Meter (srTCM).";
reference
"RFC 2697: A Single Rate Three Color Marker.";
}
grouping two-rate-three-color-meter {
container two-rate-three-color-meter {
description
"A container that defines A Two Rate Three Color Meter
(trTCM).";
leaf committed-information-rate {
type uint64;
units "bytes-per-second";
description
"The value for Committed Information Rate (CIR).";
reference
"RFC 2698: A Two Rate Three Color Marker.";
}
leaf committed-burst-size {
type uint64;
units "bytes";
description
"The value for Committed Burst Size (CBS).";
reference
"RFC 2698: A Two Rate Three Color Marker.";
}
leaf peak-information-rate {
type uint64;
units "bytes-per-second";
description
"The value for Peak Information Rate (PIR).";
reference
Choudhary, et al. Expires 25 January 2024 [Page 19]
Internet-Draft YANG Models for QoS July 2023
"RFC 2698: A Two Rate Three Color Marker.";
}
leaf peak-burst-size {
type uint64;
units "bytes";
description
"The value for Peak Burst Size (PBS).";
reference
"RFC 2698: A Two Rate Three Color Marker.";
}
container conform-action {
uses meter-action;
description
"A packet is marked conforming, or green, if it does not
exceed CIR.";
reference
"RFC 2698: A Two Rate Three Color Marker.";
}
container exceed-action {
uses meter-action;
description
"A packet is marked exceeding, or yellow, if it exceeds
CIR but not PIR.";
reference
"RFC 2698: A Two Rate Three Color Marker.";
}
container violate-action {
uses meter-action;
description
"A packet is marked as violating, or red, if it exceeds
both CIR and PIR.";
reference
"RFC 2698: A Two Rate Three Color Marker.";
}
}
description
"Container for a Two Rate Three Color Marker.";
}
grouping meter {
choice meter-types {
case single-rate-two-color-meter-type {
uses single-rate-two-color-meter;
}
Choudhary, et al. Expires 25 January 2024 [Page 20]
Internet-Draft YANG Models for QoS July 2023
case single-rate-three-color-meter-type {
uses single-rate-three-color-meter;
}
case two-rate-three-color-meter-type {
uses two-rate-three-color-meter;
}
description
"A meter action based on choice of meter action type.";
}
description
"Meter attributes.";
}
container meters {
description
"List of meter templates.";
list meter {
key "name";
description
"Meter entry template.";
leaf name {
type string;
description
"A unique string to identify the meter.";
}
uses meter;
}
}
grouping meter-reference {
container meter {
leaf name {
type string ;
mandatory true;
description
"This leaf defines name of the meter referenced.";
}
leaf type {
type identityref {
base qos-types:meter-type;
}
mandatory true;
description
"This leaf defines type of the meter.";
Choudhary, et al. Expires 25 January 2024 [Page 21]
Internet-Draft YANG Models for QoS July 2023
}
description
"The name and type for meter reference.";
}
description
"Grouping to define meter reference.";
}
grouping count {
container count {
if-feature qos-types:count;
leaf count-action {
type empty;
description
"Take an action if this is defined.";
}
description
"Container for whether to take an action for count.";
}
description
"The count action grouping.";
}
grouping named-counter {
container named-counter {
if-feature qos-types:named-counter;
leaf count-name-action {
type string;
description
"A unique name for named counter.";
}
description
"The named counter action.";
}
description
"The named counter action grouping.";
}
grouping discard {
container discard {
leaf discard {
type empty;
description
"If defined this enables discard action.";
}
description
"Container for discard action.";
Choudhary, et al. Expires 25 January 2024 [Page 22]
Internet-Draft YANG Models for QoS July 2023
}
description
"Grouping for discard action.";
}
grouping priority {
container priority {
leaf level {
type uint8;
description
"Priority level.";
}
description
"Container for priority.";
}
description
"Grouping for priority.";
}
grouping min-rate {
container min-rate {
uses rate-value-unit;
description
"Minimum guaranteed bandwidth.";
}
description
"Grouping for minimum rate.";
}
grouping dscp-marking {
container dscp {
leaf dscp {
type inet:dscp;
description
"DSCP marking.";
}
description
"Container for DSCP marking.";
}
description
"Grouping for DSCP marking.";
}
grouping traffic-group-marking {
container traffic-group {
leaf traffic-group {
type string;
description
Choudhary, et al. Expires 25 January 2024 [Page 23]
Internet-Draft YANG Models for QoS July 2023
"A unique name for traffic group.";
}
description
"Container for traffic group marking container.";
}
description
"Grouping for traffic group marking.";
}
grouping child-policy {
container child-policy {
if-feature qos-types:child-policy;
leaf name {
type string;
description
"A unique name for hierarchical policy.";
}
description
"Hierarchical Policy configuration container.";
}
description
"Grouping of Hierarchical Policy configuration.";
}
grouping max-rate {
container max-rate {
uses rate-value-unit;
leaf burst-value {
type uint64;
description
"Burst value in bytes.";
}
leaf burst-unit {
type identityref {
base qos-types:burst-unit-type;
}
default qos-types:bytes;
description
"Burst value in bytes or milliseconds, with a default
of bytes.";
}
description
"Maximum rate attributes container.";
}
description
"Grouping for maximum rate attributes.";
Choudhary, et al. Expires 25 January 2024 [Page 24]
Internet-Draft YANG Models for QoS July 2023
}
grouping red-config-parameters {
leaf min-threshold-val {
type uint64;
description
"Minimum value of RED threshold.";
}
leaf min-threshold-unit {
type identityref {
base qos-types:red-threshold-unit;
}
default qos-types:red-threshold-bytes;
description
"The unit for minimum RED threshold value, with the default
of bytes.";
}
leaf max-threshold-val {
type uint64;
description
"Maximum value of RED threshold.";
}
leaf max-threshold-unit {
type identityref {
base qos-types:red-threshold-unit;
}
default qos-types:red-threshold-bytes;
description
"The unit for maximum RED threshold value, with the default
of bytes.";
}
leaf weight {
type uint8;
description
"The decay factor for the average queue size
calculation. The numbers is a 2's exponent.";
}
leaf max-probability-val {
type uint64;
description
"Value of maximum probability value. This value need
be interpreted along with max-probability-unit";
}
Choudhary, et al. Expires 25 January 2024 [Page 25]
Internet-Draft YANG Models for QoS July 2023
leaf max-probability-unit {
type identityref {
base qos-types:probability-unit;
}
default qos-types:probability-pc;
description
"Probability unit type, with a default of percentage.";
}
description
"Random Early Detect (RED) configuration parameters.";
}
grouping queue {
container queue {
uses priority;
uses min-rate;
uses max-rate;
container algorithmic-drop {
choice drop-algorithm {
case tail-drop {
container tail-drop {
leaf tail-drop {
type empty;
description
"When defined, tail drop algorithm is enabled.";
}
description
"Tail Drop configuration container.";
}
description
"Tail Drop choice.";
}
case red {
container red {
uses red-config-parameters;
leaf ecn-enabled {
type boolean;
default "false";
description
"ECN is enabled on the queue.";
}
description
"Random Early Detect (RED) configuration.";
}
}
case wred {
Choudhary, et al. Expires 25 January 2024 [Page 26]
Internet-Draft YANG Models for QoS July 2023
container wred {
list wred {
key "profile";
leaf profile {
type uint8;
description
"Profile id of each WRED profile.";
}
leaf color-type {
type identityref {
base qos-types:wred-color-type;
}
default qos-types:wred-color-dscp;
description
"WRED color-type of each profile.";
}
list color-val {
key "min max";
leaf min {
type uint8;
description
"Minimum value of color types.";
}
leaf max {
type uint8;
description
"Maximum value of color types.";
}
description
"List of color markings which constitute
a traffic profile.";
}
uses red-config-parameters;
description
"List of RED profiles each with its own
threshold values.";
}
leaf ecn-enabled {
type boolean;
default "false";
description
"ECN is enabled on the queue.";
Choudhary, et al. Expires 25 January 2024 [Page 27]
Internet-Draft YANG Models for QoS July 2023
}
description
"Weighted Random Early Detect (WRED) configuration.";
}
}
description
"Choice of Drop Algorithm.";
}
description
"Algorithmic Drop configuration container.";
}
description
"Queue configuration container.";
}
description
"Queue grouping.";
}
container queues {
description
"List of queue templates.";
list queue {
key "name";
description
"Queue entry template.";
leaf name {
type string;
description
"A unique name identifying this queue template";
}
uses queue;
}
}
grouping queue-reference {
container queue-reference {
leaf queue-name {
type string;
mandatory true;
description
"This leaf defines name of the queue template
referenced.";
}
description
"Queue template reference.";
}
Choudhary, et al. Expires 25 January 2024 [Page 28]
Internet-Draft YANG Models for QoS July 2023
description
"Queue template reference grouping.";
}
grouping scheduler {
container scheduler {
uses min-rate;
uses max-rate;
description
"Scheduler configuration container.";
}
description
"Scheduler configuration grouping.";
}
}
<CODE ENDS>
Figure 5: ietf-qos-actions module
4.3. DiffServ Module
DiffServ module augments Traffic Policy module to enable
diffrentiated services for different types of packets.
module: ietf-diffserv
augment /traffic-policy:classifiers/traffic-policy:classifier
/traffic-policy:filter:
+--rw (filter-param)?
+--:(dscp)
| +--rw dscp* [min max]
| ...
+--:(source-ipv4-prefix)
| +--rw source-ipv4-prefix* [prefix]
| ...
+--:(destination-ipv4-prefix)
| +--rw destination-ipv4-prefix* [prefix]
| ...
+--:(source-ipv6-prefix)
| +--rw source-ipv6-prefix* [prefix]
| ...
+--:(destination-ipv6-prefix)
| +--rw destination-ipv6-prefix* [prefix]
| ...
+--:(source-port)
| +--rw source-port* [min max]
| ...
+--:(destination-port)
Choudhary, et al. Expires 25 January 2024 [Page 29]
Internet-Draft YANG Models for QoS July 2023
| +--rw destination-port* [min max]
| ...
+--:(protocol)
| +--rw protocol* [min max]
| ...
+--:(traffic-group)
| +--rw traffic-group
| ...
+--:(filter-match-all)
+--rw match-all
...
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:inline
/traffic-policy:filter:
+--rw (filter-params)?
+--:(dscp)
| +--rw dscp* [min max]
| ...
+--:(source-ipv4-prefix)
| +--rw source-ipv4-prefix* [prefix]
| ...
+--:(destination-ipv4-prefix)
| +--rw destination-ipv4-prefix* [prefix]
| ...
+--:(source-ipv6-prefix)
| +--rw source-ipv6-prefix* [prefix]
| ...
+--:(destination-ipv6-prefix)
| +--rw destination-ipv6-prefix* [prefix]
| ...
+--:(source-port)
| +--rw source-port* [min max]
| ...
+--:(destination-port)
| +--rw destination-port* [min max]
| ...
+--:(protocol)
| +--rw protocol* [min max]
| ...
+--:(traffic-group)
| +--rw traffic-group
| ...
+--:(filter-match-all)
+--rw match-all
...
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:action:
+--rw (action-params)?
Choudhary, et al. Expires 25 January 2024 [Page 30]
Internet-Draft YANG Models for QoS July 2023
+--:(dscp-marking)
| +--rw dscp
| ...
+--:(meter-inline)
| +--rw (meter-types)?
| ...
+--:(meter-reference)
| +--rw meter
| ...
+--:(traffic-group-marking)
| +--rw traffic-group
| ...
+--:(child-policy) {qos-types:child-policy}?
| +--rw child-policy {qos-types:child-policy}?
| ...
+--:(count) {qos-types:count}?
| +--rw count {qos-types:count}?
| ...
+--:(named-count) {qos-types:named-counter}?
| +--rw named-counter {qos-types:named-counter}?
| ...
+--:(queue-inline)
| +--rw queue
| ...
+--:(scheduler-inline)
+--rw scheduler
...
Figure 6: ietf-diffserv abridged tree diagram
<CODE BEGINS>
file "ietf-diffserv@2023-07-20.yang"
module ietf-diffserv {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-diffserv";
prefix diffserv;
import ietf-traffic-policy {
prefix traffic-policy;
}
import ietf-qos-action {
prefix qos-action;
}
import ietf-inet-types {
prefix inet;
}
import iana-qos-types {
prefix qos-types;
Choudhary, et al. Expires 25 January 2024 [Page 31]
Internet-Draft YANG Models for QoS July 2023
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
organization
"IETF Routing Area Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:achoudhary@aviatrix.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains a collection of YANG definitions for
configuring DiffServ specification implementations.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial version.";
reference
"RFC XXXX: A YANG Model for Quality of Service (QoS).";
}
grouping dscp {
list dscp {
key "min max";
description
"List of DSCP ranges.";
leaf min {
type inet:dscp;
description
Choudhary, et al. Expires 25 January 2024 [Page 32]
Internet-Draft YANG Models for QoS July 2023
"Minimum value of DSCP min-max range.";
}
leaf max {
type inet:dscp;
must ". >= ../min" {
error-message
"max must be greater than or equal to min.";
}
description
"Maximum value of DSCP min-max range.";
}
}
description
"Filter grouping containing list of DSCP ranges.";
}
grouping source-ipv4-prefix {
list source-ipv4-prefix {
key "prefix";
description
"List of source IPv4 prefixes.";
leaf prefix {
type inet:ipv4-prefix;
description
"Source IPv4 prefix.";
}
}
description
"Filter grouping containing list of source IPv4 prefixes.";
}
grouping destination-ipv4-prefix {
list destination-ipv4-prefix {
key "prefix";
description
"List of destination IPv4 prefixes.";
leaf prefix {
type inet:ipv4-prefix;
description
"Destination IPv4 prefix.";
}
}
description
"Filter grouping containing list of destination IPv4
prefixes.";
}
grouping source-ipv6-prefix {
Choudhary, et al. Expires 25 January 2024 [Page 33]
Internet-Draft YANG Models for QoS July 2023
list source-ipv6-prefix {
key "prefix";
description
"List of source IPv6 prefixes.";
leaf prefix {
type inet:ipv6-prefix;
description
"Source IPv6 prefix.";
}
}
description
"Filter grouping containing list of source IPv6
prefixes.";
}
grouping destination-ipv6-prefix {
list destination-ipv6-prefix {
key "prefix";
description
"List of destination IPv6 prefixes.";
leaf prefix {
type inet:ipv6-prefix;
description
"Destination IPv6 prefix.";
}
}
description
"Filter grouping containing list of destination IPv6
prefixes.";
}
grouping source-port {
list source-port {
key "min max";
description
"List of ranges of source port.";
leaf min {
type inet:port-number;
description
"Minimum value of source port range.";
}
leaf max {
type inet:port-number;
must ". >= ../min" {
error-message
"max must be greater than or equal to min.";
Choudhary, et al. Expires 25 January 2024 [Page 34]
Internet-Draft YANG Models for QoS July 2023
}
description
"Maximum value of source port range.";
}
}
description
"Filter grouping containing list of source port ranges.";
}
grouping destination-port {
list destination-port {
key "min max";
description
"List of min-max range of destination ports.";
leaf min {
type inet:port-number;
description
"Minimum value of destination port.";
}
leaf max {
type inet:port-number;
must ". >= ../min" {
error-message
"max must be greater than or equal to min.";
}
description
"Maximum value of destination port range.";
}
}
description
"Filter grouping containing list of destination port ranges.";
}
grouping protocol {
list protocol {
key "min max";
description
"List of ranges of protocol values. Protocol refers to the
value in the protocol field of the IPv4 header and value
in the 'next-header' field of IPv6 header. In IPv6 header,
'next-header' field indicates first extension header or the
protocol in the 'upper-layer' header.";
reference
"RFC 791: Internet Protocol
RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification.";
leaf min {
Choudhary, et al. Expires 25 January 2024 [Page 35]
Internet-Draft YANG Models for QoS July 2023
type uint8 {
range "0..255";
}
description
"Minimum value of protocol range.";
}
leaf max {
type uint8 {
range "0..255";
}
must ". >= ../min" {
error-message
"max must be greater than or equal to min.";
}
description
"Maximum value of protocol range.";
}
}
description
"Filter grouping containing list of protocol ranges.";
}
grouping traffic-group {
container traffic-group {
leaf name {
type string ;
description
"This leaf defines name of the traffic group referenced.";
}
description
"Traffic group container.";
}
description
"Traffic group grouping.";
}
grouping filter-match-all {
container match-all {
leaf action {
type empty;
description
"When set, the filter matches all packets.";
}
description
"The match all action.";
}
description
Choudhary, et al. Expires 25 January 2024 [Page 36]
Internet-Draft YANG Models for QoS July 2023
"The match all filter grouping.";
}
augment "/traffic-policy:classifiers/traffic-policy:classifier" +
"/traffic-policy:filter" {
choice filter-param {
description
"Choice of filter types.";
case dscp {
uses dscp;
description
"Filter containing list of DSCP ranges.";
}
case source-ipv4-prefix {
uses source-ipv4-prefix;
description
"Filter containing list of source IPv4 prefixes.";
}
case destination-ipv4-prefix {
uses destination-ipv4-prefix;
description
"Filter containing list of destination IPv4 prefix.";
}
case source-ipv6-prefix {
uses source-ipv6-prefix;
description
"Filter containing list of source IPv6 prefixes.";
}
case destination-ipv6-prefix {
uses destination-ipv6-prefix;
description
"Filter containing list of destination IPv6 prefix.";
}
case source-port {
uses source-port;
description
"Filter containing list of source-port ranges.";
}
case destination-port {
uses destination-port;
description
"Filter containing list of destination-port ranges.";
Choudhary, et al. Expires 25 January 2024 [Page 37]
Internet-Draft YANG Models for QoS July 2023
}
case protocol {
uses protocol;
description
"Filter Type Protocol.";
}
case traffic-group {
uses traffic-group;
description
"Filter Type traffic-group.";
}
case filter-match-all {
uses filter-match-all;
description
"When the filter type is set to match all packets.";
}
}
description
"Augments QoS classifier to add in DiffServ filters.";
}
augment "/traffic-policy:policies/traffic-policy:policy" +
"/traffic-policy:classifier/traffic-policy:inline" +
"/traffic-policy:filter" {
when "derived-from-or-self(../../../traffic-policy:type, " +
"'qos-types:ipv4-diffserv-policy-type') or " +
"derived-from-or-self(../../../traffic-policy:type, " +
"'qos-types:ipv6-diffserv-policy-type') or " +
"derived-from-or-self(../../../traffic-policy:type, " +
"'qos-types:diffserv-policy-type')" {
description
"If policy type is v4, v6 or default DiffServ,
this filter can be used.";
}
choice filter-params {
description
"Choice of action types.";
case dscp {
uses dscp;
description
"Filter containing list of DSCP ranges.";
}
case source-ipv4-prefix {
when "derived-from-or-self(/traffic-policy:policies/" +
Choudhary, et al. Expires 25 January 2024 [Page 38]
Internet-Draft YANG Models for QoS July 2023
"traffic-policy:policy/traffic-policy:type, " +
"'qos-types:ipv6-diffserv-policy-type')" {
description
"If policy type is v6, this filter cannot be used.";
}
uses source-ipv4-prefix;
description
"Filter containing list of source IPv4 prefixes.";
}
case destination-ipv4-prefix {
when "derived-from-or-self(/traffic-policy:policies" +
"/traffic-policy:policy/traffic-policy:type, " +
"'qos-types:ipv6-diffserv-policy-type')" {
description
"If policy type is v6, this filter cannot be used.";
}
uses destination-ipv4-prefix;
description
"Filter containing list of destination IPv4 prefix.";
}
case source-ipv6-prefix {
when "derived-from-or-self(/traffic-policy:policies" +
"/traffic-policy:policy/traffic-policy:type, "+
"'qos-types:ipv4-diffserv-policy-type')" {
description
"If policy type is v4, this filter cannot be used.";
}
uses source-ipv6-prefix;
description
"Filter containing list of source IPv6 prefixes.";
}
case destination-ipv6-prefix {
when "derived-from-or-self(/traffic-policy:policies" +
"/traffic-policy:policy/traffic-policy:type, " +
"'qos-types:ipv4-diffserv-policy-type')" {
description
"If policy type is v4, this filter cannot be used.";
}
uses destination-ipv6-prefix;
description
"Filter containing list of destination IPv6 prefix.";
}
case source-port {
uses source-port;
Choudhary, et al. Expires 25 January 2024 [Page 39]
Internet-Draft YANG Models for QoS July 2023
description
"Filter containing list of source-port ranges.";
}
case destination-port {
uses destination-port;
description
"Filter containing list of destination-port ranges.";
}
case protocol {
uses protocol;
description
"Filter Type Protocol.";
}
case traffic-group {
uses traffic-group;
description
"Filter Type traffic-group.";
}
case filter-match-all {
uses filter-match-all;
description
"When the filter type is set to match all packets.";
}
}
description
"Augments Diffserv Classifier with common filter types.";
}
augment "/traffic-policy:policies/traffic-policy:policy/" +
"traffic-policy:classifier/traffic-policy:action" {
when "derived-from-or-self(../../traffic-policy:type, " +
"'qos-types:ipv4-diffserv-policy-type') or " +
"derived-from-or-self(../../traffic-policy:type, " +
"'qos-types:ipv6-diffserv-policy-type') or " +
"derived-from-or-self(../../traffic-policy:type, " +
"'qos-types:diffserv-policy-type')" {
description
"If policy type is v4, v6 or default DiffServ,
these actions can be used.";
}
description
"Augments Diffserv Policy with action configuration.";
choice action-params {
Choudhary, et al. Expires 25 January 2024 [Page 40]
Internet-Draft YANG Models for QoS July 2023
description
"Choice of different action parameters that can be taken.";
case dscp-marking {
uses qos-action:dscp-marking;
}
case meter-inline {
uses qos-action:meter;
}
case meter-reference {
uses qos-action:meter-reference;
}
case traffic-group-marking {
uses qos-action:traffic-group-marking;
}
case child-policy {
if-feature qos-types:child-policy;
uses qos-action:child-policy;
}
case count {
if-feature qos-types:count;
uses qos-action:count;
}
case named-count {
if-feature qos-types:named-counter;
uses qos-action:named-counter;
}
case queue-inline {
uses qos-action:queue;
}
case scheduler-inline {
uses qos-action:scheduler;
}
}
}
}
<CODE ENDS>
Figure 7: ietf-diffserv module
Choudhary, et al. Expires 25 January 2024 [Page 41]
Internet-Draft YANG Models for QoS July 2023
4.4. QoS Operational Module
QoS Operational module contains all operational statistics. It
contains statistics related to classifier, metering, queueing, and
named.
Classifier statistics consist of list of classifier entries
identified by a classifier entry name. Classifier counters include
matched packets and bytes, and average rate of traffic matching a
particular classifier.
Metering statistics consist of meters identified by an identifier.
Metering counters include conform, exceed, violate, drop packets, and
bytes.
Queuing counters include instantaneous, peak, average queue length,
as well as output conform, exceed, tail drop packets and bytes.
Named statistics is defined as statistics which is tagged by a name.
This could be aggregated or non-aggregated. Aggregated named
statistics is defined as counters which are aggregated across
classifier entries in a policy applied to an interface in a
particular direction. Non-aggregated named statistics are counters
of classifier, metering or queuing which have the same tag name but
maintained separately.
A clear action is provided to clear all statistics or statistics of a
particular kind.
Choudhary, et al. Expires 25 January 2024 [Page 42]
Internet-Draft YANG Models for QoS July 2023
module: ietf-qos-oper
augment /if:interfaces/if:interface:
+--ro qos-interface-statistics
+--ro stats-per-direction* []
| +--ro direction? identityref
| +--ro policy-name? string
| +--ro classifier* []
| | ...
| +--ro named* []
| | ...
| +--ro metering* []
| | ...
| +--ro queueing* []
| ...
+---x clear
+---w input
| ...
+--ro output
...
Figure 8: ietf-qos-oper abridged tree diagram
<CODE BEGINS>
file "ietf-qos-oper@2023-07-20.yang"
module ietf-qos-oper {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-qos-oper";
prefix qos-oper;
import ietf-yang-types {
prefix yang;
reference
"RFC 6991:Common YANG Data Types.";
}
import ietf-interfaces {
prefix if;
reference
"RFC8343: A YANG Data Model for Interface Management.";
}
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
organization "IETF RTG (Routing Area) Working Group.";
Choudhary, et al. Expires 25 January 2024 [Page 43]
Internet-Draft YANG Models for QoS July 2023
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:achoudhary@aviatrix.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains a collection of YANG definitions for
QoS operational specification.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial version.";
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
grouping classifier-statistics {
description
"Statistics for a classifier.";
leaf name {
type string;
description
"A unique identifier for Classifier name.";
}
leaf classified-pkts {
type yang:zero-based-counter64;
description
"Number of total packets filtered for a classifier.";
}
leaf classified-bytes {
Choudhary, et al. Expires 25 January 2024 [Page 44]
Internet-Draft YANG Models for QoS July 2023
type yang:zero-based-counter64;
description
"Number of total bytes filtered for a classifier.";
}
leaf classified-rate {
type yang:gauge64;
units "bits-per-second";
description
"Rate of average data flow through a classifier.";
}
}
grouping queuing-stats {
description
"Statistics for a queue.";
leaf queue-id {
type string;
description
"A unique identifier for the Queue.";
}
leaf transmit-pkts {
type yang:zero-based-counter64;
description
"Number of packets transmitted from queue.";
}
leaf transmit-bytes {
type yang:zero-based-counter64;
description
"Number of bytes transmitted from queue.";
}
leaf queue-current-size-bytes {
type yang:gauge64;
description
"Number of bytes currently buffered.";
}
leaf queue-average-size-bytes {
type yang:gauge64;
description
"Average queue size in number of bytes.";
}
leaf queue-peak-size-bytes {
Choudhary, et al. Expires 25 January 2024 [Page 45]
Internet-Draft YANG Models for QoS July 2023
type yang:gauge64;
description
"Peak buffer queue size in bytes.";
}
leaf tail-drop-pkts {
type yang:zero-based-counter64;
description
"Total number of packets tail-dropped.";
}
leaf tail-drop-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes tail-dropped.";
}
leaf red-drop-pkts {
type yang:zero-based-counter64;
description
"Total number of packets dropped because of RED.";
}
leaf red-drop-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes dropped because of RED.";
}
leaf red-ecn-marked-pkts {
type yang:zero-based-counter64;
description
"Total number of packets that were marked with ECN
because of RED.";
}
leaf red-ecn-marked-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes that were marked with ECN because of
RED.";
}
list wred-stats {
config false;
description
"QoS WRED statistics.";
Choudhary, et al. Expires 25 January 2024 [Page 46]
Internet-Draft YANG Models for QoS July 2023
leaf profile {
type uint8;
description
"Profile identifier for each color of traffic.";
}
leaf drop-pkts {
type yang:zero-based-counter64;
description
"Total number of packets dropped because of WRED.";
}
leaf drop-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes dropped because of WRED.";
}
leaf ecn-marked-pkts {
type yang:zero-based-counter64;
description
"Total number of packets that were marked with ECN because
of WRED.";
}
leaf ecn-marked-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes that were marked with ECN because of
WRED.";
}
}
}
grouping metering-stats {
description
"Statistics for a meter.";
leaf meter-id {
type string;
description
"A unique identifier that identifies this set of metering
statistics.";
}
leaf conform-pkts {
type yang:zero-based-counter64;
description
Choudhary, et al. Expires 25 January 2024 [Page 47]
Internet-Draft YANG Models for QoS July 2023
"Number of packets that conform to the rate and burst.";
}
leaf conform-bytes {
type yang:zero-based-counter64;
description
"Total bytes count that conform to the rate and burst.";
}
leaf conform-rate {
type yang:gauge64;
units "bits-per-second";
description
"Traffic Rate measured as conformimg.";
}
leaf exceed-pkts {
type yang:zero-based-counter64;
description
"Number of packets that exceed the peak rate and peak
burst.";
}
leaf exceed-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes which exceed the peak rate and peak
burst.";
}
leaf exceed-rate {
type yang:gauge64;
units "bits-per-second";
description
"Traffic Rate measured as exceeding.";
}
leaf violate-pkts {
type yang:zero-based-counter64;
description
"Number of packets that were beyond peak rate
and peak burst.";
}
leaf violate-bytes {
type yang:zero-based-counter64;
description
"Total number of bytes which were beyond peak rate and
Choudhary, et al. Expires 25 January 2024 [Page 48]
Internet-Draft YANG Models for QoS July 2023
peak burst.";
}
leaf violate-rate {
type yang:gauge64;
units "bits-per-second";
description
"Traffic Rate measured as violating.";
}
leaf drop-pkts {
type yang:zero-based-counter64;
description
"Number of packets dropped by meter.";
}
leaf drop-bytes {
type yang:zero-based-counter64;
description
"Number of bytes dropped by meter.";
}
}
augment "/if:interfaces/if:interface" {
description
"Augments interface module to add QoS Target entry.";
container qos-interface-statistics {
config false;
description
"QoS Interface statistics.";
list stats-per-direction {
description
"QoS interface statistics in ingress or egress direction.";
leaf direction {
type identityref {
base qos-types:direction;
}
description
"Direction of the traffic flow. Either ingress or
egress.";
}
leaf policy-name {
type string;
description
Choudhary, et al. Expires 25 January 2024 [Page 49]
Internet-Draft YANG Models for QoS July 2023
"Policy name for single level policy as well as
for Hierarchical policies. For Hierarchical policies,
this represent relative path as well as the last level
policy name.";
}
list classifier {
description
"Statistics for each Classifier in a
Policy applied in a particular direction.";
uses classifier-statistics;
}
list named {
description
"Statistics for a statistics-name.";
leaf name {
type string;
description
"A name for statistics.";
}
container aggregated {
description
"Matched aggregated statistics for a statistics-name.";
leaf pkts {
type yang:zero-based-counter64;
description
"Number of total matched packets associated
with a statistics name.";
}
leaf bytes {
type yang:zero-based-counter64;
description
"Number of total matched bytes associated
with a statistics name.";
}
leaf rate {
type yang:gauge64;
units "bits-per-second";
description
"Rate of average matched data which is associated
to a statistics name.";
}
Choudhary, et al. Expires 25 January 2024 [Page 50]
Internet-Draft YANG Models for QoS July 2023
}
container non-aggregated {
description
"Statistics for non-aggregated statistics-name.";
list classifier {
description
"Statistics for each Classifier in a
Policy applied in a particular direction.";
uses classifier-statistics;
}
list metering {
description
"Statistics for each Meter associated with
the Policy.";
reference
"RFC2697: A Single Rate Three Color Marker
RFC2698: A Two Rate Three Color Marker.";
uses metering-stats;
}
list queueing {
description
"Statistics for each Queue associated with
the Policy.";
uses queuing-stats;
}
}
}
list metering {
description
"Statistics for each Meter associated with the Policy.";
reference
"RFC2697: A Single Rate Three Color Marker
RFC2698: A Two Rate Three Color Marker.";
uses metering-stats;
}
list queueing {
description
"Statistics for each Queue associated with the Policy.";
uses queuing-stats;
}
}
Choudhary, et al. Expires 25 January 2024 [Page 51]
Internet-Draft YANG Models for QoS July 2023
action clear {
description
"Clear statistics action command. Execution of this command
should result in all the QoS interface counters to be
cleared and set to 0.";
input {
leaf category {
type identityref {
base qos-types:clear-counters-type;
}
description
"Category of counters which is being cleared.";
}
leaf started-at {
type yang:date-and-time;
description
"The date and time when the counters should be
cleared.";
}
}
output {
leaf finished-at {
type yang:date-and-time;
description
"The date and time when the counters finished
clearing.";
}
}
}
}
}
}
<CODE ENDS>
Figure 9: ietf-qos-oper module
4.5. Scheduler Policy Module
Scheduling Policy module defines a set of scheduling parameters and
associates a Queue Policy with it.
Choudhary, et al. Expires 25 January 2024 [Page 52]
Internet-Draft YANG Models for QoS July 2023
module: ietf-scheduler-policy
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:inline
/traffic-policy:filter:
+--rw (filter-params)?
+--:(filter-match-all)
+--rw match-all
...
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:action:
+--rw (action-params)?
+--:(scheduler)
| +--rw scheduler
| ...
+--:(queue-policy-name)
+--rw queue-policy-name
...
Figure 10: ietf-scheduler-policy abridged abridged tree diagram
<CODE BEGINS>
file "ietf-scheduler-policy@2023-07-20.yang"
module ietf-scheduler-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-scheduler-policy";
prefix scheduler-policy;
import ietf-traffic-policy {
prefix traffic-policy;
}
import ietf-qos-action {
prefix qos-action;
}
import ietf-diffserv {
prefix diffserv;
}
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
organization
"IETF Routing Area Working Group.";
contact
"WG Web: <https://datatracker.ietf.org/wg/rtgwg/>
Choudhary, et al. Expires 25 January 2024 [Page 53]
Internet-Draft YANG Models for QoS July 2023
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:achoudhary@aviatrix.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains a collection of YANG definitions for
configuring QoS scheduler policies.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial version.";
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
augment "/traffic-policy:policies/traffic-policy:policy" +
"/traffic-policy:classifier/traffic-policy:inline" +
"/traffic-policy:filter" {
when "derived-from-or-self(../../../traffic-policy:type, " +
"'qos-types:scheduler-policy-type')" {
description
"This filter can be used only when policy type is
scheduler-policy.";
}
choice filter-params {
description
"Choice of filter parameters.";
case filter-match-all {
uses diffserv:filter-match-all;
description
"A filter that matches all packets.";
}
Choudhary, et al. Expires 25 January 2024 [Page 54]
Internet-Draft YANG Models for QoS July 2023
}
description
"Augments Queue Policy Classifier to add filter parameters.";
}
augment "/traffic-policy:policies/traffic-policy:policy/" +
"traffic-policy:classifier/traffic-policy:action" {
when "derived-from-or-self(../../traffic-policy:type, " +
"'qos-types:scheduler-policy-type')" {
description
"These actions apply only when policy type is
scheduler-policy.";
}
choice action-params {
description
"Choice of action parameters that can be taken.";
case scheduler {
uses qos-action:scheduler;
}
case queue-policy-name {
container queue-policy-name {
leaf queue-policy {
type leafref {
path "/traffic-policy:policies/" +
"traffic-policy:policy/traffic-policy:name";
}
must "derived-from-or-self(/traffic-policy:policies" +
"/traffic-policy:policy/traffic-policy:type," +
"'qos-types:queue-policy-type')";
mandatory true;
description
"This leafref refers to Queue Policy name.";
}
description
"Container for Queue Policy name.";
}
}
}
description
"Augments Queue Policy Classifier to add in Action parameters
for Scheduler policy.";
}
}
<CODE ENDS>
Choudhary, et al. Expires 25 January 2024 [Page 55]
Internet-Draft YANG Models for QoS July 2023
Figure 11: ietf-scheduler-policy module
4.6. Queue Policy Module
Queue Policy module augments the Traffic Policy module. It augments
to allow queues to be referred to in a policy. The match is based on
Traffic group and action parameters which are defined in QoS Action
module.
module: ietf-queue-policy
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:inline
/traffic-policy:filter:
+--rw (filter-params)?
+--:(traffic-group)
| +--rw traffic-group
| ...
+--:(filter-match-all)
+--rw match-all
...
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:action:
+--rw (action-params)?
+--:(queue-template-name)
| +--rw queue-reference
| ...
+--:(queue-inline)
+--rw queue
...
Figure 12: ietf-queue-policy abridged tree diagram
<CODE BEGINS>
file "ietf-queue-policy@2023-07-20.yang"
module ietf-queue-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-queue-policy";
prefix queue-policy;
import ietf-traffic-policy {
prefix traffic-policy;
}
import ietf-qos-action {
prefix qos-action;
}
import ietf-diffserv {
prefix diffserv;
Choudhary, et al. Expires 25 January 2024 [Page 56]
Internet-Draft YANG Models for QoS July 2023
}
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
organization
"IETF Routing Area Working Group.";
contact
"WG Web: <https://datatracker.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:achoudhary@aviatrix.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains a collection of YANG definitions for
QoS Queue policies.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial version.";
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
augment "/traffic-policy:policies/traffic-policy:policy" +
"/traffic-policy:classifier/traffic-policy:inline" +
"/traffic-policy:filter" {
when "derived-from-or-self(../../../traffic-policy:type, " +
"'qos-types:queue-policy-type')" {
Choudhary, et al. Expires 25 January 2024 [Page 57]
Internet-Draft YANG Models for QoS July 2023
description
"If policy type is Queue Policy, this filter can be used.";
}
choice filter-params {
description
"Choice of Action types.";
case traffic-group {
uses diffserv:traffic-group;
description
"Traffic group name.";
}
case filter-match-all {
uses diffserv:filter-match-all;
description
"When the filter type is set to match all packets.";
}
}
description
"Augments Queue Policy to add filter types.";
}
augment "/traffic-policy:policies/traffic-policy:policy" +
"/traffic-policy:classifier/traffic-policy:action" {
when "derived-from-or-self(../../traffic-policy:type," +
"'qos-types:queue-policy-type')" {
description
"Queue Policy actions.";
}
choice action-params {
description
"Choice of different action parameters that can be taken.";
case queue-template-name {
uses qos-action:queue-reference;
}
case queue-inline {
uses qos-action:queue;
}
}
description
"Augments Queue Policy action to add Queue template reference
or Queue inline.";
}
}
<CODE ENDS>
Choudhary, et al. Expires 25 January 2024 [Page 58]
Internet-Draft YANG Models for QoS July 2023
Figure 13: ietf-queue-policy module
4.7. IANA QoS Types Module
The QoS Types module contains all the type definitions used by the
other QoS modules.
<CODE BEGINS>
file "iana-qos-types@2023-07-20.yang"
module iana-qos-types {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-qos-types";
prefix qos-types;
organization
"IETF Routing Area Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>";
description
"This module contains type definitions for all QoS types.
Copyright (c) 2022 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial version";
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
Choudhary, et al. Expires 25 January 2024 [Page 59]
Internet-Draft YANG Models for QoS July 2023
/*
* Features.
*/
feature child-policy {
description
" This feature allows configuration of hierarchical policy.";
}
feature count {
description
"This feature allows action configuration to enable
counter in a classifier";
}
feature named-counter {
description
"This feature allows action configuration to enable
named counter in a classifier";
}
/*
* Identities.
*/
identity policy-type {
description
"Base identity for policy type.";
}
identity diffserv-policy-type {
base policy-type;
description
"Policy type defined as DiffServ.";
}
identity ipv4-diffserv-policy-type {
base policy-type;
description
"Policy type defined as a DiffServ IPv4 policy type.";
}
identity ipv6-diffserv-policy-type {
base policy-type;
description
"Policy type defined as a DiffServ IPv6 policy type.";
}
identity queue-policy-type {
base policy-type;
description
"Policy type defined as a queue policy type.";
}
identity scheduler-policy-type {
base policy-type;
description
Choudhary, et al. Expires 25 January 2024 [Page 60]
Internet-Draft YANG Models for QoS July 2023
"Policy type defined as a scheduler policy type.";
}
identity action-type {
description
"Base identity for the action type.";
}
identity dscp-marking {
base action-type;
description
"Action type defined as DSCP marking.";
}
identity meter-inline {
base action-type;
description
"Action type defined as meter inline.";
}
identity meter-reference {
base action-type;
description
"Action type defined as meter reference.";
}
identity queue {
base action-type;
description
"Action type defined as queue.";
}
identity scheduler {
base action-type;
description
"Action type defined as scheduler.";
}
identity discard {
base action-type;
description
"Action type defined as discard.";
}
identity child-policy {
if-feature child-policy;
base action-type;
description
"Action type defined as child policy.";
}
identity count {
if-feature count;
base action-type;
description
"Action type defined as count.";
Choudhary, et al. Expires 25 January 2024 [Page 61]
Internet-Draft YANG Models for QoS July 2023
}
identity named-counter {
if-feature named-counter;
base action-type;
description
"Action type specified as a named counter.";
}
identity queue-policy-name {
base action-type;
description
"Action type specified as a queue policy name.";
}
identity meter-type {
description
"Base identity for types of meter.";
}
identity one-rate-two-color {
base meter-type;
description
"Meter type specified as one rate two color meter.";
}
identity one-rate-tri-color {
base meter-type;
description
"Meter type specified as one rate three color meter.";
}
identity two-rate-tri-color {
base meter-type;
description
"Meter type specified as two rate three color meter.";
}
identity drop-type {
description
"Base identity for drop algorithm.";
}
identity tail-drop {
base drop-type;
description
"Drop algorithm specified as tail drop.";
}
identity red {
base drop-type;
description
"Drop algorithm specified as RED.";
}
identity wred {
Choudhary, et al. Expires 25 January 2024 [Page 62]
Internet-Draft YANG Models for QoS July 2023
base drop-type;
description
"Drop algorithm specified as WRED.";
}
identity rate-unit-type {
description
"Base definition for the type of rate unit.";
}
identity bits-per-second {
base rate-unit-type;
description
"Rate specified in bits per second.";
}
identity percent {
base rate-unit-type;
description
"Rate specified as a percentage of queue depth.";
}
identity burst-unit-type {
description
"Base definition for burst specification.";
}
identity bytes {
base burst-unit-type;
description
"Burst specified in bytes.";
}
identity microsecond {
base burst-unit-type;
description
"Burst specified in microseconds.";
}
identity red-threshold-unit {
description
"Base definition for RED threshold specification.";
}
identity red-threshold-bytes {
base red-threshold-unit;
description
"RED threshold specified in bytes.";
}
identity red-threshold-us {
base red-threshold-unit;
description
"RED threshold specified in microseconds.";
Choudhary, et al. Expires 25 January 2024 [Page 63]
Internet-Draft YANG Models for QoS July 2023
}
identity red-threshold-pc {
base red-threshold-unit;
description
"RED threshold specified as a percentage.";
}
identity red-theshold-pt {
base red-threshold-unit;
description
"RED threshold specified per-thousand.";
}
identity wred-color-type {
description
"Base identity for WRED color type.";
}
identity wred-color-dscp {
base wred-color-type;
description
"WRED color specified by DSCP.";
}
identity probability-unit {
description
"Base definition for probability unit.";
}
identity probability-pc {
base probability-unit;
description
"Probability specified in percentage.";
}
identity probability-pt {
base probability-unit;
description
"Probability specified in unit of per thousand.";
}
identity probability-denominator {
base probability-unit;
description
"Probability value specified as a denominator value
while numerator is always 1.";
}
identity filter-type {
description
"Base identity for filter type.";
}
Choudhary, et al. Expires 25 January 2024 [Page 64]
Internet-Draft YANG Models for QoS July 2023
identity dscp {
base filter-type;
description
"Filter type specified as DSCP.";
}
identity source-ipv4-prefix {
base filter-type;
description
"Filter type specified as source IPv4 prefix.";
}
identity destination-ipv4-prefix {
base filter-type;
description
"Filter type specified as destination IPv4 prefix.";
}
identity source-ipv6-prefix {
base filter-type;
description
"Filter type specified as source IPv6 prefix.";
}
identity destination-ipv6-prefix {
base filter-type;
description
"Filter type specified as destination IPv6 prefix.";
}
identity source-port {
base filter-type;
description
"Filter type specified as source port.";
}
identity destination-port {
base filter-type;
description
"Filter type specified as destination port.";
}
identity protocol {
base filter-type;
description
"Filter type specified as protocol.";
}
identity traffic-group-name {
base filter-type;
description
"Filter type specified as traffic group name.";
}
identity filter-match-all {
base filter-type;
description
Choudhary, et al. Expires 25 January 2024 [Page 65]
Internet-Draft YANG Models for QoS July 2023
"Filter type specified as match all.";
}
typedef match-operation-type {
type enumeration {
enum match-all {
description
"Classifier entry filters logical AND operation";
}
enum match-any {
description
"Classifier entry filters logical OR operation";
}
}
default "match-all";
description
"Filter match logical operation type";
}
identity direction {
description
"Base identity for traffic direction";
}
identity ingress {
base direction;
description
"Direction of traffic coming into the network entry";
}
identity egress {
base direction;
description
"Direction of traffic going out of the network entry";
}
identity meter-action-type {
description
"Base identify for actions related to metering";
}
identity action-drop {
base meter-action-type;
description
"Drop packets that conform/exceed/violate to the set value.";
}
identity action-transmit {
base meter-action-type;
description
"Transmit packets that conform/exceed/violate to the set
value.";
Choudhary, et al. Expires 25 January 2024 [Page 66]
Internet-Draft YANG Models for QoS July 2023
}
identity action-mark {
base meter-action-type;
description
"Mark packets that conform/exceed/violate to the set value.";
}
identity clear-counters-type {
description
"Base identify for clear interface counters related options";
}
identity all-counters {
base clear-counters-type;
description
"Clear all counters in both directions.";
}
identity inbound-counters {
base clear-counters-type;
description
"Clear counters in inbound direction.";
}
identity outbound-counters {
base clear-counters-type;
description
"Clear counters in outbound direction.";
}
}
<CODE ENDS>
Figure 14: iana-qos-types module
5. IANA Considerations
This document registers seven URIs and seven YANG modules.
5.1. URI Registration
Following the format in the IETF XML registry [RFC3688], the
following registration is requested to be made:
URI: urn:ietf:params:xml:ns:yang:iana-qos-types
URI: urn:ietf:params:xml:ns:yang:ietf-diffserv
URI: urn:ietf:params:xml:ns:yang:ietf-qos-action
URI: urn:ietf:params:xml:ns:yang:ietf-qos-oper
URI: urn:ietf:params:xml:ns:yang:ietf-queue-policy
URI: urn:ietf:params:xml:ns:yang:ietf-scheduler-policy
URI: urn:ietf:params:xml:ns:yang:ietf-traffic-policy
Choudhary, et al. Expires 25 January 2024 [Page 67]
Internet-Draft YANG Models for QoS July 2023
Registrant Contact: The IESG. XML: N/A, the requested URI is an XML
namespace.
5.2. YANG Module Name Registration
This document registers seven YANG modules in the YANG Module Names
registry YANG [RFC6020].
name: iana-qos-types
namespace: urn:ietf:params:xml:ns:yang:iana-qos-types
prefix: qos-types
reference: RFC XXXX
name: ietf-diffserv
namespace: urn:ietf:params:xml:ns:yang:ietf-diffserv
prefix: diffserv
reference: RFC XXXX
name: ietf-qos-action
namespace: urn:ietf:params:xml:ns:yang:ietf-qos-action
prefix: action
reference: RFC XXXX
name: ietf-qos-oper
namespace: urn:ietf:params:xml:ns:yang:ietf-qos-oper
prefix: oper
reference: RFC XXXX
name: ietf-queue-policy
namespace: urn:ietf:params:xml:ns:yang:ietf-queue-policy
prefix: queue-policy
reference: RFC XXXX
name: ietf-scheduler-policy
namespace: urn:ietf:params:xml:ns:yang:ietf-scheduler-policy
prefix: scheduler-policy
reference: RFC XXXX
name: ietf-traffic-policy
namespace: urn:ietf:params:xml:ns:yang:ietf-traffic-policy
prefix: policy
reference: RFC XXXX
Choudhary, et al. Expires 25 January 2024 [Page 68]
Internet-Draft YANG Models for QoS July 2023
6. Security Considerations
The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
is HTTPS, and the mandatory-to-implement secure transport is TLS
[RFC8446]. The NETCONF Access Control Model (NACM) [RFC8341]
provides the means to restrict access for particular NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF or
RESTCONF protocol operations and content.
There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative
effect on network operations. Some of the subtrees and data nodes
and their sensitivity/vulnerability are described here.
- 'filter-operation' and 'filter'. 'filter-operation' includes the
ability to 'match all', which is a logical AND operation or 'match
any', which is a logical OR operation. Both the operations have an
impact on the traffic that is being classified. Similarly, the
'filter' list decides what parts of the packet will examined, which
will also impact the traffic that is being classified.
- 'action'. The 'action' decides what action will be taken on the
packet. That includes whether the packet will be marked, queued, or
just discarded.
Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes. Some of the subtrees and data
nodes and their sensitivity/vulnerability are:
- 'conform-pkts', 'conform-bytes', 'exceed-pkts', 'exceed-bytes',
'voilate-pkts' or 'voilate-bytes'. All these statistics combined
with their 'meter-id' are an indication of what is happening in the
network, and can allow for an intruder insight into how to disrupt
the traffic.
- 'tail-drop-pkts', 'red-drop-bytes', 'wred-stats' are examples of
statistics that indicate the kind of traffic that is being profiled
for drop or marked for Explicit Congestion Notification (ECN), and
can give an insight into the operation of a network.
Choudhary, et al. Expires 25 January 2024 [Page 69]
Internet-Draft YANG Models for QoS July 2023
Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the
operations and their sensitivity/vulnerability:
- The model allows for statistics to be cleared by the 'clear' RPC
operation, causing all the individual statistics to be cleared.
7. Acknowledgement
The authors wish to thank Ruediger Geib, Fred Baker, Greg Mirsky, Tom
Petch, Acee Lindem, many others for their helpful comments.
8. Contributors
The following people have substantially contributed to the editing of
this document:
Norm Strahle
Email: nstrahle@juniper.net .
Shitanshu Shah
Email: svshah@cisco.com .
9. References
9.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
Choudhary, et al. Expires 25 January 2024 [Page 70]
Internet-Draft YANG Models for QoS July 2023
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, DOI 10.17487/RFC8343, March 2018,
<https://www.rfc-editor.org/info/rfc8343>.
9.2. Informative References
[RFC2474] Nichols, K., Blake, S., Baker, F., and D. Black,
"Definition of the Differentiated Services Field (DS
Field) in the IPv4 and IPv6 Headers", RFC 2474,
DOI 10.17487/RFC2474, December 1998,
<https://www.rfc-editor.org/info/rfc2474>.
[RFC2475] Blake, S., Black, D., Carlson, M., Davies, E., Wang, Z.,
and W. Weiss, "An Architecture for Differentiated
Services", RFC 2475, DOI 10.17487/RFC2475, December 1998,
<https://www.rfc-editor.org/info/rfc2475>.
[RFC2697] Heinanen, J. and R. Guerin, "A Single Rate Three Color
Marker", RFC 2697, DOI 10.17487/RFC2697, September 1999,
<https://www.rfc-editor.org/info/rfc2697>.
[RFC2698] Heinanen, J. and R. Guerin, "A Two Rate Three Color
Marker", RFC 2698, DOI 10.17487/RFC2698, September 1999,
<https://www.rfc-editor.org/info/rfc2698>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
Choudhary, et al. Expires 25 January 2024 [Page 71]
Internet-Draft YANG Models for QoS July 2023
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
Appendix A. Complete tree Diagrams
This section carries complete tree diagrams of each module defined in
this draft. The tree diagrams use the notation defined in YANG Tree
Diagrams [RFC8340].
A.1. Traffic Policy Module Tree Diagram
Choudhary, et al. Expires 25 January 2024 [Page 72]
Internet-Draft YANG Models for QoS July 2023
module: ietf-traffic-policy
+--rw classifiers
| +--rw classifier* [name]
| +--rw name string
| +--rw description? string
| +--rw filter-operation? qos-types:match-operation-type
| +--rw filter* [type logical-not]
| +--rw type identityref
| +--rw logical-not boolean
+--rw policies
+--rw policy* [name type]
+--rw name string
+--rw type identityref
+--rw description? string
+--rw classifier* [name]
+--rw name string
+--rw inline!
| +--rw filter-operation?
| | qos-types:match-operation-type
| +--rw filter* [type logical-not]
| +--rw type identityref
| +--rw logical-not boolean
+--rw action* [type]
+--rw type identityref
augment /if:interfaces/if:interface:
+--rw qos-target-policy* [direction type]
+--rw direction identityref
+--rw type identityref
+--rw name string
Figure 15: Traffic Policy Tree Diagram
A.2. QoS Action Module Tree Diagram
module: ietf-qos-action
+--rw meters
| +--rw meter* [name]
| +--rw name string
| +--rw (meter-types)?
| +--:(single-rate-two-color-meter-type)
| | +--rw single-rate-two-color-meter
| | +--rw committed-information-rate? uint64
| | +--rw committed-burst-size? uint64
| | +--rw conform-action
| | | +--rw action-type? identityref
| | | +--rw dscp-mark? inet:dscp
| | | +--rw traffic-group-mark? string
Choudhary, et al. Expires 25 January 2024 [Page 73]
Internet-Draft YANG Models for QoS July 2023
| | +--rw exceed-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--:(single-rate-three-color-meter-type)
| | +--rw single-rate-three-color-meter
| | +--rw committed-information-rate? uint64
| | +--rw committed-burst-size? uint64
| | +--rw excess-burst-size? uint64
| | +--rw conform-action
| | | +--rw action-type? identityref
| | | +--rw dscp-mark? inet:dscp
| | | +--rw traffic-group-mark? string
| | +--rw exceed-action
| | | +--rw action-type? identityref
| | | +--rw dscp-mark? inet:dscp
| | | +--rw traffic-group-mark? string
| | +--rw violate-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--:(two-rate-three-color-meter-type)
| +--rw two-rate-three-color-meter
| +--rw committed-information-rate? uint64
| +--rw committed-burst-size? uint64
| +--rw peak-information-rate? uint64
| +--rw peak-burst-size? uint64
| +--rw conform-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--rw exceed-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--rw violate-action
| +--rw action-type? identityref
| +--rw dscp-mark? inet:dscp
| +--rw traffic-group-mark? string
+--rw queues
+--rw queue* [name]
+--rw name string
+--rw queue
+--rw priority
| +--rw level? uint8
+--rw min-rate
| +--rw value? uint64
| +--rw unit? identityref
Choudhary, et al. Expires 25 January 2024 [Page 74]
Internet-Draft YANG Models for QoS July 2023
+--rw max-rate
| +--rw value? uint64
| +--rw unit? identityref
| +--rw burst-value? uint64
| +--rw burst-unit? identityref
+--rw algorithmic-drop
+--rw (drop-algorithm)?
+--:(tail-drop)
| +--rw tail-drop
| +--rw tail-drop? empty
+--:(red)
| +--rw red
| +--rw min-threshold-val? uint64
| +--rw min-threshold-unit? identityref
| +--rw max-threshold-val? uint64
| +--rw max-threshold-unit? identityref
| +--rw weight? uint8
| +--rw max-probability-val? uint64
| +--rw max-probability-unit? identityref
| +--rw ecn-enabled? boolean
+--:(wred)
+--rw wred
+--rw wred* [profile]
| +--rw profile uint8
| +--rw color-type? identityref
| +--rw color-val* [min max]
| | +--rw min uint8
| | +--rw max uint8
| +--rw min-threshold-val? uint64
| +--rw min-threshold-unit? identityref
| +--rw max-threshold-val? uint64
| +--rw max-threshold-unit? identityref
| +--rw weight? uint8
| +--rw max-probability-val? uint64
| +--rw max-probability-unit? identityref
+--rw ecn-enabled? boolean
Figure 16: QoS Action Module Tree Diagram
A.3. DiffServ Module Tree Diagram
module: ietf-diffserv
augment /traffic-policy:classifiers/traffic-policy:classifier
/traffic-policy:filter:
+--rw (filter-param)?
+--:(dscp)
| +--rw dscp* [min max]
Choudhary, et al. Expires 25 January 2024 [Page 75]
Internet-Draft YANG Models for QoS July 2023
| +--rw min inet:dscp
| +--rw max inet:dscp
+--:(source-ipv4-prefix)
| +--rw source-ipv4-prefix* [prefix]
| +--rw prefix inet:ipv4-prefix
+--:(destination-ipv4-prefix)
| +--rw destination-ipv4-prefix* [prefix]
| +--rw prefix inet:ipv4-prefix
+--:(source-ipv6-prefix)
| +--rw source-ipv6-prefix* [prefix]
| +--rw prefix inet:ipv6-prefix
+--:(destination-ipv6-prefix)
| +--rw destination-ipv6-prefix* [prefix]
| +--rw prefix inet:ipv6-prefix
+--:(source-port)
| +--rw source-port* [min max]
| +--rw min inet:port-number
| +--rw max inet:port-number
+--:(destination-port)
| +--rw destination-port* [min max]
| +--rw min inet:port-number
| +--rw max inet:port-number
+--:(protocol)
| +--rw protocol* [min max]
| +--rw min uint8
| +--rw max uint8
+--:(traffic-group)
| +--rw traffic-group
| +--rw name? string
+--:(filter-match-all)
+--rw match-all
+--rw action? empty
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:inline
/traffic-policy:filter:
+--rw (filter-params)?
+--:(dscp)
| +--rw dscp* [min max]
| +--rw min inet:dscp
| +--rw max inet:dscp
+--:(source-ipv4-prefix)
| +--rw source-ipv4-prefix* [prefix]
| +--rw prefix inet:ipv4-prefix
+--:(destination-ipv4-prefix)
| +--rw destination-ipv4-prefix* [prefix]
| +--rw prefix inet:ipv4-prefix
+--:(source-ipv6-prefix)
| +--rw source-ipv6-prefix* [prefix]
Choudhary, et al. Expires 25 January 2024 [Page 76]
Internet-Draft YANG Models for QoS July 2023
| +--rw prefix inet:ipv6-prefix
+--:(destination-ipv6-prefix)
| +--rw destination-ipv6-prefix* [prefix]
| +--rw prefix inet:ipv6-prefix
+--:(source-port)
| +--rw source-port* [min max]
| +--rw min inet:port-number
| +--rw max inet:port-number
+--:(destination-port)
| +--rw destination-port* [min max]
| +--rw min inet:port-number
| +--rw max inet:port-number
+--:(protocol)
| +--rw protocol* [min max]
| +--rw min uint8
| +--rw max uint8
+--:(traffic-group)
| +--rw traffic-group
| +--rw name? string
+--:(filter-match-all)
+--rw match-all
+--rw action? empty
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:action:
+--rw (action-params)?
+--:(dscp-marking)
| +--rw dscp
| +--rw dscp? inet:dscp
+--:(meter-inline)
| +--rw (meter-types)?
| +--:(single-rate-two-color-meter-type)
| | +--rw single-rate-two-color-meter
| | +--rw committed-information-rate? uint64
| | +--rw committed-burst-size? uint64
| | +--rw conform-action
| | | +--rw action-type? identityref
| | | +--rw dscp-mark? inet:dscp
| | | +--rw traffic-group-mark? string
| | +--rw exceed-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--:(single-rate-three-color-meter-type)
| | +--rw single-rate-three-color-meter
| | +--rw committed-information-rate? uint64
| | +--rw committed-burst-size? uint64
| | +--rw excess-burst-size? uint64
| | +--rw conform-action
Choudhary, et al. Expires 25 January 2024 [Page 77]
Internet-Draft YANG Models for QoS July 2023
| | | +--rw action-type? identityref
| | | +--rw dscp-mark? inet:dscp
| | | +--rw traffic-group-mark? string
| | +--rw exceed-action
| | | +--rw action-type? identityref
| | | +--rw dscp-mark? inet:dscp
| | | +--rw traffic-group-mark? string
| | +--rw violate-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--:(two-rate-three-color-meter-type)
| +--rw two-rate-three-color-meter
| +--rw committed-information-rate? uint64
| +--rw committed-burst-size? uint64
| +--rw peak-information-rate? uint64
| +--rw peak-burst-size? uint64
| +--rw conform-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--rw exceed-action
| | +--rw action-type? identityref
| | +--rw dscp-mark? inet:dscp
| | +--rw traffic-group-mark? string
| +--rw violate-action
| +--rw action-type? identityref
| +--rw dscp-mark? inet:dscp
| +--rw traffic-group-mark? string
+--:(meter-reference)
| +--rw meter
| +--rw name string
| +--rw type identityref
+--:(traffic-group-marking)
| +--rw traffic-group
| +--rw traffic-group? string
+--:(child-policy) {qos-types:child-policy}?
| +--rw child-policy {qos-types:child-policy}?
| +--rw name? string
+--:(count) {qos-types:count}?
| +--rw count {qos-types:count}?
| +--rw count-action? empty
+--:(named-count) {qos-types:named-counter}?
| +--rw named-counter {qos-types:named-counter}?
| +--rw count-name-action? string
+--:(queue-inline)
| +--rw queue
| +--rw priority
Choudhary, et al. Expires 25 January 2024 [Page 78]
Internet-Draft YANG Models for QoS July 2023
| | +--rw level? uint8
| +--rw min-rate
| | +--rw value? uint64
| | +--rw unit? identityref
| +--rw max-rate
| | +--rw value? uint64
| | +--rw unit? identityref
| | +--rw burst-value? uint64
| | +--rw burst-unit? identityref
| +--rw algorithmic-drop
| +--rw (drop-algorithm)?
| +--:(tail-drop)
| | +--rw tail-drop
| | +--rw tail-drop? empty
| +--:(red)
| | +--rw red
| | +--rw min-threshold-val? uint64
| | +--rw min-threshold-unit? identityref
| | +--rw max-threshold-val? uint64
| | +--rw max-threshold-unit? identityref
| | +--rw weight? uint8
| | +--rw max-probability-val? uint64
| | +--rw max-probability-unit? identityref
| | +--rw ecn-enabled? boolean
| +--:(wred)
| +--rw wred
| +--rw wred* [profile]
| | +--rw profile uint8
| | +--rw color-type? identityref
| | +--rw color-val* [min max]
| | | +--rw min uint8
| | | +--rw max uint8
| | +--rw min-threshold-val? uint64
| | +--rw min-threshold-unit? identityref
| | +--rw max-threshold-val? uint64
| | +--rw max-threshold-unit? identityref
| | +--rw weight? uint8
| | +--rw max-probability-val? uint64
| | +--rw max-probability-unit? identityref
| +--rw ecn-enabled? boolean
+--:(scheduler-inline)
+--rw scheduler
+--rw min-rate
| +--rw value? uint64
| +--rw unit? identityref
+--rw max-rate
+--rw value? uint64
+--rw unit? identityref
Choudhary, et al. Expires 25 January 2024 [Page 79]
Internet-Draft YANG Models for QoS July 2023
+--rw burst-value? uint64
+--rw burst-unit? identityref
Figure 17: DiffServ Module Tree Diagram
A.4. QoS Operational Module Tree Diagram
module: ietf-qos-oper
augment /if:interfaces/if:interface:
+--ro qos-interface-statistics
+--ro stats-per-direction* []
| +--ro direction? identityref
| +--ro policy-name? string
| +--ro classifier* []
| | +--ro name? string
| | +--ro classified-pkts? yang:zero-based-counter64
| | +--ro classified-bytes? yang:zero-based-counter64
| | +--ro classified-rate? yang:gauge64
| +--ro named* []
| | +--ro name? string
| | +--ro aggregated
| | | +--ro pkts? yang:zero-based-counter64
| | | +--ro bytes? yang:zero-based-counter64
| | | +--ro rate? yang:gauge64
| | +--ro non-aggregated
| | +--ro classifier* []
| | | +--ro name? string
| | | +--ro classified-pkts?
| | | | yang:zero-based-counter64
| | | +--ro classified-bytes?
| | | | yang:zero-based-counter64
| | | +--ro classified-rate? yang:gauge64
| | +--ro metering* []
| | | +--ro meter-id? string
| | | +--ro conform-pkts? yang:zero-based-counter64
| | | +--ro conform-bytes? yang:zero-based-counter64
| | | +--ro conform-rate? yang:gauge64
| | | +--ro exceed-pkts? yang:zero-based-counter64
| | | +--ro exceed-bytes? yang:zero-based-counter64
| | | +--ro exceed-rate? yang:gauge64
| | | +--ro violate-pkts? yang:zero-based-counter64
| | | +--ro violate-bytes? yang:zero-based-counter64
| | | +--ro violate-rate? yang:gauge64
| | | +--ro drop-pkts? yang:zero-based-counter64
| | | +--ro drop-bytes? yang:zero-based-counter64
| | +--ro queueing* []
| | +--ro queue-id? string
Choudhary, et al. Expires 25 January 2024 [Page 80]
Internet-Draft YANG Models for QoS July 2023
| | +--ro transmit-pkts?
| | | yang:zero-based-counter64
| | +--ro transmit-bytes?
| | | yang:zero-based-counter64
| | +--ro queue-current-size-bytes? yang:gauge64
| | +--ro queue-average-size-bytes? yang:gauge64
| | +--ro queue-peak-size-bytes? yang:gauge64
| | +--ro tail-drop-pkts?
| | | yang:zero-based-counter64
| | +--ro tail-drop-bytes?
| | | yang:zero-based-counter64
| | +--ro red-drop-pkts?
| | | yang:zero-based-counter64
| | +--ro red-drop-bytes?
| | | yang:zero-based-counter64
| | +--ro red-ecn-marked-pkts?
| | | yang:zero-based-counter64
| | +--ro red-ecn-marked-bytes?
| | | yang:zero-based-counter64
| | +--ro wred-stats* []
| | +--ro profile? uint8
| | +--ro drop-pkts?
| | | yang:zero-based-counter64
| | +--ro drop-bytes?
| | | yang:zero-based-counter64
| | +--ro ecn-marked-pkts?
| | | yang:zero-based-counter64
| | +--ro ecn-marked-bytes?
| | yang:zero-based-counter64
| +--ro metering* []
| | +--ro meter-id? string
| | +--ro conform-pkts? yang:zero-based-counter64
| | +--ro conform-bytes? yang:zero-based-counter64
| | +--ro conform-rate? yang:gauge64
| | +--ro exceed-pkts? yang:zero-based-counter64
| | +--ro exceed-bytes? yang:zero-based-counter64
| | +--ro exceed-rate? yang:gauge64
| | +--ro violate-pkts? yang:zero-based-counter64
| | +--ro violate-bytes? yang:zero-based-counter64
| | +--ro violate-rate? yang:gauge64
| | +--ro drop-pkts? yang:zero-based-counter64
| | +--ro drop-bytes? yang:zero-based-counter64
| +--ro queueing* []
| +--ro queue-id? string
| +--ro transmit-pkts?
| | yang:zero-based-counter64
| +--ro transmit-bytes?
| | yang:zero-based-counter64
Choudhary, et al. Expires 25 January 2024 [Page 81]
Internet-Draft YANG Models for QoS July 2023
| +--ro queue-current-size-bytes? yang:gauge64
| +--ro queue-average-size-bytes? yang:gauge64
| +--ro queue-peak-size-bytes? yang:gauge64
| +--ro tail-drop-pkts?
| | yang:zero-based-counter64
| +--ro tail-drop-bytes?
| | yang:zero-based-counter64
| +--ro red-drop-pkts?
| | yang:zero-based-counter64
| +--ro red-drop-bytes?
| | yang:zero-based-counter64
| +--ro red-ecn-marked-pkts?
| | yang:zero-based-counter64
| +--ro red-ecn-marked-bytes?
| | yang:zero-based-counter64
| +--ro wred-stats* []
| +--ro profile? uint8
| +--ro drop-pkts? yang:zero-based-counter64
| +--ro drop-bytes? yang:zero-based-counter64
| +--ro ecn-marked-pkts? yang:zero-based-counter64
| +--ro ecn-marked-bytes? yang:zero-based-counter64
+---x clear
+---w input
| +---w category? identityref
| +---w started-at? yang:date-and-time
+--ro output
+--ro finished-at? yang:date-and-time
Figure 18: QoS Operational Module Tree Diagram
A.5. Scheduler Policy Module Tree Diagram
Choudhary, et al. Expires 25 January 2024 [Page 82]
Internet-Draft YANG Models for QoS July 2023
module: ietf-scheduler-policy
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:inline
/traffic-policy:filter:
+--rw (filter-params)?
+--:(filter-match-all)
+--rw match-all
+--rw action? empty
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:action:
+--rw (action-params)?
+--:(scheduler)
| +--rw scheduler
| +--rw min-rate
| | +--rw value? uint64
| | +--rw unit? identityref
| +--rw max-rate
| +--rw value? uint64
| +--rw unit? identityref
| +--rw burst-value? uint64
| +--rw burst-unit? identityref
+--:(queue-policy-name)
+--rw queue-policy-name
+--rw queue-policy
-> /traffic-policy:policies/policy/name
Figure 19: Scheduler Policy Module Tree Diagram
A.6. Queue Policy Module Tree Diagram
module: ietf-queue-policy
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:inline
/traffic-policy:filter:
+--rw (filter-params)?
+--:(traffic-group)
| +--rw traffic-group
| +--rw name? string
+--:(filter-match-all)
+--rw match-all
+--rw action? empty
augment /traffic-policy:policies/traffic-policy:policy
/traffic-policy:classifier/traffic-policy:action:
+--rw (action-params)?
+--:(queue-template-name)
| +--rw queue-reference
Choudhary, et al. Expires 25 January 2024 [Page 83]
Internet-Draft YANG Models for QoS July 2023
| +--rw queue-name string
+--:(queue-inline)
+--rw queue
+--rw priority
| +--rw level? uint8
+--rw min-rate
| +--rw value? uint64
| +--rw unit? identityref
+--rw max-rate
| +--rw value? uint64
| +--rw unit? identityref
| +--rw burst-value? uint64
| +--rw burst-unit? identityref
+--rw algorithmic-drop
+--rw (drop-algorithm)?
+--:(tail-drop)
| +--rw tail-drop
| +--rw tail-drop? empty
+--:(red)
| +--rw red
| +--rw min-threshold-val? uint64
| +--rw min-threshold-unit? identityref
| +--rw max-threshold-val? uint64
| +--rw max-threshold-unit? identityref
| +--rw weight? uint8
| +--rw max-probability-val? uint64
| +--rw max-probability-unit? identityref
| +--rw ecn-enabled? boolean
+--:(wred)
+--rw wred
+--rw wred* [profile]
| +--rw profile uint8
| +--rw color-type? identityref
| +--rw color-val* [min max]
| | +--rw min uint8
| | +--rw max uint8
| +--rw min-threshold-val? uint64
| +--rw min-threshold-unit? identityref
| +--rw max-threshold-val? uint64
| +--rw max-threshold-unit? identityref
| +--rw weight? uint8
| +--rw max-probability-val? uint64
| +--rw max-probability-unit? identityref
+--rw ecn-enabled? boolean
Figure 20: Queue Policy Module Tree Diagram
Choudhary, et al. Expires 25 January 2024 [Page 84]
Internet-Draft YANG Models for QoS July 2023
Appendix B. Company A and Company B examples
Company A and Company B DiffServ modules augments all the filter
types of the QoS Classifier module as well as the QoS Policy module
that allow it to define marking, metering, min-rate, max-rate
actions. Queueing and metering counters are realized by augmenting
of the QoS Target module.
B.1. Example of Company A DiffServ Model
The following Company A vendor example augments the QoS and DiffServ
model, demonstrating some of the following functionality:
- use of template based classifier definitions
- use of single policy type modelling queue, scheduler policy, and a
filter policy. All of these policies either augment the QoS policy
or the DiffServ modules
- use of inline actions in a policy
- flexibility in marking dscp or metadata at ingress and/or egress.
module example-compa-diffserv {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:example-compa-diffserv";
prefix example;
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
import ietf-traffic-policy {
prefix traffic-policy;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
import ietf-qos-action {
prefix qos-action;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
import ietf-diffserv {
prefix diffserv;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
Choudhary, et al. Expires 25 January 2024 [Page 85]
Internet-Draft YANG Models for QoS July 2023
organization "Company A";
contact
"Editor: XYZ
<mailto:xyz@compa.com>";
description
"This module contains a collection of YANG definitions of
companyA diffserv specification extension.";
revision 2023-07-20 {
description
"Initial revision for diffserv actions on network packets.";
reference
"RFC XXXX: A YANG Data Model for Quality of Service (QoS).";
}
identity default-policy-type {
base qos-types:policy-type;
description
"This defines default policy-type.";
}
identity qos-group {
base qos-types:filter-type;
description
"Filter-type to match on packet metadata. This metadata
can be used for packet marking, queuing for traffic in
egress direction.";
}
grouping qos-group {
list qos-group {
key "min max";
description
"List of qos-groups to match on. A QoS group is a set of
packets tagged as group.";
leaf min {
type uint8;
description
"Minimum value of qos-group range.";
}
leaf max {
type uint8;
must ". >= ../min" {
error-message
"The qos-group max must be
greater than or equal to qos-group min.";
}
description
"Maximum value of qos-group range.";
Choudhary, et al. Expires 25 January 2024 [Page 86]
Internet-Draft YANG Models for QoS July 2023
}
}
description
"Filter containing list of qos-group ranges.";
}
grouping bw-remaining-percent {
container bw-remaining-percent {
leaf value {
type uint8;
units "percentage";
description
"Percentage of the remaining bandwidth present.";
}
description
"Remaining bandwidth of the link in percent.";
}
description
"Grouping for bandwidth remaining after
reserved and priority bandwidth.";
}
grouping qos-group-marking {
container qos-group {
leaf qos-group {
type uint8;
description
"Mark metadata information in the network packet";
}
description
"Container for QoS-Group marking.";
}
description
"Grouping for QoS-Group marking.";
}
augment "/traffic-policy:classifiers/" +
"traffic-policy:classifier/" +
"traffic-policy:filter/diffserv:filter-param" {
case qos-group {
uses qos-group;
description
"Filter containing list of qos-group ranges.
QoS-group represent packet metadata information
in a network packet.";
}
description
"Augmentation of classifier filters.";
}
Choudhary, et al. Expires 25 January 2024 [Page 87]
Internet-Draft YANG Models for QoS July 2023
augment "/traffic-policy:policies/traffic-policy:policy/" +
"traffic-policy:classifier/" +
"traffic-policy:action" {
choice action-params {
case priority {
uses qos-action:priority;
}
case min-rate {
uses qos-action:min-rate;
}
case max-rate {
uses qos-action:max-rate;
}
case bw-remaining {
uses bw-remaining-percent;
}
case mark-qos-group {
uses qos-group-marking;
}
description
"Choice of action parameters.";
}
description
"Augments policy entry to add action parameters.";
}
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:action" +
"/diffserv:action-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-types" +
"/diffserv:single-rate-two-color-meter-type" +
"/diffserv:single-rate-two-color-meter" {
description
"Augment the single-rate-two-color meter to add" +
"color classifiers.";
container conform-color {
uses traffic-policy:generic-classifier-attr;
description
"Conform color classifier container.";
}
container exceed-color {
uses traffic-policy:generic-classifier-attr;
description
"Exceed color classifier container.";
}
Choudhary, et al. Expires 25 January 2024 [Page 88]
Internet-Draft YANG Models for QoS July 2023
}
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:action" +
"/diffserv:action-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-types" +
"/diffserv:single-rate-three-color-meter-type" +
"/diffserv:single-rate-three-color-meter" {
description
"Augment the one-rate-tri-color meter to add" +
"color classifiers.";
container conform-color {
uses traffic-policy:generic-classifier-attr;
description
"Conform color classifier container.";
}
container exceed-color {
uses traffic-policy:generic-classifier-attr;
description
"Exceed color classifier container.";
}
container violate-color {
uses traffic-policy:generic-classifier-attr;
description
"Violate color classifier container.";
}
}
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:action" +
"/diffserv:action-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-types" +
"/diffserv:two-rate-three-color-meter-type" +
"/diffserv:two-rate-three-color-meter" {
description
"Augment the two-rate-tri-color meter to add" +
"color classifiers.";
container conform-color {
uses traffic-policy:generic-classifier-attr;
description
"Conform color classifier container.";
}
Choudhary, et al. Expires 25 January 2024 [Page 89]
Internet-Draft YANG Models for QoS July 2023
container exceed-color {
uses traffic-policy:generic-classifier-attr;
description
"Exceed color classifier container.";
}
container violate-color {
uses traffic-policy:generic-classifier-attr;
description
"Violate color classifier container.";
}
}
}
B.2. Example of Company B DiffServ Model
The following vendor example augments the QoS and DiffServ model,
demonstrating some of the following functionality:
- use of inline classifier definitions (defined inline in the policy
vs referencing an externally defined classifier)
- use of mulitple policy types, e.g. a queue policy, a scheduler
policy, and a filter policy. All of these policies either augment
the QoS policy or the DiffServ modules
- use of a queue module, which uses and extends the queue grouping
from the QoS Action module
- use of meter templates (v.s. meter inline)
- use of internal meta data for classification and marking
module example-compb-diffserv-filter-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:" +
"example-compb-diffserv-filter-policy";
prefix compb-filter-policy;
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
import ietf-traffic-policy {
prefix traffic-policy;
}
import ietf-qos-action {
prefix qos-action;
Choudhary, et al. Expires 25 January 2024 [Page 90]
Internet-Draft YANG Models for QoS July 2023
}
import ietf-diffserv {
prefix diffserv;
}
organization
"Company B";
contact
"Editor: XYZ
<mailto:xyz@compb.com>";
description
"This module contains a collection of YANG definitions for
configuring diffserv specification implementations.
Copyright (c) 2022 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial revision of diffserv policy for Company B.";
reference
"RFC XXXX: YANG Data Model for QoS.";
}
/*************************************************
* Classification types
*************************************************/
identity internal-loss-priority {
base qos-types:filter-type;
description
"Internal loss priority filter type.";
}
grouping loss-priority {
Choudhary, et al. Expires 25 January 2024 [Page 91]
Internet-Draft YANG Models for QoS July 2023
list loss-priority {
key "loss-priority";
description
"list of loss-priorities";
leaf loss-priority {
type enumeration {
enum high {
description "High loss Priority.";
}
enum medium-high {
description "Medium to high loss priority.";
}
enum medium-low {
description "Medium to low loss priority.";
}
enum low {
description "Low loss priority.";
}
}
description
"Loss priority.";
}
}
description
"Filter containing list of loss priorities";
}
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:inline/traffic-policy:filter" +
"/diffserv:filter-params" {
case internal-loss-priority {
uses loss-priority;
description
"Filter Type Internal-loss-priority";
}
description
"Augments Diffserv Classifier with vendor " +
"specific types.";
}
/*************************************************
* Actions
*************************************************/
identity mark-loss-priority {
base qos-types:action-type;
Choudhary, et al. Expires 25 January 2024 [Page 92]
Internet-Draft YANG Models for QoS July 2023
description
"Mark loss-priority action type.";
}
grouping mark-loss-priority {
container mark-loss-priority {
leaf loss-priority {
type enumeration {
enum high {
description "High loss Priority.";
}
enum medium-high {
description "Medium to high loss priority.";
}
enum medium-low {
description "Medium to low loss priority.";
}
enum low {
description "Low loss priority.";
}
}
description
"Loss priority.";
}
description
"Mark loss priority container.";
}
description
"Mark loss priority grouping.";
}
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:action" +
"/diffserv:action-params" {
case traffic-group-marking {
uses qos-action:traffic-group-marking;
description
"Mark traffic group in the packet.";
}
case mark-loss-priority {
uses mark-loss-priority;
description
"Mark loss priority in the packet.";
}
case meter-reference {
uses qos-action:meter-reference;
Choudhary, et al. Expires 25 January 2024 [Page 93]
Internet-Draft YANG Models for QoS July 2023
description
"Assign a meter as an action.";
}
case discard {
uses qos-action:discard;
description
"Discard action.";
}
case count {
uses qos-action:count;
description
"Count action - explicit count configuration.";
}
description
"Augments common diffserv policy actions";
}
augment "/qos-action:meters" +
"/qos-action:meter" +
"/qos-action:meter-types" +
"/qos-action:single-rate-three-color-meter-type" +
"/qos-action:single-rate-three-color-meter" {
leaf one-rate-color-aware {
type boolean;
description
"This defines if the meter is color-aware.";
}
description
"Augmentation of color-aware flag.";
}
augment "/qos-action:meters" +
"/qos-action:meter" +
"/qos-action:meter-types" +
"/qos-action:two-rate-three-color-meter-type" +
"/qos-action:two-rate-three-color-meter" {
leaf two-rate-color-aware {
type boolean;
description
"This defines if the meter is color-aware.";
}
description
"Augmentation of color-aware flag.";
}
}
module example-compb-queue-policy {
Choudhary, et al. Expires 25 January 2024 [Page 94]
Internet-Draft YANG Models for QoS July 2023
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:example-compb-queue-policy";
prefix queue-plcy;
import iana-qos-types {
prefix qos-types;
reference
"RFC XXXX: YANG Models for Quality of Service (QoS).";
}
import ietf-traffic-policy {
prefix traffic-policy;
}
organization "Company B";
contact
"Editor: XYZ
<mailto:xyz@compb.com>";
description
"This module defines a queue policy. The classification
is based on aforwarding class, and the actions are queues.
Copyright (c) 2014 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial revision of diffserv policy";
reference
"RFC XXXX: A YANG Data Model for Quality of Service (QoS).";
}
identity compb-queue {
base qos-types:action-type;
description
"compb-queue action type";
}
Choudhary, et al. Expires 25 January 2024 [Page 95]
Internet-Draft YANG Models for QoS July 2023
grouping compb-queue-name {
container queue-name {
leaf name {
type string;
description
"Queue class name";
}
description
"compb queue container";
}
description
"compb-queue grouping";
}
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:action" {
choice action-params {
description
"Choice of action types";
case compb-queue {
uses compb-queue-name;
}
}
description
"Augment the queue actions to queue policy entry";
}
}
module example-compb-queue {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-compb-queue";
prefix compb-queue;
import ietf-qos-action {
prefix qos-action;
reference "RFC XXXX: YANG Model for QoS";
}
organization "Company B";
contact
"Editor: XYZ
<mailto:xyz@compb.com>";
description
"This module describes a compb queue module. This is a
template for a queue within a queue policy, referenced
Choudhary, et al. Expires 25 January 2024 [Page 96]
Internet-Draft YANG Models for QoS July 2023
by name.
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2023-07-20 {
description
"Initial revision of diffserv based classifier";
reference
"RFC XXXX: YANG Data Model for Quality of Service (QoS).";
}
container compb-queue {
description
"Queue used in compb architecture";
leaf name {
type string;
description
"A unique name identifying this queue";
}
uses qos-action:queue;
container excess-rate {
choice excess-rate-type {
case percent {
leaf excess-rate-percent {
type uint32 {
range "1..100";
}
description
"excess-rate-percent";
}
}
case proportion {
leaf excess-rate-poroportion {
type uint32 {
range "1..1000";
}
description
"excess-rate-poroportion";
}
}
description
"Choice of excess-rate type";
}
description
"Excess rate value";
}
leaf excess-priority {
Choudhary, et al. Expires 25 January 2024 [Page 97]
Internet-Draft YANG Models for QoS July 2023
type enumeration {
enum high {
description "High Loss Priority";
}
enum medium-high {
description "Medium-high Loss Priority";
}
enum medium-low {
description "Medium-low Loss Priority";
}
enum low {
description "Low Loss Priority";
}
enum none {
description "No excess priority";
}
}
description
"Priority of excess (above guaranted rate) traffic";
}
container buffer-size {
choice buffer-size-type {
case percent {
leaf buffer-size-percent {
type uint32 {
range "1..100";
}
description
"buffer-size-percent";
}
}
case temporal {
leaf buffer-size-temporal {
type uint64;
units "microsecond";
description
"buffer-size-temporal";
}
}
case remainder {
leaf buffer-size-remainder {
type empty;
description
"use remaining of buffer";
}
}
description
"Choice of buffer size type";
Choudhary, et al. Expires 25 January 2024 [Page 98]
Internet-Draft YANG Models for QoS July 2023
}
description
"Buffer size value";
}
}
augment
"/compb-queue/queue/algorithmic-drop" +
"/drop-algorithm" {
case random-detect {
list drop-profile-list {
key "priority";
description
"map of priorities to drop-algorithms";
leaf priority {
type enumeration {
enum any {
description "Any priority mapped here";
}
enum high {
description "High Priority Packet";
}
enum medium-high {
description "Medium-high Priority Packet";
}
enum medium-low {
description "Medium-low Priority Packet";
}
enum low {
description "Low Priority Packet";
}
}
description
"Priority of guaranteed traffic";
}
leaf drop-profile {
type string;
description
"drop profile to use for this priority";
}
}
}
description
"compb random detect drop algorithm config";
}
}
module example-compb-scheduler-policy {
Choudhary, et al. Expires 25 January 2024 [Page 99]
Internet-Draft YANG Models for QoS July 2023
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:" +
"example-compb-scheduler-policy";
prefix scheduler-plcy;
import ietf-qos-action {
prefix qos-action;
reference
"RFC XXXX: A YANG Data Model for Quality of Service (QoS).";
}
import ietf-traffic-policy {
prefix traffic-policy;
reference
"RFC XXXX: A YANG Data Model for Quality of Service (QoS).";
}
organization
"Company B";
contact
"Editor: XYZ
<mailto:xyz@compb.com>";
description
"This module defines a scheduler policy. The classification
is based on classifier-any, and the action is a scheduler.";
revision 2023-07-20 {
description
"Initial revision of diffserv policy";
reference
"RFC XXXX: A YANG Data Model for Quality of Service (QoS).";
}
grouping queue-policy-name {
container compb-queue-policy-name {
leaf name {
type string;
description
"Queue policy name";
}
description
"compb-queue-policy container";
}
description
"compb-queue policy grouping";
}
Choudhary, et al. Expires 25 January 2024 [Page 100]
Internet-Draft YANG Models for QoS July 2023
augment "/traffic-policy:policies" +
"/traffic-policy:policy" +
"/traffic-policy:classifier" +
"/traffic-policy:action" {
choice action-params {
case scheduler {
uses qos-action:scheduler;
}
case queue-policy {
uses queue-policy-name;
}
description
"Augment the scheduler policy with a queue policy";
}
description
"Augmentation of the scheduler policy with a queue policy";
}
}
Appendix C. Configuration examples
This section describes several examples of how the models defined in
this draft can be used for configuration.
C.1. Configuration example for QoS Classifier
Choudhary, et al. Expires 25 January 2024 [Page 101]
Internet-Draft YANG Models for QoS July 2023
<!--
This example shows a QoS classifier configuration.
This classifier will match on any packet which has
dscp value not in the range of 11-13 and source-port
value which is in the range of either 10000-10300 or
17540-19800. In other words, packets with dscp value
0-10 or 14-63 and source-port value 10000-10300 or
17540-19800
-->
<?xml version="1.0" encoding="UTF-8"?>
<classifiers
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<classifier>
<name>my-classifier</name>
<filter-operation>match-all</filter-operation>
<filter>
<type>qt:dscp</type>
<logical-not>true</logical-not>
<dscp
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>11</min>
<max>13</max>
</dscp>
</filter>
<filter>
<type>qt:source-port</type>
<logical-not>false</logical-not>
<source-port
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>10000</min>
<max>10300</max>
</source-port>
<source-port
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>17540</min>
<max>19800</max>
</source-port>
</filter>
</classifier>
</classifiers>
Figure 21: Configuration example for QoS Classifier
C.2. Configuration example for QoS Policy
Choudhary, et al. Expires 25 January 2024 [Page 102]
Internet-Draft YANG Models for QoS July 2023
<!--
This example shows a QoS policy configuration.
-->
<?xml version="1.0" encoding="UTF-8"?>
<policies
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<policy>
<name>my-policy</name>
<type>qt:diffserv-policy-type</type>
<classifier>
<name>my-classifier</name>
<inline>
<filter>
<type>qt:dscp</type>
<logical-not>false</logical-not>
<dscp
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>21</min>
<max>22</max>
</dscp>
</filter>
</inline>
<action>
<type>qt:dscp-marking</type>
<dscp
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<dscp>23</dscp>
</dscp>
</action>
</classifier>
</policy>
</policies>
Figure 22: Configuration example for QoS Policy
C.3. Configuration example for QoS Policing
<!--
This example shows a QoS policy configuration for a single rate
two color policing. For a description of the problem refer to:
https://networklessons.com/quality-of-service/
policing-configuration-example
-->
<?xml version="1.0" encoding="UTF-8"?>
<classifiers
Choudhary, et al. Expires 25 January 2024 [Page 103]
Internet-Draft YANG Models for QoS July 2023
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<classifier>
<name>ICMP</name>
<description>class-map definition for ICMP</description>
<filter>
<type>qt:protocol</type>
<logical-not>false</logical-not>
<protocol
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>4</min>
<max>4</max>
</protocol>
</filter>
</classifier>
</classifiers>
<policies
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<policy>
<name>SINGLE-RATE-TWO-COLOR</name>
<type>qt:diffserv-policy-type</type>
<classifier>
<name>ICMP</name>
<action>
<type>qt:meter-inline</type>
<single-rate-two-color-meter
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<committed-information-rate>128000</committed-information-rate>
<conform-action>
<action-type>qt:action-transmit</action-type>
</conform-action>
<exceed-action>
<action-type>qt:action-drop</action-type>
</exceed-action>
</single-rate-two-color-meter>
</action>
</classifier>
</policy>
</policies>
<interfaces
xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types"
xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">
<interface>
<name>FastEthernet 0/0</name>
Choudhary, et al. Expires 25 January 2024 [Page 104]
Internet-Draft YANG Models for QoS July 2023
<type>ianaift:ethernetCsmacd</type>
<qos-target-policy
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy">
<direction>qt:ingress</direction>
<type>qt:diffserv-policy-type</type>
<name>SINGLE-RATE-TWO-COLOR</name>
</qos-target-policy>
</interface>
</interfaces>
Figure 23: Configuration example for QoS Policing
C.4. Configuration example for QoS Queueing
<!--
This example shows a QoS policy configuration for queuing.
For a description of the problem refer to:
https://networklessons.com/quality-of-service/
queuing-configuration-example
-->
<?xml version="1.0" encoding="UTF-8"?>
<classifiers
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<classifier>
<name>VOICE</name>
<description>class-map definition for VOICE</description>
<filter>
<type>qt:protocol</type>
<logical-not>false</logical-not>
<dscp
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>46</min>
<max>46</max>
</dscp>
</filter>
</classifier>
<classifier>
<name>VIDEO</name>
<description>class-map definition for VIDEO</description>
<filter>
<type>qt:protocol</type>
<logical-not>false</logical-not>
<dscp
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>34</min>
<max>34</max>
Choudhary, et al. Expires 25 January 2024 [Page 105]
Internet-Draft YANG Models for QoS July 2023
</dscp>
</filter>
</classifier>
<classifier>
<name>DATA</name>
<description>class-map definition for DATA</description>
<filter>
<type>qt:protocol</type>
<logical-not>false</logical-not>
<dscp
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<min>10</min>
<max>10</max>
</dscp>
</filter>
</classifier>
</classifiers>
<policies
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<policy>
<name>QUEUEING-POLICY</name>
<type>qt:diffserv-policy-type</type>
<classifier>
<name>VOICE</name>
<action>
<type>qt:queue</type>
<queue
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<priority>
<level>1</level>
</priority>
<min-rate>
<value>2000000</value>
<unit>qt:bits-per-second</unit>
</min-rate>
<max-rate>
<value>4000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</queue>
</action>
</classifier>
<classifier>
<name>VIDEO</name>
<action>
<type>qt:queue</type>
Choudhary, et al. Expires 25 January 2024 [Page 106]
Internet-Draft YANG Models for QoS July 2023
<queue
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<priority>
<level>2</level>
</priority>
<min-rate>
<value>10000000</value>
<unit>qt:bits-per-second</unit>
</min-rate>
<max-rate>
<value>30000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</queue>
</action>
</classifier>
<classifier>
<name>DATA</name>
<action>
<type>qt:queue</type>
<queue
xmlns="urn:ietf:params:xml:ns:yang:ietf-diffserv">
<priority>
<level>2</level>
</priority>
<min-rate>
<value>8000000</value>
<unit>qt:bits-per-second</unit>
</min-rate>
<max-rate>
<value>18000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</queue>
</action>
</classifier>
</policy>
</policies>
<interfaces
xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types"
xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">
<interface>
<name>FastEthernet 0/0</name>
<type>ianaift:ethernetCsmacd</type>
<qos-target-policy
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy">
Choudhary, et al. Expires 25 January 2024 [Page 107]
Internet-Draft YANG Models for QoS July 2023
<direction>qt:egress</direction>
<type>qt:diffserv-policy-type</type>
<name>QUEUEING-POLICY</name>
</qos-target-policy>
</interface>
</interfaces>
Figure 24: Configuration example for QoS Queueing
C.5. Configuration example for QoS Scheduling
<!--
This example shows a QoS policy configuration for scheduling.
-->
<?xml version="1.0" encoding="UTF-8"?>
<policies
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy"
xmlns:qp="urn:ietf:params:xml:ns:yang:ietf-queue-policy"
xmlns:sp="urn:ietf:params:xml:ns:yang:ietf-scheduler-policy"
xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-diffserv"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types">
<policy>
<name>QUEUEING-POLICY</name>
<type>qt:queue-policy-type</type>
<classifier>
<name>VOICE</name>
<inline>
<filter>
<type>qt:traffic-group-name</type>
<logical-not>false</logical-not>
<traffic-group
xmlns="urn:ietf:params:xml:ns:yang:ietf-queue-policy">
<name>voice</name>
</traffic-group>
</filter>
</inline>
<action>
<type>qt:queue</type>
<queue
xmlns="urn:ietf:params:xml:ns:yang:ietf-queue-policy">
<priority>
<level>1</level>
</priority>
<min-rate>
<value>2000000</value>
<unit>qt:bits-per-second</unit>
Choudhary, et al. Expires 25 January 2024 [Page 108]
Internet-Draft YANG Models for QoS July 2023
</min-rate>
<max-rate>
<value>4000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</queue>
</action>
</classifier>
<classifier>
<name>VIDEO</name>
<inline>
<filter>
<type>qt:traffic-group-name</type>
<logical-not>false</logical-not>
<traffic-group
xmlns="urn:ietf:params:xml:ns:yang:ietf-queue-policy">
<name>video</name>
</traffic-group>
</filter>
</inline>
<action>
<type>qt:queue</type>
<queue
xmlns="urn:ietf:params:xml:ns:yang:ietf-queue-policy">
<priority>
<level>2</level>
</priority>
<min-rate>
<value>10000000</value>
<unit>qt:bits-per-second</unit>
</min-rate>
<max-rate>
<value>30000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</queue>
</action>
</classifier>
<classifier>
<name>DATA</name>
<inline>
<filter>
<type>qt:traffic-group-name</type>
<logical-not>false</logical-not>
<traffic-group
xmlns="urn:ietf:params:xml:ns:yang:ietf-queue-policy">
<name>data</name>
</traffic-group>
Choudhary, et al. Expires 25 January 2024 [Page 109]
Internet-Draft YANG Models for QoS July 2023
</filter>
</inline>
<action>
<type>qt:queue</type>
<queue
xmlns="urn:ietf:params:xml:ns:yang:ietf-queue-policy">
<priority>
<level>2</level>
</priority>
<min-rate>
<value>8000000</value>
<unit>qt:bits-per-second</unit>
</min-rate>
<max-rate>
<value>18000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</queue>
</action>
</classifier>
</policy>
<policy>
<name>SCHEDULING-POLICY</name>
<type>qt:scheduler-policy-type</type>
<classifier>
<name>ALL</name>
<inline>
<filter>
<type>qt:filter-match-all</type>
<logical-not>false</logical-not>
<sp:match-all>
<sp:action></sp:action>
</sp:match-all>
</filter>
</inline>
<action>
<type>qt:scheduler</type>
<scheduler
xmlns="urn:ietf:params:xml:ns:yang:ietf-scheduler-policy">
<min-rate>
<value>20000000</value>
<unit>qt:bits-per-second</unit>
</min-rate>
<max-rate>
<value>50000000</value>
<unit>qt:bits-per-second</unit>
</max-rate>
</scheduler>
Choudhary, et al. Expires 25 January 2024 [Page 110]
Internet-Draft YANG Models for QoS July 2023
</action>
<action>
<type>qt:queue-policy-name</type>
<queue-policy-name
xmlns="urn:ietf:params:xml:ns:yang:ietf-scheduler-policy">
<queue-policy>QUEUEING-POLICY</queue-policy>
</queue-policy-name>
</action>
</classifier>
</policy>
</policies>
<interfaces
xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"
xmlns:qt="urn:ietf:params:xml:ns:yang:iana-qos-types"
xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">
<interface>
<name>FastEthernet 0/0</name>
<type>ianaift:ethernetCsmacd</type>
<qos-target-policy
xmlns="urn:ietf:params:xml:ns:yang:ietf-traffic-policy">
<direction>qt:egress</direction>
<type>qt:scheduler-policy-type</type>
<name>SCHEDULING-POLICY</name>
</qos-target-policy>
</interface>
</interfaces>
Figure 25: Configuration example for QoS Scheduling
Authors' Addresses
Aseem Choudhary
Aviatrix Systems
2901 Tasman Drive #109
Santa Clara, CA 95054
United States of America
Email: achoudhary@aviatrix.com
Mahesh Jethanandani
Kloud Services
Email: mjethanandani@gmail.com
Choudhary, et al. Expires 25 January 2024 [Page 111]
Internet-Draft YANG Models for QoS July 2023
Ebben Aries
Juniper Networks
1194 North Mathilda Avenue
Sunnyvale, CA 94089
United States of America
Email: exa@juniper.net
Ing-Wher Chen
The MITRE Corporation
Email: ingwherchen@mitre.org
Choudhary, et al. Expires 25 January 2024 [Page 112]