Extracting topology data for all chassis devices that belong to a set of classes

Edit online

You can use the Topology API to extract topology data from the NCIM topology database for all chassis devices that belong to a specified set of classes, or that do not belong to a specified set of classes.

Syntax

Specify the following parameters within a REST client in order to extract topology data for all chassis devices that do or do not belong to a specified set of classes.
Table 1. Parameters to extract topology data for all chassis devices that do or do not belong to a specified set of classes
Parameter Value
Method GET
URL 
https://HOST:PORT/ROOT-CONTEXT/nm_rest/topology/devices/classes?classes=CLASSNAME1,CLASSNAME2&include=true|false&includeSubChassis=true|false
Where:
  • HOST is the hostname or IP address of the Dashboard Application Services Hub server.
  • PORT is the secure port number of the Dashboard Application Services Hub server. By default, this is 16311.
  • ROOT-CONTEXT is the path from the root of your file system to the Topology API.
  • classes is a comma-separated list of class names. See Retrieving class data for information about retrieving class data by using the Topology API.
  • include is an optional parameter. It can be set to true, in which case data is extracted for devices that belong to the specified classes, or false, in which case data is extracted for all devices except those that belong to the specified classes. The default is true.
  • includeSubChassis is an optional Boolean parameter. If this parameter is set to true, the results of the call include sub-chassis. If this parameter is set to false, the results of this call exclude sub-chassis. The default is true. For the purposes of this feature, a sub-chassis is defined as a device that exists in ncim.chassis, where its entityId in ncim.entityData is not equal to its mainNodeEntityId, and its className in ncim.chassis is equal to the className of the row for its mainNodeEntityId.
For example:
https://myHost.com:16311/ibm/console/nm_rest/topology/devices/classes?classes=Router,Linux&includeSubChassis=true
Content Type application/json