A YANG Network Data Model of Network Inventory
draft-wzwb-opsawg-network-inventory-management-04
| Document | Type | Active Internet-Draft (individual) | |
|---|---|---|---|
| Authors | Bo Wu , Cheng Zhou , Qin Wu , Mohamed Boucadair | ||
| Last updated | 2023-10-19 | ||
| RFC stream | (None) | ||
| Intended RFC status | (None) | ||
| Formats | |||
| Stream | Stream state | (No stream defined) | |
| Consensus boilerplate | Unknown | ||
| RFC Editor Note | (None) | ||
| IESG | IESG state | I-D Exists | |
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-wzwb-opsawg-network-inventory-management-04
OPSAWG B. Wu
Internet-Draft Huawei
Intended status: Standards Track C. Zhou
Expires: 21 April 2024 China Mobile
Q. Wu
Huawei
M. Boucadair
Orange
19 October 2023
A YANG Network Data Model of Network Inventory
draft-wzwb-opsawg-network-inventory-management-04
Abstract
This document defines a base YANG data model for network inventory
that is application- and technology-agnostic. This data model can be
augmented with application-specific and technology-specific details
in other, more specific network inventory data models.
This document is meant to help IVY base Network Inventory model
discussion and ease agreement on a base model that would be flexible
enough to be augmented with components that are covered by the IVY
Charter.
The hardware components definition are adapted from draft-ietf-ccamp-
network-inventory-yang-02.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 21 April 2024.
Wu, et al. Expires 21 April 2024 [Page 1]
Internet-Draft Network Inventory Management October 2023
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Requirements Language . . . . . . . . . . . . . . . . . . . . 3
3. YANG Data Model for Network Inventory . . . . . . . . . . . . 4
3.1. Network Element . . . . . . . . . . . . . . . . . . . . . 4
3.2. Components of Network Element . . . . . . . . . . . . . . 5
3.3. Hardware Components of Network Element . . . . . . . . . 6
3.4. Software Attributes of Network Element . . . . . . . . . 7
4. Extending Network Inventory . . . . . . . . . . . . . . . . . 7
5. Model Overview . . . . . . . . . . . . . . . . . . . . . . . 7
6. YANG Data model for Network Inventory . . . . . . . . . . . . 8
7. Security Considerations . . . . . . . . . . . . . . . . . . . 9
8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 9
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
10.1. Normative References . . . . . . . . . . . . . . . . . . 9
10.2. Informative References . . . . . . . . . . . . . . . . . 11
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11
1. Introduction
Network inventory is a foundation for all types of network
management. Network operators need to keep track of the equipment
planned and installed in their networks (including product name,
manufacturer, product family, embedded software, and hardware/
software version). Building a network inventory from management
system can be used to control and monitor the actual devices/
instances in the network and expose this information in a consistent
way to applications that would consume that data. This document does
not make any assumptions on these applications.
Wu, et al. Expires 21 April 2024 [Page 2]
Internet-Draft Network Inventory Management October 2023
Network Inventory is a collection of data for network devices and
their components managed by a specific management system. Per the
definition of [RFC8969],the network inventory model is a network
model.
The purpose of this document is to define a base network inventory
YANG data model that is application- and technology-agnostic. The
base data model can be augmented to describe application-specific or
technology-specific information.
The YANG data model defined in this document conforms to [RFC8342].
Section 4 provides a set of augmentation consideration for extensions
of hardware, software, entitlement, and inventory topology mapping.
2. 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 [RFC2119][RFC8174] when, and only when, they appear in all
capitals, as shown here.
This document defines the following terms:
Network Inventory: Network Inventory is a collection of data for
network devices and their components managed by a specific
management system. It consists of Network Element (NE), hardware,
software, and entitlement/license data.
Network Element Is a manageable network entity that contains
hardware and software units, e.g. a network device installed on
one or several chassis, or a network controller which may reside
in any computing devices.
Component: Is a unit of the network element, e.g. hardware
components like chassis, card, port, software components like
software-patch, bios, and boot-loader.
Entitlement Is defined by a device vendor, that grants and restricts
access to inventory items, such as NE, hardware component,
software component.
Wu, et al. Expires 21 April 2024 [Page 3]
Internet-Draft Network Inventory Management October 2023
3. YANG Data Model for Network Inventory
The network element definition is generalized to support physical
devices and other types of inventory objects (e.g., virtual network
elements) that can be managed as physical network elements from an
inventory perspective. The data model for Network Element presented
in this document uses a flat list of network element. Each network
element in the list is identified by its identifier, "ne-id".
Furthermore, each network element has a "ne-type" leaf.
The "ne-type" leaf is a YANG identity that describes the type of the
network element. This document defines "physical-network-element"
identity.
The component definition is also generalized to support any type of
component, such as hardware, software, or firmware.
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.
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-specific or technology-
specific companion augmentation data models, such as
[I-D.wzwb-ivy-network-inventory-software].
+--rw network-elements
+--rw network-element* [ne-id]
+--rw ne-id string
+--rw ne-type? identityref
............................................
+--rw components
+--rw component* [component-id]
+--rw component-id string
+--rw class union
......................................
3.1. Network Element
Some of the hardware and software attributes defined in Section 3.1
of [RFC7317] are borrowed, such as platform-os version and machine.
To be consistent with the component definition, some of the
attributes defined in [RFC8348] for components are reused for network
elements. These attributes include:
Wu, et al. Expires 21 April 2024 [Page 4]
Internet-Draft Network Inventory Management October 2023
+--ro network-elements
+--ro network-element* [ne-id]
...................................
+--ro hardware-rev? string
+--ro software-rev? string
+--ro mfg-name? string
+--ro mfg-date? yang:date-and-time
+--ro part-number? string
+--ro serial-number? string
+--ro product-name? string
...................................
Figure 1: YANG Structure of Network Element
Note: Whether the identity of device-type (e.g., optical device,
router) is defined in the base model is to be discussed.
3.2. Components of Network Element
The component definition is generalized to both hardware components
and non-hardware components (e.g., software components).
+--rw components
+--rw component* [component-id]
+--rw component-id string
+--rw uuid? yang:uuid
+--rw name? string
+--rw description? string
+--rw alias? string
+--rw class union
+--rw child-component-ref
+--rw parent-rel-pos? int32
+--rw parent-component-ref
+--rw hardware-rev? string
+--rw firmware-rev? string
+--rw software-rev? string
+--rw serial-num? string
+--rw mfg-name? string
+--rw part-number? string
+--rw asset-id? string
+--rw is-fru? boolean
+--rw mfg-date? yang:date-and-time
+--rw uri* inet:uri
Figure 2: YANG Structure of Component
Wu, et al. Expires 21 April 2024 [Page 5]
Internet-Draft Network Inventory Management October 2023
3.3. Hardware Components of Network Element
The modelling of the hardware components of network elements mainly
follow the same approach of [RFC8348]. The hardware components are
reported in the list of components of a network element and for each
component the mandatory 'class' leaf is used indicate the type of
component (e.g., chassis, module, and port).
The relationship between typical inventory objects in a physical
network element can be described as shown in Figure 3:
+-----------------+
| network element |
+-----------------+
||
|| 1:N
||
\/
+-------------+
| chassis/ |---+
| sub-chassis |<--|
+-------------+
||
______1:N______||_____1:M_______
||------------------ ---------||
\/ \/
+--------------+ +-----------+
+---| slot | | board |
|-->| /sub-slot | | |
+--------------+ +-----------+
||
||1:N
\/
+-----------+
| port |
+-----------+
Figure 3: Relationship between typical inventory objects in
physical network elements
The "iana-hardware" module [IANA_YANG] defines YANG identities for
the hardware component types in the IANA-maintained "IANA-ENTITY-MIB"
registry. Some of the definitions taken from [RFC8348] are actually
based on the ENTITY-MIB [RFC6933].
For the additional attributes of specific hardware, such as CPU,
storage, port, power supply is defined in the hardware extension.
Wu, et al. Expires 21 April 2024 [Page 6]
Internet-Draft Network Inventory Management October 2023
3.4. Software Attributes of Network Element
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, defined in the software extension
[I-D.wzwb-ivy-network-inventory-software].
Note: Whether the software patch is in the base inventory model is to
be discussed.
4. Extending Network Inventory
This document defines the basic network inventory attributes
applicable to typical network scenarios. For finer-grained and
specific management scenarios, the relationship between this model
and other models is illustrated in Figure 4.
+-------------------------+
| |
| Base Network Inventory |
| |
+------------+------------+
|
+------------------+-------------------+
| | |
+------V------+ +------V------ +------V------ +-------------+
| | | | | | | |
| Hardware | | Software | | | | Inventory |
| Extensions | | Extensions | | Entitlement | | Topology |
| e.g. Power | | e.g. | | | | Mapping |
| supply unit | | SW patch | | | | |
+-------------+ +-------------+ +-------------+ +-------------+
Figure 4
5. Model Overview
The following tree diagram [RFC8340] provides an overview of "ietf-
network-inventory" module.
Wu, et al. Expires 21 April 2024 [Page 7]
Internet-Draft Network Inventory Management October 2023
module: ietf-network-inventory
+--rw network-elements
+--rw network-element* [ne-id]
+--rw ne-id string
+--rw ne-type? identityref
+--rw uuid? yang:uuid
+--rw name? string
+--rw description? string
+--rw alias? string
+--rw hardware-rev? string
+--rw software-rev? string
+--rw mfg-name? string
+--rw mfg-date? yang:date-and-time
+--rw part-number? string
+--rw serial-number? string
+--rw product-name? string
+--rw components
+--rw component* [component-id]
+--rw component-id string
+--rw uuid? yang:uuid
+--rw name? string
+--rw description? string
+--rw alias? string
+--rw class? union
+--rw contained-child* -> ../component-id
+--rw parent-rel-pos? int32
+--rw parent-component-ref
+--rw hardware-rev? string
+--rw firmware-rev? string
+--rw software-rev? string
+--rw serial-num? string
+--rw mfg-name? string
+--rw part-number? string
+--rw asset-id? string
+--rw is-fru? boolean
+--rw mfg-date? yang:date-and-time
+--rw uri* inet:uri
6. YANG Data model for Network Inventory
Wu, et al. Expires 21 April 2024 [Page 8]
Internet-Draft Network Inventory Management October 2023
7. Security Considerations
The YANG module specified in this document defines a data schema
designed to be accessed through network management protocols such as
NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is
the secure transport layer, and the required secure transport is
Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS,
and the required secure transport is TLS [RFC8446].
The Network Configuration Access Control Model (NACM) [RFC8341]
provides a means of restricting access to specific NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF or
RESTCONF protocol operations and contents. Thus, NACM SHOULD be used
to restrict the NSF registration from unauthorized users.
There are a number of data nodes defined in this YANG module that are
writable, creatable, and deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations to these data nodes
could have a negative effect on network and security operations.
Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability:
<<<to be completed>>>
8. Acknowledgements
TBD
9. IANA Considerations
TBD
10. References
10.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
Wu, et al. Expires 21 April 2024 [Page 9]
Internet-Draft Network Inventory Management October 2023
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for
System Management", RFC 7317, DOI 10.17487/RFC7317, August
2014, <https://www.rfc-editor.org/info/rfc7317>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8345] Clemm, A., Medved, J., Varga, R., Bahadur, N.,
Ananthakrishnan, H., and X. Liu, "A YANG Data Model for
Network Topologies", RFC 8345, DOI 10.17487/RFC8345, March
2018, <https://www.rfc-editor.org/info/rfc8345>.
Wu, et al. Expires 21 April 2024 [Page 10]
Internet-Draft Network Inventory Management October 2023
[RFC8348] Bierman, A., Bjorklund, M., Dong, J., and D. Romascanu, "A
YANG Data Model for Hardware Management", RFC 8348,
DOI 10.17487/RFC8348, March 2018,
<https://www.rfc-editor.org/info/rfc8348>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[RFC9179] Hopps, C., "A YANG Grouping for Geographic Locations",
RFC 9179, DOI 10.17487/RFC9179, February 2022,
<https://www.rfc-editor.org/info/rfc9179>.
10.2. Informative References
[I-D.wzwb-ivy-network-inventory-software]
Wu, B., Zhou, C., Wu, Q., and M. Boucadair, "A YANG
Network Data Model of Network Inventory Software
Extensions", Work in Progress, Internet-Draft, draft-wzwb-
ivy-network-inventory-software-00, 18 October 2023,
<https://datatracker.ietf.org/doc/html/draft-wzwb-ivy-
network-inventory-software-00>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8969] Wu, Q., Ed., Boucadair, M., Ed., Lopez, D., Xie, C., and
L. Geng, "A Framework for Automating Service and Network
Management with YANG", RFC 8969, DOI 10.17487/RFC8969,
January 2021, <https://www.rfc-editor.org/info/rfc8969>.
Authors' Addresses
Bo Wu
Huawei
101 Software Avenue, Yuhua District
Nanjing
Jiangsu, 210012
China
Email: lana.wubo@huawei.com
Cheng Zhou
China Mobile
Beijing
100053
China
Wu, et al. Expires 21 April 2024 [Page 11]
Internet-Draft Network Inventory Management October 2023
Email: zhouchengyjy@chinamobile.com
Qin Wu
Huawei
101 Software Avenue, Yuhua District
Nanjing
Jiangsu, 210012
China
Email: bill.wu@huawei.com
Mohamed Boucadair
Orange
Rennes 35000
France
Email: mohamed.boucadair@orange.com
Wu, et al. Expires 21 April 2024 [Page 12]