Summary
Turn Up a New Device
Description
Turn up a new device mainly used for tasking purposes
Route
POST /device_management/turn_up
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
Device name |
| host |
string |
yes |
Host's name |
| address |
string |
yes |
Address |
| port |
string |
yes |
Port |
| authgroup |
string |
yes |
Authentication group |
| protocol |
string |
yes |
Protocol |
| ned |
string |
yes |
Network Element Driver |
| device-type |
string |
yes |
Device type |
| tenant |
string |
yes |
Tenant |
Copied to Clipboard
{
"name": "a10-acos-1",
"host": "Local Host",
"address": "3000",
"port": "42",
"authgroup": "default",
"protocol": "protocol1",
"ned": "nso46",
"device-type": "type1",
"tenant": "tenant1"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"$ref": "deviceManagerDoc#/definitions/deviceName"
},
"host": {
"title": "host",
"$ref": "deviceManagerDoc#/definitions/host"
},
"address": {
"title": "address",
"type": "string",
"examples": [
"3000"
]
},
"port": {
"title": "port",
"type": "string",
"examples": [
"42"
]
},
"authgroup": {
"title": "authgroup",
"$ref": "deviceManagerDoc#/definitions/authgroup"
},
"protocol": {
"title": "protocol",
"type": "string",
"examples": [
"protocol1"
]
},
"ned": {
"title": "ned",
"$ref": "deviceManagerDoc#/definitions/ned"
},
"device-type": {
"title": "device-type",
"type": "string",
"examples": [
"type1"
]
},
"tenant": {
"title": "tenant",
"type": "string",
"examples": [
"tenant1"
]
}
},
"required": [
"name",
"host",
"address",
"port",
"authgroup",
"protocol",
"ned",
"device-type",
"tenant"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Result of turning up a new device |
Copied to Clipboard
{
"value": "success"
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"value": {
"type": "string",
"examples": [
"success"
]
}
}
}
