Skip to content

gnmic

overview

The following examples are used to find openconfig paths within Arista EOS using the gNMIC binary. There will be some commands which will specify one liners which will have the address of the gNMI target and some commands which will use the .gnmic.yaml file which will have the target information inside declared. All outputs will be redirected to the outputs file with the .json extension so they are easier to view within a text editor.

Download && install gnmic

To install run:

bash -c "$(curl -sL https://get-gnmic.openconfig.net)"

To get the version run:

gnmi_stuff$ gnmic version

Output:

version : 0.27.0
 commit : cc5759c
   date : 2022-10-10T06:40:26Z
 gitURL : https://github.com/openconfig/gnmic
   docs : https://gnmic.openconfig.net

Device config

management api gnmi
   transport grpc default
       no shutdown
   provider eos-native

ceos3#                show management api gnmi
Octa:               enabled
Enabled:            Yes
Server:             running on port 6030
SSL Profile:        none
QoS DSCP:           none
Authorization Required:No

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure capabilities  \
  >> outputs/capabilities.json

gNMI GET RPC Examples

OpenConfig paths

Get all information

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path "/"

Get the BGP configuration in the default VRF

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  '/network-instances/network-instance[name=default]/protocols/protocol[identifier=BGP][name=BGP]/bgp'

Get BGP neighbors

gnmic -a 192.0.2.139:6030 -u cvpadmin -p arista --insecure get --path  \
  '/network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors'

Get all interface descriptions

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  '/interfaces/interface/subinterfaces/subinterface/state/description'

Get an interface's description

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'interfaces/interface[name=Ethernet1]/subinterfaces/subinterface/state/description'

[
  {
    "timestamp": 1626293671204274106,
    "time": "2021-07-14T21:14:31.204274106+01:00",
    "updates": [
      {
        "Path": "interfaces/interface[name=Ethernet1]/subinterfaces/subinterface[index=0]/state/description",
        "values": {
          "interfaces/interface/subinterfaces/subinterface/state/description": "To-SPINE1"
        }
      }
    ]
  }
]

Get the operational status of all interfaces

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'interfaces/interface/state/oper-status'
Reveal output 

[
  {
    "timestamp": 1626293641102904713,
    "time": "2021-07-14T21:14:01.102904713+01:00",
    "updates": [
      {
        "Path": "interfaces/interface[name=Management1]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Ethernet1]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Ethernet5]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Ethernet4]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Ethernet3]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Ethernet2]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Port-Channel4]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      },
      {
        "Path": "interfaces/interface[name=Port-Channel3]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      }
    ]
  }
]

Get all states of an interface

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'interfaces/interface[name=Ethernet1]/state/'
Reveal output 

[[
  {
    "timestamp": 1626293429376469348,
    "time": "2021-07-14T21:10:29.376469348+01:00",
    "updates": [
      {
        "Path": "interfaces/interface[name=Ethernet1]/state",
        "values": {
          "interfaces/interface/state": {
            "arista-intf-augments:inactive": false,
            "openconfig-interfaces:admin-status": "UP",
            "openconfig-interfaces:counters": {
              "in-broadcast-pkts": "0",
              "in-discards": "0",
              "in-errors": "0",
              "in-fcs-errors": "0",
              "in-multicast-pkts": "48",
              "in-octets": "111398",
              "in-unicast-pkts": "1460",
              "out-broadcast-pkts": "1",
              "out-discards": "0",
              "out-errors": "0",
              "out-multicast-pkts": "49",
              "out-octets": "117389",
              "out-unicast-pkts": "1457"
            },
            "openconfig-interfaces:description": "To-SPINE1",
            "openconfig-interfaces:ifindex": 1,
            "openconfig-interfaces:last-change": "1626292006733589760",
            "openconfig-interfaces:mtu": 0,
            "openconfig-interfaces:name": "Ethernet1",
            "openconfig-interfaces:oper-status": "UP",
            "openconfig-interfaces:type": "iana-if-type:ethernetCsmacd",
            "openconfig-platform-port:hardware-port": "Port1"
          }
        }
      }
    ]
  }
]

Get an interface's operational status

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'interfaces/interface[name=Ethernet24]/state/oper-status'

[
  {
    "timestamp": 1626293414057239130,
    "time": "2021-07-14T21:10:14.05723913+01:00",
    "updates": [
      {
        "Path": "interfaces/interface[name=Ethernet2]/state/oper-status",
        "values": {
          "interfaces/interface/state/oper-status": "UP"
        }
      }
    ]
  }
]

Get an interface's admin status

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'interfaces/interface[name=Ethernet1]/state/admin-status'

[
  {
    "timestamp": 1626293085257457373,
    "time": "2021-07-14T21:04:45.257457373+01:00",
    "updates": [
      {
        "Path": "interfaces/interface[name=Ethernet1]/state/admin-status",
        "values": {
          "interfaces/interface/state/admin-status": "UP"
        }
      }
    ]
  }
]

Get the DOM metrics of all interfaces

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  "components/component/transceiver/physical-channels/channel/state/"
Reveal output 

[
  {
    "timestamp": 1626293085257457373,
    "time": "2021-07-14T21:04:45.257457373+01:00",
    "updates": [
      {
        "Path": "components/component[name=Ethernet49 transceiver]/transceiver/physical-channels/channel[index=0]/state",
        "values": {
          "components/component/transceiver/physical-channels/channel/state": {
            "openconfig-platform-transceiver:index": 0,
            "openconfig-platform-transceiver:input-power": {
              "instant": "1.15"
            },
            "openconfig-platform-transceiver:laser-bias-current": {
              "instant": "0.0"
            },
            "openconfig-platform-transceiver:output-power": {}
          }
        }
      },
      {
        "Path": "components/component[name=Ethernet50 transceiver]/transceiver/physical-channels/channel[index=0]/state",
        "values": {
          "components/component/transceiver/physical-channels/channel/state": {
            "openconfig-platform-transceiver:index": 0,
            "openconfig-platform-transceiver:input-power": {
              "instant": "1.11"
            },
            "openconfig-platform-transceiver:laser-bias-current": {
              "instant": "0.0"
            },
            "openconfig-platform-transceiver:output-power": {}
          }
        }
      }
    ]
  }
]

Get the DOM metrics of an interface

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  "components/component[name=Ethernet49 transceiver]/transceiver/physical-channels/channel/state/"
Reveal output 

[
  {
    "time": "1970-01-01T01:00:00+01:00",
    "updates": [
      {
        "Path": "components/component[name=Ethernet49 transceiver]/transceiver/physical-channels/channel[index=0]/state",
        "values": {
          "components/component/transceiver/physical-channels/channel/state": {
            "openconfig-platform-transceiver:index": 0,
            "openconfig-platform-transceiver:input-power": {
              "instant": "1.08"
            },
            "openconfig-platform-transceiver:laser-bias-current": {
              "instant": "0.0"
            },
            "openconfig-platform-transceiver:output-power": {}
          }
        }
      }
    ]
  }
]

Get per core CPU utilization

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'components/component/cpu'
Reveal output 

[
  {
    "timestamp": 1626294810779644595,
    "time": "2021-07-14T21:33:30.779644595+01:00",
    "updates": [
      {
        "Path": "components/component[name=CPU1]/cpu",
        "values": {
          "components/component/cpu": {
            "openconfig-platform-cpu:utilization": {
              "state": {
                "avg": 6,
                "instant": 6,
                "interval": "1000000000000",
                "max": 14,
                "max-time": "3252585270429488128",
                "min": 2,
                "min-time": "3252586330424618496"
              }
            }
          }
        }
      },
      {
        "Path": "components/component[name=CPU0]/cpu",
        "values": {
          "components/component/cpu": {
            "openconfig-platform-cpu:utilization": {
              "state": {
                "avg": 5,
                "instant": 7,
                "interval": "1000000000000",
                "max": 13,
                "max-time": "3252586170423993344",
                "min": 1,
                "min-time": "3252585340433252352"
              }
            }
          }
        }
      }
    ]
  }
]

Get the available/utilized memory

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'components/component/state/memory/'

[
  {
    "timestamp": 1626294846423115892,
    "time": "2021-07-14T21:34:06.423115892+01:00",
    "updates": [
      {
        "Path": "components/component[name=Chassis]/state/memory",
        "values": {
          "components/component/state/memory": {
            "openconfig-platform:available": "4098412544",
            "openconfig-platform:utilized": "4018016256"
          }
        }
      }
    ]
  }
]

Get the system environment temperatures

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
   'components/component/state/temperature/instant'
Reveal output 

[
  {
    "timestamp": 1626294876186613578,
    "time": "2021-07-14T21:34:36.186613578+01:00"
    "updates": [
      {
        "Path": "components/component[name=DomTemperatureSensor50]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 2709375,
            "precision": 5
          }
        }
      },
      {
        "Path": "components/component[name=DomTemperatureSensor49]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 27140625,
            "precision": 6
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor7]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 41168000000000006,
            "precision": 15
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor8]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 4225279999999998,
            "precision": 14
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor9]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 4062560000000002,
            "precision": 14
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor1]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 39141723894742796,
            "precision": 15
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor6]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 23875,
            "precision": 3
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor3]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 21
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor4]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 1725,
            "precision": 2
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor5]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 29
          }
        }
      },
      {
        "Path": "components/component[name=TempSensor2]/state/temperature/instant",
        "values": {
          "components/component/state/temperature/instant": {
            "digits": 32
          }
        }
      }
    ]
  }
]

Get the information about connected gNMI clients

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip get --path \
  '/telemetry-system/subscriptions'
Reveal output 

[
  {
    "source": "192.0.2.214:6030",
    "timestamp": 1723202310565051604,
    "time": "2024-08-09T16:48:30.565051604+05:30",
    "updates": [
      {
        "Path": "telemetry-system/subscriptions",
        "values": {
          "telemetry-system/subscriptions": {
            "openconfig-telemetry:dynamic-subscriptions": {
              "dynamic-subscription": [
                {
                  "id": "2",
                  "sensor-paths": {
                    "sensor-path": [
                      {
                        "path": "/components/component/state/memory",
                        "state": {
                          "path": "/components/component/state/memory"
                        }
                      },
                      {
                        "path": "/Kernel/proc/cpu/utilization/total",
                        "state": {
                          "path": "/Kernel/proc/cpu/utilization/total"
                        }
                      }
                    ]
                  },
                  "state": {
                    "destination-address": "192.0.2.139",
                    "destination-port": 51478,
                    "encoding": "openconfig-telemetry-types:ENC_PROTO3",
                    "id": "2",
                    "protocol": "openconfig-telemetry-types:STREAM_GRPC"
                  }
                },
                {
                  "id": "3",
                  "sensor-paths": {
                    "sensor-path": [
                      {
                        "path": "/components/component/transceiver/physical-channels/channel/state",
                        "state": {
                          "path": "/components/component/transceiver/physical-channels/channel/state"
                        }
                      }
                    ]
                  },
                  "state": {
                    "destination-address": "192.168.3.2",
                    "destination-port": 57928,
                    "encoding": "openconfig-telemetry-types:ENC_PROTO3",
                    "id": "3",
                    "protocol": "openconfig-telemetry-types:STREAM_GRPC"
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
]

gNMI SUBSCRIBE RPC Examples

OpenConfig paths

Subscribe to all BGP neighbor states

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip subscribe --path  \
  '/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/state'
Reveal output 

{
  "source": "192.0.2.214:6030",
  "subscription-name": "default-1626302647",
  "timestamp": 1626292010055258009,
  "time": "2021-07-14T20:46:50.055258009+01:00",
  "updates": [
    {
      "Path": "network-instances/network-instance[name=default]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=172.18.255.42]/state/messages/sent/UPDATE",
      "values": {
        "network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/state/messages/sent/UPDATE": 8
      }
    }
  ]
}
{
  "source": "192.0.2.214:6030",
  "subscription-name": "default-1626302647",
  "timestamp": 1626292008053994815,
  "time": "2021-07-14T20:46:48.053994815+01:00",
  "updates": [
    {
      "Path": "network-instances/network-instance[name=default]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=172.18.255.42]/state/established-transitions",
      "values": {
        "network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/state/established-transitions": 1
      }
    }
  ]
}

Subscribe to specific BGP neighbor state

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip subscribe --path  \
  'network-instances/network-instance[name=Tenant_A_WEB_Zone]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.21]/state'
Reveal output 

{
  "source": "192.0.2.214:6030",
  "subscription-name": "default-1626303017",
  "timestamp": 1626302991598465536,
  "time": "2021-07-14T23:49:51.598465536+01:00",
  "updates": [
    {
      "Path": "network-instances/network-instance[name=Tenant_A_WEB_Zone]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.21]/state/last-established",
      "values": {
        "network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/state/last-established": 1626302991563603200
      }
    }
  ]
}

Subscribe with stream mode sample and interval

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip --sample-interval 5s --stream-mode sample subscribe --path  \
  '/network-instances/network-instance[name=Tenant_A_WEB_Zone]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.21]/afi-safis/afi-safi[afi-safi-name=openconfig-bgp-types:IPV4_UNICAST]/state/prefixes/received'
Reveal output 

{
  "source": "192.0.2.214:6030",
  "subscription-name": "default-1626303393",
  "timestamp": 1626303158135414182,
  "time": "2021-07-14T23:52:38.135414182+01:00",
  "updates": [
    {
      "Path": "network-instances/network-instance[name=Tenant_A_WEB_Zone]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.21]/afi-safis/afi-safi[afi-safi-name=IPV4_UNICAST]/state/prefixes/received",
      "values": {
        "network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/afi-safis/afi-safi/state/prefixes/received": 5
      }
    }
  ]
}
{
  "source": "192.0.2.214:6030",
  "subscription-name": "default-1626303393",
  "timestamp": 1626303158135414182,
  "time": "2021-07-14T23:52:38.135414182+01:00",
  "updates": [
    {
      "Path": "network-instances/network-instance[name=Tenant_A_WEB_Zone]/protocols/protocol[identifier=BGP][name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.21]/afi-safis/afi-safi[afi-safi-name=IPV4_UNICAST]/state/prefixes/received",
      "values": {
        "network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/afi-safis/afi-safi/state/prefixes/received": 5
      }
    }
  ]
}

Subscribe to interface counters and save them to a file

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure subscribe --path \
  "/interfaces/interface/state/counters"  >> outputs/interface_state.json

gNMI SET RPC Examples

OpenConfig paths

Configure BGP neighbor address and peer AS

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip set \
--update-path '/network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]' \
--update-file value.json

value.json:

{"config": {"neighbor-address":"198.51.100.43", "peer-as": 123}}

Output:

{
  "timestamp": 1626305876151537555,
  "time": "2021-07-15T00:37:56.151537555+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]"
    }
  ]
}

Configure BGP neighbor address, peer AS and send-community

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip set  \
--update-path '/network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]' \
--update-file value.json

value.json:

{"config": {"neighbor-address":"198.51.100.43", "peer-as": 123, "enabled": true, "send-community": "EXTENDED"}}

Output:

{
  "timestamp": 1626305480401353997,
  "time": "2021-07-15T00:31:20.401353997+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]"
    }
  ]
}

Create BGP peer group

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip set \
  --update-path '/network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/peer-groups/peer-group[peer-group-name=XYZ]' \
  --update-file value.json

value.json:

{"config": {"peer-group-name":"XYZ", "local-as": 114}}

Update BGP peer AS

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip set \
--update-path '/network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]/config/peer-as' \
--update-value '110'

Output:

{
  "timestamp": 1626306067189329813,
  "time": "2021-07-15T00:41:07.189329813+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]/config/peer-as"
    }
  ]
}

Update BGP peer group

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip set \
--update-path '/network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]/config/peer-group' \
--update-value 'XYZ'

Output:

{
  "timestamp": 1626306067189329813,
  "time": "2021-07-15T00:41:07.189329813+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "network-instances/network-instance[name=default]/protocols/protocol[name=BGP]/bgp/neighbors/neighbor[neighbor-address=198.51.100.43]/config/peer-as"
    }
  ]
}

Create an ACL

gnmic -a 192.0.2.108:6030 -u cvpadmin -p arista --insecure --gzip set \
--update-path /acl/acl-sets \
--update-file acl2.json

Output:

{
  "timestamp": 1626307972085688242,
  "time": "2021-07-15T01:12:52.085688242+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "acl/acl-sets"
    }
  ]
}
acl2.json 

{
   "acl-set": [
      {
         "config": {
            "name": "test",
            "type": "ACL_IPV4"
         },
         "name": "test",
         "type": "ACL_IPV4",
         "acl-entries": {
            "acl-entry": [
               {
                  "sequence-id": 10,
                  "actions": {
                     "config": {
                        "forwarding-action": "DROP"
                     }
                  },
                  "config": {
                     "sequence-id": 10
                  },
                  "ipv4": {
                     "config": {
                        "destination-address": "192.0.2.0/24",
                        "source-address": "0.0.0.0/0"
                     }
                  }
               }
            ]
         }
      }
   ]
}

This creates

ip access-list test
   10 deny ip any 192.0.2.0/24

Shutdown an interface

gnmic -a 192.0.2.108:6030 -u cvpadmin -p arista --insecure --gzip set \
--update-path '/interfaces/interface[name=Ethernet1]/config/enabled' \
--update-value 'false'

{
  "timestamp": 1626309145489047571,
  "time": "2021-07-15T01:32:25.489047571+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "interfaces/interface[name=Ethernet1]/config/enabled"
    }
  ]
}

Bring up an interface

gnmic -a 192.0.2.108:6030 -u cvpadmin -p arista --insecure --gzip set \
--update-path '/interfaces/interface[name=Ethernet1]/config/enabled' \
--update-value 'true'

{
  "timestamp": 1626309156607307596,
  "time": "2021-07-15T01:32:36.607307596+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "interfaces/interface[name=Ethernet1]/config/enabled"
    }
  ]
}

EOS Native paths

To get EOS native paths, OCTA has to be enabled as mentioned in the configuration section. Performing GET/SUBSCRIBE actions using EOS native paths require changing the origin to eos_native.

Commonly used paths

  • MAC table: /Smash/bridging/status/smashFdbStatus
  • ARP table: /Smash/arp/status/arpEntry
  • Neighbor table: /Smash/arp/status/neighborEntry
  • IPv4 RIB: /Smash/routing/status/route
  • IPv6 RIB: /Smash/routing6/status/route
  • IPv4 next-hop table: /Smash/routing/status/nexthop
  • IPv6 next-hop table: /Smash/routing6/status/nexthop
  • CPU info: /Kernel/proc/cpu
  • Process statistics: /Kernel/proc/stat
  • System info: /Kernel/sysinfo
  • EOS version: /Eos/image
  • Interface counters: /Smash/counters/ethIntf/<agent>/current/counter
  • Values for <agent> are:
    • 7500-family, 7280-family, 7020-family (Arad/Jericho ASICs): SandCounters
    • 7300-family, 7250-family, 7050-family, 7010 products, 720-family (Trident ASICs): StrataCounters
    • For 7060-family, 7260-family (Tomahawk): Strata-FixedSystem or StrataCounters from 4.22+
    • 7150-family products (Alta ASICs): FocalPointV2
    • 7160-family products (Cavium/Xpliant ASICs): XpCounters
    • 7170-family products (Barefoot ASIC): BfnCounters

Get CPU utilization

 gnmic -a 192.0.2.108:6030 -u cvpadmin -p arista --insecure --gzip get --path  \
  'eos_native:/Kernel/proc/cpu/utilization/total'
Reveal output 

[
  {
    "timestamp": 1626291721294738334,
    "time": "2021-07-14T20:42:01.294738334+01:00",
    "prefix": "eos_native:Kernel/proc/cpu/utilization/total",
    "updates": [
      {
        "Path": "name",
        "values": {
          "name": "total"
        }
      },
      {
        "Path": "nice",
        "values": {
          "nice": 28845
        }
      },
      {
        "Path": "util",
        "values": {
          "util": 41
        }
      },
      {
        "Path": "user",
        "values": {
          "user": 32058347
        }
      },
      {
        "Path": "system",
        "values": {
          "system": 4597389
        }
      },
      {
        "Path": "idle",
        "values": {
          "idle": 76373566
        }
      }
    ]
  }
]

Get transceiver DOM temperature

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure --gzip get --path \
  eos_native:/Sysdb/hardware/archer/xcvr/status >> outputs/doms.json

Get EOS image version

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure --gzip get \
  --path eos_native:/Eos/image >> outputs/eos_image.json

Get LANZ Data Streaming

In addition to Octa, LANZ and LANZ Data Streaming also needs to be enabled on the switch.

queue-monitor length
!
queue-monitor streaming
   no shutdown

With Octa and LANZ Data Streaming enabled, LANZ metrics can be subscribed to:

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure --gzip \
  subscribe --path 'eos_native:/LANZ'
Reveal output 

{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669903438845029161,
  "time": "2022-12-01T19:33:58.845029161+05:30",
  "prefix": "eos_native:LANZ/config",
  "updates": [
    {
      "Path": "name",
      "values": {
        "name": "config"
      }
    }
  ]
}
{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669903438845141433,
  "time": "2022-12-01T19:33:58.845141433+05:30",
  "prefix": "eos_native:LANZ/globalBufferUsage",
  "updates": [
    {
      "Path": "name",
      "values": {
        "name": "globalBufferUsage"
      }
    },
    {
      "Path": "globalBufferUsageRecord",
      "values": {
        "globalBufferUsageRecord": {
          "bufferSize": 0,
          "duration": 0,
          "entryType": "",
          "timestamp": 0
        }
      }
    }
  ]
}
{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669906008617947980,
  "time": "2022-12-01T20:16:48.61794798+05:30",
  "prefix": "eos_native:LANZ/congestion",
  "updates": [
    {
      "Path": "congestionRecord",
      "values": {
        "congestionRecord": {
          "entryType": "POLLING",
          "fabricPeerIntfName": "",
          "intfName": "Ethernet6",
          "portID": 105,
          "qDropCount": 0,
          "queueSize": 1998240,
          "switchID": 0,
          "timeOfMaxQLen": 0,
          "timestamp": 1669906008617720,
          "trafficClass": 1,
          "txLatency": 0
        }
      }
    }
  ]
}
{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669903438845107943,
  "time": "2022-12-01T19:33:58.845107943+05:30",
  "prefix": "eos_native:LANZ/congestion",
  "updates": [
    {
      "Path": "name",
      "values": {
        "name": "congestion"
      }
    }
  ]
}
{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669905829532672732,
  "time": "2022-12-01T20:13:49.532672732+05:30",
  "prefix": "eos_native:LANZ/config/portConfigRecord",
  "updates": [
    {
      "Path": "Ethernet6/intfName",
      "values": {
        "Ethernet6/intfName": "Ethernet6"
      }
    },
    {
      "Path": "Ethernet6/switchID",
      "values": {
        "Ethernet6/switchID": 0
      }
    },
    {
      "Path": "Ethernet6/portID",
      "values": {
        "Ethernet6/portID": 105
      }
    },
    {
      "Path": "Ethernet6/internalPort",
      "values": {
        "Ethernet6/internalPort": false
      }
    },
    {
      "Path": "Ethernet6/highThreshold",
      "values": {
        "Ethernet6/highThreshold": 40962
      }
    },
    {
      "Path": "Ethernet6/lowThreshold",
      "values": {
        "Ethernet6/lowThreshold": 10241
      }
    }
  ]
}
{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669905829532649815,
  "time": "2022-12-01T20:13:49.532649815+05:30",
  "prefix": "eos_native:LANZ/config",
  "updates": [
    {
      "Path": "configRecord",
      "values": {
        "configRecord": {
          "globalUsageHighThreshold": 0,
          "globalUsageLowThreshold": 0,
          "globalUsageReportingEnabled": true,
          "lanzVersion": 1,
          "maxQueueSize": 524288000,
          "numOfPorts": 121,
          "segmentSize": 16,
          "timestamp": 1669905829532490
        }
      }
    }
  ]
}
{
  "source": "192.0.2.1:6030",
  "subscription-name": "default-1669906007",
  "timestamp": 1669903438845176033,
  "time": "2022-12-01T19:33:58.845176033+05:30",
  "prefix": "eos_native:LANZ/error",
  "updates": [
    {
      "Path": "name",
      "values": {
        "name": "error"
      }
    },
    {
      "Path": "errorRecord",
      "values": {
        "errorRecord": {
          "errorMessage": "",
          "timestamp": 0
        }
      }
    }
  ]
}

Cli origin

Get the running config

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure  get \
  --path "cli:/show running-config" >> outputs/outputs.json

Get the total route count

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure  get \
  --path "cli:/show ip route summary" \
  | jq '.[0].updates[0].values."show ip route summary".totalRoutes'

Changing the running-config

There are multiple ways to change the configuration using the cli origin:

Using JSON

Multiple config sections can be change at a time, for instance in the below example vlan 304 is created and the description of Ethernet1 is changed:

 gnmic -a 192.0.2.214:6030 -u admin -p admin --insecure --gzip set \
    --request-file intf.json

Output:

Reveal output 

{
  "timestamp": 1628103804792021864,
  "time": "2021-08-04T20:03:24.792021864+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    }
  ]
}


cat intf.json

{
  "updates": [
    {
      "path": "cli:",
      "value": "interface Ethernet 1",
      "encoding": "ascii"
    },
    {
      "path": "cli:",
      "value": "description arista-openmgmt",
      "encoding": "ascii"
    },
    {
      "path": "cli:",
      "value": "vlan 304",
      "encoding": "ascii"
    },
    {
      "path": "cli:",
      "value": "name test",
      "encoding": "ascii"
    }
  ]
}

Using YAML

Changing the maximum-routes for a BGP neighbor:

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip set \
   --request-file bgp.yaml

Output:

Reveal output 

{
  "timestamp": 1628091791855672771,
  "time": "2021-08-04T16:43:11.855672771+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    }
  ]
}


cat bgp.yaml

updates:
 - path: "cli:"
   value: router bgp 65101
   encoding: ascii
 - path: "cli:"
   value: neighbor IPv4-UNDERLAY-PEERS maximum-routes 15500
   encoding: ascii

Using imperative commands

gnmic -a 192.0.2.214:6030 -u cvpadmin -p arista --insecure --gzip \
   --encoding ASCII set \
   --update-path "cli:" \
   --update-value "router bgp 65101" \
   --update-path "cli:" \
   --update-value "neighbor IPv4-UNDERLAY-PEERS maximum-routes 13500"

Output:

Reveal output 

{
  "timestamp": 1628091405938523430,
  "time": "2021-08-04T16:36:45.93852343+01:00",
  "results": [
    {
      "operation": "UPDATE",
      "path": "cli:"
    },
    {
      "operation": "UPDATE",
      "path": "cli:"
    }
  ]
}

Running unconverted show commands that use 'text' format

To run show commands that are not converted to JSON and require format="text" the ASCII encoding can be used from EOS 4.29.2F or newer.

show platform fap interrupts

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure get --gzip --encoding ASCII --path "cli:/show platform fap interrupts"

Output:

Reveal output 

[
  {
    "source": "10.81.117.21:6030",
    "timestamp": 1698270415643755294,
    "time": "2023-10-25T22:46:55.643755294+01:00",
    "updates": [
      {
        "Path": "cli:show platform fap interrupts",
        "values": {
          "show platform fap interrupts": " Jericho0\n -------------------------------------------------------------------------------------------------------------- \n
          | Interrupt Bit                                                         | Count | First Occurrence    | Last Occurrence     |\n -------------------------------------------------------------------------------------------------------------- \n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_12[0]       |    55 | 2023-10-05 00:02:22 | 2023-10-20 10:29:21 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_13[0]       |    39 | 2023-10-05 00:02:21 | 2023-10-16 19:00:15 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_14[0]       |    39 | 2023-10-05 00:02:23 | 2023-10-16 19:00:15 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_15[0]       |    39 | 2023-10-05 00:02:22 | 2023-10-16 19:00:15 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_20[0]       |    67 | 2023-10-05 00:02:26 | 2023-10-24 00:44:24 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_21[0]       |    56 | 2023-10-05 00:02:25 | 2023-10-24 00:44:24 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_22[0]       |    53 | 2023-10-05 00:02:25 | 2023-10-24 00:45:15 |\n
          | NBIH_LINK_STATUS_CHANGE_LinkStatusChangeInterruptRegister_23[0]       |    55 | 2023-10-05 00:02:24 | 2023-10-24 00:45:15 |\n
          | IPS_QueueEnteredDel[1]                                                |     6 | 2023-10-11 14:00:20 | 2023-10-11 14:12:02 |\n
          | EPNI_PP_NewDaErr[0]                                                   | 255279 | 2023-10-05 15:06:43 | 2023-10-25 21:46:52 |\n
          | EPNI_PP_VsiMembershipDeny[1]                                          |     2 | 2023-10-11 02:27:16 | 2023-10-11 14:11:46 |\n
          | EPNI_PP_EesLastActionNotAc[0]                                         | 255279 | 2023-10-05 15:06:43 | 2023-10-25 21:46:52 |\n
          | EPNI_PP_EesLastActionNotAc[1]                                         | 47299 | 2023-10-05 13:33:12 | 2023-10-23 16:16:04 |\n
          | FMAC_FMAC_2_RxLostOfSync_0[32]                                        | 883687 | 2023-10-05 00:02:34 | 2023-10-25 21:46:54 |\n
          | FMAC_FMAC_2_RxLostOfSync_1[33]
          <ommitted>
          \n"
        }
      }
    ]
  }
]

Misc

Save all status states to a file

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure get \
  --path ".../state/..." >> outputs/states.json

Save all config states to a file

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure get \
  --path ".../config/..." >> outputs/configs.json

Save network instance states to a file

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure get --path \
  /network-instances/network-instance >> outputs/network-instances.json

Save BGP states to a file

gnmic -a 192.0.2.1:6030 -u admin -p admin --insecure get --path \
  /network-instances/network-instance[name=default]/protocols/protocol[name=BGP]\
  >> outputs/bgp.json