| Internet-Draft | Network Inventory Location | February 2024 |
| Wu, et al. | Expires 10 August 2024 | [Page] |
This document defines a Yang data model for Network Inventory location, e.g. site, room, rack, geo-location data, which is used to provide location information with different granularities for network inventory items (such as Network Elements, device components).¶
Accurate location information is useful for network planning, deployment, and maintenance. However, such information cannot be obtained or verified from Network Elements and therefore is not included in the base Network Inventory model defined in draft-ietf-ivy-network-inventory-yang. The purpose of this document is to define a location model for network inventory that extends the base inventory with comprehensive location data.¶
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 10 August 2024.¶
Copyright (c) 2024 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.¶
During the discussion of base Network Inventory (NI) model [I-D.ietf-ivy-network-inventory-yang], 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 domain controller and configured manually.¶
NEs can be grouped by location to provide more information for network planning, deployment, and maintenance (e.g. Locate problematic NEs and optimize network resources). The location could be outdoors or indoors. The indoor location may be represented as a building, room, or similar organizational identifier. Outdoor locations can be walls, poles, or other mount places.¶
Network Inventory location model allows you to create physical locations, such as sites, building, equipment rooms, racks, and so on. The location information can be extended to the base network inventory, rack-mounted or not. The model can also include a physical address or geo-location data (geographic coordinates).¶
The model Network Inventory location conforms to the Network Management Datastore Architecture (NMDA).¶
The following terms are defined in [RFC7950] and are not redefined here:¶
The following terms are defined in [RFC6241] and are not redefined here:¶
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 "location" list is generalized to support abstract locations, such as sites, as well as concrete type of location, such as room, building.¶
A site represents a abstract geographic location to group a set of Network Elements (NEs) and corresponding inventory components. NEs, racks, equipment rooms, and buildings can be grouped within a site.¶
A room is a facility, a centralized space for network elements and other equipment (such as servers, storage) with power supply system, air conditioning system, etc.¶
Locations can be nested to form a hierarchy. For example, buildings can be within a site and rooms in a building.¶
The "location-type" is defined as a YANG identity to describe the type of the inventory location, which could be site, equipment room, or building.¶
+--rw location* [id]
| +--rw id yang:uri
| +--rw name? string
| +--rw description? string
| +--rw alias? string
| +--rw location-type? identityref
| +--rw parent -> ../../location/id
| +--rw child* -> ../../location/id
| +--rw physical-address
| | ...
| +--rw geo-location
| ...
...................................
"racks" represent physical equipment racks in which Network Elements (NEs) can be installed, which facilitate device maintenance. Through "rack-location", each rack can be assigned to a site or a specific location within the site, such as a equipment room.¶
Each rack is assigned a unique ID and a name. A rack could have some specific attributes, such as appearance-related attributes and electricity-related attributes. The height, depth and width are described by Figure 2 (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".¶
---------------- ---
/| /| |
/ | / | |
/ | / | |
----|-----------| | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | height
| | | | |
| | | | |
| | | | |
| | Door Q | | |
| | Q | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| /-----------|---- ---
| / | / /
| / | / depth
|/ | / /
----------------- ---
|______width____|
| |
The rack attributes include:¶
+--ro racks
+--ro rack* [id]
...................................
+--rw height? uint16
+--rw width? uint16
+--rw depth? uint16
+--rw max-voltage? uint16
+--rw max-allocated-power? uint16
...................................
Max-voltage: the maximum voltage supported by the rack.¶
The following tree diagram [RFC8340] provides an overview of the data model for "ietf-ni-location" module.¶
module: ietf-ni-location
+--rw locations
+--rw location* [id]
| +--rw id yang:uri
| +--rw name? string
| +--rw description? string
| +--rw alias? string
| +--rw location-type? identityref
| +--rw parent? -> ../../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 yang:uri
+--rw name? string
+--rw description? string
+--rw alias? string
+--rw rack-location
| +--rw location-ref? -> /locations/location/id
| +--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* [ne-ref component-ref]
+--rw ne-ref
| -> /nwi:network-elements/network-element/id
+--rw component-ref leafref
+--rw relative-position? uint8
augment /nwi:network-elements/nwi:network-element:
+--rw locations
+--rw location* -> /locations/location/id
+--rw rack? -> /locations/racks/rack/id
¶
The "ietf-ni-location" module uses types defined in [RFC9179], [I-D.ietf-ivy-network-inventory-yang].¶
<CODE BEGINS> file="ietf-ni-location@2024-02-07.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
"RFCXXXX: 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: <https://datatracker.ietf.org/wg/ivy>
WG List: <mailto:inventory-yang@ietf.org>
Editor: Bo Wu
<lana.wubo@huawei.com>
Editor: Sergio Belotti
<sergio.belotti@nokia.com>
Editor: Jean-Francois Bouquier
<jeff.bouquier@vodafone.com>
Editor: Fabio Peruzzini
<fabio.peruzzini@telecomitalia.it>
Editor: Phil Bedard
<phbedard@cisco.com>";
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-02-07 {
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
}
identity inventory-location-type {
description
"Base identity for network inventory location types.";
}
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.";
}
grouping locations-grouping {
description
"The grouping of the locations.";
list location {
key "id";
description
"The list of sites within the network.";
uses nwi:common-entity-attributes;
leaf location-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 parent locations.";
}
leaf-list child {
type leafref {
path "../../location/id";
}
description
"The name of the child locations.";
}
uses physical-address-grouping;
uses geo:geo-location;
}
}
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
"Address (number and street) of the site.";
}
leaf postal-code {
type string;
description
"Postal code of the site.";
}
leaf state {
type string;
description
"State of the site. This leaf can also be
used to describe a region for a country that
does not have states.";
}
leaf city {
type string;
description
"City of the site.";
}
leaf country-code {
type string {
pattern '[A-Z]{2}';
}
description
"Country of the site.
Expressed as ISO ALPHA-2 code.";
}
}
}
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 an 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 leafref {
path "/nil:locations/nil:location/nil:id";
}
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 "ne-ref component-ref";
description
"The list of chassis within a rack.";
leaf ne-ref {
type leafref {
path "/nwi:network-elements/nwi:network-element"
+ "/nwi:id";
}
description
"The reference to the network element containing
the chassis component.";
}
leaf component-ref {
type leafref {
path "/nwi:network-elements/nwi:network-element"
+ "[nwi:id=current()/../ne-ref]/nwi:components"
+ "/nwi:component/nwi:id";
}
description
"The reference to the chassis component within
the network element and contained by the rack.";
}
leaf relative-position {
type uint8;
description
"A relative position of chassis within
the rack";
}
}
}
}
}
grouping locations-ref-grouping {
description
"The attributes of the locations.";
container locations {
description
"The container for the location.";
leaf-list location {
type leafref {
path "/nil:locations/nil:location/nil:id";
}
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-elements/nwi:network-element" {
description
"Provides location information for network inventory.";
uses locations-ref-grouping;
}
}
<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-ni-location
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-ni-location
namespace: urn:ietf:params:xml:ns:yang:ietf-ni-location
prefix: nil
maintained by IANA: N
reference: RFC xxxx
¶
The authors of this document would like to thank the authors and contributors of [I-D.ietf-ccamp-network-inventory-yang] to trigger this work.¶
The following authors contributed significantly to this document:¶
Italo Busi Huawei Technologies Email: italo.busi@huawei.com Chaode Yu Huawei Technologies Email: yuchaode@huawei.com¶