bbf-interface-usage

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

  • Version: 2020-10-13

    bbf-interface-usage@2020-10-13


    
      module bbf-interface-usage {
    
        yang-version 1.1;
    
        namespace
          "urn:bbf:yang:bbf-interface-usage";
    
        prefix bbf-if-usg;
    
        import ietf-interfaces {
          prefix if;
        }
        import iana-if-type {
          prefix ianaift;
        }
        import bbf-if-type {
          prefix bbfift;
        }
    
        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 interface
         management 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 YANG
         definitions defining how interfaces are used.
    
         Copyright (c) 2017-2020, 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-383a3; see
         the TR itself for full legal notices.";
    
        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-12-03" {
          description
            "Amendment 2.
           * Approval Date:    2018-12-03.
           * Publication Date: 2018-12-03.";
          reference
            "TR-383a2: Common YANG Modules
            	<https://www.broadband-forum.org/technical/download/
            		 TR-383_Amendment-2.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>";
    
        }
    
    
        typedef interface-usage {
          type enumeration {
            enum "user-port" {
              value 0;
              description
                "The interface having this interface usage connects the
               Access Node to a user.";
            }
            enum "network-port" {
              value 1;
              description
                "The interface having this interface usage connects the
               Access Node to a network.";
            }
            enum "subtended-node-port" {
              value 2;
              description
                "The interface having this interface usage connects the
               Access Node to a another Access Node.";
            }
            enum "inherit" {
              value 3;
              description
                "The interface usage is not defined for this interface.
               Instead the interface usage is inherited from the interface
               usage of the lower-layer interface. If no interface-usage
               is specified at the lowest level of an interface stack,
               then the default is product and interface specific.";
            }
          }
          description
            "This type identifies the position of the interface in the
           network. Access Nodes are typically asymetric: some interfaces
           connect users to the Access Node while other interfaces connect
           the Access Node to the network.
    
           For some functionality of the Access Node the position of the
           interface matters.";
        }
    
        augment /if:interfaces/if:interface {
          when
            "derived-from-or-self(if:type, 'ianaift:ethernetCsmacd') or
           derived-from-or-self(if:type, 'ianaift:ieee8023adLag') or
           derived-from-or-self(if:type, 'ianaift:ptm') or
           derived-from-or-self(if:type, 'bbfift:vlan-sub-interface') or
           derived-from-or-self(if:type, 'bbfift:l2-termination') or
           derived-from(if:type, 'bbfift:ethernet-like')" {
            description
              "The interfaces applicable for interface usage data.";
          }
          description
            "Augments interfaces with nodes relative to interface usage.";
          container interface-usage {
            description
              "Provides the interface with an interface usage.";
            leaf interface-usage {
              type interface-usage;
              description
                "Identifies the position of the interface in the network.";
            }
          }  // container interface-usage
        }
      }  // module bbf-interface-usage
    

© 2023 YumaWorks, Inc. All rights reserved.