Summary
Assign device to authgroup
Description
Assign a device to an authgroup in NSO
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| device |
string |
yes |
Device name |
| group |
string |
yes |
Authgroup name |
Copied to Clipboard
{
"device": "device1",
"group": "authGroup2"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"device": {
"title": "device",
"type": "string",
"examples": [
"device1",
"device2",
"device3"
]
},
"group": {
"title": "group",
"type": "string",
"examples": [
"authGroup1",
"authGroup2",
"authGroup3"
]
}
},
"required": [
"device",
"group"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Result of adding device to authgroup. |
Copied to Clipboard
{
"code": 0,
"value": {
"result": "failure"
}
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code",
"examples": [
0
]
},
"value": {
"type": "object",
"description": "Contains result",
"properties": {
"result": {
"type": "string",
"description": "Return result",
"examples": [
"success",
"failure"
]
}
},
"required": [
"result"
]
}
},
"required": [
"code",
"value"
]
}
