Business Critical Services(BCS) Operational Insights API

Inventory

The inventory API provides insights into your install-base. They are sub-divided into these resources:

  • /inventory/assets
  • /inventory/assets/:physicalAssetId
  • /inventory/devices
  • /inventory/devices/:deviceId

The Devices resource returns an overview of the physical or logical devices in your network. These are devices like a router, a switch, a firewall, etc. Each device has the unique identifier deviceId.

The Assets resource returns an overview of your devices, and the hardware assets inside of them. Each asset has a unique identifier physicalAssetId. The deviceId identifier points to the physical device the asset is related to.

NOTE: The identifiers deviceId and physicalAssetId will allow you to identify the exact device or asset in all other API outputs.

To quickly get an idea of how many assets or devices we analyze, you can send a HEAD request to both endpoints. This will return a count to you.

Devices

As explained above, the devices API resource provides detailed information about all the logical devices being collected.

Below you can find an example output:

json
Copy{
  "items": [
    {
      "collectorName": "mycollector",
      "configRegister": "2102",
      "configStatus": "Completed",
      "configTimestamp": "2022-02-02T15:33:37",
      "createdTimestamp": "2022-02-02T15:33:37",
      "deviceId": 22345640,
      "deviceIp": "172.21.1.1",
      "deviceName": "switch",
      "deviceStatus": "ACTIVE",
      "deviceType": "Unmanaged Chassis",
      "featureSetDescription": "",
      "imageName": "",
      "inventoryStatus": "Completed",
      "inventoryTimestamp": "2022-02-02T15:33:37",
      "ipAddress": "172.16.1.1",
      "isInSeedFile": true,
      "lastResetTimestamp": "2022-02-02T15:33:37",
      "productFamily": "Cisco Catalyst 3560-E Series Switches",
      "productId": "WS-C3560X-24P-E",
      "productType": "Metro Ethernet Switches",
      "resetReason": "",
      "snmpSysContact": "",
      "snmpSysDescription": "",
      "snmpSysLocation": "",
      "snmpSysName": "",
      "snmpSysObjectId": "",
      "softwareType": "IOS",
      "softwareVersion": "15.1(4)M4",
      "userField1": "",
      "userField2": "",
      "userField3": "",
      "userField4": ""
    },
    ...
  ]
}

You see a list of devices represented as JSON blobs. The above highlighted devices has deviceId 22345640, is a Cisco Catalyst 3560-E Series switch with PID WS-C3560X-24P-E, running IOS version 15.1(4)M4. Its management IP is 172.21.1.1 and can also be reached through IP 172.16.1.1. It has configregister 0x2102 and is being collected through mycollector.

Assets

As explained above, the assets API resource provides detailed information about all the assets being collected.

NOTE: A logical device is still an asset by itself! It differentiates itself in the output by physicalAssetType. If it is set to Chassis it is a logical device in which all other assets with the same deviceId sit.

Below is an example for the assets:

json
Copy{
  "items": [
    {
        "chassisName": "10.201.23.147",
        "deviceId": 24948009,
        "deviceName": "10.201.23.147",
        "hardwareRevision": "",
        "installedFlash": null,
        "installedMemory": null,
        "printedCircuitBoardName": "",
        "printedCircuitBoardRevision": "",
        "physicalAssetId": 477944695,
        "physicalAssetSubtype": "",
        "physicalAssetType": "Fan",
        "productFamily": "Catalyst 2K/3K Series Fans",
        "productId": "FAN-T1=",
        "productType": "Fans",
        "serialNumber": "",
        "serialNumberStatus": "N/A",
        "slot": "FAN1",
        "softwareVersion": "",
        "topAssemblyNumber": "",
        "topAssemblyNumberRevision": ""
    },
    ...
  ]
}

The above asset is a Fan of the type Catalyst 2K/3K Series Fans with PID FAN-T1=. It is located in slot FAN1 of device with deviceId 24948009. The parent device will be of type Chassis.

Next