Summary
Send a gNMI get command.
Description
Send a gNMI get command for the list of provided paths.
Route
POST /automationgateway/gnmi/get/execute
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| host |
string |
yes |
A host from the gRPC inventory |
| options |
object |
no |
Additional options: datatype, encoding |
| path |
array |
yes |
Device Interface |
Copied to Clipboard
{
"host": "xr9kv-atl",
"path": [
"openconfig-interfaces:interfaces"
],
"options": {
"datatype": "operational",
"encoding": "proto"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"datatype": {
"type": "string",
"enum": [
"all",
"config",
"operational",
"state"
]
},
"encoding": {
"type": "string",
"enum": [
"ascii",
"bytes",
"json",
"json_ietf",
"proto"
]
}
}
},
"path": {
"items": {
"type": "string"
},
"examples": [
[
"openconfig-interfaces:interfaces"
]
]
}
},
"required": [
"host",
"path"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
gNMI response object. |
Copied to Clipboard
{
"key": "result",
"status": "200"
}
