Summary
Retrieves some health information for the device
Description
This method will retrieve the health information (memory, cpu utilization) of the device from Automation Gateway
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
deviceName |
string |
yes |
the name of a device |
Copied to Clipboard
{
"deviceName": "xr9kv-atl"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"deviceName": {
"title": "deviceName",
"$ref": "deviceData#/definitions/deviceName"
}
},
"required": [
"deviceName"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
object |
An object containing health information about the device |
Copied to Clipboard
{
"device": "some-device-name",
"memory": {
"memtotal_mb": 12345,
"memfree_mb": 12345
},
"cpu": [
"Some CPU data"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"device": {
"$id": "#/properties/response/items/properties/device",
"type": "string",
"title": "The Device Name",
"description": "The Device Name",
"examples": [
"some-device-name"
],
"pattern": "^(.*)$"
},
"memory": {
"$id": "#/properties/response/items/properties/memory",
"type": "object",
"title": "Memory information",
"description": "If available for the device, this will show the memory details for the device (used, free, etc)",
"properties": {
"memtotal_mb": {
"$id": "#/properties/response/items/properties/memory/properties/memtotal_mb",
"type": "integer",
"title": "Allocated memory",
"description": "Allocated memory",
"examples": [
12345
]
},
"memfree_mb": {
"$id": "#/properties/response/items/properties/memory/properties/memfree_mb",
"type": "integer",
"title": "Free Memory",
"description": "Free memory",
"examples": [
12345
]
}
}
},
"cpu": {
"$id": "#/properties/response/items/properties/cpu",
"type": "array",
"title": "CPU information",
"description": "CPU utilization information for the device",
"items": {
"$id": "#/properties/response/items/properties/cpu/items",
"type": "string",
"examples": [
"Some CPU data"
],
"pattern": "^(.*)$"
}
}
}
}