gnmi

Documentation

Index

• Constants
• Variables
• func Marshal(value ygot.ValidatedGoStruct) (map[string]any, error)
• func RandomPassword() (string, error)
• func Unmarshal(data []byte, dest ygot.ValidatedGoStruct) error
• func UnmarshalWithOpts(data []byte, dest ygot.ValidatedGoStruct, opts ...ytypes.UnmarshalOpt) error
• type Client
  • func New(ctx context.Context, address, username, password string) (*Client, error)
  • func NewInSONiC(ctx context.Context, basedir string, skipAgentUserCreation bool) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Get(ctx context.Context, path string, dest ygot.ValidatedGoStruct, ...) error
  • func (c *Client) GetWithOpts(ctx context.Context, path string, dest ygot.ValidatedGoStruct, extract bool, ...) error
  • func (c *Client) Set(ctx context.Context, req *gnmi.SetRequest) error
• type ExtractOpt
  • func (ExtractOpt) IsUnmarshalOpt()

Constants

const (
	JSONIETFEncoding  = "json_ietf"
	Target            = "sonic"
	DefaultAddress    = "127.0.0.1:8080"
	AgentUser         = "hhagent"
	AgentPasswordFile = "agent-passwd"
)

const (
	PasswdLower   = "abcdefghijklmnopqrstuvwxyz"
	PasswdUpper   = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
	PasswdDigits  = "0123456789"
	PasswdSymbols = "~!@#$%^&*()_+`-={}|[]\\:\"<>?,./"
	PasswdLength  = 32
)

Variables

var (
	DefaultUsers     = []string{"admin"}
	DefaultPasswords = []string{"YourPaSsWoRd"}
)

var PasswdAlphabet = PasswdLower + PasswdUpper + PasswdDigits + PasswdSymbols

Functions

func Marshal

func Marshal(value ygot.ValidatedGoStruct) (map[string]any, error)

func RandomPassword

func RandomPassword() (string, error)

func Unmarshal

func Unmarshal(data []byte, dest ygot.ValidatedGoStruct) error

func UnmarshalWithOpts

func UnmarshalWithOpts(data []byte, dest ygot.ValidatedGoStruct, opts ...ytypes.UnmarshalOpt) error

Types

type Client

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

func New

func New(ctx context.Context, address, username, password string) (*Client, error)

func NewInSONiC

func NewInSONiC(ctx context.Context, basedir string, skipAgentUserCreation bool) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, dest ygot.ValidatedGoStruct, options ...api.GNMIOption) error

func (*Client) GetWithOpts

func (c *Client) GetWithOpts(ctx context.Context, path string, dest ygot.ValidatedGoStruct, extract bool, options ...api.GNMIOption) error

func (*Client) Set

func (c *Client) Set(ctx context.Context, req *gnmi.SetRequest) error

type ExtractOpt

type ExtractOpt struct{}

func (ExtractOpt) IsUnmarshalOpt

func (ExtractOpt) IsUnmarshalOpt()