Summary
Send a gNOI ping command.
Description
Send a ping command over gRPC gNOI to a host and return the results.
Route
POST /automationgateway/gnoi/ping/execute
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| count |
number |
yes |
- |
| destination |
string |
yes |
IP address |
| do_not_fragment |
boolean |
no |
A host from the gRPC inventory |
| do_not_resolve |
boolean |
no |
Do not perform DNS resolution |
| interval |
number |
no |
Interval in milliseconds |
| host |
string |
yes |
A host from the gRPC inventory |
| l3protocol |
string |
no |
1:IPV4, 2:IPV6 |
| size |
number |
no |
Size in bytes |
| source |
string |
no |
IP address |
| wait |
number |
no |
- |
Copied to Clipboard
{
"count": 37121896,
"destination": "10.0.0.1",
"host": "xr9kv-atl",
"do_not_fragment": true,
"do_not_resolve": true,
"interval": 2,
"l3protocol": "IPV4",
"size": 1000,
"source": "172.17.0.2",
"wait": 2
}
Copied to Clipboard
{
"type": "object",
"properties": {
"count": {
"title": "count",
"type": "integer"
},
"destination": {
"title": "destination",
"type": "string",
"examples": [
"10.0.0.1"
]
},
"do_not_fragment": {
"title": "do_not_fragment",
"type": "boolean",
"examples": [
true
]
},
"do_not_resolve": {
"title": "do_not_resolve",
"type": "boolean",
"examples": [
true
]
},
"interval": {
"title": "interval",
"type": "integer",
"examples": [
2
]
},
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"l3protocol": {
"title": "l3protocol",
"type": "string",
"examples": [
"IPV4"
]
},
"size": {
"title": "size",
"type": "integer",
"examples": [
1000
]
},
"source": {
"title": "source",
"type": "string",
"examples": [
"172.17.0.2"
]
},
"wait": {
"title": "wait",
"type": "integer",
"examples": [
2
]
}
},
"required": [
"count",
"destination",
"host"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
gNOI response object. |
Copied to Clipboard
{
"key": "stdout",
"status": "200"
}
