Monitoring Operations for Device Adapters
Introduction
When an instance of a device is instantiated in the BAA layer, the device uses a Vendor Device Adapter (VDA) and is required to be associated with a Standard Device Adapter (SDA) for that type of device (e.g., OLT, DPU).
To assist in maintaining the Device Adapters in the BAA layer, this section describes commands that can assist in monitoring the library of the Device Adapters, including finding out:
-
What Device Adapters exist and their corresponding attributes of the Device Adapter
-
How well a Device Adapter conforms to the standard YANG modules for the device
-
What YANG modules are associated with a Device Adapter
-
What YANG modules used by a device
Looking up Information Associated with Device Adapters
This command provides the capability to lookup the information about the Device Adapters (i.e., SDA, VDA) that have been deployed into the BAA layer.
Request to lookup information about Device Adapters
<?xml version="1.0" encoding="UTF-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1543910289808">
<get>
<filter type="subtree">
<network-manager xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapters/>
</network-manager>
</filter>
</get>
</rpc>
Response for Device Adapter lookup
<rpc-reply message-id="1543910289808" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<baa-network-manager:network-manager xmlns:baa-network-manager="urn:bbf:yang:obbaa:network-manager">
<device-adapters xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapter-count>3</device-adapter-count>
<device-adapter>
<type>DPU</type>
<interface-version>1.0</interface-version>
<model>standard</model>
<vendor>BBF</vendor>
<description>This is an adapter for standard.DPU provided by BBF</description>
<developer>BBF</developer>
<revision>2019-01-01T00:00:00Z</revision>
<upload-date>2019-01-31T12:20:52.433Z</upload-date>
<in-use>false</in-use>
<yang-modules>
<module>
<name>bbf-availability</name>
<revision>2018-07-13</revision>
</module>
<module>
<name>bbf-dot1q-types</name>
<revision>2018-07-13</revision>
</module>
<module>
<name>bbf-fast</name>
<revision>2018-10-01</revision>
</module>
<module>
<name>bbf-fastdsl</name>
<revision>2018-10-01</revision>
</module>
...........
</yang-modules>
</device-adapter>
</device-adapters>
</baa-network-manager:network-manager>
</data>
</rpc-reply>
Determine the Conformance of a Device Adapter to the Standardized Data Model:
Overview:
This Factory Garment tag is calculated based on the YANG modules that are being used in the adapters (standard vs vendor). It provides an overview of vendor adapter model alignment with respect to Standard adapters bundled in OB-BAA.
Description:
Factory Garment Tags for a vendor adapter is calculated by comparing the YANG modules available in standard adapters and YANG modules that are used in the vendor specific adapters. For each vendor adapter it provides metrics about the model alignment with the standard model set.
Precondition:
Vendor specific device adapters should be loaded/deployed to the BAA system.
Factory Garment Tag Parameters
The parameters of the Factory Garment Tags are defined below:
| S.no | Parameter | Description | Remarks |
|---|---|---|---|
| 1 | number-of-modules-present-in-standard-adapter | Number of modules present in the corresponding standard adapter | This shall be calculated by counting the total number of YANG modules present in the corresponding standard adapter |
| 2 | total-number-of-modules-present | Total number of modules present in the vendor adapter | This shall be calculated by counting the total number of YANG modules present in the vendor adapter |
| 3 | percentage-adherence-to-standard-module | Percentage of standard modules that are being re-used in the vendor adapter | Percentage of standard modules being reused in vendor adapter (i.e., ((number-of-reused-standard-modules *100)/total-number-of-standard-modules)) |
| 4 | deviated-standard-module | List of deviated standard modules | Standard modules that are having deviations added in vendor adapter |
| 5 | percentage-of-standard-modules-having-deviation | Percentage of standard modules that are deviated | Percentage of reused standard modules that are having deviations added in vendor adapter (i.e., ((number-of-deviated-standard-modules *100)/number-of-reused-standard-module)) |
| 6 | augmented-standard-module | List of augmented standard modules | Standard modules that are having augmentations added in vendor adapter |
| 7 | percentage-of-standard-modules-having-augments | Percentage of standard modules that are augmentation | Percentage of standard modules that are being referred in augments added in vendor adapter (i.e., ((number-of-augmented-standard-modules *100)/number-of-reused-standard-module)) |
Example of a Get Device Adapters Request:
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1548128755928">
<get>
<filter type="subtree">
<network-manager xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapters>
<device-adapter-count />
<device-adapter>
<factory-garment-tag />
<type />
<interface-version />
<model />
<vendor />
<is-netconf/>
<description />
<upload-date />
<developer />
<revision/>
<push-pma-configuration-to-device />
<in-use />
<devices-related />
</device-adapter>
</device-adapters>
</network-manager>
</filter>
</get>
</rpc>
Response for Get Adapters Request when the Factory Garment environment value is True:
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1548128755928">
<data>
<baa-network-manager:network-manager xmlns:baa-network-manager="urn:bbf:yang:obbaa:network-manager">
<device-adapters xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapter>
<type>DPU</type>
<interface-version>1.0</interface-version>
<model>standard</model>
<vendor>BBF</vendor>
<is-netconf>true</is-netconf>
<description>This is an adapter for standard.DPU provided by BBF</description>
<upload-date>2020-02-11T09:14:22.392Z</upload-date>
<developer>BBF</developer>
<revision>2020-01-17</revision>
<in-use>false</in-use>
</device-adapter>
<device-adapter>
<type>OLT</type>
<interface-version>1.0</interface-version>
<model>standard</model>
<vendor>BBF</vendor>
<is-netconf>true</is-netconf>
<description>This is an adapter for standard.OLT provided by BBF</description>
<upload-date>2020-02-11T09:14:24.857Z</upload-date>
<developer>BBF</developer>
<revision>2020-01-17</revision>
<in-use>false</in-use>
</device-adapter>
<device-adapter>
<type>DPU</type>
<interface-version>1.0</interface-version>
<model>modeltls</model>
<vendor>sample</vendor>
<factory-garment-tag>
<number-of-modules-present-in-standard-adapter>70</number-of-modules-present-in-standard-adapter>
<total-number-of-modules-present>60</total-number-of-modules-present>
<percentage-adherence-to-standard-module>31%</percentage-adherence-to-standard-module>
<deviated-standard-module>bbf-fast</deviated-standard-module>
<percentage-of-standard-modules-having-deviation>4%</percentage-of-standard-modules-having-deviation>
<augmented-standard-module>ietf-netconf-acm</augmented-standard-module>
<augmented-standard-module>bbf-l2-forwarding</augmented-standard-module>
<augmented-standard-module>ietf-netconf</augmented-standard-module>
<augmented-standard-module>ietf-interfaces</augmented-standard-module>
<augmented-standard-module>ietf-system</augmented-standard-module>
<percentage-of-standard-modules-having-augments>7%</percentage-of-standard-modules-having-augments>
</factory-garment-tag>
<is-netconf>true</is-netconf>
<description>This is an adapter for modeltls.DPU provided by sample</description>
<upload-date>2020-02-12T11:47:40.513Z</upload-date>
<developer>Sample developer for Model translation</developer>
<revision>2019-01-01</revision>
<in-use>false</in-use>
</device-adapter>
<device-adapter-count>3</device-adapter-count>
</device-adapters>
</baa-network-manager:network-manager>
</data>
</rpc-reply>
Response for Get Adapters Request when the Factory Garment environment value is False:
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1548128755928">
<data>
<baa-network-manager:network-manager xmlns:baa-network-manager="urn:bbf:yang:obbaa:network-manager">
<device-adapters xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapter>
<type>DPU</type>
<interface-version>1.0</interface-version>
<model>standard</model>
<vendor>BBF</vendor>
<is-netconf>true</is-netconf>
<description>This is an adapter for standard.DPU provided by BBF</description>
<upload-date>2020-02-11T09:14:22.392Z</upload-date>
<developer>BBF</developer>
<revision>2020-01-17</revision>
<in-use>false</in-use>
</device-adapter>
<device-adapter>
<type>OLT</type>
<interface-version>1.0</interface-version>
<model>standard</model>
<vendor>BBF</vendor>
<is-netconf>true</is-netconf>
<description>This is an adapter for standard.OLT provided by BBF</description>
<upload-date>2020-02-11T09:14:24.857Z</upload-date>
<developer>BBF</developer>
<revision>2020-01-17</revision>
<in-use>false</in-use>
</device-adapter>
<device-adapter>
<type>DPU</type>
<interface-version>1.0</interface-version>
<model>modeltls</model>
<vendor>sample</vendor>
<is-netconf>true</is-netconf>
<description>This is an adapter for modeltls.DPU provided by sample</description>
<upload-date>2020-02-12T11:47:40.513Z</upload-date>
<developer>Sample developer for Model translation</developer>
<revision>2019-01-01</revision>
<in-use>false</in-use>
</device-adapter>
<device-adapter-count>3</device-adapter-count>
</device-adapters>
</baa-network-manager:network-manager>
</data>
</rpc-reply>
Info: In a vendor adapter, if no modules for the corresponding standard YNG modules are reused, the percentage-of-standard-modules-having-deviation and percentage-of-standard-modules-having-augments will become "Not Applicable" as the number of reused modules are "0" (zero) in this case.
Monitoring Device Adapter
When monitoring a Device Adapter, there are several questions that are typically asked about the Device Adapter:
-
Is the Device Adapter in use and what devices are currently using the Device Adapter?
-
What YANG modules use which Device Adapter and which devices currently use that Device Adapter?
-
What devices use which YANG modules?
Retrieving Information About the Device Adapter's Use
For deployed Device Adapters, the BAA layer provides the capability to check:
-
If a Device Adapter currently has devices that use the Device Adapter. If at least one device is using the Device Adapter, then the Device Adapter is considered to be in use.
-
What devices (pANs) are currently associated with a Device Adapter
Retrieve information about the Device Adapter’s use
<?xml version="1.0" encoding="UTF-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1548128755928">
<get>
<filter type="subtree">
<network-manager xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapters>
<device-adapter-count />
<device-adapter>
<type />
<interface-version />
<model />
<vendor />
<description />
<upload-date />
<developer />
<revision/>
<push-pma-configuration-to-device />
<in-use />
<devices-related />
</device-adapter>
</device-adapters>
</network-manager>
</filter>
</get>
</rpc>
Response to Device Adapter use
<rpc-reply message-id="1548128755928" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<baa-network-manager:network-manager xmlns:baa-network-manager="urn:bbf:yang:obbaa:network-manager">
<device-adapters xmlns="urn:bbf:yang:obbaa:network-manager">
<device-adapter>
<type>OLT</type>
<interface-version>1.0</interface-version>
<model>standard</model>
<vendor>BBF</vendor>
<description>This is an adapter for standard.OLT provided by BBF</description>
<upload-date>2019-01-31T12:20:55.193Z</upload-date>
<developer>BBF</developer>
<revision>2019-01-01T00:00:00Z</revision>
<in-use>true</in-use>
<devices-related>
<device-count>1</device-count>
<device>deviceA</device>
</devices-related>
</device-adapter>
</baa-network-manager:network-manager>
</data>
</rpc-reply>
Retrieving Information About a YANG module's Use
In the operation of the BAA layer, YANG modules are used by many devices in the context of an Device Adapter.
This command retrieves the following information about YANG modules;
-
If the YANG module is currently in use by at least 1 device instance
-
What Device Adapter is associated with the YANG module along with the devices that use the Device Adapter
Retrieving information about the YANG module’s use
<?xml version="1.0" encoding="UTF-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1542612595090">
<get>
<filter type="subtree">
<in-use-library-modules xmlns="urn:bbf:yang:obbaa:module-library-check" />
</filter>
</get>
</rpc>
Response to retrieve YANG module information
<rpc-reply message-id="1542612595090" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<in-use-library-modules xmlns="urn:bbf:yang:obbaa:module-library-check">
<module>
<name>iana-hardware</name>
<revision>2018-03-13</revision>
<associated-adapters>
<device-adapter>
<vendor>BBF</vendor>
<model>standard</model>
<type>OLT</type>
<interface-version>1.0</interface-version>
<device-count>1</device-count>
<devices>
<device>deviceA</device>
</devices>
</device-adapter>
</associated-adapters>
</module>
<module>
<name>ietf-hardware</name>
<revision>2017-03-07</revision>
<associated-adapters>
<device-adapter>
<vendor>BBF</vendor>
<model>standard</model>
<type>OLT</type>
<interface-version>1.0</interface-version>
<device-count>1</device-count>
<devices>
<device>deviceA</device>
</devices>
</device-adapter>
</associated-adapters>
</module>
</in-use-library-modules>
</data>
</rpc-reply>
Retrieve YANG module information for a specific module
<?xml version="1.0" encoding="UTF-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1543477791934">
<get>
<filter type="subtree">
<in-use-library-modules xmlns="urn:bbf:yang:obbaa:module-library-check">
<module>
<name>iana-hardware</name>
<revision>2018-03-13</revision>
</module>
</in-use-library-modules>
</filter>
</get>
</rpc>
Response for retrieving YANG module information for a specific module
<rpc-reply message-id="1543477791934" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<in-use-library-modules xmlns="urn:bbf:yang:obbaa:module-library-check">
<module>
<name>iana-hardware</name>
<revision>2018-03-13</revision>
<associated-adapters>
<device-adapter>
<vendor>BBF</vendor>
<model>standard</model>
<type>OLT</type>
<interface-version>1.0</interface-version>
<device-count>1</device-count>
<devices>
<device>deviceA</device>
</devices>
</device-adapter>
</associated-adapters>
</module>
</in-use-library-modules>
</data>
</rpc-reply>
Retrieving Information About the Device's Use
In the BAA layer, a device instance uses many different YANG modules in the context of a Device Adapter.
This command retrieves information about the device's use with the BAA layer of:
-
The Device Adapter associated with the device instance
-
The YANG modules used by the device instance
Retrieving information about the Device's use
<?xml version="1.0" encoding="UTF-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1527307907169">
<get xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<filter type="subtree">
<network-manager xmlns="urn:bbf:yang:obbaa:network-manager">
<managed-devices>
<device>
<name>deviceA</name>
<root>
<device-used-yang-modules xmlns="urn:bbf:yang:obbaa:module-library-check" />
</root>
</device>
</managed-devices>
</network-manager>
</filter>
</get>
</rpc>
Response to retrieve of device information
<rpc-reply message-id="1527307907169" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<managed-devices xmlns="urn:bbf:yang:obbaa:network-manager">
<device>
<name>deviceA</name>
<root>
<device-library-modules xmlns="urn:bbf:yang:obbaa:module-library-check">
<related-adapter>
<vendor>BBF</vendor>
<model>standard</model>
<type>OLT</type>
<interface-version>1.0</interface-version>
</related-adapter>
<in-use-library-modules>
<module>
<name>iana-hardware</name>
<revision>2018-03-13</revision>
</module>
<module>
<name>ietf-hardware</name>
<revision>2017-03-07</revision>
</module>
</in-use-library-modules>
</device-library-modules>
</root>
</device>
</managed-devices>
</data>
</rpc-reply>