Business Critical Services(BCS) Operational Insights API

Device Reset

This API resource provides insights into device crashes and resets. It is sub-divided into these endpoints:

  • /deviceReset/lastResetDetails
  • /deviceReset/lastResetDetails/:productId
  • /deviceReset/resetCount
  • /deviceReset/resetHistory
  • /deviceReset/resetHistory/:productId

Last Reset Details

The lastResetDetails endpoint returns a list of JSON objects showing which devices have crashed. The reason of the crash is given as well as several extra attributes extra that can be used to quickly learn more details about the crashed device.

Here is an example:

json
Copy{
    "deviceId": 4761645,
    "deviceIp": "10.39.236.65",
    "deviceName": "BHPCLPAGSW01",
    "inventoryTimestamp": "2021-12-02T17:20:09",
    "lastResetTimestamp": "2021-09-27T21:57:27",
    "productFamily": "Cisco Catalyst 3850 Series Switches",
    "productId": "WS-C3850-24P-S",
    "resetReason": "Power Failure or Unknown",
    "resetType": "reload",
    "softwareType": "IOS-XE",
    "softwareVersion": "16.6.4a"
},
...

The device with ID 4761645, running IOS-XE version 16.6.4a was last reset at 2021-09-27T21:57:27. The reason for the reset was Power Failure or Unknown. The resetType was found to be reload. It can also be crash which indicates an abnormal reset due to a software defect.

Reset Count

The resetCount endpoint is a simple one. It returns an aggregate overview of the number of resets and crashes.

Here is an example:

json
Copy{
    "devicesCrashCount": 4,
    "devicesReloadCount": 0
}

NOTE: This endpoint does NOT tell which devices have crashed or reset. In order to learn which devices these crashes belong to you have to query the lastResetDetails endpoint. A filter can always be applied. For example, {"resetType":"crash"}.

Reset History

The resetHistory endpoint is similar to the lastResetDetails endpoint, except that it returns all the resets known for each device as a list of resets.

Here is an example:

json
Copy{
    "deviceId": 5091900,
    "deviceIp": "10.80.77.254",
    "deviceName": "MY-KUL-SPP-L35-RTR01",
    "productFamily": "Cisco 4000 Series Integrated Services Routers",
    "productId": "ISR4431/K9",
    "resetDetails": [
        {
            "resetTimestamp": "2021-08-21T10:58:44",
            "resetReason": "Critical software exception, check bootflash:crashinfo_RP_00_00_20210821-085029-UTC",
            "resetType": "crash",
            "softwareType": "IOS-XE",
            "softwareVersion": "16.8.3"
        },
        {
            "resetTimestamp": "2021-11-29T09:38:08",
            "resetReason": "Critical software exception, check bootflash:crashinfo_RP_00_00_20211129-083227-UTC",
            "resetType": "crash",
            "softwareType": "IOS-XE",
            "softwareVersion": "16.8.3"
        }
    ]
}

The device with ID 5091900 is an ISR4431 router. There are two resets recorded for it of the type crash. Both occurred while the device was on IOS-XE version 16.8.3 and indicate a Critical software exception.

Next