gnmi_subscribe

README

gNMI Subscribe Client

A simple shell binary that performs gNMI Subscribe client operations against a gNMI target.

gNMI Subscribe Operations

There are 3 subscription modes that can be used:

• ONCE by using -once. In this mode, the target generates the requested update messages, transmits them, and then closes the RPC.

• POLL by using -poll. In this mode, the target generates and transmits updates when requested by the client.

• STREAM is used by default when neither of the flags above are set. In this mode, data can be streamed:

  • Periodically, using -sample_interval <nanoseconds> between samples.
    • -suppress_redundant where updates are only generated for those individual leaf nodes in the subscription that have changed.
      • -heartbeat_interval <nanoseconds> forces generating a telemetry update regardless if the individual leaf has changed or not.
  • On change, using -stream_on_change
    • -heartbeat_interval <nanoseconds> forces generating a telemetry update regardless if the individual leaf has changed or not.
  • If neither flag is set then the target determines the best subscription type.

Install

go get github.com/google/gnxi/gnmi_subscribe
go install github.com/google/gnxi/gnmi_subscribe

Run

./gnmi_subscribe \
    -xpath "/system/openflow/agent/config/datapath-id" \
    -xpath "/system/openflow/controllers/controller[name=main]" \
    -target_addr localhost:9339 \
    -target_name target.com \
    -ca ca.crt \
    -key client.key \
    -cert client.crt \
    -sample_interval 500000 \
    -encoding JSON_IETF