Summary
Set configuration on a device
Description
This method will set the configuration on a device based on the configuration line(s) provided
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| deviceName |
string |
yes |
the name of a device |
| changes |
array |
yes |
an array of configuration lines to change on the device |
Copied to Clipboard
{
"deviceName": "xr9kv-atl",
"changes": [
{
"parents": [
"groups",
"global"
],
"new": "hostname something-new"
},
{
"parents": [
"system"
],
"new": "hostname something-new"
},
{
"parents": [
"system",
"global",
"groups",
"global"
],
"old": "hostname something-old",
"new": "hostname something-new"
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"deviceName": {
"title": "deviceName",
"$ref": "deviceData#/definitions/deviceName"
},
"changes": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"parents": {
"type": "array",
"items": {
"type": "string",
"examples": [
"groups",
"global",
"system"
]
}
},
"old": {
"type": "string",
"description": "Required if you're deleting a config. Required with the 'new' property if you're making an update",
"examples": [
"hostname something-old"
]
},
"new": {
"type": "string",
"description": "Required if you're adding a brand new config. Required with the 'old' property if you're making an update",
"examples": [
"hostname something-new"
]
}
},
"oneOf": [
{
"required": [
"parents",
"new"
],
"not": {
"required": [
"old"
]
}
},
{
"required": [
"parents",
"old",
"new"
]
},
{
"required": [
"parents",
"old"
],
"not": {
"required": [
"new"
]
}
}
]
}
}
},
"required": [
"deviceName",
"changes"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
An object containing an array of the status of all the changes that were requested |
Copied to Clipboard
{
"response": []
}
Copied to Clipboard
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
