netconfcentral logo

bbf-qos-filters

HTML

bbf-qos-filters@2018-07-13



  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:      Joey Boyd, ADTRAN

     Editor:      Ludwig Pauwels, Nokia

     PS Leader:   Joey Boyd, ADTRAN

     PS Leader:   Ken Kerpez, ASSIA

     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-2018, 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-383; see
     the TR itself for full legal notices.";

    revision "2018-07-13" {
      description
        "Initial revision.
       * 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>";

    }


    container filters {
      description "Filters configuration.";
      list filter {
        key "name";
        description
          "List of filter entries.";
        leaf name {
          type bbf-yang:string-ascii64;
          description "Filter name.";
        }

        leaf description {
          type bbf-yang:string-ascii64-or-empty;
          description
            "Description of the class template.";
        }

        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

    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

    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

Summary

  
  
Organization Broadband Forum <https://www.broadband-forum.org> Common YANG Work Area
  
Module bbf-qos-filters
Version 2018-07-13
File bbf-qos-filters.yang
  
Prefix bbf-qos-filt
Namespace urn:bbf:yang:bbf-qos-filters
  
Cooked /cookedmodules/bbf-qos-filters/2018-07-13
YANG /src/bbf-qos-filters@2018-07-13.yang
XSD /xsd/bbf-qos-filters@2018-07-13.xsd
  
Abstract This module contains a collection of YANG definitions for supporting the Broadband Forum requirements on the management of Quali...
  
Contact
Comments or questions about this Broadband Forum YANG module
should be directed to <mailto:help@broadband-forum.org>.

Editor:      Joey Boyd, ADTRAN

Editor:      Ludwig Pauwels, Nokia

PS Leader:   Joey Boyd, ADTRAN

PS Leader:   Ken Kerpez, ASSIA

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-2018, 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-383; see
the TR itself for full legal notices.

Groupings

Grouping Objects Abstract
filter-entry-ref filter-name A reference to a filter.

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
filters container Filters configuration.
   filter list List of filter entries.
      description leaf Description of the class template.
      filter-field choice A field to be classified.
         destination-mac-address case destination-mac-address
            destination-mac-address container Filter containing destination MAC address.
               mac-address choice A choice on the value of the MAC address.
                  any-multicast-mac-address case This represents the multicast MAC addresses, i.e. addresses for which the least significant bit of the first octet is set to 1.
                     any-multicast-mac-address leaf Indicates the MAC address is a multicast address.
                  broadcast-address case This represents the broadcast MAC address, i.e. address FF:FF:FF:FF:FF:FF.
                     broadcast-address leaf Indicates the MAC address is a broadcast address.
                  cfm-multicast-address case This represents a mask for all CFM OAM multicast addresses. These are the addresses of the form 01:80:C2:00:00:3X.
                     cfm-multicast-address leaf Indicates the MAC address is a CFM multicast address.
                  ipv4-multicast-address case This represents a mask for all IPv4 multicast addresses. These are the addresses in the range 01:00:5E:00:00:00 up to and including 01:00:5E:7F:FF:FF.
                     ipv4-multicast-address leaf Indicates the MAC address is an IPv4 multicast address.
                  ipv6-multicast-address case This represents a mask for all IPv6 multicast addresses. These are the addresses of the form 33:33:XX:XX:XX:XX.
                     ipv6-multicast-address leaf Indicates the MAC address is an IPv6 multicast address.
                  mac-address-filter case The value and the mask together identify a set of MAC addresses that comply with this classification. Evaluation is performed by making a bit-wise AND operation between the to be evaluated MAC address and the mac-address-mask. There is a match if the resu...
                     mac-address-mask leaf A mask to be applied on the to be evaluated MAC address. The mask is applied as a bit-wise AND operation.
                     mac-address-value leaf The value with which a comparison shall be made after performing the bit-wise AND operation on the to be evaluated MAC address.
                  unicast-address case This represents the unicast MAC addresses, i.e. addresses for which the least significant bit of the first octet is set to 0 (zero).
                     unicast-address leaf Indicates the MAC address is a unicast address.
         source-mac-address case source-mac-address
            source-mac-address container Filter containing source MAC address.
               mac-address choice A choice on the value of the MAC address.
                  any-multicast-mac-address case This represents the multicast MAC addresses, i.e. addresses for which the least significant bit of the first octet is set to 1.
                     any-multicast-mac-address leaf Indicates the MAC address is a multicast address.
                  broadcast-address case This represents the broadcast MAC address, i.e. address FF:FF:FF:FF:FF:FF.
                     broadcast-address leaf Indicates the MAC address is a broadcast address.
                  cfm-multicast-address case This represents a mask for all CFM OAM multicast addresses. These are the addresses of the form 01:80:C2:00:00:3X.
                     cfm-multicast-address leaf Indicates the MAC address is a CFM multicast address.
                  ipv4-multicast-address case This represents a mask for all IPv4 multicast addresses. These are the addresses in the range 01:00:5E:00:00:00 up to and including 01:00:5E:7F:FF:FF.
                     ipv4-multicast-address leaf Indicates the MAC address is an IPv4 multicast address.
                  ipv6-multicast-address case This represents a mask for all IPv6 multicast addresses. These are the addresses of the form 33:33:XX:XX:XX:XX.
                     ipv6-multicast-address leaf Indicates the MAC address is an IPv6 multicast address.
                  mac-address-filter case The value and the mask together identify a set of MAC addresses that comply with this classification. Evaluation is performed by making a bit-wise AND operation between the to be evaluated MAC address and the mac-address-mask. There is a match if the resu...
                     mac-address-mask leaf A mask to be applied on the to be evaluated MAC address. The mask is applied as a bit-wise AND operation.
                     mac-address-value leaf The value with which a comparison shall be made after performing the bit-wise AND operation on the to be evaluated MAC address.
                  unicast-address case This represents the unicast MAC addresses, i.e. addresses for which the least significant bit of the first octet is set to 0 (zero).
                     unicast-address leaf Indicates the MAC address is a unicast address.
      filter-match leaf 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.
      name leaf Filter name.