kryndex / gnxi

gNXI Tools - gRPC Network Management/Operations Interface Tools

gNxI Tools

• gNMI - gRPC Network Management Interface
• gNOI - gRPC Network Operations Interface

A collection of tools for Network Management that use the gNMI and gNOI protocols.

Summary

Note: These tools are intended for testing and as reference implementation of the protocol.

• gNMI Capabilities
• gNMI Set
• gNMI Get
• gNMI Target

Documentation

• See gNMI Protocol documentation.
• See gNOI Protocol documentation.
• See Openconfig documentation.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Docker for instructions on how to test against network equipment.

Prerequisites

Install go in your system https://golang.org/doc/install.

Clone

Clone the project to your go source folder:

mkdir -p $GOPATH/src/github.com/google/
cd $GOPATH/src/github.com/google/
git clone https://github.com/google/gnxi.git

Running

To run the binaries:

cd $GOPATH/src/github.com/google/gnxi/gnmi_get
go run ./gnmi_get.go

Docker

FAUCET currently includes a Dockerfile to setup the environment that facilitates testing these tools against network equipment. See the gNMI FAUCET documentation for more information.

Disclaimer

• This is not an official Google product.
• See how to contribute.