<?xml version="1.0" encoding="US-ASCII"?>
<!-- This is built from a template for a generic Internet Draft. Suggestions for
     improvement welcome - write to Brian Carpenter, brian.e.carpenter @ gmail.com 
     This can be converted using the Web service at http://xml.resource.org/ -->
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<!-- You want a table of contents -->
<!-- Use symbolic labels for references -->
<!-- This sorts the references -->
<!-- Change to "yes" if someone has disclosed IPR for the draft -->
<!-- This defines the specific filename and version number of your draft (and inserts the appropriate IETF boilerplate -->
<?rfc sortrefs="yes"?>
<?rfc toc="yes"?>
<?rfc symrefs="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<?rfc topblock="yes"?>
<?rfc comments="no"?>
<rfc category="std"
     docName="draft-wzwb-opsawg-network-inventory-management-02"
     ipr="trust200902">
  <front>
    <title abbrev="Network Inventory Management">An Inventory Management Model
    for Enterprise Networks</title>

    <author fullname="Bo Wu" initials="B." surname="Wu">
      <organization>Huawei</organization>

      <address>
        <postal>
          <street>101 Software Avenue, Yuhua District</street>

          <city>Nanjing</city>

          <region>Jiangsu</region>

          <code>210012</code>

          <country>China</country>
        </postal>

        <email>lana.wubo@huawei.com</email>
      </address>
    </author>

    <author fullname="Cheng Zhou" initials="C." surname="Zhou">
      <organization>China Mobile</organization>

      <address>
        <postal>
          <street/>

          <city>Beijing</city>

          <code>100053</code>

          <country>China</country>
        </postal>

        <email>zhouchengyjy@chinamobile.com</email>
      </address>
    </author>

    <author fullname="Qin Wu" initials="Q." surname="Wu">
      <organization>Huawei</organization>

      <address>
        <postal>
          <street>101 Software Avenue, Yuhua District</street>

          <city>Nanjing</city>

          <region>Jiangsu</region>

          <code>210012</code>

          <country>China</country>
        </postal>

        <email>bill.wu@huawei.com</email>
      </address>
    </author>

    <author fullname="Mohamed Boucadair" initials="M." surname="Boucadair">
      <organization>Orange</organization>

      <address>
        <postal>
          <street>Rennes 35000</street>

          <country>France</country>
        </postal>

        <email>mohamed.boucadair@orange.com</email>
      </address>
    </author>

    <!---->

    <date day="" month="" year="2023"/>

    <area>OPS Area</area>

    <workgroup>OPSAWG</workgroup>

    <keyword>Network Inventory Management</keyword>

    <abstract>
      <t>This document defines a YANG model for network inventory management,
      which provides consistent representation and reporting of network nodes
      (including endpoints) inventory and enable a network orchestrator in the
      network to maintain a centralized view of all the network nodes and
      endpoint types across multiple domains of the underlying network to
      implement a coherent control strategy.</t>
    </abstract>
  </front>

  <middle>
    <section anchor="intro" title="Introduction">
      <t>A network inventory is a list of equipment connected to a network to
      track and manage network resources.</t>

      <t><xref target="RFC8345"/> defines a network topology model that can be
      used for network inventory extensions. The SAP network model <xref
      target="I-D.ietf-opsawg-sap"/> provides inventory data associated with
      Service Attachment Points (SAPs), which maintains an inventory of nodes
      contained in a network relying upon <xref target="RFC8345"/>.</t>

      <t>To fill the gap of the network inventory model, this document extends
      the RFC 8345 network model for inventory management, which facilitates
      the association with other network and topology models, such as SAP, L2
      topology, and L3 topology, supporting automatic service provisioning and
      network maintenance.</t>

      <t>This document also defines the common types of network inventory,
      which can be reused in multiple network management applications as
      network inventory is the basis of multiple network management, such as
      asset tracking.</t>
    </section>

    <section title="Requirements Language">
      <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
      "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
      "OPTIONAL" in this document are to be interpreted as described in BCP 14
      <xref target="RFC2119"/><xref target="RFC8174"/> when, and only when,
      they appear in all capitals, as shown here.</t>

      <t>This document defines the following term:<list style="hanging">
          <t hangText="Network Inventory:">A network inventory is a list of
          equipment connected to a network to track and manage network
          resources. The equipment can be network device, security device or
          network endpoint device, which include physical or virtual. It also
          provides information related to devices, which could include
          hardware components, software/firmware information and management
          information relevant for the device.</t>
        </list></t>
    </section>

    <section title="Sample Use Cases">
      <t>The YANG model of network inventory is used to provide abstract
      interfaces to obtain network inventory under each network management
      systems or network controllers of different network domains.</t>

      <section title="Network Inventory Managment in Service Provider Network">
        <t>Inventory management in a Service Provider environment is
        challenging. Devices, components are constantly being added or removed
        from the network, which can make it difficult to maintain an accurate
        inventory. Real-time inventory helps service providers to optimize
        their network utilization and reduce operational costs. The inventory
        topology model can be used as a base to retrieve other information,
        such as hardware components and layer 2 and Layer 3 logical inventory
        information.</t>
      </section>

      <section title="Network Inventory Management in Enterprise Network">
        <t>Enterprise networks are becoming heterogenous and supporting a
        variety of device types, such as BYOD vs. enterprise-supplied devices,
        Internet of things (IoT) devices, IP phones, printers, IP cameras), OT
        (Operation Technology) devices (e.g., sensors), etc. Also, these
        networks are designed to support both localized applications and
        cloud-based applications (e.g., public cloud computing, storage,
        etc.), or hybrid applications. Also, means to access network resources
        are not anymore from within specific sites, but access can be granted
        from anywhere. Dedicated gateways and authorization procedures are
        being generalized.</t>

        <t>This trend is observed for the medical, power, manufacturing, or
        other infrastructure industries. These networks host a large number of
        multi-vendor IoT or OT devices, with frequent additions and changes.
        These complex environments often expose unknown safety and reliability
        blind spots.</t>

        <t>The endpoints connected to an Enterprise network lack unified
        modelling and lifecycle management, and different services are
        modelled, collected, processed, and stored separately. The same
        category of network device and network endpoints may be (repeatedly)
        discovered, processed, and stored. Therefore, the inventory is
        difficult to manage when they are tracked in different places.
        Maintaining a centralized and up-to-date inventory is a technical
        enabler in order to implement a coherent control strategy for all
        endpoint types connected to an Enterprise network.</t>

        <t><xref target="orchestration"/> shows an example of an enterprise
        network consisting of two network domains: one campus network domain
        and one cloud network domain. The inventory data in the network can
        include network infrastructure devices (such as routers, switchs,
        security devices) and network endpoints (such as IoT/OT devices,
        servers, laptop, mobile devices). The management systems or network
        controllers in different domains can automatically collect or discover
        the inventory by multiple approaches.</t>

        <figure anchor="orchestration"
                title="An Example of Enterprise Network Management">
          <artwork><![CDATA[            +-------------------------------------+
            | Service/network   Orchestration     |
            +-------------------------------------+
                |                               |
                |     network inventory model   |
                |                               |
                |                               |
        +----------------+              +----------------+
        | Campus manager |              | SD-WAN manager |
        +----------------+              +-------+--------+
                |                               |
                |                               |
                |                               |
  +-------------------------+            +------+--------------------+
  |     Campus Domain #1    |            |     Cloud network         |
  |                         |            |                           |
  |-------+  +-----------+  |            | +-----------+   +-------+ |
  |+IT/OTs+- +  Router   +--+---------   +-+vRouter    +---+Service| |
  |-------+  +-----------+  |            | ------------+   +-------+ |
  |                         |            |                           |
  |Site A                   |            |             Cloud Site B  |
  +-------------------------+            +---------------------------+
]]></artwork>
        </figure>

        <t>With the inventory data collected from the underlying network, the
        network orchestration system can centrally manage security and network
        policies related to network endpoints.</t>
      </section>

      <section title="The example Digital Twin Network">
        <t><xref target="I-D.irtf-nmrg-network-digital-twin-arch"/> defines
        "digital twin network" as a virtual representation of the physical
        network. Such virtual representation of the network is meant to be
        used to analyze, diagnose, emulate, and then manage the physical
        network based on data, models, and interfaces. A digital twin network
        architecture is proposed as follows.</t>

        <t><figure>
            <artwork><![CDATA[        +---------------------------------------------------------+
        |   +-------+   +-------+          +-------+              |
        |   | App 1 |   | App 2 |   ...    | App n |   Application|
        |   +-------+   +-------+          +-------+              |
        +-------------^-------------------+-----------------------+
                      |Capability Exposure| Intent Input
                      |                   |
        +-------------+-------------------v-----------------------+
        |                        Instance of Digital Twin Network |
        |  +--------+   +------------------------+   +--------+   |
        |  |        |   | Service Mapping Models |   |        |   |
        |  |        |   |  +------------------+  |   |        |   |
        |  | Data   +--->  |Functional Models |  +---> Digital|   |
        |  | Repo-  |   |  +-----+-----^------+  |   | Twin   |   |
        |  | sitory |   |        |     |         |   | Network|   |
        |  |        |   |  +-----v-----+------+  |   |  Mgmt  |   |
        |  |        <---+  |  Basic Models    |  <---+        |   |
        |  |        |   |  +------------------+  |   |        |   |
        |  +--------+   +------------------------+   +--------+   |
        +--------^----------------------------+-------------------+
                 |                            |
                 | data collection            | control
        +--------+----------------------------v-------------------+
        |                   Physical Network                      |
        |                                                         |
        +---------------------------------------------------------+]]></artwork>
          </figure>The service orchestration system can use digital twin
        platform to build visual relationship maps for networks and endpoints
        with relationship types and dependencies, and identify potential
        impacts on configuration management information from incidents,
        problems, and changes.</t>

        <t>The inventory model can, for example, be used to emulate several
        what-if scenario such as the impact of EOL or depletion of a hardware
        component on the network resilience and service availability.</t>
      </section>
    </section>

    <section title="Model Overview">
      <t>The following tree diagram <xref target="RFC8340"/> provides an
      overview of the data model for "ietf-network-inventory" module.</t>

      <figure>
        <artwork><![CDATA[
module: ietf-network-inventory
  augment /nw:networks/nw:network/nw:network-types:
    +--rw network-inventory!
  augment /nw:networks/nw:network/nw:node:
    +--rw name?                      string
    +--ro node-type?                 identityref
    +--ro is-virtual?                boolean
    +--ro is-gateway?                boolean
    +--ro gateway-ref?               -> ../name
    +--rw management-ipv4-address?   inet:host
    +--rw management-ipv6-address?   inet:host
    +--ro mac-address?               yang:mac-address
    +--ro mud-url?                   inet:uri
    +--ro transparency-info?         inet:uri
    +--rw site?                      string
    +--ro hardware-rev?              string
    +--ro firmware-rev?              string
    +--ro software-rev?              string
    +--ro serial-num?                string
    +--ro mfg-name?                  string
    +--ro model-name?                string
    +--ro alias?                     string
    +--ro asset-id?                  string
    +--ro mfg-date?                  yang:date-and-time
    +--ro uri*                       inet:uri
    +--ro uuid?                      yang:uuid
    +--ro oper-state?                oper-state
    +--rw components
    |  +--rw component* [name]
    |     +--rw name              string
    |     +--ro class?            union
    |     +--ro parent?           -> ../../component/name
    |     +--ro parent-rel-pos?   int32
    |     +--ro is-fru?           boolean
    |     +--ro hardware-rev?     string
    |     +--ro firmware-rev?     string
    |     +--ro software-rev?     string
    |     +--ro serial-num?       string
    |     +--ro mfg-name?         string
    |     +--ro model-name?       string
    |     +--ro alias?            string
    |     +--ro asset-id?         string
    |     +--ro mfg-date?         yang:date-and-time
    |     +--ro uri*              inet:uri
    |     +--ro uuid?             yang:uuid
    |     +--ro oper-state?       oper-state
    |     +--ro usage-state?      hw:usage-state
    |     +--ro alarm-state?      hw:alarm-state
    |     +--ro standby-state?    hw:standby-state
    +--ro licenses
    |  +--ro license* [license-id]
    |     +--ro license-id         string
    |     +--ro description?       string
    |     +--ro license-data?      union
    |     +--ro active?            boolean
    |     +--ro issue-date?        uint64
    |     +--ro expiration-date?   uint64
    |     +--ro in-use?            boolean
    |     +--ro expired?           boolean
    |     +--ro valid?             boolean
    +--rw geo-location
       +--rw reference-frame
       |  +--rw alternate-system?    string {alternate-systems}?
       |  +--rw astronomical-body?   string
       |  +--rw geodetic-system
       |     +--rw geodetic-datum?    string
       |     +--rw coord-accuracy?    decimal64
       |     +--rw height-accuracy?   decimal64
       +--rw (location)?
       |  +--:(ellipsoid)
       |  |  +--rw latitude?    decimal64
       |  |  +--rw longitude?   decimal64
       |  |  +--rw height?      decimal64
       |  +--:(cartesian)
       |     +--rw x?           decimal64
       |     +--rw y?           decimal64
       |     +--rw z?           decimal64
       +--rw velocity
       |  +--rw v-north?   decimal64
       |  +--rw v-east?    decimal64
       |  +--rw v-up?      decimal64
       +--rw timestamp?         yang:date-and-time
       +--rw valid-until?       yang:date-and-time
  augment /nw:networks/nw:network:
    +--rw link* [link-id]
       +--rw link-id             yang:uuid
       +--ro link-description?   string
       +--ro link-type?          string
       +--rw ltp-ref*
       |       -> ../../nw:node/nt:termination-point/tp-id
       +--ro oper-state?         oper-state

]]></artwork>
      </figure>
    </section>

    <section title="YANG Data model for Network Inventory Management Types">
      <t>The "ietf-network-inventory" module uses types defined in <xref
      target="RFC6991"/>, <xref target="RFC8345"/>, <xref target="RFC8348"/>,
      and <xref target="RFC9179"/>.</t>

      <figure>
        <artwork><![CDATA[<CODE BEGINS> file="ietf-network-inventory@2023-07-10.yang"
module ietf-network-inventory {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-network-inventory";
  prefix nw-inv;

  import ietf-network {
    prefix nw;
    reference
      "RFC 8345: A YANG Data Model for Network Topologies";
  }
  import ietf-network-topology {
    prefix nt;
    reference
      "RFC 8345: A YANG Data Model for Network Topologies";
  }
  import ietf-inet-types {
    prefix inet;
    reference
      "RFC 6991: Common YANG Data Types";
  }
  import ietf-yang-types {
    prefix yang;
    reference
      "RFC 6991: Common YANG Data Types";
  }
  import ietf-geo-location {
    prefix geo;
    reference
      "RFC 9179: A YANG Grouping for Geographic Locations";
  }
  import ietf-network-inventory-types {
    prefix nw-inv-types;
  }

  organization
    "IETF OPSAWG (Operations and Management Area Working Group)";
  contact
    "WG Web:   <https://datatracker.ietf.org/wg/opsawg/>
     WG List:  <mailto:opsawg@ietf.org>

     Editor: Bo Wu
          <lana.wubo@huawei.com>
     Editor: Cheng Zhou
          <zhouchengyjy@chinamobile.com>
     Editor: Qin Wu
          <bill.wu@huawei.com>
     Editor: Mohamed Boucadair
          <mohamed.boucadair@orange.com>";
  description
    "This YANG module defines XXX.

     Copyright (c) 2023 IETF Trust and the persons identified
     as authors of the code. All rights reserved.

     Redistribution and use in source and binary forms, with
     or without modification, is permitted pursuant to, and
     subject to the license terms contained in, the Revised
     BSD License set forth in Section 4.c of the IETF Trust's
     Legal Provisions Relating to IETF Documents
     (https://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX
     (https://www.rfc-editor.org/info/rfcXXXX); see the RFC
     itself for full legal notices.";

  revision 2023-07-10 {
    description
      "Initial revision.";
    reference
      "RFC XXXX: A Network Inventory Management Model for
       Enterprise Networks ";
  }

  identity node-type {
    description
      "Base identity for node device type.";
  }

  identity switch {
    base node-type;
    description
      "Identity for switch device.";
  }

  identity router {
    base node-type;
    description
      "Identity for router device.";
  }

  identity firewall {
    base node-type;
    description
      "Identity for Firewall device.";
  }

  identity access-controller {
    base node-type;
    description
      "Identity for WIFI access controller device.";
  }

  identity access-point {
    base node-type;
    description
      "Identity for WIFI access point device.";
  }

  identity sdn-controller {
    base node-type;
    description
      "Identity for controller.";
  }

  identity server {
    base node-type;
    description
      "Identity for computing server device.";
  }

  identity vm {
    base node-type;
    description
      "Identity for VM node.";
  }

  identity camera {
    base node-type;
    description
      "Identity for camera device.";
  }

  identity printer {
    base node-type;
    description
      "Identity for camera device.";
  }

  identity cell-phone {
    base node-type;
    description
      "Identity for mobile phone.";
  }

  typedef oper-state {
    type enumeration {
      enum unknown {
        value 1;
        description
          "The resource is unable to report its operational
           state.";
      }
      enum disabled {
        value 2;
        description
          "The resource is totally inoperable.";
      }
      enum enabled {
        value 3;
        description
          "The resource is partially or fully operable.";
      }
      enum testing {
        value 4;
        description
          "The resource is currently being tested and cannot
           therefore report whether or not it is operational.";
      }
    }
    description
      "Represents the possible values of operational states.";
    reference
      "RFC 4268: Entity State MIB - EntityOperState";
  }

  grouping inventory-network-type {
    description
      "Indicates the topology type to be inventory.";
    container network-inventory {
      presence "Indicates Network Inventory.";
      description
        "The presence of the container node indicates
         Network Inventory.";
    }
  }

  grouping inventory-node-attributes {
    description
      "Augment used to define attach the node configuration";
    leaf name {
      type string;
      description
        "The name of the node.";
    }
    leaf node-type {
      type identityref {
        base node-type;
      }
      config false;
      description
        "Node type.";
    }
    leaf is-virtual {
      type boolean;
      default "false";
      config false;
      description
        "Set to true if the node is virtual.
         Set to false if the node is physical.";
    }
    leaf is-gateway {
      type boolean;
      default "false";
      config false;
      description
        "Set to true if the node is a gateway.
         Set to false if the node is not a gateway.";
    }
    leaf gateway-ref {
      type leafref {
        path "../name";
      }
      config false;
      description
        "gateway for endpoint device.";
    }
    leaf management-ipv4-address {
      type inet:host;
      description
        "The IP address or DNS domain name of the device.";
    }
    leaf management-ipv6-address {
      type inet:host;
      description
        "The IP address or DNS domain name of the device.";
    }
    leaf mac-address {
      type yang:mac-address;
      config false;
      description
        "The MAC address of the device.";
    }
    leaf mud-url {
      type inet:uri;
      config false;
      description
        "This is the MUD URL associated with the MUD device found
         in a MUD file.";
    }
    leaf transparency-info {
      type inet:uri;
      config false;
      description
        "Link to software bill of material,
         see draft-ietf-opsawg-sbom-access";
    }
    leaf site {
      type string;
      description
        "The site of the node.";
    }
    uses nw-inv-types:component-info;
    uses nw-inv-types:components;
    uses nw-inv-types:licenses;
    uses geo:geo-location;
  }

  grouping inventory-link-attributes {
    description
      "Augment used to define the inventory link attributes.";
    list link {
      key "link-id";
      description
        "An inventory link connects a set of nodes via a set of
         the respective node's termination points. ";
      leaf link-id {
        type yang:uuid;
        description
          "The identifier of a link in the topology.
           A link is specific to a topology to which it belongs.";
      }
      leaf link-description {
        type string;
        config false;
        description
          "A textual description of the interface.";
      }
      leaf link-type {
        type string;
        config false;
        description
          "The type of the link.";
      }
      leaf-list ltp-ref {
        type leafref {
          path "../../nw:node/nt:termination-point/nt:tp-id";
        }
        config false;
        description
          "The interfaces for this link.";
      }
      leaf oper-state {
        type oper-state;
        config false;
        description
          "The operational state for this link.";
      }
    }
  }

  /* Main blocks */

  augment "/nw:networks/nw:network/nw:network-types" {
    description
      "Introduces new network type for network inventory.";
    uses inventory-network-type;
  }

  augment "/nw:networks/nw:network/nw:node" {
    when '/nw:networks/nw:network/nw:network-types/
   nw-inv:network-inventory' {
      description
        "Augmentation parameters apply only for network inventory.";
    }
    description
      "Configuration parameters for inventory at the node
       level.";
    uses inventory-node-attributes;
  }

  augment "/nw:networks/nw:network" {
    when '/nw:networks/nw:network/nw:network-types/
  nw-inv:network-inventory' {
      description
        "Augmentation parameters apply only for network
         inventory.";
    }
    description
      "Augments inventory link information.";
    uses inventory-link-attributes;
  }
}

<CODE ENDS>]]></artwork>
      </figure>
    </section>

    <section title="YANG Data model for Network Inventory Management">
      <t>The "ietf-network-inventory" module uses types defined in <xref
      target="RFC6991"/>, <xref target="RFC8348"/>.</t>

      <figure>
        <artwork><![CDATA[<CODE BEGINS> file="ietf-network-inventory-types@2023-07-10.yang"
module ietf-network-inventory-types {
  yang-version 1.1;
  namespace
    "urn:ietf:params:xml:ns:yang:ietf-network-inventory-types";
  prefix nw-inv-types;

  import ietf-inet-types {
    prefix inet;
    reference
      "RFC 6991: Common YANG Data Types";
  }
  import ietf-yang-types {
    prefix yang;
    reference
      "RFC 6991: Common YANG Data Types";
  }
  import iana-hardware {
    prefix ianahw;
    reference
      "RFC 8348: A YANG Data Model for Hardware Management";
  }
  import ietf-hardware {
    prefix hw;
    reference
      "RFC 8348: A YANG Data Model for Hardware Management";
  }

  organization
    "IETF OPSAWG (Operations and Management Area Working Group)";
  contact
    "WG Web:   <https://datatracker.ietf.org/wg/opsawg/>
     WG List:  <mailto:opsawg@ietf.org>

     Editor: Bo Wu
          <lana.wubo@huawei.com>
     Editor: Cheng Zhou
          <zhouchengyjy@chinamobile.com>
     Editor: Qin Wu
          <bill.wu@huawei.com>
     Editor: Mohamed Boucadair
          <mohamed.boucadair@orange.com>";
  description
    "This YANG module contains a collection of network inventory
        specific YANG data type defintions.

     Copyright (c) 2023 IETF Trust and the persons identified
     as authors of the code. All rights reserved.

     Redistribution and use in source and binary forms, with
     or without modification, is permitted pursuant to, and
     subject to the license terms contained in, the Revised
     BSD License set forth in Section 4.c of the IETF Trust's
     Legal Provisions Relating to IETF Documents
     (https://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX
     (https://www.rfc-editor.org/info/rfcXXXX); see the RFC
     itself for full legal notices.";

  revision 2023-07-10 {
    description
      "Initial revision.";
    reference
      "RFC XXXX: A Network Inventory Management Model for
       Enterprise Networks ";
  }

  identity software-component {
    description
      "Base identity for software components in a managed device.";
  }

  identity operating-system {
    base software-component;
    description
      "OS software type.";
  }

  identity operating-system-patch {
    base software-component;
    description
      "An operating system update - which should be a subcomponent
       of the `operating-system` running on a component. A patch is
       defined to be a set of software changes that are atomically
       installed (and uninstalled) together. ";
  }

  identity bios {
    base software-component;
    description
      "Legacy BIOS or UEFI firmware interface responsible for
       initializing hardware components and first stage boot
       loader.";
  }

  identity boot-loader {
    base software-component;
    description
      "Software layer responsible for loading and booting the
       device OS or network OS.";
  }

  identity software-module {
    base software-component;
    description
      "A base identity for software modules installed and/or
       running on the device.  Modules include user-space programs
       and kernel modules that provide specific functionality.
       A component with type SOFTWARE_MODULE should also have a
       module type that indicates the specific type of software
       module";
  }

  identity operating-software-patch {
    base software-component;
    description
      "An software update - which should be a subcomponent
       of the `software-module` running on a component. A patch is
       defined to be a set of software changes that are atomically
       installed (and uninstalled) together. ";
  }

  /* Groupings */

  grouping component-info {
    description
      "Grouping for common component information.";
    leaf hardware-rev {
      type string;
      config false;
      description
        "The vendor-specific hardware revision string for the
         component.  The preferred value is the hardware revision
         identifier actually printed on the component itself (if
         present).";
      reference
        "RFC 6933: Entity MIB (Version 4) -
                   entPhysicalHardwareRev";
    }
    leaf firmware-rev {
      type string;
      config false;
      description
        "The vendor-specific firmware revision string for the
         component.";
      reference
        "RFC 6933: Entity MIB (Version 4) -
                   entPhysicalFirmwareRev";
    }
    leaf software-rev {
      type string;
      config false;
      description
        "The vendor-specific software revision string for the
         component.";
      reference
        "RFC 6933: Entity MIB (Version 4) -
                   entPhysicalSoftwareRev";
    }
    leaf serial-num {
      type string;
      config false;
      description
        "The vendor-specific serial number string for the
         component.  The preferred value is the serial number
         string actually printed on the component itself (if
         present).";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalSerialNum";
    }
    leaf mfg-name {
      type string;
      config false;
      description
        "The name of the manufacturer of this physical component.
         The preferred value is the manufacturer name string
         actually printed on the component itself (if present).

         Note that comparisons between instances of the
         'model-name', 'firmware-rev', 'software-rev', and
         'serial-num' nodes are only meaningful amongst
         components with the same value of 'mfg-name'.

         If the manufacturer name string associated with the
         physical component is unknown to the server, then this
         node is not instantiated.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalMfgName";
    }
    leaf model-name {
      type string;
      config false;
      description
        "The vendor-specific model name identifier string
         associated with this physical component.  The preferred
         value is the customer-visible part number, which may be
         printed on the component itself.
         If the model name string associated with the physical
         component is unknown to the server, then this node is not
         instantiated.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalModelName";
    }
    leaf alias {
      type string;
      config false;
      description
        "An 'alias' name for the component, as specified by a
         network manager, that provides a non-volatile 'handle' for
         the component.

         If no configured value exists, the server MAY set the
         value of this node to a locally unique value in the
         operational state.

         A server implementation MAY map this leaf to the
         entPhysicalAlias MIB object.  Such an implementation needs
         to use some mechanism to handle the differences in size
         and characters allowed between this leaf and
         entPhysicalAlias.  The definition of such a mechanism is
         outside the scope of this document.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalAlias";
    }
    leaf asset-id {
      type string;
      config false;
      description
        "This node is a user-assigned asset tracking identifier for
         the component.

         A server implementation MAY map this leaf to the
         entPhysicalAssetID MIB object.  Such an implementation
         needs to use some mechanism to handle the differences in
         size and characters allowed between this leaf and
         entPhysicalAssetID.  The definition of such a mechanism is
         outside the scope of this document.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalAssetID";
    }
    leaf mfg-date {
      type yang:date-and-time;
      config false;
      description
        "The date of manufacturing of the managed component.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalMfgDate";
    }
    leaf-list uri {
      type inet:uri;
      config false;
      description
        "This node contains identification information about the
         component.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalUris";
    }
    leaf uuid {
      type yang:uuid;
      config false;
      description
        "A Universally Unique Identifier of the component.";
      reference
        "RFC 6933: Entity MIB (Version 4) - entPhysicalUUID";
    }
    leaf oper-state {
      type hw:oper-state;
      config false;
      description
        "The operational state for this component.
         Note that this node does not follow the administrative
         state.  An administrative state of 'down' does not
         predict an operational state of 'disabled'.
         Note that some implementations may not be able to
         accurately report oper-state while the admin-state node
         has a value other than 'unlocked'.  In these cases, this
         node MUST have a value of 'unknown'.";
      reference
        "RFC 4268: Entity State MIB - entStateOper";
    }
  }

  grouping components {
    description
      "Grouping for software and hardware components.";
    container components {
      description
        "The components within the device.";
      list component {
        key "name";
        description
          "The list of software instances contained within the
           device.";
        leaf name {
          type string;
          description
            "The name of the component.";
        }
        leaf class {
          type union {
            type identityref {
              base ianahw:hardware-class;
            }
            type identityref {
              base software-component;
            }
          }
          config false;
          description
            "Type of component as identified by the system";
        }
        leaf parent {
          type leafref {
            path "../../component/name";
          }
          config false;
          description
            "The name of the component that physically contains this
             component.

             If this leaf is not instantiated, it indicates that this
             component is not contained in any other component.

             In the event that a physical component is contained by
             more than one physical component (e.g., double-wide
             modules), this node contains the name of one of these
             components.  An implementation MUST use the same name
             every time this node is instantiated.";
          reference
            "RFC 6933: Entity MIB (Version 4) -
                       entPhysicalContainedIn";
        }
        leaf parent-rel-pos {
          type int32 {
            range "0 .. 2147483647";
          }
          config false;
          description
            "An indication of the relative position of this child
             component among all its sibling components.  Sibling
             components are defined as components that:

               o share the same value of the 'parent' node and

               o share a common base identity for the 'class' node.";
          reference
            "RFC 6933: Entity MIB (Version 4) -
                       entPhysicalParentRelPos";
        }
        leaf is-fru {
          type boolean;
          config false;
          description
            "This node indicates whether or not this component is
             considered a 'field-replaceable unit' by the vendor.
             If this node contains the value 'true', then this
             component identifies a field-replaceable unit.";
          reference
            "RFC 6933: Entity MIB (Version 4) - entPhysicalIsFRU";
        }
        uses component-info;
        leaf usage-state {
          type hw:usage-state;
          config false;
          description
            "The usage state for this component.

             This node refers to a component's ability to service
             more components in a containment hierarchy.

             Some components will exhibit only a subset of the usage
             state values.  Components that are unable to ever
             service any components within a containment hierarchy
             will always have a usage state of 'busy'.  In some
             cases, a component will be able to support only one
             other component within its containment hierarchy and
             will therefore only exhibit values of 'idle' and
             'busy'.";
          reference
            "RFC 4268: Entity State MIB - entStateUsage";
        }
        leaf alarm-state {
          type hw:alarm-state;
          config false;
          description
            "The alarm state for this component.  It does not
             include the alarms raised on child components within
             its containment hierarchy.";
          reference
            "RFC 4268: Entity State MIB - entStateAlarm";
        }
        leaf standby-state {
          type hw:standby-state;
          config false;
          description
            "The standby state for this component.

             Some components will exhibit only a subset of the
             remaining standby state values.  If this component
             cannot operate in a standby role, the value of this
             node will always be 'providing-service'.";
          reference
            "RFC 4268: Entity State MIB - entStateStandby";
        }
      }
    }
  }

  grouping licenses {
    description
      "Grouping for licenses.";
    container licenses {
      config false;
      description
        "Container for list of licenses";
      list license {
        key "license-id";
        description
          "List of licenses.";
        leaf license-id {
          type string;
          description
            "License ID. A string that uniquelly identifies the
             license. ";
        }
        leaf description {
          type string;
          description
            "The license description.";
        }
        leaf license-data {
          type union {
            type binary;
            type string;
          }
          description
            "The contents of the licence (if required) .";
        }
        leaf active {
          type boolean;
          default "false";
          description
            "The activation state of the license.";
        }
        leaf issue-date {
          type uint64;
          description
            "The date and time at which the license was issued.";
        }
        leaf expiration-date {
          type uint64;
          description
            "The date and time at which the license will expire.";
        }
        leaf in-use {
          type boolean;
          description
            "The license is in use.";
        }
        leaf expired {
          type boolean;
          description
            "The license has expired.";
        }
        leaf valid {
          type boolean;
          description
            "The license is valid. Can be activated in the system
             or platform.";
        }
      }
    }
  }
}

<CODE ENDS>]]></artwork>
      </figure>
    </section>

    <section anchor="Security" title="Security Considerations">
      <t>The YANG module specified in this document defines a data schema
      designed to be accessed through network management protocols such as
      NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the
      secure transport layer, and the required secure transport is Secure
      Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the
      required secure transport is TLS [RFC8446].</t>

      <t>The Network Configuration Access Control Model (NACM) [RFC8341]
      provides a means of restricting access to specific NETCONF or RESTCONF
      users to a preconfigured subset of all available NETCONF or RESTCONF
      protocol operations and contents. Thus, NACM SHOULD be used to restrict
      the NSF registration from unauthorized users.</t>

      <t>There are a number of data nodes defined in this YANG module that are
      writable, creatable, and deletable (i.e., config true, which is the
      default). These data nodes may be considered sensitive or vulnerable in
      some network environments. Write operations to these data nodes could
      have a negative effect on network and security operations.</t>

      <t>Some of the readable data nodes in this YANG module may be considered
      sensitive or vulnerable in some network environments. It is thus
      important to control read access (e.g., via get, get-config, or
      notification) to these data nodes. These are the subtrees and data nodes
      and their sensitivity/vulnerability:</t>

      <t>&lt;&lt;&lt;to be completed&gt;&gt;&gt;</t>
    </section>

    <section title="Privacy Considerations">
      <t>The model includes sensitive PII data. More to be discussed:<list
          style="symbols">
          <t>Data related to BYOD devices</t>
        </list></t>
    </section>

    <section anchor="IANA" title="IANA Considerations">
      <t>This document registers a URI in the "IETF XML Registry" <xref
      target="RFC3688"/>. Following the format in <xref target="RFC3688"/>,
      the following registration has been made.</t>

      <figure>
        <artwork><![CDATA[     URI: urn:ietf:params:xml:ns:yang:ietf-network-inventory-types
     Registrant Contact: The IESG.
     XML: N/A, the requested URI is an XML namespace.

     URI: urn:ietf:params:xml:ns:yang:ietf-network-inventory
     Registrant Contact: The IESG.
     XML: N/A, the requested URI is an XML namespace.]]></artwork>
      </figure>

      <t>This document registers a YANG module in the "YANG Module Names"
      registry<xref target="RFC7950"/> .</t>

      <figure>
        <artwork><![CDATA[     name:         ietf-network-inventory-types
     namespace:    urn:ietf:params:xml:ns:yang:ietf-network-inventory-types
     prefix:       nw-inv
     maintained by IANA: N
     reference:    RFC xxxx

     name:         ietf-network-inventory
     namespace:    urn:ietf:params:xml:ns:yang:ietf-network-inventory
     prefix:       nw-inv
     maintained by IANA: N
     reference:    RFC xxxx
]]></artwork>
      </figure>
    </section>

    <section title="Acknowledgements">
      <t>TBD</t>
    </section>
  </middle>

  <back>
    <references title="Normative References">
      <?rfc include="reference.RFC.2119"?>

      <?rfc include='reference.RFC.3688'?>

      <?rfc include='reference.RFC.6242'?>

      <?rfc include='reference.RFC.7950'?>

      <?rfc include='reference.RFC.8040'?>

      <?rfc include='reference.RFC.8446'?>

      <?rfc include='reference.RFC.8341'?>

      <?rfc include="reference.RFC.8174"?>

      <?rfc include="reference.RFC.6241"?>

      <?rfc include="reference.RFC.8345"?>

      <?rfc include="reference.RFC.8348"?>

      <?rfc include="reference.RFC.9179"?>

      <?rfc include="reference.RFC.6991"?>
    </references>

    <references title="Informative References">
      <?rfc include='reference.I-D.ietf-opsawg-sap'?>

      <?rfc include="reference.RFC.8340"?>

      <?rfc include='reference.I-D.irtf-nmrg-network-digital-twin-arch'?>
    </references>
  </back>
</rfc>
