Internet DRAFT - draft-wzwb-ivy-network-inventory-entitlement
draft-wzwb-ivy-network-inventory-entitlement
IVY B. Wu
Internet-Draft Huawei
Intended status: Standards Track C. Zhou
Expires: 20 April 2024 China Mobile
Q. Wu
Huawei
M. Boucadair
Orange
18 October 2023
A YANG Network Data Model of Network Inventory Entitlement/License
draft-wzwb-ivy-network-inventory-entitlement-00
Abstract
This document defines the YANG model for network inventory licenses/
entitlements. It provides licenses/entitlements information for
network inventory management and facilitates fine-grained network
inventory management.
This document augments the 'ietf-network-inventory' data model
defined in xxx by adding the licenses/entitlements attributes that
are applicable to the Network Element (NE) and hareware and software
components.
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 20 April 2024.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
Wu, et al. Expires 20 April 2024 [Page 1]
Internet-Draft Network Inventory Licenses October 2023
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 . . . . . . . . . . . . . . . . . . . . 2
3. Model Overview . . . . . . . . . . . . . . . . . . . . . . . 3
4. YANG Data model for Network Inventory Entitlement . . . . . . 3
5. Security Considerations . . . . . . . . . . . . . . . . . . . 7
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8
8. References . . . . . . . . . . . . . . . . . . . . . . . . . 8
8.1. Normative References . . . . . . . . . . . . . . . . . . 8
8.2. Informative References . . . . . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9
1. Introduction
The Network Inventory support the inventory management of all the
network devices, hardware components, firmware components, and
software components on the a managed network domain. Examples of
inventory hardware components could be rack, shelf, slot, board and
physical port. Examples of inventory software components could be
platform operating system (OS), software-patch, bios, and boot-
loader.
This document extends the 'ietf-network-inventory' model defined in
xxx by adding the licenses/entitlements attributes that are
applicable to the Network Element (NE) and hareware and software
components.
The YANG data model in Section 4 conforms to the Network Management
Datastore Architecture (NMDA) [RFC8342]
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.
Wu, et al. Expires 20 April 2024 [Page 2]
Internet-Draft Network Inventory Licenses October 2023
3. Model Overview
The following tree diagram [RFC8340] provides an overview of the data
model for "ietf-network-inventory-entitlements" module.
module: ietf-network-inventory-entitlement
+--ro entitlements
+--ro entitlement* [entitlement-id]
+--ro entitlement-id string
+--ro entitlement-type? string
+--ro mfg-name? string
+--ro serial-number? string
+--ro entitlement-data? union
+--ro active? boolean
+--ro issue-date? uint64
+--ro expiration-date? uint64
+--ro in-use? boolean
+--ro expired? boolean
+--ro valid? boolean
+--ro network-elements-ref* string
+--ro ne-components-ref* string
augment /ni:network-elements/ni:network-element:
+--ro entitle-ref* -> /entitlements/entitlement/entitlement-id
augment /ni:network-elements/ni:network-element/ni:components/ni:component:
+--ro entitle-ref* -> /entitlements/entitlement/entitlement-id
4. YANG Data model for Network Inventory Entitlement
The "ietf-network-inventory-entitlements" module uses types defined
in [RFC6991], [RFC8348].
<CODE BEGINS>
file="ietf-network-inventory-entitlement@2023-10-19.yang"
module ietf-network-inventory-entitlement {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-network-inventory-entitlement";
prefix nie;
import ietf-network-inventory {
prefix ni;
reference
"RFCxxxx: IETF Network Inventory";
}
organization
"IETF Network Inventory YANG (ivy) Working Group";
contact
Wu, et al. Expires 20 April 2024 [Page 3]
Internet-Draft Network Inventory Licenses October 2023
"WG Web: <https://datatracker.ietf.org/wg/ivy>
WG List: <mailto:inventory-yang@ietf.org>
Editor: Bo Wu
<lana.wubo@huawei.com>
Editor: Cheng Zhou
<zhouchengyjy@chinamobile.com>
Editor: Qin Wu
<bill.wu@huawei.com>
Editor: Mohamed Boucadair
<mohamed.boucadair@orange.com>";
description
"This YANG module defines a model for retrieving network inventory
entitlements.
Copyright (c) 2023 IETF Trust and the persons
identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.";
revision 2023-10-19 {
description
"Initial version";
reference
"RFC XXXX: A YANG Data Model for Network Inventory Entitlement.";
}
grouping entitl-ref-list {
description
"Defines a grouping to a reference list of entitlement.";
leaf-list entitle-ref {
type leafref {
path "/nie:entitlements/nie:entitlement/nie:entitlement-id";
}
Wu, et al. Expires 20 April 2024 [Page 4]
Internet-Draft Network Inventory Licenses October 2023
config false;
description
"Defines a reference to a list of entitlement.";
}
}
/* Main blocks */
container entitlements {
config false;
description
"The top-level container for the list of entitlements
of the network inventory.";
list entitlement {
key "entitlement-id";
description
"List of entitlements.";
leaf entitlement-id {
type string;
description
"entitlement ID. A string that uniquelly identifies the
entitlement. ";
}
leaf entitlement-type {
type string;
description
"The entitlement type.";
}
leaf mfg-name {
type string;
description
"The name of the manufacturer of this entitlement";
}
leaf serial-number {
type string;
description
"The vendor-specific serial number string for the
entitlement";
}
leaf entitlement-data {
type union {
type binary;
type string;
}
description
"The contents of the licence (if required) .";
}
leaf active {
Wu, et al. Expires 20 April 2024 [Page 5]
Internet-Draft Network Inventory Licenses October 2023
type boolean;
default "false";
description
"The activation state of the entitlement.";
}
leaf issue-date {
type uint64;
description
"The date and time at which the entitlement was issued.";
}
leaf expiration-date {
type uint64;
description
"The date and time at which the entitlement will expire.";
}
leaf in-use {
type boolean;
description
"The entitlement is in use.";
}
leaf expired {
type boolean;
description
"The entitlement has expired.";
}
leaf valid {
type boolean;
description
"The entitlement is valid. Can be activated in the system
or platform.";
}
leaf-list network-elements-ref {
type string;
description
"The list of the the references of network elements.";
}
leaf-list ne-components-ref {
type string;
description
"The list of the references of the components.";
}
}
}
augment "/ni:network-elements/ni:network-element" {
description
"Introduces new network type for network inventory.";
uses entitl-ref-list;
Wu, et al. Expires 20 April 2024 [Page 6]
Internet-Draft Network Inventory Licenses October 2023
}
augment "/ni:network-elements/ni:network-element/"
+ "ni:components/ni:component" {
description
"Introduces new network type for network inventory.";
uses entitl-ref-list;
}
}
<CODE ENDS>
5. 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>>>
6. IANA Considerations
This document registers a URI in the "IETF XML Registry" [RFC3688].
Following the format in [RFC3688], the following registration has
been made.
Wu, et al. Expires 20 April 2024 [Page 7]
Internet-Draft Network Inventory Licenses October 2023
URI: urn:ietf:params:xml:ns:yang:ietf-network-inventory-entitlement
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
This document registers a YANG module in the "YANG Module Names"
registry[RFC7950] .
name: ietf-network-inventory-entitlement
namespace: urn:ietf:params:xml:ns:yang:ietf-network-inventory-entitlement
prefix: nwie
maintained by IANA: N
reference: RFC xxxx
7. Acknowledgements
TBD
8. References
8.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>.
[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>.
[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>.
Wu, et al. Expires 20 April 2024 [Page 8]
Internet-Draft Network Inventory Licenses October 2023
[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>.
[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>.
8.2. Informative References
[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>.
Authors' Addresses
Bo Wu
Huawei
101 Software Avenue, Yuhua District
Nanjing
Jiangsu, 210012
China
Email: lana.wubo@huawei.com
Wu, et al. Expires 20 April 2024 [Page 9]
Internet-Draft Network Inventory Licenses October 2023
Cheng Zhou
China Mobile
Beijing
100053
China
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 20 April 2024 [Page 10]
