module bbf-qos-traffic-mngt-state {

    yang-version 1.1;

    namespace
      "urn:bbf:yang:bbf-qos-traffic-mngt-state";

    prefix bbf-qos-tm-s;

    import ietf-interfaces {
      prefix if;
    }
    import bbf-qos-traffic-mngt {
      prefix bbf-qos-tm;
    }

    organization
      "Broadband Forum <https://www.broadband-forum.org>
Common YANG Work Area";

    contact
      "Comments or questions about this Broadband Forum YANG module
should be directed to <mailto:help@broadband-forum.org>.

Editor:      Nick Hancock, ADTRAN

Editor:      Ludwig Pauwels, Nokia

PS Leader:   Joey Boyd, ADTRAN

PS Leader:   Sowrirajan Padmanabhan, Nokia

WA Director: Joey Boyd, ADTRAN

WA Director: Sven Ooghe, Nokia";

    description
      "This module contains a collection of YANG definitions for
supporting the Broadband Forum requirements on the management of
Quality of Service (QoS) as applicable to access network
equipment. As such, this module is specific to access network
equipment (e.g., BBF-specified Access Nodes and FTTdp DPUs).

Specifically, this module contains a collection of functions for
monitoring QoS traffic management (TM). This module is to be
used, along with 'bbf-qos-traffic-mngt' when the server does not
support Network Management Datastore Architecture (NMDA) as
defined in RFC 8342.

Copyright (c) 2017-2021, Broadband Forum

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials
   provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products
   derived from this software without specific prior written
   permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only.
Please reference the Forum IPR Policy for patent licensing terms
<https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above
license grant are also deemed granted under this license.

This version of this YANG module is part of TR-383a4; see
the TR itself for full legal notices.";

    revision "2021-06-02" {
      description
        "Amendment 4.
* Approval Date:    2021-06-02.
* Publication Date: 2021-06-02.";
      reference
        "TR-383a4: Common YANG Modules
        	  <https://www.broadband-forum.org/technical/download/
        		   TR-383_Amendment-4.pdf>";

    }


    augment /if:interfaces-state/if:interface {
      description
        "Augment interface state data with traffic management state
data.";
      container tm-root {
        presence
          "The presence of this container indicates the interface
contains traffic management state data.";
        description
          "The root in the scheduling tree.";
        choice children-type {
          description
            "Choice of child types of the root scheduler node.";
          case queues {
            description
              "In this mode the interface related to the tm-root can
directly be selected by the forwarding process and has
its own set of queues. Hence the scheduling of a frame
from a forwarder to the egress queue takes place in a
single stage.";
            container queues {
              description
                "State data associated with queues.";
              action reset-statistics {
                description
                  "Reset all queue statistics associated with this
scheduler.";
              }  // rpc reset-statistics

              list queue {
                key "local-queue-id";
                description "A queue.";
                leaf local-queue-id {
                  type bbf-qos-tm:queue-id;
                  description
                    "The identification of a queue within the context of
this list.";
                }

                container statistics {
                  if-feature bbf-qos-tm:queue-statistics;
                  description
                    "Statistics associated with a queue.";
                  uses bbf-qos-tm:queue-statistics;
                }  // container statistics

                uses bbf-qos-tm:reset-queue-counters;
              }  // list queue
            }  // container queues
          }  // case queues
        }  // choice children-type
      }  // container tm-root
    }
  }  // module bbf-qos-traffic-mngt-state