A YANG Data Model for Optical Network InventoryHuawei Technologiesyuchaode@huawei.comHuawei Technologiesitalo.busi@huawei.comFuturewei Technologiesaihuaguo.ietf@gmail.comNokiasergio.belotti@nokia.comVodafonejeff.bouquier@vodafone.comTIMfabio.peruzzini@telecomitalia.itTelefonicaoscar.gonzalezdedios@telefonica.comNokiavictor.lopez@nokia.comCCAMP Working GroupThis document defines a YANG data model for optical network 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 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).IntroductionNetwork 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 inventory data model.For optical network 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 analysed to cover the requirements and use cases for Optical Network 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 NotationsRefer to and for the key terms used in this
document. The following terms are defined in and are not
redefined here:clientserveraugmentdata modeldata nodeThe following terms are defined in and are not redefined
here:configuration datastate dataThe 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
optical network inventory.Network Element:a device installed on one or several shelves and can afford some specific transmission function independently.Cabinet: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 rack, shelf, slot, sub-slot, board and port.Board/Card:a pluggable equipment on the network element and can afford a specific transmission function independently.Port:an interface on boardTree DiagramA 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 NamesIn 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.PrefixYang ModuleReferenceianahwiana-hardwareniietf-network-inventoryRFCXXXyangietf-yang-typesRFC Editor Note:
Please replace XXXX with the RFC number assigned to this document.
Please remove this note.YANG Data Model for Optical Network InventoryYANG Model OverviewBased on TMF classification in , inventory objects can be divided into two groups, holder group and equipment group. The holder group contains rack, shelf, 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, shelf, 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 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 inventory model when the controller uses the YANG data model defined in to retrieve the hardware configuration from the network elements under its control.Note: review in future versions of this document which attributes from are required also for network inventory and whether there are attributes not defined in which are required for network inventoryNote: review in future versions of this document whether to re-use definitions from or use schema-mount.The YANG data model for network inventory follows the same approach of and reports the network inventory as a list of components of different types (e.g., chassis, module, port).Note: review in future versions of this document whether the component list should be under the network-inventory instead of under the network-element containerHowever, 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 shelves 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 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.Optical Network Inventory Tree Diagram below shows the tree diagram of the YANG data model defined in module ietf-network-inventory.yang ().YANG Model for Optical Network InventoryManageability Considerations<Add any manageability considerations>Security Considerations<Add any security considerations>IANA Considerations<Add any IANA considerations>TMF MTOSI 4.0 Equipment ModelTM Forum (TMF)A YANG Data Model for Hardware ManagementThis document defines a YANG data model for the management of hardware on a single server.Network Management Datastore Architecture (NMDA)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.Routing and Wavelength Assignment Information Model for Wavelength Switched Optical NetworksThis document provides a model of information needed by the Routing and Wavelength Assignment (RWA) process in Wavelength Switched Optical Networks (WSONs). The purpose of the information described in this model is to facilitate constrained optical path computation in WSONs. This model takes into account compatibility constraints between WSON signal attributes and network elements but does not include constraints due to optical impairments. Aspects of this information that may be of use to other technologies utilizing a GMPLS control plane are discussed.Routing and Wavelength Assignment Information Encoding for Wavelength Switched Optical NetworksA Wavelength Switched Optical Network (WSON) requires certain key information fields be made available to facilitate path computation and the establishment of Label Switched Paths (LSPs). The information model described in "Routing and Wavelength Assignment Information Model for Wavelength Switched Optical Networks" (RFC 7446) shows what information is required at specific points in the WSON. Part of the WSON information model contains aspects that may be of general applicability to other technologies, while other parts are specific to WSONs.This document provides efficient, protocol-agnostic encodings for the WSON-specific information fields. It is intended that protocol- specific documents will reference this memo to describe how information is carried for specific uses. Such encodings can be used to extend GMPLS signaling and routing protocols. In addition, these encodings could be used by other mechanisms to convey this same information to a Path Computation Element (PCE).The YANG 1.1 Data Modeling LanguageYANG 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).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]YANG Tree DiagramsThis 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.Common YANG Data TypesThis document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021.TAPI v2.1.3 Reference Implementation AgreementOpen Networking Foundation (ONF)Applicability of Abstraction and Control of Traffic Engineered Networks (ACTN) to Packet Optical Integration (POI)TIMVodafoneHuaweiOld Dog ConsultingEricsson 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.
A YANG Data Model for Network TopologiesThis 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.AcknowledgmentsThe 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.