bbf-xponani-v-enet-body

This submodule contains data related to virtual Ethernet interfaces belonging to the physical Optical Network Unit (ONU), such a...

  • Version: 2024-04-23

    bbf-xponani-v-enet-body@2024-04-23


    
      submodule bbf-xponani-v-enet-body {
    
        yang-version 1.1;
    
        belongs-to bbf-xponani {
            prefix bbf-xponani;
        }
    
        import ietf-interfaces {
          prefix if;
        }
        import bbf-xpon-if-type {
          prefix bbf-xponift;
        }
    
        include bbf-xponani-base;
    
        organization
          "Broadband Forum <https://www.broadband-forum.org>
    Fiber Access Networks Work Area";
    
        contact
          "Comments or questions about this Broadband Forum YANG module
    should be directed to <mailto:info@broadband-forum.org>.
    
    Editor:      Robert Peschi, Nokia
    
    PS Leader:   Joey Boyd, Adtran
    
    WA Director: Marta Seda, Calix";
    
        description
          "This submodule contains data related to virtual Ethernet
    interfaces belonging to the physical Optical Network Unit (ONU),
    such as the'onu-v-enet' and the 'onu-v-vrefpoint' interfaces.
    
    Copyright (c) 2018-2024, 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-385i3; see
    the TR itself for full legal notices.";
    
        revision "2024-04-23" {
          description
            "Issue 3.
    * Approval Date:    2024-04-23.
    * Publication Date: 2024-04-23.";
          reference
            "TR-385i3: YANG Modules for PON Management
            	<https://www.broadband-forum.org/technical/download/
            		 TR-385_Issue-3.pdf>";
    
        }
    
        revision "2023-06-21" {
          description
            "Issue 2 Amendment 1.
    * Approval Date:    2023-06-21.
    * Publication Date: 2023-06-21.";
          reference
            "TR-385i2a1: ITU-T PON YANG Modules
            	<https://www.broadband-forum.org/technical/download/
            		 TR-385_Issue-2_Amendment-1.pdf>";
    
        }
    
        revision "2020-10-13" {
          description
            "Issue 2.
    * Approval Date:    2020-10-13.
    * Publication Date: 2020-10-13.";
          reference
            "TR-385i2: ITU-T PON YANG Modules
            	<https://www.broadband-forum.org/technical/download/
            		 TR-385_Issue-2.pdf>";
    
        }
    
        revision "2019-02-25" {
          description
            "Initial revision.
    * Approval Date:    2019-02-25.
    * Publication Date: 2019-02-25.";
          reference
            "TR-385: ITU-T PON YANG Modules
            	<https://www.broadband-forum.org/technical/download/
            		 TR-385.pdf>";
    
        }
    
    
        grouping onu-v-enet-config-data {
          description
            "Config data intended for the ONU-vENET interface.
    This data is brought to the Optical Network Unit (ONU) physical
    device, when present, for instance using ONU Management and
    Control Interface (OMCI) on the Management G-PON Encapsulation
    Method (GEM) port.";
          leaf ani {
            type if:interface-ref;
            must
              "derived-from-or-self(/if:interfaces/if:interface[if:name = current()]/if:type,'bbf-xponift:ani')" {
              error-message
                "The referenced interface is not of type or derived from type 'bbf-xponift:ani'.";
              description
                "The referenced interface must be of or derived from type
    'bbf-xponift:ani'.";
            }
            mandatory true;
            description
              "References the Access Network Interface (ANI) which is the
    lower-layer interface under the ONU-vENET.";
          }
        }  // grouping onu-v-enet-config-data
    
        grouping onu-v-vrefpoint-config-data {
          description
            "Config data intended for the ONU-vVREFPOINT interface,
    (sometimes also called 'virtual User Network Interface (UNI)').
    This data is brought to the Optical Network Unit (ONU) physical
    device, when present, for instance using ONU Management and
    Control Interface (OMCI) on the Management G-PON Encapsulation
    Method (GEM) port.";
          leaf related-onu {
            type if:interface-ref;
            must
              "derived-from-or-self(/if:interfaces/if:interface[if:name = current()]/if:type,'bbf-xponift:ani')" {
              error-message
                "The referenced interface is not of type or derived from type 'bbf-xponift:ani'.";
              description
                "The referenced interface must be of or derived from type
    'bbf-xponift:ani'.";
            }
            mandatory true;
            description
              "References the Optical Network Unit (ONU) to which the
    virtual User Network Interface (UNI) relates.";
          }
        }  // grouping onu-v-vrefpoint-config-data
    
        augment /if:interfaces/if:interface/bbf-xponani:onu-v-enet {
          description
            "Configuration of an xPON Optical Network Unit (ONU) virtual
    Ethernet (ENET) interface.";
          uses onu-v-enet-config-data;
        }
    
        augment /if:interfaces/if:interface/bbf-xponani:onu-v-vrefpoint {
          description
            "Configuration of an xPON Optical Network Unit (ONU) virtual V
    reference point interface per TR-167 (sometimes also called
    'virtual User Network Interface (UNI)').";
          reference
            "TR-167";
    
          uses onu-v-vrefpoint-config-data;
        }
      }  // submodule bbf-xponani-v-enet-body
    

© 2023 YumaWorks, Inc. All rights reserved.