bbf-interfaces-remote-hardware-state.yang

module bbf-interfaces-remote-hardware-state {
  yang-version 1.1;
  namespace "urn:bbf:yang:bbf-interfaces-remote-hardware-state";
  prefix bbf-if-rhw-s;

  import ietf-interfaces {
    prefix if;
  }
  import ietf-hardware {
    prefix hw;
  }
  import bbf-hardware-types {
    prefix bbf-hwt;
  }

  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 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 augments the IETF interfaces data
     model, ietf-interfaces (RFC 7223), with nodes for monitoring the
     software of remote hardware.

     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>";
  }

  augment "/if:interfaces-state/if:interface" {
    description
      "Operational state data nodes to manage remote hardware
       connected via an interface.";
    container remote-hardware {
      presence
        "Indicates that the remote hardware, reachable through this
         interface, is represented as a component in the IETF Hardware
         Management model (ietf-hardware).

         This hardware component provides the client of the local
         Hardware Management YANG data model the ability to perform
         some monitoring or management activities for it.";
      description
        "Data nodes that define the relationship between the interface
         and the connected remote hardware when this remote hardware
         is managed as a local hardware component within the local
         Hardware Management YANG data model of the device.";
      leaf-list component {
        type leafref {
          path "/hw:hardware/hw:component/hw:name";
        }
        must "derived-from (/hw:hardware/hw:component[hw:name="
           + "current()]/hw:class, 'bbf-hwt:remote-hardware')" {
          description
            "The referenced hardware component must be of a class
             that is derived from the class 'remote-hardware'.";
        }
        min-elements 1;
        max-elements 1;
        description
          "A reference to a hardware component that represents remote
           hardware that is managed locally on the device.";
      }
    }
  }
}