openBackhaul / MicroWaveDeviceInventory

Physical and logical inventory of the MW SDN Domain
Apache License 2.0
5 stars 1 forks source link

MicroWaveDeviceInventory

Location

The MicroWaveDeviceInventory is part of the HighPerformanceNetworkInterface.

Description

The MicroWaveDeviceInventory supports GETting device information and documenting connection information.
The GET requests to the MicroWaveDeviceInventory can either be addressed to the

The purpose of the /cache/ paths of the MWDI is to shorten the response time and to minimize the number and size of accesses to the devices.
The /live/ paths of the MWDI serve as a gateway that restricts GET requests to the devices to approved applications and pre-defined classes.

The API of the MWDI is made in such a way that consuming applications could easily switch between /cache/ or /live/ paths.

The cache of the MicroWaveDeviceInventory covers Capability, Configuration, Status, Historical Performance and Alarm information.
Also internal (ForewardingDamain and ForewardingConstruct) and external (Link) connection information can be read from the cache.

Current counter readings (e.g. current dropped frames count) are provided via the /live/ paths of the MWDI only.

No matter which path chosen, the information provided by the MicroWaveDeviceInventory is limited to devices that are currently connected to the controller.

The MicroWaveDeviceInventory is updating its cache by retrieving the entire data tree from the devices at a configurable periode and continuously updating individual attributes based on value change notifications and requests to the /live/ paths in between.

The MWDI supports directly addressing entire classes only.
Individual attributes or combinations of attributes are indirectly addressed by using the fields filter.
The RESTCONF interface of the controller could process the same requests, too.

The MWDI offers subscribing for ONF-TR-532-like notifications (webhook based method) that relate to the content of its cache.

Latest Update

The v1.1.0 release represents a major step from MicroWaveDeviceInventory to MicroWaveNetworkInventory.
Paths for documenting external connections (Link) and reading internal (ForewardingDamain and ForewardingConstruct) and external connections (Link) have been added.
It sets the stage for the v0.0.5 release of the AirInterfacePowerSaver.

Relevance

The MicroWaveDeviceInventory holds the inventory of the live MW network at Telefonica Germany.
As such, it is more close to be a component of the controller than of the application layer.
It is a precondition for most applications.

Resources

Comments

This application has been specified during training for ApplicationOwners.