]> Huawei

lana.wubo@huawei.com

China Mobile

zhouchengyjy@chinamobile.com

Huawei

bill.wu@huawei.com

Orange

mohamed.boucadair@orange.com

Network Inventory YANG Automation Network Inventory Network Operation This document extends the base Network Inventory YANG model to support non-physical network elements (NEs), such as controllers, virtual routers, and virtual firewalls, as well as software components like platform operating systems and software modules. In addition to the software revisions and patches already defined in the base model, this extension introduces software status and time stamp information. Discussion Venues Discussion of this document takes place on the Network Inventory YANG mailing list (inventory-yang@ietf.org), which is archived at . Source for this draft and an issue tracker can be found at .

Introduction The Network Inventory consists of the physical and non-physical network elements (NEs), hardware components, firmware components, and software components on a managed network domain. The non-physical network elements (NEs) are network devices that support network protocols and functions, e.g., routers, firewalls, and controllers, which can reside in any network or compute devices, such as servers in Data Center (DC), server-based virtual machines (VMs), or server-based containers. defines the base Network Inventory YANG model for physical network element (NE) and hardware components of NEs. Examples of hardware components could be rack, shelf, slot, board and physical port. The management of non-physical NE and software components information is similar to the management of physical NE and hardware information. For example, inventory data, including product names, serial numbers, etc. are also applicable. This document defines a network inventory software extension YANG model. In addition to inheriting the common inventory attributes of the base network inventory model, this document also adds some software-specific attributes of non-physical NEs (such as controllers, virtual routers, and virtual firewalls) and software components (such as operating system, software modules, BIOS, and boot loader). The Network Inventory software extension model is classified as a network model (Section 4 of ). The YANG data model in this document conforms to the Network Management Datastore Architecture (NMDA) defined in .

Editorial Note (To be removed by RFC Editor) Note to the RFC Editor: This section is to be removed prior to publication. This document contains placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed. Please apply the following replacements:

• XXXX --> the assigned RFC number for this I-D
• AAAA --> the assigned RFC number for

Terminology and Notations The following terms are defined in and are not redefined here:

• client
• server
• augment
• data model
• data node The following terms are defined in and are not redefined here:
• configuration data
• state data The tree diagram used in this document follows the notation defined in ..

Also, this document uses terms defined in .

Requirements Language 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 when, and only when, they appear in all capitals, as shown here.

Relationship to Other YANG Data Models The base network inventory model supports the software versions of NEs and software versions of hardware components. This document adds more software component identifiers (e.g. platformos, software patch) and more NE types (e.g. software NE, virtual NE) to provide enhanced software information on the NE to facilitate software compatibility check. depicts the relationship between the Software Extension model and the base network inventory model. The Software Extension network inventory model enhances the model defined in the base network inventory model with more software specific attributes.

Relationship of SW Extension Model to the Base Inventory Model

Model Overview The tree diagram in provides an overview of the data model for "ietf-network-inventory-sw-ext" module.

YANG Tree of Software Extensions

Non-physical Network Elements In the base Network Inventory YANG model, "ne-type" is a YANG identity that describes the type of the network element and only the "physical-network-element" identity" is defined. This document adds non-physical NE identity, such as "ne-software", "ne-virtual", and "ne-container". The base Network Inventory model also defines common inventory attributes, including the software version, patch versions, product name, and serial number. The data is also applicable to non-physical NEs. The Network Inventory software extension mode defines some new software attributes, consisting of software status, installation time, and activation time.

Software components Software components refer to the software installed on the NE, such as operating system, software modules, BIOS, and boot loaders. Similar to the common inventory attributes of NEs, the common attributes of software components (such as software revisions, patch revisions, product name, and serial number) are also applicable to software components. For software revisions and patch revisions, the base inventory (Section 4 of ) defines the "list" of "software-rev" and the "list" of "patch". For example, on a router, software components may include a routing protocol package (e.g., " foo-rt-protocol-suite"), or a firmware module for a line card (e.g., " foo-lc-fw-21.5.3"). If more detailed installation and activation information is needed—such as whether a component is active, pending-reboot, or rollback-eligible, along with its install time or activation time stamp, the extension attributes of software components can be used.

YANG Data model for Network Inventory Software Extensions The "ietf-network-inventory-sw-ext" module uses types defined in , . WG List: Editor: Bo Wu Editor: Cheng Zhou Editor: Qin Wu Editor: Mohamed Boucadair "; description "This YANG module defines a model for network inventory software extensions. Copyright (c) 2025 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; see the RFC itself for full legal notices. 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 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2025-10-20 { description "Initial version"; reference "RFC XXXX: A YANG Data Model for Network Inventory Software Extensions."; } identity ne-nonphysical { base nwi:ne-type; description "Any network element implemented purely in software. It performs protocol or forwarding functions but does not correspond to a distinguishable hardware chassis. It can be hosted on a bare-metal server, VM, container, or cloud instance."; } identity ne-software { base ne-nonphysical; description "Software NE that runs directly on a host OS (a.k.a. bare-metal deployment) or hypervisor. Examples of software NEs are network controllers."; } identity ne-virtual { base ne-nonphysical; description "Virtual NE instantiated inside a virtual-machine (VM). Provides virtual network function (VNF) implementations such as vRouter, vFirewall, vPE."; } identity ne-container { base ne-nonphysical; description "Container NE packaged as CNF (Containerised Network Function). Runs under Docker/K8s."; } identity software-component { base nwi:non-hardware-component-class; description "Base identity for software components in a managed device."; } identity operating-system { base software-component; description "Operating system software type."; } identity bios { base software-component; description "BIOS or UEFI firmware image responsible for hardware initialisation and secure boot."; } 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 "Installable unit smaller than a full OS image, e.g. feature package."; } identity software-status { description "Base identity for software status."; } identity software-installed { base software-status; description "Software status is Installed."; } identity software-activated { base software-status; description "Software status is Activated."; } grouping software-info-grouping { description "Specific attributes applicable to software."; leaf status { type identityref { base software-status; } description "Software status."; } leaf installation-time { type yang:date-and-time; description "Time when the software or patch revision was first installed."; } leaf activation-time { type yang:date-and-time; description "Time when the currently installed revision became active (i.e., was rebooted into)."; } } /* Main blocks */ augment "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element/nwi:software-rev" { description "Adds installation-/activation-time, status, etc. to the base NE software revision."; uses software-info-grouping; } augment "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element/nwi:software-rev/nwi:patch" { description "Adds installation-/activation-time, status, etc. to the patch level."; uses software-info-grouping; } augment "/nwi:network-inventory/nwi:network-elements/" + "nwi:network-element/nwi:components/nwi:component/" + "nwi:software-rev" { description "Extends components, such as line-card/CPU/etc. software revision with timestamp and state information."; uses software-info-grouping; } augment "/nwi:network-inventory/nwi:network-elements/" + "nwi:network-element/nwi:components/nwi:component/" + "nwi:software-rev/nwi:patch" { description "Applies the software-info attributes to component-level patches."; uses software-info-grouping; } } ]]>

Security Considerations This section uses the template described in . The "ietf-network-inventory-sw-ext" YANG module defines a data model that is designed to be accessed via YANG-based management protocols, such as NETCONF NETCONF or RESTCONF . These YANG-based management protocols (1) have to use a secure transport layer (e.g., SSH , TLS , and QUIC ) and (2) have to use mutual authentication. The Network Configuration Access Control Model (NACM) provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. 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. Specifically, the following subtrees and data nodes have particular sensitivities/ vulnerabilities:

• "/nwi:network-elements/network-element/software-rev" This subtree reports the software information for all the network elements and their hardware components deployed within the network as well as of the software modules being active on these network elements and components. This may reveal software versions or unpatched vulnerabilities.

IANA Considerations IANA is requested to register the following URI in the "ns" subregistry within the "IETF XML Registry" : IANA is requested to register the following YANG module in the "YANG Module Names" registry within the "YANG Parameters" registry group:

References Normative References Huawei Technologies Nokia Vodafone FiberCop Cisco This document defines a base YANG data model for reporting network inventory. The scope of this base model is set to be application- and technology-agnostic. The base data model can be augmented with application- and technology-specific details. Datastores are a fundamental concept binding the data models written in the YANG data modeling language to network management protocols such as the Network Configuration Protocol (NETCONF) and RESTCONF. This document defines an architectural framework for datastores based on the experience gained with the initial simpler model, addressing requirements that were not well supported in the initial model. This document updates RFC 7950. YANG is a data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols. This document describes the syntax and semantics of version 1.1 of the YANG language. YANG version 1.1 is a maintenance release of the YANG language, addressing ambiguities and defects in the original specification. There are a small number of backward incompatibilities from YANG version 1. This document also specifies the YANG mappings to the Network Configuration Protocol (NETCONF). The Network Configuration Protocol (NETCONF) defined in this document provides mechanisms to install, manipulate, and delete the configuration of network devices. It uses an Extensible Markup Language (XML)-based data encoding for the configuration data as well as the protocol messages. The NETCONF protocol operations are realized as remote procedure calls (RPCs). This document obsoletes RFC 4741. [STANDARDS-TRACK] This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021. The standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) or the RESTCONF protocol requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF or RESTCONF protocol access for particular users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. This document defines such an access control model. This document obsoletes RFC 6536. This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas. YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS-TRACK] Informative References The IETF has produced many modules in the YANG modeling language. The majority of these modules are used to construct data models to model devices or monolithic functions. A small number of YANG modules have been defined to model services (for example, the Layer 3 Virtual Private Network Service Model (L3SM) produced by the L3SM working group and documented in RFC 8049). This document describes service models as used within the IETF and also shows where a service model might fit into a software-defined networking architecture. Note that service models do not make any assumption of how a service is actually engineered and delivered for a customer; details of how network protocols and devices are engineered to deliver a service are captured in other modules that are not exposed through the interface between the customer and the provider. This document captures the current syntax used in YANG module tree diagrams. The purpose of this document is to provide a single location for this definition. This syntax may be updated from time to time based on the evolution of the YANG language. In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. YumaWorks Orange Huawei This document provides guidelines for authors and reviewers of specifications containing YANG data models, including IANA-maintained modules. Recommendations and procedures are defined, which are intended to increase interoperability and usability of Network Configuration Protocol (NETCONF) and RESTCONF Protocol implementations that utilize YANG modules. This document obsoletes RFC 8407. Also, this document updates RFC 8126 by providing additional guidelines for writing the IANA considerations for RFCs that specify IANA-maintained modules. This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF). The Secure Shell Protocol (SSH) is a protocol for secure remote login and other secure network services over an insecure network. This document describes the SSH authentication protocol framework and public key, password, and host-based client authentication methods. Additional authentication methods are described in separate documents. The SSH authentication protocol runs on top of the SSH transport layer protocol and provides a single authenticated tunnel for the SSH connection protocol. [STANDARDS-TRACK] This document specifies version 1.3 of the Transport Layer Security (TLS) protocol. TLS allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery. This document updates RFCs 5705 and 6066, and obsoletes RFCs 5077, 5246, and 6961. This document also specifies new requirements for TLS 1.2 implementations. This document defines the core of the QUIC transport protocol. QUIC provides applications with flow-controlled streams for structured communication, low-latency connection establishment, and network path migration. QUIC includes security measures that ensure confidentiality, integrity, and availability in a range of deployment circumstances. Accompanying documents describe the integration of TLS for key negotiation, loss detection, and an exemplary congestion control algorithm.

Examples of Software Attributes This appendix provides some examples of software attributes implementations and how they can be modeled using the “ietf-network-inventory-sw-ext” module defined. This appendix illustrates, by means of two typical scenarios, how to populate the software-specific nodes defined in ietf-network-inventory-sw-ext and explains the common values that can be used. Scenario 1: Whole-device base software (example-os) plus hot patches (P3 already activated, P4 installed but not yet activated). Scenario 2: Line-card programmable forwarding image (example-fpga-image) plus its patch (2.1.0.P1 installed and awaiting activation). =============== NOTE: '' line wrapping per RFC 8792 ================ { "ietf-network-inventory:network-inventory": { "network-elements": { "network-element": [ { "ne-id": "example:NE-01", "software-rev": [ { "name": "example:ne-os", "revision": "7.9.2", "ietf-network-inventory-sw-ext:status": "software-\ activated", "ietf-network-inventory-sw-ext:installation-time": "\ 2024-08-01T12:00:00Z", "ietf-network-inventory-sw-ext:activation-time": "2024\ -08-01T12:05:00Z", "patch": [ { "revision": "P3", "ietf-network-inventory-sw-ext:status": "software-\ activated", "ietf-network-inventory-sw-ext:installation-time"\ : "2024-09-15T10:30:00Z", "ietf-network-inventory-sw-ext:activation-time": "\ 2024-09-15T10:32:00Z" }, { "revision": "P4", "ietf-network-inventory-sw-ext:status": "software-\ installed", "ietf-network-inventory-sw-ext:installation-time"\ : "2024-10-01T14:00:00Z", "ietf-network-inventory-sw-ext:activation-time": \ null } ] } ], "components": { "component": [ { "component-id": "example:lpu/1/0", "class": "iana-hardware:module", "software-rev": [ { "name": "example-fp-image", "revision": "2.1.0", "ietf-network-inventory-sw-ext:status": "\ software-activated", "ietf-network-inventory-sw-ext:installation-time\ ": "2024-08-01T12:00:00Z", "ietf-network-inventory-sw-ext:activation-time"\ : "2024-08-01T12:06:00Z", "patch": [ { "revision": "2.1.0.P1", "ietf-network-inventory-sw-ext:status": "\ software-installed", "ietf-network-inventory-sw-ext:installation-\ time": "2024-10-01T14:10:00Z", "activation-time": null } ] } ] } ] } } ] } } }

Acknowledgments The authors would like to thank Prasenjit Manna,Phil Bedard, Diego R. Lopez, Italo Busi, and many others for their helpful comments and suggestions.

Contributors Huawei

zhaoyao.zhaoyao@huawei.com