gnmi

README

Add support or configuration, metrics, alerts and management functions to your application! and be compatible with a growing set of DevOps tools instantly.

In this repository

• Support for Google's gNMI server-side management protocol handlers to any Go application. gNMI is a management standard to manage a system's config and metrics.
• Works in conjunction with FreeCONF YANG and FreeCONF RESTCONF projects. If you are already using FreeCONF RESTCONF library, you can add support for Google's gNMI protocol with a couple lines of code.
• Works in conjunction with FreeCONF lang to add support for Python.

Getting Started

• Getting started with FreeCONF gNMI
• Getting started with FreeCONF

Building Requirements

Requires Go version 1.20 or greater.

Getting the source

go get -u github.com/freeconf/gnmi

Resources

• Web site
• Documentation
  • Getting Started with FreeCONF gNMI
  • Working with FreeCONF and gNMIc
• Go API Docs
• Issues
• Discussions

Documentation

Index

• Variables
• func Manage(s *Server) node.Node
• type Server
  • func NewServer(d *device.Local) *Server
  • func (s *Server) Apply(opts ServerOpts) error
  • func (s *Server) Options() ServerOpts
• type ServerOpts

Variables

var InternalYPath = source.Any(restconf.InternalYPath, source.EmbedDir(internal, "yang"))

Access to fc-gnmi yang definitions.

var Version = "0.0.0"

Functions

func Manage

func Manage(s *Server) node.Node

Types

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(d *device.Local) *Server

func (*Server) Apply

func (s *Server) Apply(opts ServerOpts) error

func (*Server) Options

func (s *Server) Options() ServerOpts

type ServerOpts

type ServerOpts struct {
	Port string
}