Summary
Add a device group to Automation Gateway
Description
This method will add a device group to Automation Gateway
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| group |
string |
yes |
the name of a device group |
| devices |
array |
yes |
array of devices in the device group |
| groupVars |
object |
yes |
the information for the device group |
Copied to Clipboard
{
"group": "voluptate",
"devices": [
{
"name": "xr9kv01-aws",
"device-type": "cli",
"ipaddress": "10.1.6.100",
"port": "22",
"ostype": "cisco-ios-xr",
"host": "nso46",
"actions": [
"applyTemplate",
"checkSync"
],
"authgroup": "xr9kv-aws",
"address": "10.1.6.100",
"ned": "cisco-ios-xr",
"admin": false,
"origins": [
"nso46"
]
},
{
"name": "xr9kv01-aws",
"device-type": "cli",
"ipaddress": "10.1.6.100",
"port": "22",
"ostype": "cisco-ios-xr",
"host": "nso46",
"actions": [
"runCommand",
"removeDeviceFromGroup",
"applyTemplates"
],
"authgroup": "xr9kv-aws",
"address": "10.1.6.100",
"ned": "cisco-ios-xr",
"admin": true,
"origins": [
"nso46",
"nso46",
"nso46",
"nso46",
"nso46"
]
},
{
"name": "xr9kv01-aws",
"device-type": "cli",
"ipaddress": "10.1.6.100",
"port": "22",
"ostype": "cisco-ios-xr",
"host": "nso46",
"actions": [
"runCommand",
"restoreDevice",
"verifyConfig"
],
"authgroup": "xr9kv-aws",
"address": "10.1.6.100",
"ned": "cisco-ios-xr",
"admin": true,
"origins": [
"nso46",
"nso46",
"nso46"
]
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"group": {
"type": "string"
},
"devices": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/deviceDetails"
}
},
"groupVars": {
"type": "object",
"title": "groupVars"
}
},
"required": [
"group",
"devices",
"groupVars"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
the device group that was created |
Copied to Clipboard
{
"type": "object"
}
