A YANG Network Data Model of Network Inventory Entitlement/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 conforms to the Network Management Datastore Architecture (NMDA)

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.

The following tree diagram provides an overview of the data model for "ietf-network-inventory-entitlements" module.

/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 , .

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: WG List: Editor: Bo Wu Editor: Cheng Zhou Editor: Qin Wu Editor: Mohamed Boucadair "; 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; } } ]]>



    
      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" . Following the format in ,
      the following registration has been made.

      
        
      

      This document registers a YANG module in the "YANG Module Names"
      registry .

      
        
      
    

    
      TBD