System
API calls for real-time monitoring of a device:
Status
Display time and process information for the device, as well as CPU, memory, and disk usage data.
CLI Equivalent: show system status
URL: https://vmanage-ip-address/dataservice/device/system/status?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.
Status from vManage NMS
Display time and process information for the device, as well as CPU, memory, and disk usage data (from vManage NMS only).
CLI Equivalent: show system status
URL: https://vmanage-ip-address/dataservice/device/system/synced/status?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 ] }