bbf-qos-filters

This module contains a collection of YANG definitions for supporting the Broadband Forum requirements on the management of Quali...

  • Version: 2023-03-07

    bbf-qos-filters@2023-03-07


    
      module bbf-qos-filters {
    
        yang-version 1.1;
    
        namespace "urn:bbf:yang:bbf-qos-filters";
    
        prefix bbf-qos-filt;
    
        import bbf-yang-types {
          prefix bbf-yang;
        }
        import bbf-qos-classifiers {
          prefix bbf-qos-cls;
        }
        import bbf-frame-classification {
          prefix bbf-classif;
        }
    
        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
    
         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 definitions of filter
         criteria.
    
         Copyright (c) 2017-2023, 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-383a6; see
         the TR itself for full legal notices.";
    
        revision "2023-03-07" {
          description
            "Amendment 6.
           * Approval Date:    2023-03-07.
           * Publication Date: 2023-03-07.";
          reference
            "TR-383a6: Common YANG Modules
            	  <https://www.broadband-forum.org/technical/download/
            		   TR-383_Amendment-6.pdf>";
    
        }
    
        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>";
    
        }
    
        revision "2020-10-13" {
          description
            "Amendment 3.
           * Approval Date:    2020-10-13.
           * Publication Date: 2020-10-13.";
          reference
            "TR-383a3: Common YANG Modules
            	  <https://www.broadband-forum.org/technical/download/
            		   TR-383_Amendment-3.pdf>";
    
        }
    
        revision "2018-07-13" {
          description
            "Amendment 1.
           * Approval Date:    2018-06-04.
           * Publication Date: see revision date above.";
          reference
            "TR-383: Common YANG Modules
            	<https://www.broadband-forum.org/technical/download/
            		 TR-383_Amendment-1.pdf>";
    
        }
    
        revision "2017-05-08" {
          description
            "Initial revision.
           * Approval Date:    see revision date above.
           * Publication Date: 2017-06-02.";
          reference
            "TR-383: Common YANG Modules
            	<https://www.broadband-forum.org/technical/download/
            		 TR-383.pdf>";
    
        }
    
    
        grouping filter-entry-ref {
          description "A reference to a filter.";
          leaf filter-name {
            type leafref {
              path "/bbf-qos-filt:filters/bbf-qos-filt:filter/bbf-qos-filt:name";
            }
            description
              "A reference to a filter.";
          }
        }  // grouping filter-entry-ref
    
        container filters {
          description "Filters configuration.";
          list filter {
            key "name";
            description "A filter.";
            leaf name {
              type bbf-yang:string-ascii64;
              description "Filter name.";
            }
    
            leaf description {
              type bbf-yang:string-ascii64-or-empty;
              description
                "Description of the filter.";
            }
    
            leaf filter-match {
              type boolean;
              default "true";
              description
                "This is logical operator for a filter.
    
               When true, it indicates the filter looks for a match with
               a pattern defined by the filter-field. When false, it looks
               for a 'no match' with the pattern defined by the filter
               field.";
            }
    
            choice filter-field {
              description
                "A field to be classified.";
              container source-mac-address {
                description
                  "Filter containing source MAC address.";
                uses bbf-classif:mac-address-match;
              }  // container source-mac-address
              container destination-mac-address {
                description
                  "Filter containing destination MAC address.";
                uses bbf-classif:mac-address-match;
              }  // container destination-mac-address
            }  // choice filter-field
          }  // list filter
        }  // container filters
    
        augment /bbf-qos-cls:classifiers/bbf-qos-cls:classifier-entry/bbf-qos-cls:filter-method {
          description
            "The QoS policy framework allows to configure criteria to be
           applied to frames. The basic method allows to specify simple
           'in-line' classifiers. Here this is extended with a more
           advanced classification method.";
          case by-reference {
            description
              "The classifier criteria are configured in a separate list.";
            list filter {
              key "name";
              description
                "Filters to be matched.";
              leaf name {
                type bbf-yang:string-ascii64;
                description
                  "Name of the filter.";
              }
    
              uses filter-entry-ref;
            }  // list filter
          }  // case by-reference
        }
      }  // module bbf-qos-filters
    

© 2023 YumaWorks, Inc. All rights reserved.