snippetbashTip

gnmic — A gNMI client. Manage gNMI network device configuration and view operational data. More information:

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

commandclientgnmicgnminetworkclimanage

Problem

How to use the gnmic command: A gNMI client. Manage gNMI network device configuration and view operational data. More information: <https://gnmic.openconfig.net/user_guide/configuration_flags/>.

Solution

gnmic — A gNMI client. Manage gNMI network device configuration and view operational data. More information: <https://gnmic.openconfig.net/user_guide/configuration_flags/>.

Request device capabilities:

gnmic {{[-a|--address]}} {{ip:port}} capabilities

Provide a username and password to fetch device capabilities:

gnmic {{[-a|--address]}} {{ip:port}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} capabilities

Get a snapshot of the device state at a specific path:

gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}

Update device state at a specific path:

gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}

Subscribe to target state updates under the subtree at a specific path:

gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}}

Code Snippets

Request device capabilities

gnmic {{[-a|--address]}} {{ip:port}} capabilities

Provide a username and password to fetch device capabilities

gnmic {{[-a|--address]}} {{ip:port}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} capabilities

Get a snapshot of the device state at a specific path

gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}

Update device state at a specific path

gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}

Subscribe to target state updates under the subtree at a specific path

gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}}

Context

tldr-pages: common/gnmic

Revisions (0)

No revisions yet.