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": "id",
"host": "do",
"address": "in nostrud",
"port": "Lorem Duis non adipisicing",
"authgroup": "dolore ut quis",
"protocol": "deserunt sunt fugiat in",
"ned": "enim elit cillum",
"device-type": "tempor sunt laboris",
"tenant": "qui exercitation laboris adipisicing"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"description": "Device name",
"type": "string"
},
"host": {
"description": "Host's name",
"type": "string"
},
"address": {
"description": "Address",
"type": "string"
},
"port": {
"description": "Port",
"type": "string"
},
"authgroup": {
"description": "Authentication group",
"type": "string"
},
"protocol": {
"description": "Protocol",
"type": "string"
},
"ned": {
"description": "Network Element Driver",
"type": "string"
},
"device-type": {
"description": "Device type",
"type": "string"
},
"tenant": {
"description": "Tenant",
"type": "string"
}
},
"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
{
"result": true
}
Copied to Clipboard
{
"description": "Result of turning up a new device",
"type": "object",
"properties": {
"result": true
},
"required": [
"result"
],
"additionalProperties": false
}
