2022-09-01 14:57:16 -04:00
|
|
|
# gnmic
|
|
|
|
|
2025-06-29 11:48:18 +03:00
|
|
|
> A gNMI client.
|
2022-09-01 14:57:16 -04:00
|
|
|
> Manage gNMI network device configuration and view operational data.
|
|
|
|
> More information: <https://gnmic.kmrd.dev>.
|
|
|
|
|
|
|
|
- Request device capabilities:
|
|
|
|
|
2025-04-22 15:48:30 +03:00
|
|
|
`gnmic {{[-a|--address]}} {{ip:port}} capabilities`
|
2022-09-01 14:57:16 -04:00
|
|
|
|
|
|
|
- Provide a username and password to fetch device capabilities:
|
|
|
|
|
2025-04-22 15:48:30 +03:00
|
|
|
`gnmic {{[-a|--address]}} {{ip:port}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} capabilities`
|
2022-09-01 14:57:16 -04:00
|
|
|
|
|
|
|
- Get a snapshot of the device state at a specific path:
|
|
|
|
|
2025-04-22 15:48:30 +03:00
|
|
|
`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}`
|
2022-09-01 14:57:16 -04:00
|
|
|
|
|
|
|
- Update device state at a specific path:
|
|
|
|
|
2025-04-22 15:48:30 +03:00
|
|
|
`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}`
|
2022-09-01 14:57:16 -04:00
|
|
|
|
|
|
|
- Subscribe to target state updates under the subtree at a specific path:
|
|
|
|
|
2025-04-22 15:48:30 +03:00
|
|
|
`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}`
|