| Internet-Draft | Network Inventory Licenses | October 2023 |
| Wu, et al. | Expires 20 April 2024 | [Page] |
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.¶
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 (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.¶
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]¶
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.¶
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
¶
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
"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";
}
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 {
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;
}
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>¶
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>>>¶
This document registers a URI in the "IETF XML Registry" [RFC3688]. Following the format in [RFC3688], the following registration has been made.¶
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
¶
TBD¶