]> Huawei Technologies

yuchaode@huawei.com

Huawei Technologies

italo.busi@huawei.com

Futurewei Technologies

aihuaguo.ietf@gmail.com

Nokia

sergio.belotti@nokia.com

Vodafone

jeff.bouquier@vodafone.com

TIM

fabio.peruzzini@telecomitalia.it

Telefonica

oscar.gonzalezdedios@telefonica.com

Nokia

victor.lopez@nokia.com

CCAMP Working Group This document defines a YANG data model for network hardware inventory data information. The YANG data model presented in this document is intended to be used as the basis toward a generic YANG data model for network hardware inventory data information which can be augmented, when required, with technology-specific (e.g., optical) inventory data, to be defined either in a future version of this document or in another document. The YANG data model defined in this document conforms to the Network Management Datastore Architecture (NMDA).

Introduction Network hardware inventory management is a key component in operators' OSS architectures. Network inventory is a fundamental functionality in network management and was specified many years ago. Given the emerging of data models and their deployment in operator's management and control systems, the traditional function of inventory management is also requested to be defined as a data model. Network inventory management and monitoring is a critical part of ensuring the network stays healthy, well-planned, and functioning in the operator's network. Network inventory management allows the operator to keep track of what physical network devices are staying in the network including relevant software and hardware. The network inventory management also helps the operator to know when to acquire new assets and what is needed, or to decommission old or faulty ones, which can help to improve network performance and capacity planning. In a gap was identified regarding the lack of a YANG data model that could be used at ACTN MPI interface level to report whole/partial hardware inventory information available at PNC level towards north-bound systems (e.g., MDSC or OSS layer). initial goal was to make possible the augmentation of the YANG data model with network inventory data model but this was never developed and the scope was kept limited to network topology data only. It is key for operators to drive the industry towards the use of a standard YANG data model for network inventory data instead of using vendors proprietary APIs (e.g., REST API). In the ACTN architecture, this would bring also clear benefits at MDSC level for packet over optical integration scenarios since this would enable the correlation of the inventory information with the links information reported in the network topology model. The intention is to define a generic YANG data model that would be as much as possible technology agnostic (valid for IP, optical and microwave networks) and that could be augmented, when required, to include some technology-specific inventory details. defines a YANG data model for the management of the hardware on a single server and therefore it is more applicable to the PNC South Bound Interface (SBI) towards the network elements rather than at the PNC MPI. However, the YANG data model defined in has been used as a reference for defining the YANG network hardware inventory data model. For optical network hardware inventory, the network inventory YANG data model should support the use cases (4a and 4b) and requirements defined in , in order to guarantee a seamless integration at MDSC/OSS/orchestration layers. The proposed YANG data model has been analyzed to cover the requirements and use cases for Optical Network Hardware Inventory. Being based on , this data model should be a good starting point toward a generic data model and applicable to any technology. However, further analysis of requirements and use cases is needed to extend the applicability of this YANG data model to other types of networks (IP and microwave) and to identify which aspects are generic and which aspects are technology-specific for optical networks. This document defines one YANG module: ietf-network-inventory.yang (). Note: review in future versions of this document the related modules, depending on the augmentation relationship. The YANG data model defined in this document conforms to the Network Management Datastore Architecture .

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 terminology for describing YANG data models is found in . TBD: Recap the concept of chassis/slot/component/board/... in . Following terms are used for the representation of the hierarchies in the network hardware inventory. Network Element:

• a device installed on one or several chassis and can afford some specific transmission function independently.

Rack:

• a holder of the device and provides power supply for the device in it.

Chassis:

• a holder of the device installation.

Slot:

• a holder of the board.

Component:

• holders and equipments of the network element, including chassis, slot, sub-slot, board and port.

Board/Card:

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

Port:

• an interface on board

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

Tree Diagram A simplified graphical representation of the data model is used in of this document. The meaning of the symbols in these diagrams is defined in .

Prefix in Data Node Names In this document, names of data nodes and other data model objects are prefixed using the standard prefix associated with the corresponding YANG imported modules, as shown in the following table. Prefix Yang Module Reference ianahw iana-hardware ni ietf-network-inventory RFCXXX yang ietf-yang-types RFC Editor Note: Please replace XXXX with the RFC number assigned to this document. Please remove this note.

YANG Data Model for Network Hardware Inventory

YANG Model Overview Based on TMF classification in , inventory objects 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. With the requirement of GIS and on-demand domain controller selection raised, the equipment room becomes a new inventory object to be managed besides TMF classification. Logically, the relationship between these inventory objects can be described by below:

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 network hardware inventory information that a controller discovers from multiple Network Elements 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 network hardware inventory model when the controller uses the YANG data model defined in to retrieve the hardware from the network elements under its control. Note: review in future versions of this document which attributes from are required also for network hardware inventory and whether there are attributes not defined in which are required for network hardware inventory Note: review in future versions of this document whether to re-use definitions from or use schema-mount.

The YANG data model for network hardware inventory follows the same approach of and reports the network hardware inventory as a list of components with different types (e.g., chassis, module, port).

../../uuid +--ro parent +--ro parent-ref? -> ../../uuid ]]>

Note: review in future versions of this document whether the component list should be under the network-inventory instead of under the network-element container However, considering there are some special scenarios, the relationship between the rack and network elements is not 1 to 1 nor 1 to n. The network element cannot be the direct parent node of the rack. So there should be n to m relationship between racks and network elements. And the chassis in the rack should have some reference information to the component. Note that in , topology and inventory are two subsets of network information. However, considering the complexity of the existing topology models and to have a better extension capability, we define a separate root for the inventory model. We will consider some other ways to do some associations between the topology model and inventory model in the future. Note: review in future versions of this document whether network hardware inventory should be defined as an augmentation of the network model defined in instead of under a new network-inventory root. The proposed YANG data model has been analysed to cover the requirements and use cases for Optical Network Inventory. Further analysis of requirements and use cases is needed to extend the applicability of this YANG data model to other types of networks (IP and microwave) and to identify which aspects are generic and which aspects are technology-specific for optical networks.

Efficiency Issue During doing the design of integration with OSS, some efficiency issues have been discovered. More discussion is needed to be done in the future to address this issue. Considering relational database is widely used by traditional OSS systems and part of PNCs, the inventory objects are probably saved in different tables. If the generic model is adopted, when doing a full amount synchronization, PNC needs to convert all inventory objects of each NE into component objects and mix them together into a list, and then construct a response and send to OSS or MDSC. The OSS or MDSC needs to classify the component list and devide them into different groups, in order to save them in different tables. The mixing-regrouping steps are actually waste of effort. And this efficiency issue will be more serious in a larger scale of network.

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

../../uuid +--ro parent +--ro parent-ref? -> ../../uuid ]]>

YANG Model for Network Hardware Inventory

file "ietf-network-inventory@2022-03-04.yang" module ietf-network-inventory { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-network-inventory"; prefix ni; import ietf-yang-types { prefix yang; reference "RFC6991: Common YANG Data Types."; } import iana-hardware { prefix ianahw; reference "RFC 8348: A YANG Data Model for Hardware Management."; } organization "IETF CCAMP Working Group"; contact "WG Web: WG List: Editor: Chaode Yu Editor: Italo Busi Editor: Aihua Guo Editor: Sergio Belotti Editor: Jean-Francois Bouquier Editor: Fabio Peruzzini "; description "This module defines a model for retrieving network inventory. The model fully conforms to the Network Management Datastore Architecture (NMDA). Copyright (c) 2021 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 Simplified 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.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: update the date below with the date of RFC publication // and remove this note. revision 2022-03-04 { description "Initial revision."; reference "draft-yg3bp-ccamp-inventory-yang-00: A YANG Data Model for Network Inventory."; } container network-inventory { config false; description "The top-level container for the network inventory information."; uses equipment-rooms-grouping; uses network-elements-grouping; } grouping common-entity-attributes { description "A set of attributes which are common to all the entities (e.g., component, equipment room) defined in this module."; leaf uuid { type yang:uuid; description "Uniquely identifies an entity (e.g., component)."; } leaf name { type string; description "A name for an 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."; } } grouping network-elements-grouping { description "The attributes of the network elements."; container network-elements { description "The container for the list of network elements."; list network-element { key uuid; description "The list of network elements within the network."; uses common-entity-attributes; uses components-grouping; } } } grouping equipment-rooms-grouping { description "The attributes of the equipment rooms."; container equipment-rooms { description "The container for the list of equipment rooms."; list equipment-room { key uuid; description "The list of equipment rooms within the network."; uses common-entity-attributes; leaf location { type string; description "compared with the location information of the other inventory objects, a GIS address is preferred for equipment room"; } list rack { key uuid; description "The list of racks within an equipment room."; uses common-entity-attributes; leaf row-number { type uint32; description "Identifies the row within the equipment room where the rack is located."; } leaf rack-number { type uint32; description "Identifies the physical location of the rack within the row."; } list chassis { key uuid; description "The list of chassis within a rack."; uses common-entity-attributes; leaf chassis-number { type uint8; description "Identifies the location of the chassis within the rack."; } container chassis-ref { description "The reference to the network element component representing this chassis."; leaf ne-ref { type leafref { path "/ni:network-inventory/ni:network-elements" + "/ni:network-element/ni:uuid"; } description "The reference to the network element containing the component."; } leaf component-ref { type leafref { path "/ni:network-inventory/ni:network-elements" + "/ni:network-element[ni:uuid" + "=current()/../ne-ref]/ni:components" + "/ni:component/ni:uuid"; } description "The reference to the component within the network element."; } } } } } } } grouping components-grouping { description "The attributes of the hardware components."; container components { description "The container for the list of components."; list component { key uuid; description "The list of components within a network element."; uses common-entity-attributes; leaf description { type string; description "A textual description of the component."; reference "RFC 8348: A YANG Data Model for Hardware Management."; } leaf class { type identityref { base ianahw:hardware-class; } description "An indication of the general hardware type of the component."; reference "RFC 8348: A YANG Data Model for Hardware Management."; } leaf parent-rel-pos { type int32 { range "0 .. 2147483647"; } 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 8348: A YANG Data Model for Hardware Management."; } list children { key child-ref; description "The child components that are physically contained by this component."; leaf child-ref { type leafref { path "../../ni:uuid"; } description "The reference to the child component."; } } container parent { description "The parent component that physically contains this component. If this container 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 container contains the data of one of these components. An implementation MUST use the same component every time this container is instantiated."; leaf parent-ref { type leafref { path "../../ni:uuid"; } description "The reference to the parent component."; } } } } } } ]]>

Manageability Considerations <Add any manageability considerations>

Security Considerations <Add any security considerations>

IANA Considerations <Add any IANA considerations>

TM Forum (TMF) 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. 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] 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. 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. This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021. Open Networking Foundation (ONF) TIM Vodafone Huawei Old Dog Consulting Ericsson This document considers the applicability of Abstraction and Control of TE Networks (ACTN) architecture to Packet Optical Integration (POI)in the context of IP/MPLS and Optical internetworking. It identifies the YANG data models being defined by the IETF to support this deployment architecture and specific scenarios relevant for Service Providers. Existing IETF protocols and data models are identified for each multi-layer (packet over optical) scenario with a specific focus on the MPI (Multi-Domain Service Coordinator to Provisioning Network Controllers Interface)in the ACTN architecture. This document defines an abstract (generic, or base) YANG data model for network/service topologies and inventories. The data model serves as a base model that is augmented with technology-specific details in other, more specific topology and inventory data models.

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.