Monitor Status
API call for monitoring the status of an action performed on a device:
Monitor Status
Display information about status of a device action.
URL: https://vmanage-ip-address/dataservice/device/action/status/processId
Method: GET
Request Parameters
| Name | Required | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| processId | Yes | Process identifier. To obtain the process ID, issue a POST call to initiate a device action. | Path | String |
Response Content Type: application/json
Response Object: See Response Object, below.
Response Object for Monitor Status API Calls
Monitor status API call responses have the following format:
{
"header": {
"generatedOn": "timestamp, milliseconds (in UNIX time format)",
"viewKeys": {
"uniqueKey": [
"key"
]
},
"columns": [
"column properties"
],
"fields": [
"properties and type"
]
},
"data": [
"array of objects"
],
"summary": [
"array of objects"
],
"isCancelEnabled": true,
"isParallelExecutionEnabled": true
}
Example Response
{
"header": {
"generatedOn": 1485391061302,
"viewKeys": {
"uniqueKey": [],
"preferenceKey": "grid-DeviceActionRebootResult"
},
"columns": [
{
"title": "Status",
"property": "status",
"display": "iconAndText",
"iconProperty": "statusId",
"icon": [
{
"key": "success",
"value": "images/action_success.png"
},
{
"key": "success_warning",
"value": "images/action_success_warning.png"
},
{
"key": "failure",
"value": "images/action_failure.png"
},
{
"key": "in_progress",
"value": "images/action_in_progress.png"
},
{
"key": "scheduled",
"value": "images/action_scheduled.png"
},
{
"key": "time_out",
"value": "images/action_timedout.png"
},
{
"key": "skipped",
"value": "images/action_skipped.png"
},
{
"key": "cancelled",
"value": "images/action_cancelled.png"
}
],
"dataType": "string"
},
{
"title": "Hostname",
"property": "host-name",
"display": "iconAndText",
"iconProperty": "device-type",
"hideable": false,
"icon": [
{
"key": "vmanage",
"value": "images/vmanage_table.png"
},
{
"key": "vedge",
"value": "images/vedge_table.png"
},
{
"key": "vedge-vbond",
"value": "images/vedge-vbond_table.png"
},
{
"key": "vsmart",
"value": "images/vsmart_table.png"
},
{
"key": "vbond",
"value": "images/vbond_table.png"
}
],
"dataType": "string"
},
{
"title": "System IP",
"property": "system-ip",
"sortProperty": "system-ip-int",
"dataType": "ipv4"
},
{
"title": "Site ID",
"property": "site-id",
"dataType": "number"
},
{
"title": "Device Type",
"property": "device-type",
"dataType": "string"
},
{
"title": "vManage IP",
"property": "vmanageIP",
"dataType": "ipv4"
}
],
"fields": [
{
"property": "status",
"dataType": "string",
"display": "iconAndText"
},
{
"property": "host-name",
"dataType": "string",
"display": "iconAndText"
},
{
"property": "system-ip",
"dataType": "ipv4"
},
{
"property": "site-id",
"dataType": "number"
},
{
"property": "device-type",
"dataType": "string"
},
{
"property": "vmanageIP",
"dataType": "ipv4"
}
]
},
"data": [
{
"statusType": "reboot",
"activity": [
"[25-Jan-2017 16:23:47 PST] Sending message to vmanage:172.16.255.22",
"[25-Jan-2017 16:23:47 PST] Published messages to vmanage/s",
"[25-Jan-2017 16:23:47 PST] Checks completed."
],
"vmanageIP": "172.16.255.22",
"system-ip": "Validation",
"deviceID": "Validation",
"statusId": "success",
"processId": "reboot-01252017T162347537",
"currentActivity": "Done - Validation",
"actionConfig": "{}",
"action": "reboot",
"startTime": 1485390227539,
"requestStatus": "received",
"status": "Success"
},
{
"statusType": "reboot",
"activity": [],
"vmanageIP": "172.16.255.22",
"system-ip": "172.16.255.21",
"host-name": "vm11",
"site-id": "100",
"deviceID": "172.16.255.21",
"statusId": "scheduled",
"processId": "reboot-01252017T162347537",
"currentActivity": "Reboot Scheduled",
"actionConfig": "{\"devices\":{\"deviceIP\":\"172.16.255.21\",\"deviceId\":\"56de6bad-344a-4f93-9f65-c5273344585f\"}}",
"device-type": "vedge",
"action": "reboot",
"startTime": 1485390227579,
"deviceModel": "vedge-cloud",
"requestStatus": "received",
"status": "Scheduled"
},
{
"statusType": "reboot",
"activity": [],
"vmanageIP": "172.16.255.22",
"system-ip": "172.16.255.15",
"host-name": "vm5",
"site-id": "500",
"deviceID": "172.16.255.15",
"statusId": "scheduled",
"processId": "reboot-01252017T162347537",
"currentActivity": "Reboot Scheduled",
"actionConfig": "{\"devices\":{\"deviceIP\":\"172.16.255.15\",\"deviceId\":\"7dec0b5e-c023-4b7a-bff1-c58059d06eb6\"}}",
"device-type": "vedge",
"action": "reboot",
"startTime": 1485390227582,
"deviceModel": "vedge-cloud",
"requestStatus": "received",
"status": "Scheduled"
}
],
"summary": {
"action": "reboot",
"name": "Reboot",
"detailsURL": "/dataservice/device/action/status",
"total": 3,
"status": "in_progress",
"count": {
"Scheduled": 2,
"Success": 1
}
},
"isCancelEnabled": true,
"isParallelExecutionEnabled": true
}
Additional Information
Activate Software
Upgrade Software
Using the vManage REST API