Summary
Send a gNOI traceroute command.
Description
Send a traceroute command over gRPC gNOI to a host and return results.
Route
POST /automationgateway/gnoi/traceroute/execute
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| destination |
string |
yes |
IP address |
| do_not_fragment |
boolean |
no |
Do not fragment |
| do_not_resolve |
boolean |
no |
Do not perform DNS resolution |
| host |
string |
yes |
A host from the gRPC inventory |
| initial_ttl |
number |
no |
Initial ttl |
| l3protocol |
string |
no |
1:IPV4, 2:IPV6 |
| max_ttl |
number |
no |
Max ttl |
| source |
string |
no |
IP address |
| wait |
number |
no |
- |
Copied to Clipboard
{
"destination": "10.0.0.1",
"host": "xr9kv-atl",
"do_not_fragment": true,
"do_not_resolve": true,
"initial_ttl": 0,
"l3protocol": "IPV4",
"max_ttl": 0,
"source": "10.1.98.234",
"wait": 0
}
Copied to Clipboard
{
"type": "object",
"properties": {
"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
]
},
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"initial_ttl": {
"title": "initial_ttl",
"type": "integer",
"examples": [
0
]
},
"l3protocol": {
"title": "l3protocol",
"type": "string",
"examples": [
"IPV4"
]
},
"max_ttl": {
"title": "max_ttl",
"type": "integer",
"examples": [
0
]
},
"source": {
"title": "source",
"type": "string",
"examples": [
"10.1.98.234"
]
},
"wait": {
"title": "wait",
"type": "integer",
"examples": [
0
]
}
},
"required": [
"destination",
"host"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
gNOI response object. |
Copied to Clipboard
{
"key": "status",
"status": "200"
}
