Summary
Send a gNOI reboot command.
Description
Send a reboot command over gRPC gNOI to a host and return the results.
Route
POST /automationgateway/gnoi/reboot/execute
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| delay |
number |
no |
- |
| force |
boolean |
no |
- |
| host |
string |
yes |
A host from the gRPC inventory |
| message |
string |
no |
Reboot message to send |
| method |
string |
yes |
COLD, POWERDOWN, HALT, WARM, NSF, reserved, POWERUP |
| subcomponents |
array |
no |
- |
Copied to Clipboard
{
"host": "xr9kv-atl",
"method": "POWERUP",
"delay": 0,
"force": true,
"message": "1",
"subcomponents": {
"origin": "openconfig-platform",
"elem": [
{
"name": "components"
},
{
"name": "component",
"key": {
"name": "0/RP0"
}
},
{
"name": "state"
}
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"delay": {
"title": "delay",
"type": "integer",
"examples": [
0
]
},
"force": {
"title": "force",
"type": "boolean",
"examples": [
true
]
},
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"message": {
"title": "message",
"type": "string",
"examples": [
"1"
]
},
"method": {
"title": "method",
"type": "string",
"examples": [
"POWERUP"
]
},
"subcomponents": {
"title": "subcomponents",
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"examples": [
{
"origin": "openconfig-platform",
"elem": [
{
"name": "components"
},
{
"name": "component",
"key": {
"name": "0/RP0"
}
},
{
"name": "state"
}
]
}
]
}
},
"required": [
"host",
"method"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
gNOI response object. |
Copied to Clipboard
{
"key": "status",
"status": "200"
}
