gnxi

package module
Version: v0.0.0-...-ca39941 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2021 License: Apache-2.0 Imports: 0 Imported by: 0

README

License GoDoc Go Report Card Build Status Code coverage master

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

Notes about these tools:

  • They are intended for testing and as reference implementation of the protocol.
  • They log to stderr by default, disable with -logtostderr=false.
  • They use glog's log levels, use -v 1 to log proto message exchanges.
gNMI Clients:
gNMI Targets:
gNOI Clients
gNOI Targets
Helpers
Documentation

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

Install go in your system https://golang.org/doc/install. Requires golang1.14+.

Download sources
go get github.com/Jandrov/gnxi
ls $GOPATH/src/github.com/Jandrov/gnxi
Building and installing binaries
cd $GOPATH
mkdir bin
# This reads the go modules dependencies for installation
cd src/github.com/Jandrov/gnxi
go install ./...
ls -la $GOPATH/bin
Generating certificates
cd $GOPATH/bin
./../src/github.com/Jandrov/gnxi/certs/generate.sh
Running a client
cd $GOPATH/bin
./gnoi_reset \
    -target_addr localhost:9339 \
    -target_name target.com \
    -rollback_os \
    -zero_fill \
    -key client.key \
    -cert client.crt \
    -ca ca.crt

Optionally define $GOBIN as $GOPATH/bin and add it to your path to run the binaries from any folder.

export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOBIN

Disclaimer

Documentation

The Go Gopher

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: openconfig-interfaces 2.0.0, openconfig-openflow 0.1.0, openconfig-platform 0.5.0, openconfig-system 0.2.0.
Package modeldata contains the following model data in gnmi proto struct: openconfig-interfaces 2.0.0, openconfig-openflow 0.1.0, openconfig-platform 0.5.0, openconfig-system 0.2.0.
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 gnoi contains required services for running a gnoi server.
Package gnoi contains required services for running a gnoi server.
os
Binary implements a Certificate Management service client.
Binary implements a Certificate Management service client.
Binary implements a gNOI Target with a Certificate Management service.
Binary implements a gNOI Target with a Certificate Management service.
cmd
web
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.
entity
Package entity provides a lightweight method for generating certificates.
Package entity provides a lightweight method for generating certificates.
xpath
Package xpath parses xpath string into gnmi Path struct.
Package xpath parses xpath string into gnmi Path struct.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL