Network Working Group A. Choudhary
Internet-Draft Cisco Systems
Intended status: Standards Track M. Jethanandani
Expires: October 10, 2020 VMware
N. Strahle
E. Aries
Juniper Networks
I. Chen
The MITRE Corporation
April 08, 2020
YANG Model for QoS
draft-ietf-rtgwg-qos-model-01
Abstract
This document describes a YANG model for Quality of Service (QoS)
configuration and operational parameters.
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 October 10, 2020.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
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
Choudhary, et al. Expires October 10, 2020 [Page 1]
Internet-Draft YANG Model For QoS April 2020
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. QoS Model Design . . . . . . . . . . . . . . . . . . . . . . 3
4. DiffServ Model Design . . . . . . . . . . . . . . . . . . . . 4
5. Modules Tree Structure . . . . . . . . . . . . . . . . . . . 5
6. Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
6.1. IETF-QOS-CLASSIFIER . . . . . . . . . . . . . . . . . . . 14
6.2. IETF-QOS-POLICY . . . . . . . . . . . . . . . . . . . . . 17
6.3. IETF-QOS-ACTION . . . . . . . . . . . . . . . . . . . . . 20
6.4. IETF-QOS-TARGET . . . . . . . . . . . . . . . . . . . . . 38
6.5. IETF-DIFFSERV . . . . . . . . . . . . . . . . . . . . . . 40
6.6. IETF-QUEUE-POLICY . . . . . . . . . . . . . . . . . . . . 51
6.7. IETF-SCHEDULER-POLICY . . . . . . . . . . . . . . . . . . 54
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 57
8. Security Considerations . . . . . . . . . . . . . . . . . . . 57
9. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 57
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 57
10.1. Normative References . . . . . . . . . . . . . . . . . . 57
10.2. Informative References . . . . . . . . . . . . . . . . . 58
Appendix A. Company A, Company B and Company C examples . . . . 59
A.1. Example of Company A Diffserv Model . . . . . . . . . . . 59
A.2. Example of Company B Diffserv Model . . . . . . . . . . . 68
A.3. Example of Company C Diffserv Model . . . . . . . . . . . 82
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 89
1. Introduction
This document defines a base YANG [RFC6020] [RFC7950] data module for
Quality of Service (QoS) configuration parameters. Differentiated
Services (DiffServ) module is an augmentation of the base QoS model.
Remote Procedure Calls (RPC) or notification definition is not part
of this document. QoS base modules define a basic building blocks to
define a classifier, policy, action and target. The base modules
have been augmented to include packet match fields and action
parameters to define the DiffServ module. Queues and schedulers are
stitched as part of diffserv policy itself or separate modules are
defined for creating Queue policy and Scheduling policy. The
DiffServ model is based on DiffServ architecture, and various
references have been made to available standard architecture
documents.
Choudhary, et al. Expires October 10, 2020 [Page 2]
Internet-Draft YANG Model For QoS April 2020
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.
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: o "XXXX" --> the assigned RFC value
for this draft both in this draft and in the YANG models under the
revision statement. o The "revision" date in model, in the format
XXXX-XX-XX, needs to be updated with the date the draft gets
approved.
The YANG modules in this document conform to the Network Management
Datastore Architecture (NMDA) [RFC8342].
1.1. Tree Diagrams
Tree diagrams used in this document follow the notation defined in
[RFC8340]
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.
3. QoS Model Design
A classifier consists of packets which may be grouped when a logical
set of rules are applied on different packet header fields. The
grouping may be based on different values or range of values of same
packet header field, presence or absence of some values or range of
values of a packet field or a combination thereof. The QoS
classifier is defined in the ietf-qos-classifier module.
A classifier entry contains one or more packet conditioning
functions. A packet conditioning function is typically based on
direction of traffic and may drop, mark or delay network packets. A
set of classifier entries with corresponding conditioning functions
when arranged in order of priority represents a QoS policy. A QoS
Choudhary, et al. Expires October 10, 2020 [Page 3]
Internet-Draft YANG Model For QoS April 2020
policy may contain one or more classifier entries. These are defined
in ietf-qos-policy module.
Actions are configured in line with respect to the policy module.
These include marking, dropping or shaping. Actions are defined in
the ietf-qos-action module.
A meter qualifies if the traffic arrival rate is based on agreed upon
rate and variability. A meter is modeled based on commonly used
alogrithms in industry, Single Rate Tri Color Marking (srTCM)
[RFC2697] meter, Two Rate Tri Color Marking (trTCM) [RFC2698] meter,
and Single Rate Two Color Marking meter. Different vendors can
extend it with other types of meters as well.
This module imports definitions from "Common YANG Data Types"
[RFC6991] and "A YANG Data Model for Interface Management" [RFC8343].
4. DiffServ Model Design
DiffServ architecture [RFC3289] and [RFC2475] describe 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 ietf-diffserv module, this is realized by
augmenting the QoS classification 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.
Choudhary, et al. Expires October 10, 2020 [Page 4]
Internet-Draft YANG Model For QoS April 2020
5. Modules Tree Structure
This document defines seven YANG modules - four QoS base modules, a
scheduler policy module, a queuing policy module and one DiffServ
module.
ietf-qos-classifier consists of classifier entries identified by a
classifier entry name. Each entry MAY contain a list of filter
entries. When no filter entry is present in a classifier entry, it
matches all traffic.
module: ietf-qos-classifier
+--rw classifiers
+--rw classifier-entry* [classifier-entry-name]
+--rw classifier-entry-name string
+--rw classifier-entry-descr? string
+--rw classifier-entry-filter-operation? identityref
+--rw filter-entry* [filter-type filter-logical-not]
+--rw filter-type identityref
+--rw filter-logical-not boolean
An ietf-qos-policy module contains list of policy objects identified
by a policy name and policy type which MUST be provided. 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.
module: ietf-qos-policy
+--rw policies
+--rw policy-entry* [policy-name policy-type]
+--rw policy-name string
+--rw policy-type identityref
+--rw policy-descr? string
+--rw classifier-entry* [classifier-entry-name]
+--rw classifier-entry-name string
+--rw classifier-entry-inline? boolean
+--rw classifier-entry-filter-oper? identityref
+--rw filter-entry* [filter-type filter-logical-not]
{policy-inline-classifier-config}?
| +--rw filter-type identityref
| +--rw filter-logical-not boolean
+--rw classifier-action-entry-cfg* [action-type]
+--rw action-type identityref
+--rw (action-cfg-params)?
Choudhary, et al. Expires October 10, 2020 [Page 5]
Internet-Draft YANG Model For QoS April 2020
ietf-qos-action module contains grouping of set of QoS actions.
These include metering, marking, dropping and shaping. Marking sets
DiffServ codepoint value in the classified packet. Color-aware and
Color-blind meters are augmented by vendor specific modules based on
the parameters defined in action module.
module: ietf-qos-action
+--rw meter-template
+--rw meter-entry* [meter-name] {meter-template-support}?
+--rw meter-name string
+--rw (meter-type)?
+--:(one-rate-two-color-meter-type)
| +--rw one-rate-two-color-meter
| +--rw committed-rate-value? uint64
| +--rw committed-rate-unit? identityref
| +--rw committed-burst-value? uint64
| +--rw committed-burst-unit? identityref
| +--rw conform-action
| | +--rw conform-2color-meter-action-params*
[conform-2color-meter-action-type]
| | +--rw conform-2color-meter-action-type
identityref
| | +--rw (conform-2color-meter-action-val)?
| +--rw exceed-action
| +--rw exceed-2color-meter-action-params*
[exceed-2color-meter-action-type]
| +--rw exceed-2color-meter-action-type
identityref
| +--rw (exceed-2color-meter-action-val)?
+--:(one-rate-tri-color-meter-type)
| +--rw one-rate-tri-color-meter
| +--rw committed-rate-value? uint64
| +--rw committed-rate-unit? identityref
| +--rw committed-burst-value? uint64
| +--rw committed-burst-unit? identityref
| +--rw excess-burst-value? uint64
| +--rw excess-burst-unit? identityref
| +--rw conform-action
| | +--rw conform-3color-meter-action-params*
[conform-3color-meter-action-type]
| | +--rw conform-3color-meter-action-type
identityref
| | +--rw (conform-3color-meter-action-val)?
| +--rw exceed-action
| | +--rw exceed-3color-meter-action-params*
[exceed-3color-meter-action-type]
| | +--rw exceed-3color-meter-action-type
identityref
Choudhary, et al. Expires October 10, 2020 [Page 6]
Internet-Draft YANG Model For QoS April 2020
| | +--rw (exceed-3color-meter-action-val)?
| +--rw violate-action
| +--rw violate-3color-meter-action-params*
[violate-3color-meter-action-type]
| +--rw violate-3color-meter-action-type
identityref
| +--rw (violate-3color-meter-action-val)?
+--:(two-rate-tri-color-meter-type)
+--rw two-rate-tri-color-meter
+--rw committed-rate-value? uint64
+--rw committed-rate-unit? identityref
+--rw committed-burst-value? uint64
+--rw committed-burst-unit? identityref
+--rw peak-rate-value? uint64
+--rw peak-rate-unit? identityref
+--rw peak-burst-value? uint64
+--rw peak-burst-unit? identityref
+--rw conform-action
| +--rw conform-3color-meter-action-params*
[conform-3color-meter-action-type]
| +--rw conform-3color-meter-action-type
identityref
| +--rw (conform-3color-meter-action-val)?
+--rw exceed-action
| +--rw exceed-3color-meter-action-params*
[exceed-3color-meter-action-type]
| +--rw exceed-3color-meter-action-type
identityref
| +--rw (exceed-3color-meter-action-val)?
+--rw violate-action
+--rw violate-3color-meter-action-params*
[violate-3color-meter-action-type]
+--rw violate-3color-meter-action-type
identityref
+--rw (violate-3color-meter-action-val)?
ietf-qos-target module contains reference of qos-policy and augments
ietf-interfaces [RFC8343] module. A single policy of a particular
policy-type can be applied on an interface in each direction of
traffic. Policy-type is of type identity and is populated in a
vendor specific manner. This way it provides greater flexibility for
each vendor to define different policy types each with its own
capabilities and restrictions.
Classifier, metering and queuing counters are associated with a
target.
Choudhary, et al. Expires October 10, 2020 [Page 7]
Internet-Draft YANG Model For QoS April 2020
module: ietf-qos-target
augment /if:interfaces/if:interface:
+--rw qos-target-entry* [direction policy-type]
+--rw direction identityref
+--rw policy-type identityref
+--rw policy-name string
Diffserv module augments QoS classifier module. Many of the YANG
types defined in [RFC6991] are represented as leafs in the classifier
module.
Metering and marking actions are realized by augmenting the QoS
policy-module. Any queuing, AQM and scheduling actions are part of
vendor specific augmentation. Statistics are realized by augmenting
the QoS target module.
module: ietf-diffserv
augment /classifier:classifiers/classifier:classifier-entry +
/classifier:filter-entry:
+--rw (filter-param)?
+--:(dscp)
| +--rw dscp-cfg* [dscp-min dscp-max]
| +--rw dscp-min inet:dscp
| +--rw dscp-max inet:dscp
+--:(source-ipv4-address)
| +--rw source-ipv4-address-cfg* [source-ipv4-addr]
| +--rw source-ipv4-addr inet:ipv4-prefix
+--:(destination-ipv4-address)
| +--rw destination-ipv4-address-cfg* [destination-ipv4-addr]
| +--rw destination-ipv4-addr inet:ipv4-prefix
+--:(source-ipv6-address)
| +--rw source-ipv6-address-cfg* [source-ipv6-addr]
| +--rw source-ipv6-addr inet:ipv6-prefix
+--:(destination-ipv6-address)
| +--rw destination-ipv6-address-cfg* [destination-ipv6-addr]
| +--rw destination-ipv6-addr inet:ipv6-prefix
+--:(source-port)
| +--rw source-port-cfg* [source-port-min source-port-max]
| +--rw source-port-min inet:port-number
| +--rw source-port-max inet:port-number
+--:(destination-port)
| +--rw destination-port-cfg*
[destination-port-min destination-port-max]
| +--rw destination-port-min inet:port-number
| +--rw destination-port-max inet:port-number
+--:(protocol)
| +--rw protocol-cfg* [protocol-min protocol-max]
| +--rw protocol-min uint8
Choudhary, et al. Expires October 10, 2020 [Page 8]
Internet-Draft YANG Model For QoS April 2020
| +--rw protocol-max uint8
+--:(traffic-group)
+--rw traffic-group-cfg
+--rw traffic-group-name? string
augment /policy:policies/policy:policy-entry +
/policy:classifier-entry/policy:filter-entry:
+--rw (filter-params)?
+--:(dscp)
| +--rw dscp-cfg* [dscp-min dscp-max]
| +--rw dscp-min inet:dscp
| +--rw dscp-max inet:dscp
+--:(source-ipv4-address)
| +--rw source-ipv4-address-cfg* [source-ipv4-addr]
| +--rw source-ipv4-addr inet:ipv4-prefix
+--:(destination-ipv4-address)
| +--rw destination-ipv4-address-cfg* [destination-ipv4-addr]
| +--rw destination-ipv4-addr inet:ipv4-prefix
+--:(source-ipv6-address)
| +--rw source-ipv6-address-cfg* [source-ipv6-addr]
| +--rw source-ipv6-addr inet:ipv6-prefix
+--:(destination-ipv6-address)
| +--rw destination-ipv6-address-cfg* [destination-ipv6-addr]
| +--rw destination-ipv6-addr inet:ipv6-prefix
+--:(source-port)
| +--rw source-port-cfg* [source-port-min source-port-max]
| +--rw source-port-min inet:port-number
| +--rw source-port-max inet:port-number
+--:(destination-port)
| +--rw destination-port-cfg*
[destination-port-min destination-port-max]
| +--rw destination-port-min inet:port-number
| +--rw destination-port-max inet:port-number
+--:(protocol)
| +--rw protocol-cfg* [protocol-min protocol-max]
| +--rw protocol-min uint8
| +--rw protocol-max uint8
+--:(traffic-group)
+--rw traffic-group-cfg
+--rw traffic-group-name? string
augment /policy:policies/policy:policy-entry +
/policy:classifier-entry +
/policy:classifier-action-entry-cfg +
/policy:action-cfg-params:
+--:(dscp-marking)
| +--rw dscp-cfg
| +--rw dscp? inet:dscp
+--:(meter-inline) {action:meter-inline-feature}?
| +--rw (meter-type)?
Choudhary, et al. Expires October 10, 2020 [Page 9]
Internet-Draft YANG Model For QoS April 2020
| +--:(one-rate-two-color-meter-type)
| | +--rw one-rate-two-color-meter
| | +--rw committed-rate-value? uint64
| | +--rw committed-rate-unit? identityref
| | +--rw committed-burst-value? uint64
| | +--rw committed-burst-unit? identityref
| | +--rw conform-action
| | | +--rw conform-2color-meter-action-params*
[conform-2color-meter-action-type]
| | | +--rw conform-2color-meter-action-type
identityref
| | | +--rw (conform-2color-meter-action-val)?
| | +--rw exceed-action
| | +--rw exceed-2color-meter-action-params*
[exceed-2color-meter-action-type]
| | +--rw exceed-2color-meter-action-type
identityref
| | +--rw (exceed-2color-meter-action-val)?
| +--:(one-rate-tri-color-meter-type)
| | +--rw one-rate-tri-color-meter
| | +--rw committed-rate-value? uint64
| | +--rw committed-rate-unit? identityref
| | +--rw committed-burst-value? uint64
| | +--rw committed-burst-unit? identityref
| | +--rw excess-burst-value? uint64
| | +--rw excess-burst-unit? identityref
| | +--rw conform-action
| | | +--rw conform-3color-meter-action-params*
[conform-3color-meter-action-type]
| | | +--rw conform-3color-meter-action-type
identityref
| | | +--rw (conform-3color-meter-action-val)?
| | +--rw exceed-action
| | | +--rw exceed-3color-meter-action-params*
[exceed-3color-meter-action-type]
| | | +--rw exceed-3color-meter-action-type
identityref
| | | +--rw (exceed-3color-meter-action-val)?
| | +--rw violate-action
| | +--rw violate-3color-meter-action-params*
[violate-3color-meter-action-type]
| | +--rw violate-3color-meter-action-type
identityref
| | +--rw (violate-3color-meter-action-val)?
| +--:(two-rate-tri-color-meter-type)
| +--rw two-rate-tri-color-meter
| +--rw committed-rate-value? uint64
| +--rw committed-rate-unit? identityref
Choudhary, et al. Expires October 10, 2020 [Page 10]
Internet-Draft YANG Model For QoS April 2020
| +--rw committed-burst-value? uint64
| +--rw committed-burst-unit? identityref
| +--rw peak-rate-value? uint64
| +--rw peak-rate-unit? identityref
| +--rw peak-burst-value? uint64
| +--rw peak-burst-unit? identityref
| +--rw conform-action
| | +--rw conform-3color-meter-action-params*
[conform-3color-meter-action-type]
| | +--rw conform-3color-meter-action-type
identityref
| | +--rw (conform-3color-meter-action-val)?
| +--rw exceed-action
| | +--rw exceed-3color-meter-action-params*
[exceed-3color-meter-action-type]
| | +--rw exceed-3color-meter-action-type
identityref
| | +--rw (exceed-3color-meter-action-val)?
| +--rw violate-action
| +--rw violate-3color-meter-action-params*
[violate-3color-meter-action-type]
| +--rw violate-3color-meter-action-type
identityref
| +--rw (violate-3color-meter-action-val)?
+--:(meter-reference) {action:meter-reference-feature}?
| +--rw meter-reference-cfg
| +--rw meter-reference-name string
| +--rw meter-type identityref
+--:(traffic-group-marking) {action:traffic-group-feature}?
| +--rw traffic-group-cfg
| +--rw traffic-group? string
+--:(child-policy) {action:child-policy-feature}?
| +--rw child-policy-cfg {child-policy-feature}?
| +--rw policy-name? string
+--:(count) {action:count-feature}?
| +--rw count-cfg {count-feature}?
| +--rw count-action? empty
+--:(named-count) {action:named-counter-feature}?
| +--rw named-counter-cfg {named-counter-feature}?
| +--rw count-name-action? string
+--:(queue-inline) {diffserv-queue-inline-support}?
| +--rw queue-cfg
| +--rw priority-cfg
| | +--rw priority-level? uint8
| +--rw min-rate-cfg
| | +--rw rate-value? uint64
| | +--rw rate-unit? identityref
| +--rw max-rate-cfg
Choudhary, et al. Expires October 10, 2020 [Page 11]
Internet-Draft YANG Model For QoS April 2020
| | +--rw rate-value? uint64
| | +--rw rate-unit? identityref
| | +--rw burst-value? uint64
| | +--rw burst-unit? identityref
| +--rw algorithmic-drop-cfg
| +--rw (drop-algorithm)?
| +--:(tail-drop)
| +--rw tail-drop-cfg
| +--rw tail-drop-alg? empty
+--:(scheduler-inline) {diffserv-scheduler-inline-support}?
+--rw scheduler-cfg
+--rw min-rate-cfg
| +--rw rate-value? uint64
| +--rw rate-unit? identityref
+--rw max-rate-cfg
+--rw rate-value? uint64
+--rw rate-unit? identityref
+--rw burst-value? uint64
+--rw burst-unit? identityref
module: ietf-queue-policy
+--rw queue-template {queue-policy-support}?
+--rw name? string
+--rw queue-cfg
+--rw priority-cfg
| +--rw priority-level? uint8
+--rw min-rate-cfg
| +--rw rate-value? uint64
| +--rw rate-unit? identityref
+--rw max-rate-cfg
| +--rw rate-value? uint64
| +--rw rate-unit? identityref
| +--rw burst-value? uint64
| +--rw burst-unit? identityref
+--rw algorithmic-drop-cfg
+--rw (drop-algorithm)?
+--:(tail-drop)
+--rw tail-drop-cfg
+--rw tail-drop-alg? empty
augment /policy:policies/policy:policy-entry +
/policy:classifier-entry/policy:filter-entry:
+--rw (filter-params)? {queue-policy-support}?
+--:(traffic-group-name)
+--rw traffic-group-reference-cfg
+--rw traffic-group-name string
augment /policy:policies/policy:policy-entry +
/policy:classifier-entry +
/policy:classifier-action-entry-cfg +
Choudhary, et al. Expires October 10, 2020 [Page 12]
Internet-Draft YANG Model For QoS April 2020
/policy:action-cfg-params:
+--:(queue-template-name)
{queue-template-support,queue-policy-support}?
| +--rw queue-template-reference-cfg
| +--rw queue-template-name string
+--:(queue-inline)
{queue-inline-support,queue-policy-support}?
+--rw queue-cfg
+--rw priority-cfg
| +--rw priority-level? uint8
+--rw min-rate-cfg
| +--rw rate-value? uint64
| +--rw rate-unit? identityref
+--rw max-rate-cfg
| +--rw rate-value? uint64
| +--rw rate-unit? identityref
| +--rw burst-value? uint64
| +--rw burst-unit? identityref
+--rw algorithmic-drop-cfg
+--rw (drop-algorithm)?
+--:(tail-drop)
+--rw tail-drop-cfg
+--rw tail-drop-alg? empty
module: ietf-scheduler-policy
augment /policy:policies/policy:policy-entry +
/policy:classifier-entry/policy:filter-entry:
+--rw (filter-params)?
+--:(filter-match-all)
+--rw match-all-cfg
+--rw match-all-action? empty
augment /policy:policies/policy:policy-entry +
/policy:classifier-entry +
/policy:classifier-action-entry-cfg +
/policy:action-cfg-params:
+--:(scheduler)
| +--rw scheduler-cfg
| +--rw min-rate-cfg
| | +--rw rate-value? uint64
| | +--rw rate-unit? identityref
| +--rw max-rate-cfg
| +--rw rate-value? uint64
| +--rw rate-unit? identityref
| +--rw burst-value? uint64
| +--rw burst-unit? identityref
+--:(queue-policy-name)
+--rw queue-policy-name
+--rw queue-policy string
Choudhary, et al. Expires October 10, 2020 [Page 13]
Internet-Draft YANG Model For QoS April 2020
6. Modules
6.1. IETF-QOS-CLASSIFIER
<CODE BEGINS>file "ietf-qos-classifier@2019-03-13.yang"
module ietf-qos-classifier {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-qos-classifier";
prefix classifier;
organization
"IETF RTG (Routing Area) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Norm Strahle
<mailto:nstrahle@juniper.net>";
description
"This module contains a collection of YANG definitions for
configuring qos specification implementations.
Copyright (c) 2019 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 2019-03-13 {
description
"Latest revision of qos base classifier module";
reference "RFC XXXX: YANG Model for QoS";
}
feature policy-inline-classifier-config {
description
" This feature allows classifier configuration
directly under policy.";
}
feature classifier-template-feature {
Choudhary, et al. Expires October 10, 2020 [Page 14]
Internet-Draft YANG Model For QoS April 2020
description
" This feature allows classifier as template configuration
in a policy.";
}
feature match-any-filter-type-support {
description
" This feature allows classifier configuration
directly under policy.";
}
identity filter-type {
description
"This is identity of base filter-type";
}
identity classifier-entry-filter-operation-type {
description
"Classifier entry filter logical operation";
}
identity match-all-filter {
base classifier-entry-filter-operation-type;
description
"Classifier entry filter logical AND operation";
}
identity match-any-filter {
base classifier-entry-filter-operation-type;
if-feature "match-any-filter-type-support";
description
"Classifier entry filter logical OR operation";
}
grouping filters {
description
"Filters types in a Classifier entry";
leaf filter-type {
type identityref {
base filter-type;
}
description
"This leaf defines type of the filter";
}
leaf filter-logical-not {
type boolean;
description
"
Choudhary, et al. Expires October 10, 2020 [Page 15]
Internet-Draft YANG Model For QoS April 2020
This is logical-not operator for a filter. When true, it
indicates filter looks for absence of a pattern defined
by the filter
";
}
}
grouping classifier-entry-generic-attr {
description
"
Classifier generic attributes like name,
description, operation type
";
leaf classifier-entry-name {
type string;
description
"classifier entry name";
}
leaf classifier-entry-descr {
type string;
description
"classifier entry description statement";
}
leaf classifier-entry-filter-operation {
type identityref {
base classifier-entry-filter-operation-type;
}
default "match-all-filter";
description
"Filters are applicable as match-any or match-all filters";
}
}
grouping classifier-entry-inline-attr {
description
"attributes of inline classifier in a policy";
leaf classifier-entry-inline {
type boolean;
default "false";
description
"Indication of inline classifier entry";
}
leaf classifier-entry-filter-oper {
type identityref {
base classifier-entry-filter-operation-type;
}
default "match-all-filter";
description
Choudhary, et al. Expires October 10, 2020 [Page 16]
Internet-Draft YANG Model For QoS April 2020
"Filters are applicable as match-any or match-all filters";
}
list filter-entry {
if-feature "policy-inline-classifier-config";
must " ../classifier-entry-inline = 'true' " {
description
"For inline filter configuration, inline attribute must
be true";
}
key "filter-type filter-logical-not";
uses filters;
description
"Filters configured inline in a policy";
}
}
container classifiers {
if-feature "classifier-template-feature";
description
"list of classifier entry";
list classifier-entry {
key "classifier-entry-name";
description
"each classifier entry contains a list of filters";
uses classifier-entry-generic-attr;
list filter-entry {
key "filter-type filter-logical-not";
uses filters;
description
"Filter entry configuration";
}
}
}
}
<CODE ENDS>
6.2. IETF-QOS-POLICY
<CODE BEGINS>file "ietf-qos-policy@2019-03-13.yang"
module ietf-qos-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-qos-policy";
prefix policy;
import ietf-qos-classifier {
prefix classifier;
reference "RFC XXXX: YANG Model for QoS";
}
organization "IETF RTG (Routing Area) Working Group";
Choudhary, et al. Expires October 10, 2020 [Page 17]
Internet-Draft YANG Model For QoS April 2020
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Norm Strahle
<mailto:nstrahle@juniper.net>";
description
"This module contains a collection of YANG definitions for
configuring qos specification implementations.
Copyright (c) 2019 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 2019-03-13 {
description
"Latest revision of qos policy";
reference "RFC XXXX: YANG Model for QoS";
}
identity policy-type {
description
"This base identity type defines policy-types";
}
grouping policy-generic-attr {
description
"Policy Attributes";
leaf policy-name {
type string;
description
"policy name";
}
leaf policy-type {
type identityref {
base policy-type;
}
description
"policy type";
}
leaf policy-descr {
type string;
Choudhary, et al. Expires October 10, 2020 [Page 18]
Internet-Draft YANG Model For QoS April 2020
description
"policy description";
}
}
identity action-type {
description
"This base identity type defines action-types";
}
grouping classifier-action-entry-cfg {
description
"List of Configuration of classifier & associated actions";
list classifier-action-entry-cfg {
key "action-type";
ordered-by user;
description
"Configuration of classifier & associated actions";
leaf action-type {
type identityref {
base action-type;
}
description
"This defines action type ";
}
choice action-cfg-params {
description
"Choice of action types";
}
}
}
container policies {
description
"list of policy templates";
list policy-entry {
key "policy-name policy-type";
description
"policy template";
uses policy-generic-attr;
list classifier-entry {
key "classifier-entry-name";
ordered-by user;
description
"Classifier entry configuration in a policy";
leaf classifier-entry-name {
type string;
description
"classifier entry name";
}
uses classifier:classifier-entry-inline-attr;
Choudhary, et al. Expires October 10, 2020 [Page 19]
Internet-Draft YANG Model For QoS April 2020
uses classifier-action-entry-cfg;
}
}
}
}
<CODE ENDS>
6.3. IETF-QOS-ACTION
<CODE BEGINS>file "ietf-qos-action@2019-03-13.yang"
module ietf-qos-action {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-qos-action";
prefix action;
import ietf-inet-types {
prefix inet;
reference "RFC 6991: Common YANG Data Types";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
organization "IETF RTG (Routing Area) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Norm Strahle
<mailto:nstrahle@juniper.net>";
description
"This module contains a collection of YANG definitions for
configuring qos specification implementations.
Copyright (c) 2019 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 2019-03-13 {
description
"Latest revision for qos actions";
Choudhary, et al. Expires October 10, 2020 [Page 20]
Internet-Draft YANG Model For QoS April 2020
reference "RFC XXXX: YANG Model for QoS";
}
feature meter-template-support {
description
" This feature allows support of meter-template.";
}
feature meter-inline-feature {
description
"This feature allows support of meter-inline configuration.";
}
feature meter-reference-feature {
description
"This feature allows support of meter by reference
configuration.";
}
feature queue-action-support {
description
" This feature allows support of queue action configuration
in policy.";
}
feature scheduler-action-support {
description
" This feature allows support of scheduler configuration
in policy.";
}
feature child-policy-feature {
description
" This feature allows configuration of hierarchical policy.";
}
feature count-feature {
description
"This feature allows action configuration to enable
counter in a classifier";
}
feature named-counter-feature {
description
"This feature allows action configuration to enable
named counter in a classifier";
}
feature traffic-group-feature {
description
"traffic-group action support";
}
feature burst-time-unit-support {
description
"This feature allows burst unit to be configured as
time duration.";
}
Choudhary, et al. Expires October 10, 2020 [Page 21]
Internet-Draft YANG Model For QoS April 2020
identity rate-unit-type {
description
"base rate-unit type";
}
identity bits-per-second {
base rate-unit-type;
description
"bits per second identity";
}
identity kilo-bits-per-second {
base rate-unit-type;
description
"kilo bits per second identity";
}
identity mega-bits-per-second {
base rate-unit-type;
description
"mega bits per second identity";
}
identity giga-bits-per-second {
base rate-unit-type;
description
"mega bits per second identity";
}
identity percent {
base rate-unit-type;
description
"percentage";
}
identity burst-unit-type {
description
"base burst-unit type";
}
identity bytes {
base burst-unit-type;
description
"bytes";
}
identity kilo-bytes {
base burst-unit-type;
description
"kilo bytes";
}
identity mega-bytes {
base burst-unit-type;
description
"mega bytes";
}
Choudhary, et al. Expires October 10, 2020 [Page 22]
Internet-Draft YANG Model For QoS April 2020
identity millisecond {
base burst-unit-type;
if-feature burst-time-unit-support;
description
"milli seconds";
}
identity microsecond {
base burst-unit-type;
if-feature burst-time-unit-support;
description
"micro seconds";
}
identity dscp-marking {
base policy:action-type;
description
"dscp marking action type";
}
identity meter-inline {
base policy:action-type;
if-feature meter-inline-feature;
description
"meter-inline action type";
}
identity meter-reference {
base policy:action-type;
if-feature meter-reference-feature;
description
"meter reference action type";
}
identity queue {
base policy:action-type;
if-feature queue-action-support;
description
"queue action type";
}
identity scheduler {
base policy:action-type;
if-feature scheduler-action-support;
description
"scheduler action type";
}
identity discard {
base policy:action-type;
description
"discard action type";
}
identity child-policy {
base policy:action-type;
Choudhary, et al. Expires October 10, 2020 [Page 23]
Internet-Draft YANG Model For QoS April 2020
if-feature child-policy-feature;
description
"child-policy action type";
}
identity count {
base policy:action-type;
if-feature count-feature;
description
"count action type";
}
identity named-counter {
base policy:action-type;
if-feature named-counter-feature;
description
"name counter action type";
}
identity meter-type {
description
"This base identity type defines meter types";
}
identity one-rate-two-color-meter-type {
base meter-type;
description
"one rate two color meter type";
}
identity one-rate-tri-color-meter-type {
base meter-type;
description
"one rate three color meter type";
reference
"RFC2697: A Single Rate Three Color Marker";
}
identity two-rate-tri-color-meter-type {
base meter-type;
description
"two rate three color meter action type";
reference
"RFC2698: A Two Rate Three Color Marker";
}
identity drop-type {
description
"drop algorithm";
}
identity tail-drop {
base drop-type;
description
Choudhary, et al. Expires October 10, 2020 [Page 24]
Internet-Draft YANG Model For QoS April 2020
"tail drop algorithm";
}
identity conform-2color-meter-action-type {
description
"action type in a meter";
}
identity exceed-2color-meter-action-type {
description
"action type in a meter";
}
identity conform-3color-meter-action-type {
description
"action type in a meter";
}
identity exceed-3color-meter-action-type {
description
"action type in a meter";
}
identity violate-3color-meter-action-type {
description
"action type in a meter";
}
grouping rate-value-unit {
leaf rate-value {
type uint64;
description
"rate value";
}
leaf rate-unit {
type identityref {
base rate-unit-type;
}
description
"rate unit";
}
description
"rate value and unit grouping";
}
grouping burst {
description
"burst value and unit configuration";
leaf burst-value {
type uint64;
description
"burst value";
}
Choudhary, et al. Expires October 10, 2020 [Page 25]
Internet-Draft YANG Model For QoS April 2020
leaf burst-unit {
type identityref {
base burst-unit-type;
}
description
"burst unit";
}
}
grouping threshold {
description
"Threshold Parameters";
container threshold {
description
"threshold";
choice threshold-type {
case size {
leaf threshold-size {
type uint64;
units "bytes";
description
"Threshold size";
}
}
case interval {
leaf threshold-interval {
type uint64;
units "microsecond";
description
"Threshold interval";
}
}
description
"Choice of threshold type";
}
}
}
grouping drop {
container drop-cfg {
leaf drop-action {
type empty;
description
"always drop algorithm";
}
description
"the drop action";
}
Choudhary, et al. Expires October 10, 2020 [Page 26]
Internet-Draft YANG Model For QoS April 2020
description
"always drop grouping";
}
grouping queuelimit {
container qlimit-thresh {
uses threshold;
description
"the queue limit";
}
description
"the queue limit beyond which queue will not hold any packet";
}
grouping conform-2color-meter-action-params {
description
"meter action parameters";
list conform-2color-meter-action-params {
key "conform-2color-meter-action-type";
ordered-by user;
description
"Configuration of basic-meter & associated actions";
leaf conform-2color-meter-action-type {
type identityref {
base conform-2color-meter-action-type;
}
description
"meter action type";
}
choice conform-2color-meter-action-val {
description
" meter action based on choice of meter action type";
}
}
}
grouping exceed-2color-meter-action-params {
description
"meter action parameters";
list exceed-2color-meter-action-params {
key "exceed-2color-meter-action-type";
ordered-by user;
description
"Configuration of basic-meter & associated actions";
leaf exceed-2color-meter-action-type {
type identityref {
base exceed-2color-meter-action-type;
}
Choudhary, et al. Expires October 10, 2020 [Page 27]
Internet-Draft YANG Model For QoS April 2020
description
"meter action type";
}
choice exceed-2color-meter-action-val {
description
" meter action based on choice of meter action type";
}
}
}
grouping conform-3color-meter-action-params {
description
"meter action parameters";
list conform-3color-meter-action-params {
key "conform-3color-meter-action-type";
ordered-by user;
description
"Configuration of basic-meter & associated actions";
leaf conform-3color-meter-action-type {
type identityref {
base conform-3color-meter-action-type;
}
description
"meter action type";
}
choice conform-3color-meter-action-val {
description
" meter action based on choice of meter action type";
}
}
}
grouping exceed-3color-meter-action-params {
description
"meter action parameters";
list exceed-3color-meter-action-params {
key "exceed-3color-meter-action-type";
ordered-by user;
description
"Configuration of basic-meter & associated actions";
leaf exceed-3color-meter-action-type {
type identityref {
base exceed-3color-meter-action-type;
}
description
"meter action type";
}
Choudhary, et al. Expires October 10, 2020 [Page 28]
Internet-Draft YANG Model For QoS April 2020
choice exceed-3color-meter-action-val {
description
" meter action based on choice of meter action type";
}
}
}
grouping violate-3color-meter-action-params {
description
"meter action parameters";
list violate-3color-meter-action-params {
key "violate-3color-meter-action-type";
ordered-by user;
description
"Configuration of basic-meter & associated actions";
leaf violate-3color-meter-action-type {
type identityref {
base violate-3color-meter-action-type;
}
description
"meter action type";
}
choice violate-3color-meter-action-val {
description
" meter action based on choice of meter action type";
}
}
}
grouping one-rate-two-color-meter {
container one-rate-two-color-meter {
description
"single rate two color marker meter";
reference
"RFC 2475, 2.3.3.1: An Architecture for Differentiated
Services: Meters.";
leaf committed-rate-value {
type uint64;
description
"committed rate value";
}
leaf committed-rate-unit {
type identityref {
base rate-unit-type;
}
description
"committed rate unit";
}
Choudhary, et al. Expires October 10, 2020 [Page 29]
Internet-Draft YANG Model For QoS April 2020
leaf committed-burst-value {
type uint64;
description
"burst value";
}
leaf committed-burst-unit {
type identityref {
base burst-unit-type;
}
description
"committed burst unit";
}
container conform-action {
uses conform-2color-meter-action-params;
description
"conform action";
}
container exceed-action {
uses exceed-2color-meter-action-params;
description
"exceed action";
}
}
description
"single rate two color marker meter attributes";
}
grouping one-rate-tri-color-meter {
container one-rate-tri-color-meter {
description
"single rate three color meter";
reference
"RFC2697: A Single Rate Three Color Marker";
leaf committed-rate-value {
type uint64;
description
"meter rate";
}
leaf committed-rate-unit {
type identityref {
base rate-unit-type;
}
description
"committed rate unit";
}
leaf committed-burst-value {
type uint64;
description
Choudhary, et al. Expires October 10, 2020 [Page 30]
Internet-Draft YANG Model For QoS April 2020
"committed burst size";
}
leaf committed-burst-unit {
type identityref {
base burst-unit-type;
}
description
"committed burst unit";
}
leaf excess-burst-value {
type uint64;
description
"excess burst size";
}
leaf excess-burst-unit {
type identityref {
base burst-unit-type;
}
description
"excess burst unit";
}
container conform-action {
uses conform-3color-meter-action-params;
description
"conform, or green action";
}
container exceed-action {
uses exceed-3color-meter-action-params;
description
"exceed, or yellow action";
}
container violate-action {
uses violate-3color-meter-action-params;
description
"violate, or red action";
}
}
description
"one-rate-tri-color-meter attributes";
}
grouping two-rate-tri-color-meter {
container two-rate-tri-color-meter {
description
"two rate three color meter";
reference
"RFC2698: A Two Rate Three Color Marker";
leaf committed-rate-value {
Choudhary, et al. Expires October 10, 2020 [Page 31]
Internet-Draft YANG Model For QoS April 2020
type uint64;
units "bits-per-second";
description
"committed rate";
}
leaf committed-rate-unit {
type identityref {
base rate-unit-type;
}
description
"committed rate unit";
}
leaf committed-burst-value {
type uint64;
description
"commited burst size";
}
leaf committed-burst-unit {
type identityref {
base burst-unit-type;
}
description
"committed burst unit";
}
leaf peak-rate-value {
type uint64;
description
"peak rate";
}
leaf peak-rate-unit {
type identityref {
base rate-unit-type;
}
description
"committed rate unit";
}
leaf peak-burst-value {
type uint64;
description
"commited burst size";
}
leaf peak-burst-unit {
type identityref {
base burst-unit-type;
}
description
"peak burst unit";
}
Choudhary, et al. Expires October 10, 2020 [Page 32]
Internet-Draft YANG Model For QoS April 2020
container conform-action {
uses conform-3color-meter-action-params;
description
"conform, or green action";
}
container exceed-action {
uses exceed-3color-meter-action-params;
description
"exceed, or yellow action";
}
container violate-action {
uses violate-3color-meter-action-params;
description
"exceed, or red action";
}
}
description
"two-rate-tri-color-meter attributes";
}
grouping meter {
choice meter-type {
case one-rate-two-color-meter-type {
uses one-rate-two-color-meter;
description
"basic meter";
}
case one-rate-tri-color-meter-type {
uses one-rate-tri-color-meter;
description
"one rate tri-color meter";
}
case two-rate-tri-color-meter-type {
uses two-rate-tri-color-meter;
description
"two rate tri-color meter";
}
description
" meter action based on choice of meter action type";
}
description
"meter attributes";
}
container meter-template {
description
"list of meter templates";
list meter-entry {
Choudhary, et al. Expires October 10, 2020 [Page 33]
Internet-Draft YANG Model For QoS April 2020
if-feature meter-template-support;
key "meter-name";
description
"meter entry template";
leaf meter-name {
type string;
description
"meter identifier";
}
uses meter;
}
}
grouping meter-reference {
container meter-reference-cfg {
leaf meter-reference-name {
type string ;
mandatory true;
description
"This leaf defines name of the meter referenced";
}
leaf meter-type {
type identityref {
base meter-type;
}
mandatory true;
description
"This leaf defines type of the meter";
}
description
"meter reference name";
}
description
"meter reference";
}
grouping count {
container count-cfg {
if-feature count-feature;
leaf count-action {
type empty;
description
"count action";
}
description
"the count action";
}
description
Choudhary, et al. Expires October 10, 2020 [Page 34]
Internet-Draft YANG Model For QoS April 2020
"the count action grouping";
}
grouping named-counter {
container named-counter-cfg {
if-feature named-counter-feature;
leaf count-name-action {
type string;
description
"count action";
}
description
"the count action";
}
description
"the count action grouping";
}
grouping discard {
container discard-cfg {
leaf discard {
type empty;
description
"discard action";
}
description
"discard action";
}
description
"discard grouping";
}
grouping priority {
container priority-cfg {
leaf priority-level {
type uint8;
description
"priority level";
}
description
"priority attributes";
}
description
"priority attributes grouping";
}
grouping min-rate {
container min-rate-cfg {
uses rate-value-unit;
Choudhary, et al. Expires October 10, 2020 [Page 35]
Internet-Draft YANG Model For QoS April 2020
description
"min guaranteed bandwidth";
reference
"RFC3289, section 3.5.3";
}
description
"minimum rate grouping";
}
grouping dscp-marking {
container dscp-cfg {
leaf dscp {
type inet:dscp;
description
"dscp marking";
}
description
"dscp marking container";
}
description
"dscp marking grouping";
reference
"RFC 2474: Definition of the Differentiated Services
Field (DS Field) in the IPv4 and IPv6 Headers.";
}
grouping traffic-group-marking {
container traffic-group-cfg {
leaf traffic-group {
type string;
description
"traffic group marking";
}
description
"traffic group marking container";
}
description
"traffic group marking grouping";
}
grouping child-policy {
container child-policy-cfg {
if-feature child-policy-feature;
leaf policy-name {
type string;
description
"Hierarchical Policy";
}
description
"Hierarchical Policy configuration container";
}
Choudhary, et al. Expires October 10, 2020 [Page 36]
Internet-Draft YANG Model For QoS April 2020
description
"Grouping of Hierarchical Policy configuration";
}
grouping max-rate {
container max-rate-cfg {
uses rate-value-unit;
uses burst;
description
"maximum rate attributes container";
reference
"RFC3289, section 3.5.4";
}
description
"maximum rate attributes";
}
grouping queue {
container queue-cfg {
uses priority;
uses min-rate;
uses max-rate;
container algorithmic-drop-cfg {
choice drop-algorithm {
case tail-drop {
container tail-drop-cfg {
leaf tail-drop-alg {
type empty;
description
"tail drop algorithm";
}
description
"Tail Drop configuration container";
}
description
"Tail Drop choice";
}
description
"Choice of Drop Algorithm";
}
description
"Algorithmic Drop configuration container";
}
description
"Queue configuration container";
}
description
"Queue grouping";
}
grouping scheduler {
Choudhary, et al. Expires October 10, 2020 [Page 37]
Internet-Draft YANG Model For QoS April 2020
container scheduler-cfg {
uses min-rate;
uses max-rate;
description
"Schedular configuration container";
}
description
"Schedular configuration grouping";
}
}
<CODE ENDS>
6.4. IETF-QOS-TARGET
<CODE BEGINS>file "ietf-qos-target@2019-03-13.yang"
module ietf-qos-target {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-qos-target";
prefix target;
import ietf-interfaces {
prefix if;
reference "RFC8343: A YANG Data Model for Interface Management";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
organization "IETF RTG (Routing Area) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Norm Strahle
<mailto:nstrahle@juniper.net>";
description
"This module contains a collection of YANG definitions for
configuring qos specification implementations.
Copyright (c) 2019 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
Choudhary, et al. Expires October 10, 2020 [Page 38]
Internet-Draft YANG Model For QoS April 2020
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 2019-03-13 {
description
"Latest revision qos based policy applied to a target";
reference "RFC XXXX: YANG Model for QoS";
}
identity direction {
description
"This is identity of traffic direction";
}
identity inbound {
base direction;
description
"Direction of traffic coming into the network entry";
}
identity outbound {
base direction;
description
"Direction of traffic going out of the network entry";
}
augment "/if:interfaces/if:interface" {
description
"Augments QoS Target Entry to Interface module.
If an interface is not capable of applying the QoS parameters,
the server must not allow the client to configure these QoS
parameters.";
list qos-target-entry {
key "direction policy-type";
description
"policy target for inbound or outbound direction";
leaf direction {
type identityref {
base direction;
}
description
"Direction fo the traffic flow either inbound or outbound";
}
leaf policy-type {
type identityref {
Choudhary, et al. Expires October 10, 2020 [Page 39]
Internet-Draft YANG Model For QoS April 2020
base policy:policy-type;
}
description
"Policy entry type";
}
leaf policy-name {
type string;
mandatory true;
description
"Policy entry name";
}
}
}
}
<CODE ENDS>
6.5. IETF-DIFFSERV
<CODE BEGINS>file "ietf-diffserv@2020-03-17.yang"
module ietf-diffserv {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-diffserv";
prefix diffserv;
import ietf-qos-classifier {
prefix classifier;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-action {
prefix action;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-inet-types {
prefix inet;
reference "RFC 6991: Common YANG Data Types";
}
organization "IETF RTG (Routing Area) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
Choudhary, et al. Expires October 10, 2020 [Page 40]
Internet-Draft YANG Model For QoS April 2020
<mailto:mjethanandani@gmail.com>
Editor: Norm Strahle
<mailto:nstrahle@juniper.net>";
description
"This module contains a collection of YANG definitions for
configuring diffserv specification implementations.
Copyright (c) 2019 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 2020-03-17 {
description
"Latest revision of diffserv based classifier";
reference "RFC XXXX: YANG Model for QoS";
}
feature diffserv-queue-inline-support {
description
"Queue inline support in diffserv policy";
}
feature diffserv-scheduler-inline-support {
description
"scheduler inline support in diffserv policy";
}
identity diffserv-policy-type {
base policy:policy-type;
description
"This defines ip policy-type";
}
identity ipv4-diffserv-policy-type {
base policy:policy-type;
description
"This defines ipv4 policy-type";
}
identity ipv6-diffserv-policy-type {
base policy:policy-type;
description
"This defines ipv6 policy-type";
}
identity dscp {
Choudhary, et al. Expires October 10, 2020 [Page 41]
Internet-Draft YANG Model For QoS April 2020
base classifier:filter-type;
description
"Differentiated services code point filter-type";
}
identity source-ipv4-address {
base classifier:filter-type;
description
"source ipv4 address filter-type";
}
identity destination-ipv4-address {
base classifier:filter-type;
description
"destination ipv4 address filter-type";
}
identity source-ipv6-address {
base classifier:filter-type;
description
"source ipv6 address filter-type";
}
identity destination-ipv6-address {
base classifier:filter-type;
description
"destination ipv6 address filter-type";
}
identity source-port {
base classifier:filter-type;
description
"source port filter-type";
}
identity destination-port {
base classifier:filter-type;
description
"destination port filter-type";
}
identity protocol {
base classifier:filter-type;
description
"protocol type filter-type";
}
identity traffic-group-name {
base classifier:filter-type;
description
"traffic-group filter type";
}
identity meter-type {
description
"This base identity type defines meter types";
Choudhary, et al. Expires October 10, 2020 [Page 42]
Internet-Draft YANG Model For QoS April 2020
}
identity one-rate-two-color-meter-type {
base meter-type;
description
"one rate two color meter type";
}
identity one-rate-tri-color-meter-type {
base meter-type;
description
"one rate three color meter type";
}
identity two-rate-tri-color-meter-type {
base meter-type;
description
"two rate three color meter action type";
}
grouping dscp-cfg {
list dscp-cfg {
key "dscp-min dscp-max";
description
"list of dscp ranges";
leaf dscp-min {
type inet:dscp;
description
"Minimum value of dscp min-max range";
}
leaf dscp-max {
type inet:dscp;
must ". >= ../dscp-min" {
error-message
"The dscp-max must be greater than or equal to dscp-min";
}
description
"maximum value of dscp min-max range";
}
}
description
"Filter grouping containing list of dscp ranges";
reference
"RFC 2474: Definition of the Differentiated Services
Field (DS Field) in the IPv4 and IPv6 Headers.";
}
grouping source-ipv4-address-cfg {
list source-ipv4-address-cfg {
key "source-ipv4-addr";
description
"list of source ipv4 address";
leaf source-ipv4-addr {
Choudhary, et al. Expires October 10, 2020 [Page 43]
Internet-Draft YANG Model For QoS April 2020
type inet:ipv4-prefix;
description
"source ipv4 prefix";
}
}
description
"Filter grouping containing list of source ipv4 addresses";
reference
"RFC 791: Internet Protocol.";
}
grouping destination-ipv4-address-cfg {
list destination-ipv4-address-cfg {
key "destination-ipv4-addr";
description
"list of destination ipv4 address";
leaf destination-ipv4-addr {
type inet:ipv4-prefix;
description
"destination ipv4 prefix";
}
}
description
"Filter grouping containing list of destination ipv4 address";
reference
"RFC 791: Internet Protocol.";
}
grouping source-ipv6-address-cfg {
list source-ipv6-address-cfg {
key "source-ipv6-addr";
description
"list of source ipv6 address";
leaf source-ipv6-addr {
type inet:ipv6-prefix;
description
"source ipv6 prefix";
}
}
description
"Filter grouping containing list of source ipv6 addresses";
reference
"RFC 4291: IP Version 6 Addressing Architecture.";
}
grouping destination-ipv6-address-cfg {
list destination-ipv6-address-cfg {
key "destination-ipv6-addr";
description
"list of destination ipv4 or ipv6 address";
leaf destination-ipv6-addr {
Choudhary, et al. Expires October 10, 2020 [Page 44]
Internet-Draft YANG Model For QoS April 2020
type inet:ipv6-prefix;
description
"destination ipv6 prefix";
}
}
description
"Filter grouping containing list of destination ipv6 address";
reference
"RFC 4291: IP Version 6 Addressing Architecture.";
}
grouping source-port-cfg {
list source-port-cfg {
key "source-port-min source-port-max";
description
"list of ranges of source port";
leaf source-port-min {
type inet:port-number;
description
"minimum value of source port range";
}
leaf source-port-max {
type inet:port-number;
must ". >= ../source-port-min" {
error-message
"The source-port-max must be greater than or equal to
source-port-min";
}
description
"maximum value of source port range";
}
}
description
"Filter grouping containing list of source port ranges";
reference
"RFC 768: User Datagram Protocol
RFC 793: TRANSMISSION CONTROL PROTOCOL";
}
grouping destination-port-cfg {
list destination-port-cfg {
key "destination-port-min destination-port-max";
description
"list of ranges of destination port";
leaf destination-port-min {
type inet:port-number;
description
"minimum value of destination port range";
}
leaf destination-port-max {
Choudhary, et al. Expires October 10, 2020 [Page 45]
Internet-Draft YANG Model For QoS April 2020
type inet:port-number;
must ". >= ../destination-port-min" {
error-message
"The destination-port-max must be greater than or equal to
destination-port-min";
}
description
"maximum value of destination port range";
}
}
description
"Filter grouping containing list of destination port ranges";
reference
"RFC 768: User Datagram Protocol
RFC 793: TRANSMISSION CONTROL PROTOCOL";
}
grouping protocol-cfg {
list protocol-cfg {
key "protocol-min protocol-max";
description
"list of ranges of protocol values.
Internet Protocol number refers to the protocol of the
payloadi in ipv4 header. In IPv6, this field is known as
'next-header', and if extension headers are present, the
protocol is present in the 'upper-layer' header.";
leaf protocol-min {
type uint8 {
range "0..255";
}
description
"minimum value of protocol range";
}
leaf protocol-max {
type uint8 {
range "0..255";
}
must ". >= ../protocol-min" {
error-message
"The protocol-max must be greater than or equal to
protocol-min";
}
description
"maximum value of protocol range";
}
}
description
"Filter grouping containing list of Protocol ranges";
reference
Choudhary, et al. Expires October 10, 2020 [Page 46]
Internet-Draft YANG Model For QoS April 2020
"RFC 791: Internet Protocol.
RFC 8200: Internet Protocol, Version 6 (IPv6) Specification.";
}
grouping traffic-group-cfg {
container traffic-group-cfg {
leaf traffic-group-name {
type string ;
description
"This leaf defines name of the traffic group referenced";
}
description
"traffic group container";
}
description
"traffic group grouping";
}
augment "/classifier:classifiers/classifier:classifier-entry" +
"/classifier:filter-entry" {
choice filter-param {
description
"Choice of filter types";
case dscp {
uses dscp-cfg;
description
"Filter containing list of dscp ranges";
}
case source-ipv4-address {
uses source-ipv4-address-cfg;
description
"Filter containing list of source ipv4 addresses";
}
case destination-ipv4-address {
uses destination-ipv4-address-cfg;
description
"Filter containing list of destination ipv4 address";
}
case source-ipv6-address {
uses source-ipv6-address-cfg;
description
"Filter containing list of source ipv6 addresses";
}
case destination-ipv6-address {
uses destination-ipv6-address-cfg;
description
"Filter containing list of destination ipv6 address";
}
case source-port {
Choudhary, et al. Expires October 10, 2020 [Page 47]
Internet-Draft YANG Model For QoS April 2020
uses source-port-cfg;
description
"Filter containing list of source-port ranges";
}
case destination-port {
uses destination-port-cfg;
description
"Filter containing list of destination-port ranges";
}
case protocol {
uses protocol-cfg;
description
"Filter Type Protocol";
}
case traffic-group {
uses traffic-group-cfg;
description
"Filter Type traffic-group";
}
}
description
"augments diffserv filters to qos classifier";
}
augment "/policy:policies/policy:policy-entry" +
"/policy:classifier-entry/policy:filter-entry" {
when "../../policy:policy-type =
'diffserv:ipv4-diffserv-policy-type' or
../../policy:policy-type =
'diffserv:ipv6-diffserv-policy-type' or
../../policy:policy-type =
'diffserv:diffserv-policy-type'" {
description
"Filters can be augmented if policy type is
ipv4, ipv6 or default diffserv policy types ";
}
description
"Augments Diffserv Classifier with common filter types";
choice filter-params {
description
"Choice of action types";
case dscp {
uses dscp-cfg;
description
"Filter containing list of dscp ranges";
}
case source-ipv4-address {
when "../../policy:policy-type !=
'diffserv:ipv6-diffserv-policy-type'" {
Choudhary, et al. Expires October 10, 2020 [Page 48]
Internet-Draft YANG Model For QoS April 2020
description
"If policy type is v6, this filter cannot be used.";
}
uses source-ipv4-address-cfg;
description
"Filter containing list of source ipv4 addresses";
}
case destination-ipv4-address {
when "../../policy:policy-type !=
'diffserv:ipv6-diffserv-policy-type'" {
description
"If policy type is v6, this filter cannot be used.";
}
uses destination-ipv4-address-cfg;
description
"Filter containing list of destination ipv4 address";
}
case source-ipv6-address {
when "../../policy:policy-type !=
'diffserv:ipv4-diffserv-policy-type'" {
description
"If policy type is v4, this filter cannot be used.";
}
uses source-ipv6-address-cfg;
description
"Filter containing list of source ipv6 addresses";
}
case destination-ipv6-address {
when "../../policy:policy-type !=
'diffserv:ipv4-diffserv-policy-type'" {
description
"If policy type is v4, this filter cannot be used.";
}
uses destination-ipv6-address-cfg;
description
"Filter containing list of destination ipv6 address";
}
case source-port {
uses source-port-cfg;
description
"Filter containing list of source-port ranges";
}
case destination-port {
uses destination-port-cfg;
description
"Filter containing list of destination-port ranges";
}
case protocol {
Choudhary, et al. Expires October 10, 2020 [Page 49]
Internet-Draft YANG Model For QoS April 2020
uses protocol-cfg;
description
"Filter Type Protocol";
}
case traffic-group {
uses traffic-group-cfg;
description
"Filter Type traffic-group";
}
}
}
augment "/policy:policies/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" {
when "../../policy:policy-type =
'diffserv:ipv4-diffserv-policy-type' or
../../policy:policy-type =
'diffserv:ipv6-diffserv-policy-type' or
../../policy:policy-type =
'diffserv:diffserv-policy-type' " {
description
"Actions can be augmented if policy type is ipv4,
ipv6 or default diffserv policy types ";
}
description
"Augments Diffserv Policy with action configuration";
case dscp-marking {
uses action:dscp-marking;
}
case meter-inline {
if-feature action:meter-inline-feature;
uses action:meter;
}
case meter-reference {
if-feature action:meter-reference-feature;
uses action:meter-reference;
}
case child-policy {
if-feature action:child-policy-feature;
uses action:child-policy;
}
case count {
if-feature action:count-feature;
uses action:count;
}
case named-count {
if-feature action:named-counter-feature;
Choudhary, et al. Expires October 10, 2020 [Page 50]
Internet-Draft YANG Model For QoS April 2020
uses action:named-counter;
}
case queue-inline {
if-feature diffserv-queue-inline-support;
uses action:queue;
}
case scheduler-inline {
if-feature diffserv-scheduler-inline-support;
uses action:scheduler;
}
}
}
<CODE ENDS>
6.6. IETF-QUEUE-POLICY
<CODE BEGINS>file "ietf-queue-policy@2019-03-13.yang"
module ietf-queue-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-queue-policy";
prefix queue-policy;
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-action {
prefix action;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-diffserv {
prefix diffserv;
reference "RFC XXXX: YANG Model for QoS";
}
organization "IETF RTG (Routing Area) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>
Editor: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Norm Strahle
<mailto:nstrahle@juniper.net>";
description
"This module contains a collection of YANG definitions for
configuring diffserv specification implementations.
Choudhary, et al. Expires October 10, 2020 [Page 51]
Internet-Draft YANG Model For QoS April 2020
Copyright (c) 2019 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 2019-03-13 {
description
"Latest revision of queuing policy module";
reference "RFC XXXX: YANG Model for QoS";
}
feature queue-policy-support {
description
" This feature allows queue policy configuration
as a separate policy type support.";
}
feature queue-inline-support {
description
"Queue inline support in Queue policy";
}
feature queue-template-support {
description
"Queue template support in Queue policy";
}
identity queue-policy-type {
base policy:policy-type;
description
"This defines queue policy-type";
}
augment "/policy:policies/policy:policy-entry" +
"/policy:classifier-entry/policy:filter-entry" {
when "../../policy:policy-type =
'queue-policy:queue-policy-type'" {
description
"If policy type is v6, this filter cannot be used.";
}
if-feature queue-policy-support;
choice filter-params {
Choudhary, et al. Expires October 10, 2020 [Page 52]
Internet-Draft YANG Model For QoS April 2020
description
"Choice of action types";
case traffic-group-name {
uses diffserv:traffic-group-cfg;
description
"traffic group name";
}
}
description
"Augments Queue policy Classifier with common filter types";
}
identity queue-template-name {
base policy:action-type;
description
"queue template name";
}
grouping queue-template-reference {
container queue-template-reference-cfg {
leaf queue-template-name {
type string ;
mandatory true;
description
"This leaf defines name of the queue template referenced";
}
description
"queue template reference";
}
description
"queue template reference grouping";
}
container queue-template {
if-feature queue-policy-support;
description
"Queue template";
leaf name {
type string;
description
"A unique name identifying this queue template";
}
uses action:queue;
}
augment "/policy:policies/policy:policy-entry" +
"/policy:classifier-entry" +
Choudhary, et al. Expires October 10, 2020 [Page 53]
Internet-Draft YANG Model For QoS April 2020
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" {
when "../../policy:policy-type =
'queue-policy:queue-policy-type'" {
description
"queue policy actions.";
}
if-feature queue-policy-support;
case queue-template-name {
if-feature queue-template-support;
uses queue-template-reference;
}
case queue-inline {
if-feature queue-inline-support;
uses action:queue;
}
description
"augments queue template reference to queue policy";
}
}
<CODE ENDS>
6.7. IETF-SCHEDULER-POLICY
<CODE BEGINS>file "ietf-scheduler-policy@2019-03-13.yang"
module ietf-scheduler-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-scheduler-policy";
prefix scheduler-policy;
import ietf-qos-classifier {
prefix classifier;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-action {
prefix action;
reference "RFC XXXX: YANG Model for QoS";
}
organization "IETF RTG (Routing Area) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto:rtgwg@ietf.org>
Editor: Norm Strahle
Choudhary, et al. Expires October 10, 2020 [Page 54]
Internet-Draft YANG Model For QoS April 2020
<mailto:nstrahle@juniper.net>
Editor: Aseem Choudhary
<mailto:asechoud@cisco.com>";
description
"This module contains a collection of YANG definitions for
configuring diffserv specification implementations.
Copyright (c) 2019 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 2019-03-13 {
description
"Latest revision of scheduler policy module";
reference "RFC XXXX: YANG Model for QoS";
}
feature scheduler-policy-support {
description
" This feature allows sheduler policy configuration
as a separate policy type support.";
}
identity scheduler-policy-type {
base policy:policy-type;
description
"This defines scheduler policy-type";
}
identity filter-match-all {
base classifier:filter-type;
description
"Traffic-group filter type";
}
grouping filter-match-all-cfg {
container match-all-cfg {
leaf match-all-action {
type empty;
description
"match all packets";
}
description
Choudhary, et al. Expires October 10, 2020 [Page 55]
Internet-Draft YANG Model For QoS April 2020
"the match-all action";
}
description
"the match-all filter grouping";
}
augment "/policy:policies/policy:policy-entry" +
"/policy:classifier-entry/policy:filter-entry" {
when "../../policy:policy-type =
'scheduler-policy:scheduler-policy-type'" {
description
"Only when policy type is scheduler-policy";
}
choice filter-params {
description
"Choice of action types";
case filter-match-all {
uses filter-match-all-cfg;
description
"filter match-all";
}
}
description
"Augments Queue policy Classifier with common filter types";
}
identity queue-policy-name {
base policy:action-type;
description
"queue policy name";
}
grouping queue-policy-name-cfg {
container queue-policy-name {
leaf queue-policy {
type string ;
mandatory true;
description
"This leaf defines name of the queue-policy";
}
description
"container for queue-policy name";
}
description
"queue-policy name grouping";
}
Choudhary, et al. Expires October 10, 2020 [Page 56]
Internet-Draft YANG Model For QoS April 2020
augment "/policy:policies/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" {
when "../../policy:policy-type =
'scheduler-policy:scheduler-policy-type'" {
description
"Only when policy type is scheduler-policy";
}
case scheduler {
uses action:scheduler;
}
case queue-policy-name {
uses queue-policy-name-cfg;
}
description
"augments scheduler template reference to scheduler policy";
}
}
<CODE ENDS>
7. IANA Considerations
TBD
8. Security Considerations
9. Acknowledgement
The authors wish to thank Ruediger Geib, Fred Baker, Greg Misky, Tom
Petch, Acee Lindem, many others for their helpful comments.
MITRE has approved this document for Public Release, Distribution
Unlimited, with Public Release Case Number 19-3027.
10. References
10.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>.
[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>.
Choudhary, et al. Expires October 10, 2020 [Page 57]
Internet-Draft YANG Model For QoS April 2020
[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>.
[RFC3289] Baker, F., Chan, K., and A. Smith, "Management Information
Base for the Differentiated Services Architecture",
RFC 3289, DOI 10.17487/RFC3289, May 2002,
<https://www.rfc-editor.org/info/rfc3289>.
[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>.
[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>.
10.2. Informative References
[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>.
[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>.
Choudhary, et al. Expires October 10, 2020 [Page 58]
Internet-Draft YANG Model For QoS April 2020
Appendix A. Company A, Company B and Company C examples
Company A, Company B and Company C 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. Queuing and metering counters are realized by augmenting of
the QoS target module.
A.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 ietf-qos-classifier {
prefix classifier;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-action {
prefix action;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-diffserv {
prefix diffserv;
reference "RFC XXXX: YANG Model for QoS";
}
organization "Company A";
contact
"Editor: XYZ
Choudhary, et al. Expires October 10, 2020 [Page 59]
Internet-Draft YANG Model For QoS April 2020
<mailto:xyz@compa.com>";
description
"This module contains a collection of YANG definitions of
companyA diffserv specification extension.";
Copyright (c) 2019 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 2019-03-13 {
description
"Initial revision for diffserv actions on network packets";
reference
"RFC 6020: YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)";
}
identity default-policy-type {
base policy:policy-type;
description
"This defines default policy-type";
}
identity qos-group {
base classifier:filter-type;
description
"qos-group filter-type";
}
grouping qos-group-cfg {
list qos-group-cfg {
key "qos-group-min qos-group-max";
description
"list of dscp ranges";
leaf qos-group-min {
type uint8;
description
"Minimum value of qos-group range";
}
leaf qos-group-max {
type uint8;
Choudhary, et al. Expires October 10, 2020 [Page 60]
Internet-Draft YANG Model For QoS April 2020
description
"maximum value of qos-group range";
}
}
description
"Filter containing list of qos-group ranges";
}
grouping wred-threshold {
container wred-min-thresh {
uses action:threshold;
description
"Minimum threshold";
}
container wred-max-thresh {
uses action:threshold;
description
"Maximum threshold";
}
leaf mark-probability {
type uint32 {
range "1..1000";
}
description
"Mark probability";
}
description
"WRED threshold attributes";
}
grouping randomdetect {
leaf exp-weighting-const {
type uint32;
description
"Exponential weighting constant factor for wred profile";
}
uses wred-threshold;
description
"Random detect attributes";
}
augment "/classifier:classifiers/" +
"classifier:classifier-entry/" +
"classifier:filter-entry/diffserv:filter-param" {
case qos-group {
uses qos-group-cfg;
description
"Filter containing list of qos-group ranges.
Choudhary, et al. Expires October 10, 2020 [Page 61]
Internet-Draft YANG Model For QoS April 2020
Qos-group represent packet metadata information
in a device. ";
}
description
"augmentation of classifier filters";
}
augment "/policy:policies/policy:policy-entry/" +
"policy:classifier-entry/" +
"policy:classifier-action-entry-cfg/" +
"policy:action-cfg-params" {
case random-detect {
uses randomdetect;
}
description
"Augment the actions to policy entry";
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-two-color-meter-type" +
"/diffserv:one-rate-two-color-meter" +
"/diffserv:conform-action" +
"/diffserv:conform-2color-meter-action-params" +
"/diffserv:conform-2color-meter-action-val" {
description
"augment the one-rate-two-color meter conform
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
Choudhary, et al. Expires October 10, 2020 [Page 62]
Internet-Draft YANG Model For QoS April 2020
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-two-color-meter-type" +
"/diffserv:one-rate-two-color-meter" +
"/diffserv:exceed-action" +
"/diffserv:exceed-2color-meter-action-params" +
"/diffserv:exceed-2color-meter-action-val" {
description
"augment the one-rate-two-color meter exceed
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-tri-color-meter-type" +
"/diffserv:one-rate-tri-color-meter" +
"/diffserv:conform-action" +
"/diffserv:conform-3color-meter-action-params" +
"/diffserv:conform-3color-meter-action-val" {
description
"augment the one-rate-tri-color meter conform
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
Choudhary, et al. Expires October 10, 2020 [Page 63]
Internet-Draft YANG Model For QoS April 2020
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-tri-color-meter-type" +
"/diffserv:one-rate-tri-color-meter" +
"/diffserv:exceed-action" +
"/diffserv:exceed-3color-meter-action-params" +
"/diffserv:exceed-3color-meter-action-val" {
description
"augment the one-rate-tri-color meter exceed
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-tri-color-meter-type" +
"/diffserv:one-rate-tri-color-meter" +
"/diffserv:violate-action" +
"/diffserv:violate-3color-meter-action-params" +
"/diffserv:violate-3color-meter-action-val" {
description
"augment the one-rate-tri-color meter conform
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
Choudhary, et al. Expires October 10, 2020 [Page 64]
Internet-Draft YANG Model For QoS April 2020
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:two-rate-tri-color-meter-type" +
"/diffserv:two-rate-tri-color-meter" +
"/diffserv:conform-action" +
"/diffserv:conform-3color-meter-action-params" +
"/diffserv:conform-3color-meter-action-val" {
description
"augment the one-rate-tri-color meter conform
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:two-rate-tri-color-meter-type" +
"/diffserv:two-rate-tri-color-meter" +
"/diffserv:exceed-action" +
"/diffserv:exceed-3color-meter-action-params" +
"/diffserv:exceed-3color-meter-action-val" {
Choudhary, et al. Expires October 10, 2020 [Page 65]
Internet-Draft YANG Model For QoS April 2020
description
"augment the two-rate-tri-color meter exceed
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:two-rate-tri-color-meter-type" +
"/diffserv:two-rate-tri-color-meter" +
"/diffserv:violate-action" +
"/diffserv:violate-3color-meter-action-params" +
"/diffserv:violate-3color-meter-action-val" {
description
"augment the two-rate-tri-color meter violate
with actions";
case meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-dscp {
description
"meter action dscp marking";
uses action:dscp-marking;
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-two-color-meter-type" +
Choudhary, et al. Expires October 10, 2020 [Page 66]
Internet-Draft YANG Model For QoS April 2020
"/diffserv:one-rate-two-color-meter" {
description
"augment the one-rate-two-color meter with" +
"color classifiers";
container conform-color {
uses classifier:classifier-entry-generic-attr;
description
"conform color classifier container";
}
container exceed-color {
uses classifier:classifier-entry-generic-attr;
description
"exceed color classifier container";
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:one-rate-tri-color-meter-type" +
"/diffserv:one-rate-tri-color-meter" {
description
"augment the one-rate-tri-color meter with" +
"color classifiers";
container conform-color {
uses classifier:classifier-entry-generic-attr;
description
"conform color classifier container";
}
container exceed-color {
uses classifier:classifier-entry-generic-attr;
description
"exceed color classifier container";
}
container violate-color {
uses classifier:classifier-entry-generic-attr;
description
"violate color classifier container";
}
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" +
"/policy:action-cfg-params" +
Choudhary, et al. Expires October 10, 2020 [Page 67]
Internet-Draft YANG Model For QoS April 2020
"/diffserv:meter-inline" +
"/diffserv:meter-type" +
"/diffserv:two-rate-tri-color-meter-type" +
"/diffserv:two-rate-tri-color-meter" {
description
"augment the two-rate-tri-color meter with" +
"color classifiers";
container conform-color {
uses classifier:classifier-entry-generic-attr;
description
"conform color classifier container";
}
container exceed-color {
uses classifier:classifier-entry-generic-attr;
description
"exceed color classifier container";
}
container violate-color {
uses classifier:classifier-entry-generic-attr;
description
"violate color classifier container";
}
}
}
A.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 ietf-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";
Choudhary, et al. Expires October 10, 2020 [Page 68]
Internet-Draft YANG Model For QoS April 2020
prefix compb-filter-policy;
import ietf-qos-classifier {
prefix classifier;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-action {
prefix action;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-diffserv {
prefix diffserv;
reference "RFC XXXX: YANG Model for QoS";
}
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) 2019 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 2019-03-13 {
description
"Latest revision of diffserv policy";
reference "RFC XXXX";
}
/*************************************************
* Classification types
Choudhary, et al. Expires October 10, 2020 [Page 69]
Internet-Draft YANG Model For QoS April 2020
*************************************************/
identity forwarding-class {
base classifier:filter-type;
description
"Forwarding class filter type";
}
identity internal-loss-priority {
base classifier:filter-type;
description
"Internal loss priority filter type";
}
grouping forwarding-class-cfg {
list forwarding-class-cfg {
key "forwarding-class";
description
"list of forwarding-classes";
leaf forwarding-class {
type string;
description
"Forwarding class name";
}
}
description
"Filter containing list of forwarding classes";
}
grouping loss-priority-cfg {
list loss-priority-cfg {
key "loss-priority";
description
"list of loss-priorities";
leaf loss-priority {
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";
}
Choudhary, et al. Expires October 10, 2020 [Page 70]
Internet-Draft YANG Model For QoS April 2020
}
description
"Loss-priority";
}
}
description
"Filter containing list of loss priorities";
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:filter-entry" +
"/diffserv:filter-params" {
case forwarding-class {
uses forwarding-class-cfg;
description
"Filter Type Internal-loss-priority";
}
case internal-loss-priority {
uses loss-priority-cfg;
description
"Filter Type Internal-loss-priority";
}
description
"Augments Diffserv Classifier with vendor" +
" specific types";
}
/*************************************************
* Actions
*************************************************/
identity mark-fwd-class {
base policy:action-type;
description
"mark forwarding class action type";
}
identity mark-loss-priority {
base policy:action-type;
description
"mark loss-priority action type";
}
grouping mark-fwd-class {
container mark-fwd-class-cfg {
leaf forwarding-class {
Choudhary, et al. Expires October 10, 2020 [Page 71]
Internet-Draft YANG Model For QoS April 2020
type string;
description
"Forwarding class name";
}
description
"mark-fwd-class container";
}
description
"mark-fwd-class grouping";
}
grouping mark-loss-priority {
container mark-loss-priority-cfg {
leaf loss-priority {
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";
}
}
description
"Loss-priority";
}
description
"mark-loss-priority container";
}
description
"mark-loss-priority grouping";
}
identity exceed-2color-meter-action-drop {
base action:exceed-2color-meter-action-type;
description
"drop action type in a meter";
}
identity meter-action-mark-fwd-class {
base action:exceed-2color-meter-action-type;
description
"mark forwarding class action type";
Choudhary, et al. Expires October 10, 2020 [Page 72]
Internet-Draft YANG Model For QoS April 2020
}
identity meter-action-mark-loss-priority {
base action:exceed-2color-meter-action-type;
description
"mark loss-priority action type";
}
identity violate-3color-meter-action-drop {
base action:violate-3color-meter-action-type;
description
"drop action type in a meter";
}
augment "/policy:policies/policy:policy-entry/" +
"policy:classifier-entry/" +
"policy:classifier-action-entry-cfg/" +
"policy:action-cfg-params" {
case mark-fwd-class {
uses mark-fwd-class;
description
"Mark forwarding class in the packet";
}
case mark-loss-priority {
uses mark-loss-priority;
description
"Mark loss priority in the packet";
}
case discard {
uses action:discard;
description
"Discard action";
}
description
"Augments common diffserv policy actions";
}
augment "/action:meter-template" +
"/action:meter-entry" +
"/action:meter-type" +
"/action:one-rate-tri-color-meter-type" +
"/action:one-rate-tri-color-meter" {
leaf one-rate-color-aware {
type boolean;
description
"This defines if the meter is color-aware";
}
Choudhary, et al. Expires October 10, 2020 [Page 73]
Internet-Draft YANG Model For QoS April 2020
}
augment "/action:meter-template" +
"/action:meter-entry" +
"/action:meter-type" +
"/action:two-rate-tri-color-meter-type" +
"/action:two-rate-tri-color-meter" {
leaf two-rate-color-aware {
type boolean;
description
"This defines if the meter is color-aware";
}
}
/* example of augmenting a meter template with a
/* vendor specific action */
augment "/action:meter-template" +
"/action:meter-entry" +
"/action:meter-type" +
"/action:one-rate-two-color-meter-type" +
"/action:one-rate-two-color-meter" +
"/action:exceed-action" +
"/action:exceed-2color-meter-action-params" +
"/action:exceed-2color-meter-action-val" {
case exceed-2color-meter-action-drop {
description
"meter drop";
uses action:drop;
}
case meter-action-mark-fwd-class {
uses mark-fwd-class;
description
"Mark forwarding class in the packet";
}
case meter-action-mark-loss-priority {
uses mark-loss-priority;
description
"Mark loss priority in the packet";
}
}
augment "/action:meter-template" +
"/action:meter-entry" +
"/action:meter-type" +
"/action:two-rate-tri-color-meter-type" +
"/action:two-rate-tri-color-meter" +
"/action:violate-action" +
"/action:violate-3color-meter-action-params" +
Choudhary, et al. Expires October 10, 2020 [Page 74]
Internet-Draft YANG Model For QoS April 2020
"/action:violate-3color-meter-action-val" {
case exceed-3color-meter-action-drop {
description
"meter drop";
uses action:drop;
}
description
"Augment the actions to the two-color meter";
}
augment "/action:meter-template" +
"/action:meter-entry" +
"/action:meter-type" +
"/action:one-rate-tri-color-meter-type" +
"/action:one-rate-tri-color-meter" +
"/action:violate-action" +
"/action:violate-3color-meter-action-params" +
"/action:violate-3color-meter-action-val" {
case exceed-3color-meter-action-drop {
description
"meter drop";
uses action:drop;
}
description
"Augment the actions to basic meter";
}
}
module example-compb-queue-policy {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:example-compb-queue-policy";
prefix queue-plcy;
import ietf-qos-classifier {
prefix classifier;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for QoS";
}
organization "Company B";
contact
"Editor: XYZ
<mailto:xyz@compb.com>";
Choudhary, et al. Expires October 10, 2020 [Page 75]
Internet-Draft YANG Model For QoS April 2020
description
"This module defines a queue policy. The classification
is based on aforwarding class, and the actions are queues.
Copyright (c) 2019 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 2019-03-13 {
description
"Latest revision of diffserv policy";
reference "RFC XXXX";
}
identity forwarding-class {
base classifier:filter-type;
description
"Forwarding class filter type";
}
grouping forwarding-class-cfg {
leaf forwarding-class-cfg {
type string;
description
"forwarding-class name";
}
description
"Forwarding class filter";
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:filter-entry" {
/* Does NOT support "logical-not" of forwarding class.
Use "must"? */
choice filter-params {
description
"Choice of filters";
case forwarding-class-cfg {
uses forwarding-class-cfg;
description
Choudhary, et al. Expires October 10, 2020 [Page 76]
Internet-Draft YANG Model For QoS April 2020
"Filter Type Internal-loss-priority";
}
}
description
"Augments Diffserv Classifier with fwd class filter";
}
identity compb-queue {
base policy:action-type;
description
"compb-queue action type";
}
grouping compb-queue-name {
container queue-name {
leaf name {
type string;
description
"Queue class name";
}
description
"compb queue container";
}
description
"compb-queue grouping";
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" {
choice action-cfg-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;
Choudhary, et al. Expires October 10, 2020 [Page 77]
Internet-Draft YANG Model For QoS April 2020
import ietf-qos-action {
prefix 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
by name.
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2019-03-13 {
description
"Latest revision of diffserv based classifier";
reference "RFC XXXX";
}
container compb-queue {
description
"Queue used in compb architecture";
leaf name {
type string;
description
"A unique name identifying this queue";
}
uses 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";
Choudhary, et al. Expires October 10, 2020 [Page 78]
Internet-Draft YANG Model For QoS April 2020
}
description
"excess-rate-poroportion";
}
}
description
"Choice of excess-rate type";
}
description
"Excess rate value";
}
leaf excess-priority {
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
Choudhary, et al. Expires October 10, 2020 [Page 79]
Internet-Draft YANG Model For QoS April 2020
"buffer-size-temporal";
}
}
case remainder {
leaf buffer-size-remainder {
type empty;
description
"use remaining of buffer";
}
}
description
"Choice of buffer size type";
}
description
"Buffer size value";
}
}
augment
"/compb-queue" +
"/queue-cfg" +
"/algorithmic-drop-cfg" +
"/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";
Choudhary, et al. Expires October 10, 2020 [Page 80]
Internet-Draft YANG Model For QoS April 2020
}
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 {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:" +
"example-compb-scheduler-policy";
prefix scheduler-plcy;
import ietf-qos-action {
prefix action;
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-policy {
prefix policy;
reference "RFC XXXX: YANG Model for 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 2019-03-13 {
description
"Latest revision of diffserv policy";
reference "RFC XXXX";
}
identity queue-policy {
base policy:action-type;
description
"forwarding-class-queue action type";
Choudhary, et al. Expires October 10, 2020 [Page 81]
Internet-Draft YANG Model For QoS April 2020
}
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";
}
augment "/policy:policies" +
"/policy:policy-entry" +
"/policy:classifier-entry" +
"/policy:classifier-action-entry-cfg" {
choice action-cfg-params {
case schedular {
uses action:schedular;
}
case queue-policy {
uses queue-policy-name;
}
description
"Augment the scheduler policy with a queue policy";
}
}
}
A.3. Example of Company C Diffserv Model
Company C vendor augmentation is based on Ericsson's implementation
differentiated QoS. This implementation first sorts traffic based on
a classifier, which can sort traffic into one or more traffic
forwarding classes. Then, a policer or meter policy references the
classifier and its traffic forwarding classes to specify different
service levels for each traffic forwarding class.
Because each classifier sorts traffic into one or more traffic
forwarding classes, this type of classifier does not align with ietf-
qos-classifier.yang, which defines one traffic forwarding class per
classifier. Additionally, Company C's policing and metering policies
relies on the classifier's pre-defined traffic forwarding classes to
provide differentiated services, rather than redefining the patterns
Choudhary, et al. Expires October 10, 2020 [Page 82]
Internet-Draft YANG Model For QoS April 2020
within a policing or metering policy, as is defined in ietf-
diffserv.yang.
Due to these differences, even though Company C uses all the building
blocks of classifier and policy, Company C's augmentation does not
use ietf-diffserv.yang to provide differentiated service levels.
Instead, Company C's augmentation uses the basic building blocks,
ietf-qos-policy.yang to provide differentiated services.
module example-compc-qos-policy {
yang-version 1.1;
namespace "urn:example-compc-qos-policy";
prefix "compcqos";
import ietf-qos-policy {
prefix "pol";
reference "RFC XXXX: YANG Model for QoS";
}
import ietf-qos-action {
prefix "action";
reference "RFC XXXX: YANG Model for QoS";
}
organization "";
contact "";
description "";
revision 2019-03-13 {
description "";
reference "";
}
/* identities */
identity compc-qos-policy {
base pol:policy-type;
}
identity mdrr-queuing-policy {
base compc-qos-policy;
}
identity pwfq-queuing-policy {
base compc-qos-policy;
}
identity policing-policy {
Choudhary, et al. Expires October 10, 2020 [Page 83]
Internet-Draft YANG Model For QoS April 2020
base compc-qos-policy;
}
identity metering-policy {
base compc-qos-policy;
}
identity forwarding-policy {
base compc-qos-policy;
}
identity overhead-profile-policy {
base compc-qos-policy;
}
identity resource-profile-policy {
base compc-qos-policy;
}
identity protocol-rate-limit-policy {
base compc-qos-policy;
}
identity compc-qos-action {
base pol:action-type;
}
/* groupings */
grouping redirect-action-grp {
container redirect {
/* Redirect options */
}
}
/* deviations */
deviation "/pol:policies/pol:policy-entry" {
deviate add {
must "pol:type = compc-qos-policy" {
description
"Only policy types drived from compc-qos-policy " +
"are supported";
}
}
}
deviation "/pol:policies/pol:policy-entry/pol:classifier-entry" {
Choudhary, et al. Expires October 10, 2020 [Page 84]
Internet-Draft YANG Model For QoS April 2020
deviate add {
must "../per-class-action = 'true'" {
description
"Only policies with per-class actions have classifiers";
}
must "((../sub-type != 'mdrr-queuing-policy') and " +
" (../sub-type != 'pwfq-queuing-policy')) or " +
"(((../sub-type = 'mdrr-queuing-policy') or " +
" (../sub-type = 'pwfq-queueing-policy')) and " +
" ((classifier-entry-name = '0') or " +
" (classifier-entry-name = '1') or " +
" (classifier-entry-name = '2') or " +
" (classifier-entry-name = '3') or " +
" (classifier-entry-name = '4') or " +
" (classifier-entry-name = '5') or " +
" (classifier-entry-name = '6') or " +
" (classifier-entry-name = '7') or " +
" (classifier-entry-name = '8')))" {
description
"MDRR queuing policy's or PWFQ queuing policy's " +
"classifier-entry-name is limited to the listed values";
}
}
}
deviation "/pol:policies/pol:policy-entry/pol:classifier-entry" +
"/pol:classifier-action-entry-cfg" {
deviate add {
max-elements 1;
must "action-type = 'compc-qos-action'" {
description
"Only compc-qos-action is allowed";
}
}
}
/* augments */
augment "/pol:policies/pol:policy-entry" {
when "pol:type = 'compc-qos-policy')" {
description
"Additional nodes only for diffserv-policy";
}
leaf sub-type {
type identityref {
base compc-qos-policy;
}
mandatory true;
Choudhary, et al. Expires October 10, 2020 [Page 85]
Internet-Draft YANG Model For QoS April 2020
/* The value of this leaf must not change once configured */
}
leaf per-class-action {
mandatory true;
type boolean;
must "(((. = 'true') and " +
" ((../sub-type = 'policing-policy') or " +
" (../sub-type = 'metering-policy') or " +
" (../sub-type = 'mdrr-queuing-policy') or " +
" (../sub-type = 'pwfq-queuing-policy') or " +
" (../sub-type = 'forwarding-policy'))) or " +
" ((. = 'false') and " +
" ((../sub-type = 'overhead-profile-policy') or " +
" (../sub-type = 'resource-profile-policy') or " +
" (../sub-type = 'protocol-rate-limit-policy')))" {
description
"Only certain policies have per-class action";
}
}
container traffic-classifier {
presence true;
when "../sub-type = 'policing-policy' or " +
"../sub-type = 'metering-policy' or " +
"../sub-type = 'forwarding-policy'" {
description
"A classifier for policing-policy or metering-policy";
}
leaf name {
type string;
mandatory true;
description
"Traffic classifier name";
}
leaf type {
type enumeration {
enum 'internal-dscp-only-classifier' {
value 0;
description
"Classify traffic based on (internal) dscp only";
}
enum 'ipv4-header-based-classifier' {
value 1;
description
"Classify traffic based on IPv4 packet header fields";
}
enum 'ipv6-header-based-classifier' {
value 2;
description
Choudhary, et al. Expires October 10, 2020 [Page 86]
Internet-Draft YANG Model For QoS April 2020
"Classify traffic based on IPv6 packet header fields";
}
}
mandatory true;
description
"Traffic classifier type";
}
}
container traffic-queue {
when "(../sub-type = 'mdrr-queuing-policy') or " +
"(../sub-type = 'pwfq-queuing-policy')" {
description
"Queuing policy properties";
}
leaf queue-map {
type string;
description
"Traffic queue map for queuing policy";
}
}
container overhead-profile {
when "../sub-type = 'overhead-profile-policy'" {
description
"Overhead profile policy properties";
}
}
container resource-profile {
when "../sub-type = 'resource-profile-policy'" {
description
"Resource profile policy properties";
}
}
container protocol-rate-limit {
when "../sub-type = 'protocol-rate-limit-policy'" {
description
"Protocol rate limit policy properties";
}
}
}
augment "/pol:policies/pol:policy-entry/pol:classifier-entry" +
"/pol:classifier-action-entry-cfg/pol:action-cfg-params" {
when "../../../pol:type = 'compc-qos-policy')" {
description
"Configurations for a classifier-policy-type policy";
}
case metering-or-policing-policy {
when "../../../sub-type = 'policing-policy' or "
Choudhary, et al. Expires October 10, 2020 [Page 87]
Internet-Draft YANG Model For QoS April 2020
+ "../../../sub-type = 'metering-policy'" {
}
container dscp-marking {
uses action:dscp-marking;
}
container precedence-marking {
uses action:dscp-marking;
}
container priority-marking {
uses action:priority;
}
container rate-limiting {
uses action:one-rate-two-color-meter;
}
}
case mdrr-queuing-policy {
when "../../../sub-type = 'mdrr-queuing-policy'" {
description
"MDRR queue handling properties for the traffic " +
"classified into current queue";
}
leaf mdrr-queue-weight {
type uint8 {
range "20..100";
}
units percentage;
}
}
case pwfq-queuing-policy {
when "../../../sub-type = 'pwfq-queuing-policy'" {
description
"PWFQ queue handling properties for traffic " +
"classified into current queue";
}
leaf pwfq-queue-weight {
type uint8 {
range "20..100";
}
units percentage;
}
leaf pwfq-queue-priority {
type uint8;
}
leaf pwfq-queue-rate {
type uint8;
}
}
case forwarding-policy {
Choudhary, et al. Expires October 10, 2020 [Page 88]
Internet-Draft YANG Model For QoS April 2020
when "../../../sub-type = 'forwarding-policy'" {
description
"Forward policy handling properties for traffic " +
"in this classifier";
}
uses redirect-action-grp;
}
description
"Add the classify action configuration";
}
}
Authors' Addresses
Aseem Choudhary
Cisco Systems
170 W. Tasman Drive
San Jose, CA 95134
US
Email: asechoud@cisco.com
Mahesh Jethanandani
VMware
Email: mjethanandani@gmail.com
Norm Strahle
Juniper Networks
1194 North Mathilda Avenue
Sunnyvale, CA 94089
US
Email: nstrahle@juniper.net
Ebben Aries
Juniper Networks
1194 North Mathilda Avenue
Sunnyvale, CA 94089
US
Email: exa@juniper.net
Choudhary, et al. Expires October 10, 2020 [Page 89]
Internet-Draft YANG Model For QoS April 2020
Ing-Wher Chen
The MITRE Corporation
Email: ingwherchen@mitre.org
Choudhary, et al. Expires October 10, 2020 [Page 90]
