Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/google/gnxi
gNXI Tools - gRPC Network Management/Operations Interface Tools
https://github.com/google/gnxi
gnmi gnmi-client gnmi-protocol gnmi-target gnoi gnoi-client gnoi-protocols gnoi-target go
Last synced: about 2 months ago
JSON representation
gNXI Tools - gRPC Network Management/Operations Interface Tools
- Host: GitHub
- URL: https://github.com/google/gnxi
- Owner: google
- License: apache-2.0
- Created: 2017-09-26T08:19:41.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T12:24:46.000Z (8 months ago)
- Last Synced: 2024-05-08T21:47:39.640Z (7 months ago)
- Topics: gnmi, gnmi-client, gnmi-protocol, gnmi-target, gnoi, gnoi-client, gnoi-protocols, gnoi-target, go
- Language: Python
- Homepage:
- Size: 11.4 MB
- Stars: 250
- Watchers: 26
- Forks: 121
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - gNxI - A collection of tools for Network Management that use the gNMI and gNOI protocols. (Networking / Transliteration)
- zero-alloc-awesome-go - gNxI - A collection of tools for Network Management that use the gNMI and gNOI protocols. (Networking / Transliteration)
- awesome-go-extra - gnxi - gRPC Network Management/Operations Interface Tools|219|106|15|2017-09-26T08:19:41Z|2022-08-20T17:58:07Z| (Networking / Uncategorized)
- awesome-go-zh - gNxI
- awesome-go - gnxi - gNXI Tools - gRPC Network Management/Operations Interface Tools - ★ 70 (Networking)
README
[](https://opensource.org/licenses/Apache-2.0)
[](https://godoc.org/github.com/google/gnxi)
[](https://goreportcard.com/report/github.com/google/gnxi)
[](https://travis-ci.org/google/gnxi)
[](https://codecov.io/github/google/gnxi?branch=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 Capabilities](./gnmi_capabilities)
* [gNMI Get](./gnmi_get)
* [gNMI Set](./gnmi_set)
* [gNMI Subscribe](./gnmi_subscribe)
#### gNMI Targets:
* [gNMI Target](./gnmi_target)
#### gNOI Clients
* [gNOI Cert](./gnoi_cert)
* [gNOI OS](./gnoi_os)
* [gNOI Reset](./gnoi_reset)
#### gNOI Targets
* [gNOI Target](./gnoi_target)
#### Helpers
* [gNOI mockOS](./gnoi_mockos)
* [certificate generator](./certs)
### Documentation
* See [gNMI Protocol documentation](https://github.com/openconfig/reference/tree/master/rpc/gnmi).
* See [gNOI Protocol documentation](https://github.com/openconfig/gnoi).
* See [Openconfig documentation](http://www.openconfig.net/).
## 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/google/gnxi
ls $GOPATH/src/github.com/google/gnxi
```
### Building and installing binaries
```
cd $GOPATH
mkdir bin
# This reads the go modules dependencies for installation
cd src/github.com/google/gnxi
go install ./...
ls -la $GOPATH/bin
```
### Generating certificates
```
cd $GOPATH/bin
./../src/github.com/google/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
* This is not an official Google product.
* See [how to contribute](CONTRIBUTING.md).