Summary
Update a device in Automation Gateway
Description
This method will update a device in Automation Gateway.
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| deviceName |
string |
yes |
the name of a device |
| deviceVars |
object |
yes |
the information for the device |
Copied to Clipboard
{
"deviceName": "xr9kv-atl",
"deviceVars": {
"ostype": "ios",
"device-type": "network_cli",
"user": "username",
"password": "password!",
"ipaddress": "csr.devices.io"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"deviceName": {
"title": "deviceName",
"$ref": "deviceData#/definitions/deviceName"
},
"deviceVars": {
"type": "object",
"title": "deviceVars",
"properties": {},
"examples": [
{
"ostype": "ios",
"device-type": "network_cli",
"user": "username",
"password": "password!",
"ipaddress": "csr.devices.io"
}
]
}
},
"required": [
"deviceName",
"deviceVars"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
the status of the update |
Copied to Clipboard
{
"response": true
}
Copied to Clipboard
{
"type": "object",
"properties": {
"response": {
"type": "boolean"
}
}
}
