Summary
Send a gNOI Wake-on-LAN command.
Description
Send a Wake-on-LAN command over gRPC gNOI.
Route
POST /automationgateway/gnoi/wake_on_lan/execute
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| address |
string |
yes |
IP address |
| host |
string |
yes |
A host from the gRPC inventory |
| interface |
string |
yes |
Host interface |
| mac_address |
string |
yes |
- |
Copied to Clipboard
{
"address": "10.0.0.1",
"host": "xr9kv-atl",
"interface": "openconfig-interfaces",
"mac_address": "172.17.0.2"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"address": {
"title": "address",
"type": "string",
"examples": [
"10.0.0.1"
]
},
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"interface": {
"title": "interface",
"type": "string",
"examples": [
"openconfig-interfaces"
]
},
"mac_address": {
"title": "mac_address",
"type": "string",
"examples": [
"172.17.0.2"
]
}
},
"required": [
"address",
"host",
"interface",
"mac_address"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
gNOI response object. |
Copied to Clipboard
{
"key": "status",
"status": "200"
}
