Hardware
API calls for real-time monitoring of hardware information:
- Alarms
- Alarms from vManage NMS
- Environment
- Environment from vManage NMS
- Inventory
- Inventory from vManage NMS
- Threshold
Alarms
Display information about currently active hardware alarms (on vEdge routers only).
CLI Equivalent: show hardware alarms
URL: https://vmanage-ip-address/dataservice/hardware/alarms?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Alarms from vManage NMS
Display information about currently active hardware alarms (from vManage NMS only).
CLI Equivalent: show hardware alarms
URL: https://vmanage-ip-address/dataservice/hardware/synced/alarms?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Environment
Display status information about the router components, including component temperature (on vEdge routers only).
CLI Equivalent: show hardware environment
URL: https://vmanage-ip-address/dataservice/hardware/environment?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Environment from vManage NMS
Display status information about the router components, including component temperature (from vManage NMS only).
CLI Equivalent: show hardware environment
URL: https://vmanage-ip-address/dataservice/hardware/synced/environment?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Inventory
Display an inventory of the hardware components in the router, including serial numbers (from vManage NMS only).
CLI Equivalent: show hardware inventory
URL: https://vmanage-ip-address/dataservice/hardware/synced/inventory?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Inventory from vManage NMS
Display an inventory of the hardware components in the router, including serial numbers (from vManage NMS only).
CLI Equivalent: show hardware inventory
URL: https://vmanage-ip-address/dataservice/hardware/synced/inventory?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Threshold
Display temperature thresholds at which green, yellow, and red alarms are generated (on vEdge routers only).
CLI Equivalent: show hardware temperature-thresholds
URL: https://vmanage-ip-address/dataservice/hardware/threshold?deviceId=deviceId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| deviceId | Yes | IP address of device | Query | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Response Object for Real-Time Monitoring API Calls
Real-time monitoring API call responses have the following format:
{
"header": {
"generatedOn": timestamp, milliseconds (UNIX time format),
"viewKeys": {
"uniqueKey": ["key"]
},
"fields": [
properties and types
],
},
"data": [
array of objects
]
}