gnmic
(pronoun.: gee·en·em·eye·see) is a gNMI CLI client that provides full support for Capabilities, Get, Set and Subscribe RPCs with collector capabilities.
Documentation available at https://gnmic.kmrd.dev
gnmic
can be deployed as a gNMI collector that supports multiple output types (NATS, Kafka, Prometheus, InfluxDB,...).gnmic
can be deployed as a gNMI collector with an embedded tunnel server.gnmic
collector has data transformation capabilities that can be used to adapt the collected data to your specific use case.gnmic
support target loading at runtime based on input from external systems.gnmic
is executed in prompt mode. In this mode the flags that take XPATH values will get auto-suggestions based on the provided YANG modules. In other words - voodoo magic :exploding_head:prototext
output format you can see the actual gNMI messages being sent/received. Its like having a gNMI looking glass!gnimc
works, our documentation site has you covered.bash -c "$(curl -sL https://get-gnmic.kmrd.dev)"
gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure capabilities
gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure \
get --path /state/system/platform
gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure \
set --update-path /configure/system/name \
--update-value gnmic_demo
gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure \
sub --path "/state/port[port-id=1/1/c1/1]/statistics/in-packets"
The prompt mode is an interactive mode of the gnmic CLI client for user convenience.
# clone repository with YANG models (Openconfig example)
git clone https://github.com/openconfig/public
cd public
# Start gnmic in prompt mode and read in all the modules:
gnmic --file release/models \
--dir third_party \
--exclude ietf-interfaces \
prompt