README
¶
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.
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package gnmi implements a gnmi server to mock a device with YANG models.
|
Package gnmi implements a gnmi server to mock a device with YANG models. |
|
modeldata
Package modeldata contains the following model data in gnmi proto struct:
|
Package modeldata contains the following model data in gnmi proto struct: |
|
modeldata/gostruct
Package gostruct is a generated package which contains definitions of structs which represent a YANG schema.
|
Package gostruct is a generated package which contains definitions of structs which represent a YANG schema. |
|
Binary gnmi_capabilities performs a capabilities request to a gNMI target.
|
Binary gnmi_capabilities performs a capabilities request to a gNMI target. |
|
Binary gnmi_get performs a get request against a gNMI target.
|
Binary gnmi_get performs a get request against a gNMI target. |
|
Binary gnmi_set performs a set request against a gNMI target with the specified config file.
|
Binary gnmi_set performs a set request against a gNMI target with the specified config file. |
|
Binary gnmi_target implements a gNMI Target with in-memory configuration and telemetry.
|
Binary gnmi_target implements a gNMI Target with in-memory configuration and telemetry. |
|
Package utils implements utilities for gnxi.
|
Package utils implements utilities for gnxi. |
|
credentials
Package credentials loads certificates and validates user credentials.
|
Package credentials loads certificates and validates user credentials. |
|
xpath
Package xpath parses xpath string into gnmi Path struct.
|
Package xpath parses xpath string into gnmi Path struct. |
Click to show internal directories.
Click to hide internal directories.