]> Huawei Technologies

yuchaode@huawei.com

Nokia

sergio.belotti@nokia.com

Vodafone

jeff.bouquier@vodafone.com

FiberCop

fabio.peruzzini@fibercop.com

Cisco

phbedard@cisco.com

next generation unicorn sparkling distributed ledger This document defines a base YANG data model for 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. About This Document The latest revision of this draft can be found at . Status information for this document may be found at . Source for this draft and an issue tracker can be found at .

Introduction This document defines a base network inventory YANG data model that is application- and technology-agnostic. The base data model can be augmented to describe application- and technology-specific information. Please note that the usage of term "network inventory", in the context of this I-D, is to indicate that it is describing "network-wide" scope inventory information. Network inventory is a fundamental functional block in the overall network management which was specified many years ago. Network inventory management is a critical part for ensuring that the network remains healthy (e.g., auditing to identify faulty elements), well-planned (e.g., identify assets to upgrade or to decommission), and maintained appropriately to meet the performance objectives. Also, network inventory management allows operators to keep track of which devices are deployed in their networks, including relevant embedded software and hardware versions. Exposing standard interfaces to retrieve network elements capabilities as maintained in an inventory are key enablers for many applications. For example, identifies a gap about the lack of YANG data models that could be used at Abstraction and Control of TE Networks (ACTN) Multi-Domain Service Coordinator-Provisioning Network Controller Interface (MPI) level to report whole or partial network hardware inventory information available at domain controller level towards upper layer systems (e.g., Multi-Domain Service Coordinator (MDSC) or Operations Support Systems (OSS) layers). It is key for operators to coordinate with the industry towards the use of a standard YANG data model for Network Inventory data instead of using vendors proprietary APIs. defines a YANG data model for the management of the hardware on a single server and therefore it is more applicable to the domain controller towards the network elements rather than at the northbound interface of a network controller (e.g., toward an application or another hierarchical network controller). However, the YANG data model defined in has been used as a reference for defining the YANG network inventory data model presented in this document. Network Inventory is a collection of data for network devices and their components managed by a specific management system. Per the definition of , the network inventory model is a network model. This document defines one YANG module "ietf-network-inventory" in . This base data model is application- and technology-agnostic (that is, valid for IP/MPLS, optical, and microwave networks as well as optical local loops, access networks, core networks, data centers, etc.) and can be augmented to include required application- and technology-specific inventory details together with specific hardware or software component's attributes. The YANG data model defined in the document is scoped to cover the common use cases for Inventory but at network-wide level, covering both hardware and base software information. The YANG data model defined in this document conforms to the Network Management Datastore Architecture . The YANG data model defined in the document is intended to only report actual inventory data which includes both applied configuration data and state data of the network elements and components actually installed within the network.

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

Terminology and Notations

Requirements Notations 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.

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

• server
• augment
• data model
• data node

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

• configuration data
• state data

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

• applied configuration

The following terms are defined in the description statements of the corresponding YANG identities, defined in , and are not redefined here:

• backplane
• battery
• container
• cpu
• chassis
• fan
• module
• port
• power supply
• sensor
• stack
• storage device

• Editors' Note: The port definition below needs to be moved to iana-hardware update

Port:

A component where networking traffic can be received and/or transmitted, e.g., by attaching networking cables.

In case of pluggable ports, the port may be empty when no transceiver module is plugged in.

• TBD: Recap the concept of chassis/slot/component/board/... in .

Also, the document makes use of the following terms:

Physical interface:

An interface associated to a physical port. A physical interface is always in the lowest layer of the interface stack.

Logical interface:

An interface which is not associated to a physical port.

• Editors' Note: check whether the definitions of physical and logical interfaces can be replaced by a normative reference to

• Editors' Note: Add recap for the concepts of chassis/slot/component/board/... in .

Network Inventory:

A collection of data for network elements and their components with network-wide scope, managed by a specific management system.

Physical Network Element:

An implementation or application specific group of components (e.g., hardware components).

Network Element:

The generalization of the physical network element definition.

Hardware Component:

The generalization of the hardware components defined in (e.g., backplane, battery, container, cpu, chassis, fan, module, port, power supply, sensor, stack, and storage device components).

The list of hardware components can be extended in future versions of (and, consequently, of ().

Component:

The generalization of the hardware component definition to include other inventory objects which can be managed, from an inventory perspective, like hardware components.

Slot:

A holder of the board.

Board/Card:

A pluggable equipment can be inserted into one or several slots (or sub-slots) and can afford a specific transmission function independently.

Breakout Port:

A port is usually associated with a single physical interface. A breakout port is a port which is broken down and associated into multiple physical interfaces. Those physical interfaces can have the same or different speeds and the same or different number of breakout channels.

Trunk Port:

A trunk port is a port which is associated with one and only physical interface.

Port Breakout:

The configuration of a breakout port.

• Note that interface channelization, when an interface (e.g., an Ethernet interface) is configured to support multiple logical sub-interfaces (e.g., VLAN interfaces), is different than port breakout and outside the scope of inventory models.

Breakout channel:

An abstraction of the atomic resource elements into which a breakout port can be broken down: a physical interface can be associated with one or more breakout channels but no more than one physical interface can be associated with one breakout channel.

The physical elements abstracted as breakout channels are implementation specific. provides some examples of breakout ports configurations and implementations.

Container:

A hardware component class that is capable of containing one or more removable physical entities (e.g., a slot in a chassis is containing a board).

Transceiver:

A transceiver represents a transmitter/receiver (Tx/Rx) pair which is transmitting and receiving a signal from the media.

This definition generalizes the transceiver definition in to model also non optical transceivers (e.g., electrical transceivers).

Tree Diagrams The meanings of the symbols in the YANG tree diagrams are defined in .

YANG Prefixes list the prefixes of the modules that are used in this document. Prefixes and corresponding YANG modules

Prefix	YANG Module	Reference
inet	ietf-inet-types
yang	ietf-yang-types
ianahw	iana-hardware
nwi	ietf-network-inventory	RFC XXXX

YANG Data Model for Network Inventory Overview The base network inventory model, defined in this document, provides a list of network elements and of network element components:

Overall Tree Structure

The network-inventory top level container has been defined to support reporting other types of network inventory objects, besides the network elements and network element components. These additional types of network inventory objects can be defined, together with the associated YANG data model and the rationale for managing them as part of the network inventory, in other documents providing application- and technology-specific companion augmentation data models, such as The network element definition is generalized to support physical network elements and other types of components' groups that can be managed as physical network elements from an inventory perspective. Physical network elements are usually devices such as hosts, gateways, terminal servers, and the like, which have management agents responsible for performing the network management functions requested by the network management stations (). The "ne-type" is defined as a YANG identity to describe the type of the network element. This document defines only the "physical-network-element" identity. Other types of network elements can be defined in other documents, together with the associated YANG identity and the rationale for managing them as network elements from an inventory perspective. The component definition is also generalized to support any types of component inventory objects that can be managed as hardware components from an inventory perspective. The data model for components defined in this document uses a list of components within each network element. Different types of components can be distinguished by the class of component. The component "class" is defined as a union between the hardware class identity, defined in "iana-hardware", and the "non-hardware" identity, defined in this document. Other types of components can be defined in other documents, together with the associated YANG identity and the rationale for managing them as components from an inventory perspective. The identity definition of additional types of "ne-type" and "non- hardware" identity of component are outside the scope of this document and could be defined in application- and technology-specific companion augmentation data models, such as . In , rack, chassis, slot, sub-slot, board and port are defined as components of network elements with generic attributes. While is used to manage the hardware of a single server (e.g., a network element), the Network Inventory YANG data model is used to retrieve the base inventory information that a controller discovers from all the network elements with network-wide scope under its control. However, the YANG data model defined in has been used as a reference for defining the YANG network inventory data model. This approach can simplify the implementation of this inventory model when the controller uses the YANG data model defined in to retrieve the hardware from the network elements under its control.

Common Design for All Inventory Objects For all the inventory objects, there are some common attributes . Such as:

Identifier:

The UUID format is used. Such identifiers are widely implemented with systems. It is guaranteed to be globally unique.

Name:

A human-readable label information which could be used to present on a GUI. This name is suggested to be provided by a server.

Alias:

A human-readable label information which could be modified by user. It could also be present on a GUI instead of name.

Description:

A human-readable information which could be also input by a user. The description provides more detailed information to prompt users when performing maintenance operations.

Common Attributes Between Network Elements and Components Subtree

Network Element To be consistent with the component definition, some of the attributes defined in for components are reused for network elements as shown in .

Network Elements Subtree

• Not all the attributes defined in are applicable for network element. And there could also be some missing attributes which are not recognized by . More extensions could be introduced in later revisions after the missing attributes are fully discussed.

Components The YANG data model for network inventory mainly follows the same approach of and reports the network hardware inventory as a list of components with different types (e.g., chassis, module, and port). The component definition () is generalized to both hardware components and non-hardware components (e.g., software components).

Components Subtree

For state data like "admin-state", "oper-state", and so on, this document considers that they are related to device hardware management, not network inventory. Therefore, they are outside of the scope of this document. Same for the sensor-data, they should be defined in some other performance monitoring data models instead of the inventory data model.

Hardware Components Based on TMF classification in , hardware components can be divided into two groups, holder group and equipment group. The holder group contains rack, chassis, slot, sub-slot while the equipment group contains network-element, board and port. describes the relationship between typical inventory objects in a physical network element.

Relationship between typical inventory objects in physical network elements | /sub-slot | | | +--------------+ +-----------+ || ||1:N \/ +-----------+ | port | +-----------+ ]]>

The "iana-hardware" module defines YANG identities for the hardware component types in the IANA-maintained "IANA-ENTITY-MIB" registry. Some of the definitions taken from are based on the ENTITY-MIB . Additional attributes of specific hardware, such as CPU, storage, port, or power supply are defined in the hardware extension.

Software Components This document defines "software-rev" of NEs and components, which are basic software attributes of a Network Element. The software and hardware components share the same attributes of the component and have similar replaceable requirements. Generally, the device also has other software data, for example, one or more software patch information. The software components of other classes, such as platform software, BIOS, bootloader, and software patch information, are outside the scope of this document and defined other documents such as .

Breakout ports The model defines the 'breakout-channels' presence container to indicate whether the port, which contains the transceiver module, can be configured as a breakout port or not. The breakout channels represent the capability of the port to support port breakout, independently on how the port is configured (trunk or breakout). It is assumed that a port which supports port breakout can be configured either as a trunk port or as a breakout port. Reporting whether a port, which supports port breakout, is configured as a trunk or as a breakout port, is outside the scope of the base network inventory model. The model providing the mapping between the topology and the inventory models should provide sufficient information to identify how the port is configured and, in case of breakout configuration, which breakout channel is associated with which Link Termination Point (LTP), abstracting a device physical interface within the topology model.

Changes Since RFC 8348 This document re-defines some attributes listed in , based on some integration experience for network inventory data.

Part Number According to the description in , the attribute named "model-name" under the component, is preferred to have a customer-visible part number value. "Model-name" is not straightforward to understand and we suggest to rename it as "part-number" directly.

Component identifiers There are some use cases where the name of the components are assigned and changed by the operator. In these cases, the assigned names are also not guaranteed to be always unique. In order to support these use cases, this model is not aligned with in defining the component name as the key for the component list. Instead the name is defined as an optional attribute and the component-id is defined as the key for the component list (in alignment with the approach followed for the network-element list).

Network Inventory Tree Diagram below shows the tree diagram of the YANG data model defined in module "ietf-network-inventory" ().

Network inventory tree diagram ../../component/component-id +--ro is-main? boolean +--ro breakout-channels! +--ro breakout-channel* [channel-id] +--ro channel-id uint8 ]]>

YANG Data Model for Network Inventory

Network inventory YANG module WG List: Editor: Chaode Yu Editor: Sergio Belotti Editor: Jean-Francois Bouquier Editor: Fabio Peruzzini Editor: Phil Bedard "; description "This module defines a base model for retrieving network inventory. The model fully conforms to the Network Management Datastore Architecture (NMDA). 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."; // RFC Ed.: update the date below with the date of RFC publication // and remove this note. revision 2025-07-02 { description "Initial version"; reference "RFC XXXX: A YANG Data Model for Network Inventory."; } /* * Identities */ identity non-hardware-component-class { description "Base identity for non hardware components (e.g., software components) in a managed device."; } identity ne-type { description "Base identity for Network Element (NE) types."; } identity ne-physical { base nwi:ne-type; description "A physical network element (NE). "; } /* * Editors' Note: This identity may need to be moved to * iana-hardware update */ identity transceiver-module { base ianahw:hardware-class; description "This identity is applicable if the hardware class is some sort of self-contained sub-system which contains one or more transceivers (e.g., optical or electrical transceivers). A transceiver-module component can only be contained by a port component."; } /* * Types */ typedef ne-ref { type leafref { path "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element/nwi:ne-id"; } description "This type is intended to be used by data models that need to reference Network Element."; } /* * Groupings */ grouping port-ref { description "This grouping is intended to be used by data models that need to reference a port component within a Network Element."; leaf ne-ref { type nwi:ne-ref; description "The reference to the Network Element which contains the port to be referenced."; } leaf port-ref { type leafref { path "/nwi:network-inventory/nwi:network-elements/" + "nwi:network-element[nwi:ne-id=current()/../ne-ref]" + "/nwi:components/nwi:component/nwi:component-id"; } must "derived-from-or-self (/nwi:network-inventory/ nwi:network-elements/nwi:network-element [nwi:ne-id=../ne-ref]/nwi:components/nwi:component [nwi:component-id=current()]/nwi:class, 'ianahw:port')"; description "The reference to the port component."; } } grouping channel-ref { description "This grouping is intended to be used by data models that need to reference one or more breakout channels within a transceivers module component."; leaf ne-ref { type nwi:ne-ref; description "The reference to the Network Element which contains the transceiver module to be referenced."; } leaf transceiver-module-ref { type leafref { path "/nwi:network-inventory/nwi:network-elements/" + "nwi:network-element[nwi:ne-id=current()/../ne-ref]" + "/nwi:components/nwi:component/nwi:component-id"; } must "derived-from-or-self (/nwi:network-inventory/ nwi:network-elements/nwi:network-element [nwi:ne-id=../ne-ref]/nwi:components/nwi:component [nwi:component-id=current()]/nwi:class, 'nwi:transceiver-module')"; description "The reference to the transceivers module component."; } leaf-list channel-ref { type leafref { path "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element[nwi:ne-id=current()/../ne-ref]/" + "nwi:components/" + "nwi:component[nwi:component-id=" + "current()/../transceiver-module-ref]/" + "nwi:breakout-channels/nwi:breakout-channel/" + "nwi:channel-id"; } description "The references to the breakout channels."; } } grouping component-attributes { description "The set of common attributes of a component. This grouping is intended also to be re-used by data models that need to report the common attributes of a component."; leaf component-id { type string; description "An identifier that uniquely identifies the component in a node."; } leaf class { type union { type identityref { base ianahw:hardware-class; } type identityref { base non-hardware-component-class; } } config false; mandatory true; description "The type of the component."; } uses ne-component-common-entity-attributes { refine "hardware-rev" { 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"; } refine "software-rev" { reference "RFC 6933: Entity MIB (Version 4) - entPhysicalSoftwareRev"; } refine "mfg-name" { 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-number' 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"; } refine "mfg-date" { description "The date of manufacturing of the managed component."; reference "RFC 6933: Entity MIB (Version 4) - entPhysicalMfgDate"; } } 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 part-number { type string; config false; description "The vendor-specific part number of the component type. It is expected that vendors assign unique part numbers to different component types within the scope of the vendor."; } 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 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. For all components that are permanently contained within a field-replaceable unit, the value 'false' should be returned for this node."; reference "RFC 6933: Entity MIB (Version 4) - entPhysicalIsFRU"; } 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"; } } grouping basic-common-entity-attributes { description "The set of basic attributes which are common to all the entities (e.g., component, network elements, location, passive entities) defined in this module and in other inventory modules."; leaf uuid { type yang:uuid; config false; description "The Universally Unique Identifier of the entity (e.g., component)."; } leaf name { type string; description "The name of the entity (e.g., component), as specified by a network manager, that provides a non-volatile 'handle' for the entity and that can be modified anytime during the entity lifetime. If no configured value exists, the server MAY set the value of this node to a locally unique value in the operational state."; } leaf description { type string; description "The textual description of the entity (e.g., component)."; } leaf alias { type string; description "The alias name of the entity (e.g., component). This alias name can be specified by network manager."; } } grouping ne-component-common-entity-attributes { description "The set of attributes which are common to all the entities (e.g., component, network elements) defined in this module."; uses basic-common-entity-attributes; leaf hardware-rev { type string; config false; description "The vendor-specific hardware revision string for the entity (e.g., component)."; } leaf software-rev { type string; config false; description "The vendor-specific software revision string for the entity (e.g., component)."; } leaf-list software-patch-rev { type string; config false; description "The vendor-specific patch software revision string for the entity (e.g., component)."; } leaf mfg-name { type string; config false; description "The name of the manufacturer of this entity (e.g., component)."; } leaf mfg-date { type yang:date-and-time; config false; description "The date of manufacturing of the entity (e.g., component)."; } leaf serial-number { type string; config false; description "The vendor-specific serial number of the the entity (e.g., component) instance. It is expected that vendors assign unique serial numbers to different network element instances within the scope of the product name."; } leaf product-name { type string; config false; description "The vendor-specific and human-interpretable string describing the entity (e.g., component) type. It is expected that vendors assign unique product names to different entity (e.g., component) types within the scope of the vendor."; } } /* * Data Nodes */ container network-inventory { description "Top-level container for network inventory."; container network-elements { description "The top-level container for the list of network elements within the network."; list network-element { key "ne-id"; description "The list of network elements within the network."; leaf ne-id { type string; description "An identifier that uniquely identifies the NE in a network."; } leaf ne-type { type identityref { base nwi:ne-type; } default "nwi:ne-physical"; config false; description "The NE type."; } uses ne-component-common-entity-attributes; container components { description "The top-level container for the list of components within a network element."; list component { key "component-id"; description "The list of components within a network element."; uses component-attributes; container child-component-ref { config false; description "A placeholder for adding the reference to child component(s): to further discuss whether to define a child leaf-list as RFC 8348 or a list of sub-components as openconfig-platform."; } leaf parent-rel-pos { type int32 { range "0 .. 2147483647"; } config false; description "The relative position with respect to the parent component among all the sibling components."; reference "RFC 6933: Entity MIB (Version 4) - entPhysicalParentRelPos"; } leaf parent { type leafref { path "../../component/component-id"; require-instance false; } config false; description "The identifier 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 identifier 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 is-main { when "derived-from-or-self(../nwi:class, " + "'ianahw:chassis')"; type boolean; config false; description "This node indicates whether the chassis is taking or not the 'main' role. This node is applicable only to scenarios where there are chassis components which can take the 'main' role (e.g., multi-chassis network elements), otherwise it is omitted."; } container breakout-channels { when "derived-from-or-self(../nwi:class, " + "'nwi:transceiver-module')"; presence "When present, it indicates that port breakout is supported."; config false; description "Top level container for the list of breakout channels supported by the transceivers module."; list breakout-channel { key "channel-id"; description "The list of breakout channels supported by the transceivers module."; leaf channel-id { type uint8; description "An identifier that uniquely identifies the breakout channel within the transceiver module."; } } } } } } } } } ]]>

Manageability Considerations <Add any manageability considerations>

Security Considerations <Add any security considerations>

IANA Considerations <Add any IANA considerations>

References Normative References TM Forum IANA n.d. IANA n.d. This document defines a YANG data model for the management of hardware on a single server. 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. 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. 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 defines a YANG data model for the management of network interfaces. It is expected that interface-type-specific data models augment the generic interfaces data model defined in this document. The data model includes definitions for configuration and system state (status information and counters for the collection of statistics). The YANG data model in this document conforms to the Network Management Datastore Architecture (NMDA) defined in RFC 8342. This document obsoletes RFC 7223. This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021. This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it describes managed objects used for managing multiple logical and physical entities managed by a single Simple Network Management Protocol (SNMP) agent. This document specifies version 4 of the Entity MIB. This memo obsoletes version 3 of the Entity MIB module published as RFC 4133. Informative References FiberCop Vodafone Huawei Old Dog Consulting Cisco This document explores the applicability of the Abstraction and Control of TE Networks (ACTN) architecture to Packet Optical Integration (POI) within the context of IP/MPLS and optical internetworking. It examines the YANG data models defined by the IETF that enable an ACTN-based deployment architecture and highlights specific scenarios pertinent to Service Providers. Existing IETF protocols and data models are identified for each multi-technology scenario (packet over optical), particularly emphasising the Multi-Domain Service Coordinator to Provisioning Network Controller Interface (MPI) within the ACTN architecture Data models provide a programmatic approach to represent services and networks. Concretely, they can be used to derive configuration information for network and service components, and state information that will be monitored and tracked. Data models can be used during the service and network management life cycle (e.g., service instantiation, service provisioning, service optimization, service monitoring, service diagnosing, and service assurance). Data models are also instrumental in the automation of network management, and they can provide closed-loop control for adaptive and deterministic service creation, delivery, and maintenance. This document describes a framework for service and network management automation that takes advantage of YANG modeling technologies. This framework is drawn from a network operator perspective irrespective of the origin of a data model; thus, it can accommodate YANG modules that are developed outside the IETF. Nokia Orange Nokia Individual Huawei Technologies In order to provision an optical connection through optical networks, a combination of path continuity, resource availability, and impairment constraints must be met to determine viable and optimal paths through the network. The determination of appropriate paths is known as Impairment-Aware Routing and Wavelength Assignment (IA-RWA) for WSON, while it is known as Impairment-Aware Routing and Spectrum Assignment (IA-RSA) for SSON. This document provides a YANG data model for the impairment-aware TE topology in optical networks. 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. Huawei Nokia Vodafone TIM Cisco This document defines a YANG data model for Network Inventory location (e.g., site, room, rack, geo-location data), which provides location information with different granularity levels for inventoried network elements. Accurate location information is useful for network planning, deployment, and maintenance. However, such information cannot be obtained or verified from the Network Elements themselves. This document defines a location model for network inventory that extends the base inventory with comprehensive location data. This RFC is a re-release of RFC 1098, with a changed "Status of this Memo" section plus a few minor typographical corrections. This memo defines a simple protocol by which management information for a network element may be inspected or altered by logically remote users. [STANDARDS-TRACK] Huawei China Mobile Huawei Orange The base Network Inventory YANG model defines the physical network elements (NEs) and hardware components of NEs. This document extends the base Network Inventory model for non-physical NEs (e.g., controllers, virtual routers, virtual firewalls) and software components (e.g., platform operating system (OS), software-patch). This document defines encoding rules for representing configuration data, state data, parameters of Remote Procedure Call (RPC) operations or actions, and notifications defined using YANG as JavaScript Object Notation (JSON) text. Huawei Futurewei Huawei This document presents a YANG data model for passive device inventory information. The model enhances the base model outlined in [I-D.draft-ietf-ivy-network-inventory-yang] and is intended for use in the northbound interface of a domain controller as defined in [RFC8453].

Comparison With Openconfig-platform Data Model Since more and more devices can be managed by domain controller through OpenConfig, to ensure that our inventory data model can cover these devices' inventory data, we have compared our inventory data model with the "openconfig-platform" model which is the data model used to manage inventory information in OpenConfig. Openconfig-platform data model is NE-level and uses a generic component concept to describe its inner devices and containers, which is similar to "ietf-hardware" model in . Since we have also reused the component concept of in our inventory data model, we can compare the component's attributes between "openconfig-platform" and our model directly , which is stated below: Comparison between openconfig platform and inventory data models

Attributes in oc-platform	Attributes in our model	remark
name	name
type	class
id	uuid
location	location
description	description
mfg-name	mfg-name
mfg-date	mfg-date
hardware-version	hardware-rev
firmware-version	firmware-rev
software-version	software-rev
serial-no	serial-num
part-no	part-number
clei-code		TBD
removable	is-fru
oper-status		state data
empty	contained-child?	If there is no contained child, it is empty.
parent	parent-references
redundant-role		TBD
last-switchover-reason		state data
last-switchover-time		state data
last-reboot-reason		state data
last-reboot-time		state data
switchover-ready		state data
temperature		performance data
memory		performance data
allocated-power		TBD
used-power		TBD
pcie		alarm data
properties		TBD
subcomponents
chassis
port
power-supply		TBD
fan		Fan is considered as a specific board. And no need to define as a single component
fabric		TBD
storage		For Optical and IP technology, no need to manage storage on network element
cpu		For Optical and IP technology, no need to manage CPU on network element
integrated-circuit
backplane		Backplane is considered as a part of board. And no need to define as a single component
software-module		TBD
controller-card		Controller card is considered as a specific functional board. And no need to define as a single component

As it mentioned in that state data and performance data are out of scope of our data model, it is same for alarm data and it should be defined in some other alarm data models separately. And for some component specific structures in "openconfig-platform", we consider some of them can be contained by our existing structure, such as fan, backplane, and controller-card, while some others do not need to be included in this network inventory model like storage and cpu. Mostly, our inventory data model can cover the attributes from OpenConfig.

Terminology of Container Within this document , with the term "container" we consider an hardware component class capable of containing one or more removable physical entities, e.g. a slot in a chassis is containing a board. terminology mapping

terminology of IVY base model	terminology in other model
container	holder

Efficiency Issue During the integration with OSS in some operators, some efficiency/scalability concerns have been discovered when synchronizing network inventory data for big networks. More discussions are needed to address these concerns. Considering that relational databases are widely used by traditional OSS systems and also by some network controllers, the inventory objects are most likely to be saved in different tables. With the model defined in current draft, when doing a full synchronization, network controller needs to convert all inventory objects of each NE into component objects and combine them together into a single list, and then construct a response and send to OSS or MDSC. The OSS or MDSC needs to classify the component list and divide them into different groups, in order to save them in different tables. The combining-regrouping steps are impacting the network controller & OSS/MDSC processing, which may result in efficiency/scalability limitations in large scale networks. An alternative YANG model structure, which defines the inventory objects directly, instead of defining generic components, has also been analyzed. However, also with this model, there still could be some scalability limitations when synchronizing full inventory resources in large scale of networks. This scalability limitation is caused by the limited transmission capabilities of HTTP protocol. We think that this scalability limitation should be solved at protocol level rather than data model level. The model proposed by this draft is designed to be as generic as possible so to cover future special types of inventory objects that could be used in other technologies, that have not been identified yet. If the inventory objects were to be defined directly with fixed hierarchical relationships in YANG model, this new type of inventory objects needs to be manually defined, which is not a backward compatible change and therefore is not an acceptable approach for implementation. With a generic model, it is only needed to augment a new component class and extend some specific attributes for this new inventory component class, which is more flexible. We consider that this generic data model, enabling a flexible and backward compatible approach for other technologies, represents the main scope of this draft. Solution description to efficiency/scalability limitations mentioned above is considered as out-of-scope.

Examples of ports, transceivers and port breakouts This appendix provides some examples of ports, transceivers and port breakouts implementations and how they can be modelled using the "ietf-network-inventory" model defined in . shows an example of a single board which contains three type of ports:

1. An integrated port (non pluggable). This port can be of any type (e.g., optical or electrical), single-channel or multi-channel but not supporting breakouts;
2. An empty port;
3. A pluggable port

Example of a board with different types of ports

describes an implementation of a single channel optical pluggable trunk port (e.g., a 100G-LR port configured as a single 100GE interface)

Example of a single channel optical pluggable port | 100G PAM |o | | | | | |n | | (breakout |-->TX1 TX1-->| 1X100G PAM4| +--------+ |n | | configuration)|-->TX2 TX2-->| |-->|Opt.Tras|-->|e | | |-->TX3 TX3-->| Gearbox | +--------+ |c | | |-->TX4 TX4-->| | +--+ +---------------+ +------------+ ^ ^ | | Host Interface Line Interface (4x25G host channels) (1x100G line channel) ]]>

describes an implementation of a Wavelength-Division Multiplexing (WDM) based multi-channel optical pluggable trunk port (e.g., a 400G-LR4 port configured as a single 400GE interface).

Example of a WDM multi-channel optical pluggable port |Opt.TX1|-->| | | n | | | | | +-------+ |M | | n | | |-->TX1 TX1-->| | +-------+ |U | | e | | |-->TX2 TX2-->| |-->|Opt.TX2|-->|X | | c | | |-->TX3 TX3-->| | +-------+ | |-->| t | | |-->TX4 TX4-->| | +-------+ |C | | o | | |-->TX5 TX5-->| |-->|Opt.TX3|-->|W | | r | | |-->TX6 TX6-->| | +-------+ |D | +---+ | |-->TX7 TX7-->| | +-------+ |M | | |-->TX8 TX8-->| |-->|Opt.TX4|-->| | | | | | +-------+ | / +-------------+ +--------+ |/ ^ ^ | | Host Interface Line Interface (8x50G host channels) (4x100G ine channels) ]]>

In this example, since breakout is not supported, the four WDM channels cannot be modelled as breakout channels and are not relevant from inventory management perspective. describes an implementation of a Multi-Fiber Push-on (MPO) trunk port (e.g., 400G-DR4 port configured as a single 400GE interface).

Example of a MPO trunk port |Opt.TX.1|-->|1 | | | | | +--------+ | | | |-->TX1 TX1-->| | +--------+ |2 | | |-->TX2 TX2-->| |-->|Opt.TX.2|-->| | | |-->TX3 TX3-->| | +--------+ | | | |-->TX4 TX4-->| | +--------+ | | | |-->TX5 TX5-->| |-->|Opt.TX.3|-->| | | |-->TX6 TX6-->| | +--------+ | | | |-->TX7 TX7-->| | +--------+ | | | |-->TX8 TX8-->| |-->|Opt.TX.4|-->| | | | | | +--------+ | | +---------------+ +------------+ +--+ ^ ^ | | Host Interface Line Interface (8x50G host channels) (4x100G line channels) ]]>

If this MPO port cannot support breakouts, the four line channels cannot be modelled as breakout channels and are not relevant from inventory management perspective. From a network inventory perspective, there is no difference between single-channel ports and MPO trunk ports which do not support port breakouts. Instead, the MPO port can support breakouts, the four line channels are reported as breakout channels because, as describe in , the breakout channels represent the capability of the port to support breakout, independently on how the port is configured (trunk or breakout). describes an implementation of a MPO breakout port (e.g., 400G-DR4 port configured as 4x100GE interfaces).

Example of a MPO breakout port TX1 | | +--------+ | | | configuration)|-->TX2 RX3<--| | +--------+ | | +---------------+ RX4<--| |<--|Opt.RX.2|<--| | | | +--------+ | | +---------------+ RX5<--| 8 X 50 PAM4| +--------+ | | | 100G Eth. |<--RX3 RX6<--| |<--|Opt.RX.3|<--| | |Physical I/F #2|<--RX4 | to | +--------+ |M | | (breakout |-->TX3 RX7<--| | +--------+ | | | configuration)|-->TX4 RX8<--|4 X 100 PAM4|<--|Opt.RX.4|<--|P | +---------------+ | | +--------+ | | | | |O | +---------------+ TX1-->| | +--------+ | | | 100G Eth. |<--RX5 TX2-->| Gearbox |-->|Opt.TX.1|-->|1 | |Physical I/F #3|<--RX6 | | +--------+ | | | (breakout |-->TX5 TX3-->| | +--------+ |2 | | configuration)|-->TX6 TX4-->| |-->|Opt.TX.2|-->| | +---------------+ | | +--------+ | | TX5-->| | +--------+ | | +---------------+ TX6-->| |-->|Opt.TX.3|-->| | | 100G Eth. |<--RX7 | | +--------+ | | |Physical I/F #4|<--RX8 TX7-->| | +--------+ | | | (breakout |-->TX7 TX8-->| |-->|Opt.TX.4|-->| | | configuration)|-->TX8 | | +--------+ | | +---------------+ +------------+ +--+ ^ ^ | | Host Interface Line Interface (8x50G host channels) (4x100G line channels) ]]>

In this example, the four line channels are reported as breakout channels because the port shall support breakout in order to be configured as a breakout port.

JSON Examples This appendix contains an example of an instance data tree in JSON encoding , instantiating the "ietf-network-inventory" model to describe a single board, as shown in , with seven different types of ports, transceivers and breakouts configurations:

1. An integrated port (non pluggable), as shown in ;
2. An empty port, as shown in ;
3. A single channel optical pluggable port, as shown in and ;
4. A WDM based multi-channel optical pluggable port, as shown in and ;
5. An MPO trunk port, as shown in and , which does not support port breakouts;
6. An MPO trunk port, as shown in and , which can not support port breakouts but it has been configured as a trunk port,
7. An MPO breakout port, as shown in and .

Note: as described in , reporting whether an MPO port is configured as a trunk or as a breakout port, is outside the scope of the base network inventory model.

Example of multi-chassis network elements This appendix provides some examples of multi-chassis network elements and how they can be modelled using the "ietf-network-inventory" model defined in . Multi-chassis network elements are network elements composed by two or more chassis interconnected, in principle, with any topology. Stacked switches are an example of multi-chassis which consist of multiple standalone switches that are interconnected through dedicated stack ports and cables and managed as a single logical unit. Stacked switch: - are connected using a daisy-chain or a ring topology - are managed using a single IP Address - synchronized software-upgrade - use Priority/MAC-Addr(s) decide Master/Members selection and communication. and describe two examples of stacked switch with three stacked switches (pizza boxes) connected in a daisy-chain or ring topology.

Example of a stacked switch in a daisy chain topology

Example of a stacked switch in a ring topology

Using the base network inventory model, each stackable switch can be modelled as a chassis within the same network element, which models the stacked switch. The stack ports are modelled like other ports. The stack cables are not reported using the base network inventory model but can be reported using the passive network inventory model under definition in . Cascaded switches are another example of multi-chassis which consist of multiple standalone switches that are interconnected and managed as a single logical unit. Cascaded switch: - are usually connected in a tree topology - are managed using a single IP Address - the root of the tree is configured as Master. describe an example of cascaded switch with three chassis connected in a tree topology.

Example of a cascaded switch in a tree topology | 4 || | | | ... | | |+---+| | | | | | | | | | | | | | | | | |+---+| | | | ... | | ... || 6 |<-----+ | | ... | | | |+---+| | | | | | | | | | | | | | | | ... | | | | | | | | | | | |+---+| | | |+---+| | | ||10 || | | ||10 || | | |+---+| | | |+---+| | | +----------------------------------------------+ | | | | | | +-------------------------------+ | | | S1 | Chassis 2 | S16 | | | | | | | | | | | | | | | |+---+| | | | +---> 5 || | | | |+---+| | | | | | | | | | | | | | +-------------------------------+ | | | +-------------------------------+ | | S1 | Chassis 3 | S16 | | | | | | | | | | | | | | | | | | | |+---+| | | | || 7 |<--+ | | |+---+| | | | | +-------------------------------+ ]]>

Using the base network inventory model each interconnected switch can be modelled as a chassis within the same network element, which models the cascaded switch. The ports used to interconnect the different chassis are normal (traffic) ports and modelled like other ports. The interconnecting cables are not reported using the base network inventory model but can be reported using the passive network inventory model under definition in .

JSON Examples This appendix contains an example of an instance data tree in JSON encoding , instantiating the "ietf-network-inventory" model to describe the three examples of multi-chassis NEs, as shown in xxx, yyy and zzz.

• Note: the base inventory model allows reporting only the chassis and ports configuration. Reporting the link between the chassis of the same NE is outside the scope of the base inventory model. The YANG data model under definition in as an augmentation of the base inventory model can be used to provide this additional information.

Acknowledgments The authors of this document would like to thank the authors of for having identified the gap and requirements to trigger this work. This document was prepared using kramdown.

Contributors Huawei Technologies

italo.busi@huawei.com

Futurewei Technologies

aihuaguo.ietf@gmail.com

Nokia

victor.lopez@nokia.com

Huawei Technologies

lana.wubo@huawei.com

China Unicom

zhangcf80@chinaunicom.cn

Telefonica

oscar.gonzalezdedios@telefonica.com

Ciena

ndavis@ciena.com