Summary
Send a gNMI set command.
Description
Send a gNMI set command for updates, deletes, and replaces.
Route
POST /automationgateway/gnmi/set/execute
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| delete | array | no | Delete interfaces |
| host | string | yes | A host from the gRPC inventory |
| options | object | no | Additional options: encoding |
| replace | array | no | Replace interfaces. |
| update | array | no | Update interfaces |
{ "host": "xr9kv-atl", "delete": [ "openconfig-interfaces:interfaces/interface[name=Loopback25]", "openconfig-interfaces:interfaces/interface[name=Loopback25]", "openconfig-interfaces:interfaces/interface[name=Loopback25]", "openconfig-interfaces:interfaces/interface[name=Loopback25]", "openconfig-interfaces:interfaces/interface[name=Loopback25]" ], "options": { "encoding": "json" }, "replace": [ [ "openconfig-interfaces:interfaces/interface[name=Loopback25]" ], [ "openconfig-interfaces:interfaces/interface[name=Loopback25]" ], [ "openconfig-interfaces:interfaces/interface[name=Loopback25]" ], [ "openconfig-interfaces:interfaces/interface[name=Loopback25]" ] ], "update": [ [ "openconfig-interfaces:interfaces", { "interface": [ { "name": "Loopback100", "config": { "name": "Loopback100", "type": "iana-if-type:softwareLoopback", "enabled": true, "description": "***TEST LOOPBACK****" }, "subinterfaces": { "subinterface": [ { "index": 0, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "1.1.1.100", "config": { "ip": "1.1.1.100", "prefix-length": 32 } } ] } } } ] } } ] } ], [ "openconfig-interfaces:interfaces", { "interface": [ { "name": "Loopback100", "config": { "name": "Loopback100", "type": "iana-if-type:softwareLoopback", "enabled": true, "description": "***TEST LOOPBACK****" }, "subinterfaces": { "subinterface": [ { "index": 0, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "1.1.1.100", "config": { "ip": "1.1.1.100", "prefix-length": 32 } } ] } } } ] } } ] } ], [ "openconfig-interfaces:interfaces", { "interface": [ { "name": "Loopback100", "config": { "name": "Loopback100", "type": "iana-if-type:softwareLoopback", "enabled": true, "description": "***TEST LOOPBACK****" }, "subinterfaces": { "subinterface": [ { "index": 0, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "1.1.1.100", "config": { "ip": "1.1.1.100", "prefix-length": 32 } } ] } } } ] } } ] } ], [ "openconfig-interfaces:interfaces", { "interface": [ { "name": "Loopback100", "config": { "name": "Loopback100", "type": "iana-if-type:softwareLoopback", "enabled": true, "description": "***TEST LOOPBACK****" }, "subinterfaces": { "subinterface": [ { "index": 0, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "1.1.1.100", "config": { "ip": "1.1.1.100", "prefix-length": 32 } } ] } } } ] } } ] } ], [ "openconfig-interfaces:interfaces", { "interface": [ { "name": "Loopback100", "config": { "name": "Loopback100", "type": "iana-if-type:softwareLoopback", "enabled": true, "description": "***TEST LOOPBACK****" }, "subinterfaces": { "subinterface": [ { "index": 0, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "1.1.1.100", "config": { "ip": "1.1.1.100", "prefix-length": 32 } } ] } } } ] } } ] } ] ] }
{ "type": "object", "properties": { "delete": { "items": { "type": "string", "examples": [ [ "openconfig-interfaces:interfaces/interface[name=Loopback25]" ] ] } }, "host": { "title": "host", "type": "string", "$ref": "deviceData#/definitions/deviceName" }, "options": { "title": "options", "type": "object", "properties": { "encoding": { "type": "string", "enum": [ "ascii", "bytes", "json", "json_ietf", "proto" ] } } }, "replace": { "items": { "type": "array", "examples": [ [ "openconfig-interfaces:interfaces/interface[name=Loopback25]" ] ] } }, "update": { "items": { "type": "array", "examples": [ [ "openconfig-interfaces:interfaces", { "interface": [ { "name": "Loopback100", "config": { "name": "Loopback100", "type": "iana-if-type:softwareLoopback", "enabled": true, "description": "***TEST LOOPBACK****" }, "subinterfaces": { "subinterface": [ { "index": 0, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "1.1.1.100", "config": { "ip": "1.1.1.100", "prefix-length": 32 } } ] } } } ] } } ] } ] ] } } }, "required": [ "host" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| result | object | gNMI response object. |
{ "key": "status", "status": "200" }
{ "title": "result", "type": "object", "$ref": "response#/definitions/responseObject" }