A YANG Data Model for Network Inventory Location

NEs can be grouped by location to provide more information for network planning, deployment, and maintenance (e.g., easily locate problematic NEs, optimize network resources, or help planning forecasts). The location can reflect outdoor or indoor information. An indoor location may be represented as a building, room, or other similar organizational structures. Outdoor locations can be walls, poles, or other mount places. The information about sites, equipment rooms, and other more precise locations is critical, but it cannot be automatically populated and retrieved from network elements (NEs). Instead, it is usually configured manually. The Network Inventory location model is to record physical locations, such as sites, building, equipment rooms, racks, and so on. Additionally, it includes provisions for physical addresses or geo-location data (geographic coordinates). The location model can extend the base network inventory to enrich NEs with location information. The Network Inventory location model is classified as a network configuration model (Section 4 of ). The Network Inventory location YANG model conforms to the Network Management Datastore Architecture (NMDA) .

The following terms are defined in and are not redefined here: client server augment data model data node The following terms are defined in and are not redefined here: configuration data state data The tree diagram used in this document follows the notation defined in .

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 "location" list is generalized to support a variety of geographic location, such as sites, rooms, buildings. A site represents a general geographic location to group a set of NEs and corresponding inventory components. NEs, racks, equipment rooms, and buildings can be grouped within a site. A room is a facility, a space for network elements and other equipment (such as servers, storage) with power supply systems, air conditioning system, etc. Locations can be nested to form a hierarchy. For example, buildings may be within a site, and a room may be within a building. The "location-type" is defined as a YANG identity to identify the type of an inventory location, which may be site, equipment room, building, etc.

"racks" represent physical equipment racks in which NEs can be installed, which facilitate device maintenance. Through "rack-location", each rack can be assigned to a site or a specific location within a site, such as an equipment room. Each rack is assigned a unique ID and a name in the context of a facility, e.g. a site. A rack may have some specific attributes, such as appearance-related attributes and electricity-related attributes. The height, depth and width are described by (please consider that the door of the rack is facing the user). Note: Further discussion is needed to decide whether to separate "racks" from the list of "location".

The rack attributes include:

Max-voltage: the maximum voltage supported by the rack.

provides an overview of the data model for "ietf-ni-location" module.

../../location/id | +--rw child* -> ../../location/id | +--rw physical-address | | +--rw address? string | | +--rw postal-code? string | | +--rw state? string | | +--rw city? string | | +--rw country-code? string | +--rw geo-location | +--rw reference-frame | | +--rw alternate-system? string | | | {alternate-systems}? | | +--rw astronomical-body? string | | +--rw geodetic-system | | +--rw geodetic-datum? string | | +--rw coord-accuracy? decimal64 | | +--rw height-accuracy? decimal64 | +--rw (location)? | | +--:(ellipsoid) | | | +--rw latitude? decimal64 | | | +--rw longitude? decimal64 | | | +--rw height? decimal64 | | +--:(cartesian) | | +--rw x? decimal64 | | +--rw y? decimal64 | | +--rw z? decimal64 | +--rw velocity | | +--rw v-north? decimal64 | | +--rw v-east? decimal64 | | +--rw v-up? decimal64 | +--rw timestamp? yang:date-and-time | +--rw valid-until? yang:date-and-time +--rw racks +--rw rack* [id] +--rw id string +--ro uuid? yang:uuid +--rw name? string +--rw description? string +--rw alias? string +--rw rack-location | +--rw location-ref? ni-location-ref | +--rw row-number? uint32 | +--rw column-number? uint32 +--rw height? uint16 +--rw width? uint16 +--rw depth? uint16 +--rw max-voltage? uint16 +--rw max-allocated-power? uint16 +--rw contained-chassis* [relative-position] +--rw relative-position uint8 +--rw ne-ref? leafref +--rw component-ref? leafref augment /nwi:network-inventory/nwi:network-elements /nwi:network-element: +--rw locations +--rw location* ni-location-ref +--rw rack? -> /locations/racks/rack/id ]]>

The "ietf-ni-location" module uses types defined in , .

file="ietf-ni-location@2024-08-19.yang" module ietf-ni-location { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-ni-location"; prefix nil; import ietf-network-inventory { prefix nwi; reference "RFCAAAA: A YANG Data Model for Network Inventory"; } import ietf-geo-location { prefix geo; reference "RFC 9179: A YANG Grouping for Geographic Locations"; } organization "IETF Network Inventory YANG (ivy) Working Group"; contact "WG Web: WG List: Editor: Bo Wu Editor: Sergio Belotti Editor: Jean-Francois Bouquier Editor: Fabio Peruzzini Editor: Phil Bedard "; description "This YANG module defines a model for Network Inventory location. Copyright (c) 2024 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."; revision 2024-08-19 { description "Initial version"; reference "RFC XXXX: A YANG Data Model for Network Inventory location."; //RFC Editor: Please replace XXXX with actual RFC number, //update date information and remove this note } /* Identities */ identity inventory-location-type { description "Base identity for network inventory location types, e.g. site, room, building, and floor."; } identity site { base inventory-location-type; description "Indicates site as location type."; } identity room { base inventory-location-type; description "Indicates equipment room as location type."; } identity building { base inventory-location-type; description "Indicates building as location type."; } /* Typedef */ typedef ni-location-ref { type leafref { path "/nil:locations/nil:location/nil:id"; } description "This type is used by data models that need to reference network inventory location."; } /* Grouping */ grouping physical-address-grouping { description "The grouping of the physical address."; container physical-address { description "Top level container for the physical address."; leaf address { type string; description "Specifies an address (number and street)."; } leaf postal-code { type string; description "Specifies a postal code."; } leaf state { type string; description "Specifies a state. This leaf can also be used to describe a region for a country that does not have states."; } leaf city { type string; description "Specifies a city."; } leaf country-code { type string { pattern '[A-Z]{2}'; } description "Specifies a country. Expressed as ISO ALPHA-2 code."; } } } grouping locations-grouping { description "The grouping of the locations."; list location { key "id"; description "The list of locations within the network."; leaf id { type string; description "An identifier of the location."; } uses nwi:common-entity-attributes; leaf type { type identityref { base inventory-location-type; } description "The type of network inventory location, e.g. equipment room, building, or site."; } leaf parent { type leafref { path "../../location/id"; } description "The name of the location that physically contains this location."; } leaf-list child { type leafref { path "../../location/id"; } description "The name of the contained child locations."; } uses physical-address-grouping; uses geo:geo-location; } } grouping rack-grouping { description "The attributes of the rack."; container racks { description "Top level container for the list of racks."; list rack { key "id"; description "The list of racks within a location, e.g. equipment room."; leaf id { type string; description "An identifier that uniquely identifies the rack within a location, e.g. equipment room."; } uses nwi:common-entity-attributes; container rack-location { description "The location information of the rack, which comprises the name of the location, row number, and column number."; leaf location-ref { type ni-location-ref; description "Name of location where this rack is located."; } leaf row-number { type uint32; description "Identifies the row within the equipment room where the rack is located."; } leaf column-number { type uint32; description "Identifies the physical location of the rack within the column."; } } leaf height { type uint16; units "millimeter"; description "Rack height."; } leaf width { type uint16; units "millimeter"; description "Rack width."; } leaf depth { type uint16; units "millimeter"; description "Rack depth."; } leaf max-voltage { type uint16; units "volt"; description "The maximum voltage could be supported by the rack."; } leaf max-allocated-power { type uint16; units "watts"; description "The maximum allocated power to the rack."; } list contained-chassis { key "relative-position"; description "The list of chassis within a rack."; leaf relative-position { type uint8; description "A relative position of chassis within the rack"; } leaf ne-ref { type leafref { path "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element/nwi:ne-id"; } description "The reference to the network element containing the chassis component."; } leaf component-ref { type leafref { path "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element[nwi:ne-id=current()/.." + "/ne-ref]/nwi:components/nwi:component" + "/nwi:component-id"; } description "The reference to the chassis component within the network element and contained by the rack."; } } } } } grouping locations-ref-grouping { description "The attributes of the locations."; container locations { description "The container for the location."; leaf-list location { type ni-location-ref; description "The reference of the location."; } leaf rack { type leafref { path "/nil:locations/nil:racks" + "/nil:rack/nil:id"; } description "The reference to the rack."; } } } container locations { description "The top-level container for the NE location information."; uses locations-grouping; uses rack-grouping; } augment "/nwi:network-inventory/nwi:network-elements/nwi:network-element" { description "Provides location information for network inventory."; uses locations-ref-grouping; } } ]]>



    
      The YANG module specified in this document defines a data schema
      designed to be accessed through network management protocols such as
      NETCONF or RESTCONF .
      The lowest NETCONF layer is the secure transport layer, and the required
      secure transport is Secure Shell (SSH) . The
      lowest RESTCONF layer is HTTPS, and the required secure transport is TLS
      .

      The Network Configuration Access Control Model (NACM)  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 .

      
        
      
    

    
      The authors would like to thank the authors and contributors of  to trigger this work.
      During the discussion of base Network Inventory (NI) model, it is agreed
      that the definition of the equipment room and rack can be a separate
      location model and support manual configuration, while the NI model
      aggregates the inventory data of the Network Elements (NEs) on the
      network. Usually the information about sites or equipment rooms is not
      detectable by network controller and configured manually.

      The authors wish to thank Mohamed Boucadair and many others for their
      helpful comments and suggestions.
    

    
      The following authors contributed significantly to this document: