bbf-l2-dhcpv4-relay-forwarding

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

  • Version: 2022-03-01

    bbf-l2-dhcpv4-relay-forwarding@2022-03-01


    
      module bbf-l2-dhcpv4-relay-forwarding {
    
        yang-version 1.1;
    
        namespace
          "urn:bbf:yang:bbf-l2-dhcpv4-relay-forwarding";
    
        prefix bbf-l2-d4r-fwd;
    
        import bbf-l2-forwarding {
          prefix bbf-l2-fwd;
        }
    
        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 subscriber
         management via the DHCPv4 protocol 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 augments bbf-l2-forwarding with
         subscriber management via the DHCPv4 protocol.
    
         Copyright (c) 2017-2022, 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-383a5; see
         the TR itself for full legal notices.";
    
        revision "2022-03-01" {
          description
            "Amendment 5.
           * Approval Date:    2022-03-01.
           * Publication Date: 2022-03-01.";
          reference
            "TR-383a5: Common YANG Modules
            	  <https://www.broadband-forum.org/technical/download/
            		   TR-383_Amendment-5.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 "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>";
    
        }
    
    
        augment /bbf-l2-fwd:forwarding/bbf-l2-fwd:forwarders/bbf-l2-fwd:forwarder {
          description
            "Additions for L2 DHCPv4 Relay Agent at the forwarder level.";
          container l2-dhcpv4-relay {
            presence
              "Presence of this container indicates L2 DHCPv4 Relay Agent
             functionality is supported in the context of this
             forwarder.";
            description
              "L2 DHCPv4 Relay Agent related controls.";
            leaf downstream-broadcast-flooding {
              type union {
                type boolean;
                type enumeration {
                  enum "apply-layer2-forwarding" {
                    value 0;
                    description
                      "Downstream broadcast DHCP messages are forwarded
                     according forwarding rules configured for the
                     forwarder. Especially applicable to the forwarding of
                     DHCP broadcast messages is the configuration of
                     flooding rules for broadcast frames.";
                  }
                  enum
                    "single-user-with-fallback-to-layer2" {
                    value 1;
                    description
                      "Downstream broadcast DHCP messages are first
                     processed as defined for the value 'false', i.e. they
                     are forwarded to only one port of the forwarder which
                     is identified by the DHCP message content. If however
                     no port is identified in this way, then the message
                     will be processed as identified in 'apply-layer2-
                     forwarding', i.e. based on the (flooding) forwarding
                     rules of the forwarder.";
                  }
                }
              }
              default "false";
              description
                "If it is configured as 'true', the L2 DHCP Relay Agent will
               flood downstream 'broadcast DHCPv4 messages' to all output
               ports of the forwarder.
    
               If it is configured as 'false', the L2 DHCP Relay Agent
               will forward downstream 'broadcast DHCPv4 messages' to only
               one port of the forwarder, i.e. the one for which the
               message is intended. Identifying the port for which the
               message is intended is based on frame content.
    
               If it is configured with one of the enum values, then the
               L2 DHCP Relay Agent will forward downstream 'broadcast
               DHCPv4 messages' as defined in the description of the enum
               value.";
            }
          }  // container l2-dhcpv4-relay
        }
      }  // module bbf-l2-dhcpv4-relay-forwarding
    

© 2021 YumaWorks, Inc. All rights reserved.