otgpath

Documentation

Overview

Package otgpath is a generated package which contains definitions of structs which generate gNMI paths for a YANG schema. The generated paths are based on a compressed form of the schema.

This package was generated by ygnmi version: v0.7.3: (ygot: v0.25.4) using the following YANG input files:

• models-yang/models/bgp/open-traffic-generator-bgp.yang
• models-yang/models/discovery/open-traffic-generator-discovery.yang
• models-yang/models/flow/open-traffic-generator-flow.yang
• models-yang/models/interface/open-traffic-generator-port.yang
• models-yang/models/isis/open-traffic-generator-isis.yang
• models-yang/models/lacp/open-traffic-generator-lacp.yang
• models-yang/models/lag/open-traffic-generator-lag.yang
• models-yang/models/lldp/open-traffic-generator-lldp.yang
• models-yang/models/rsvp/open-traffic-generator-rsvp.yang
• models-yang/models/types/open-traffic-generator-types.yang

Imported modules were sourced from:

• models-yang/models/...

Index

• type Batch
  • func (b *Batch) AddPaths(paths ...ygnmi.PathStruct) *Batch
  • func (b *Batch) Config() ygnmi.SingletonQuery[*oc.Root]
  • func (b *Batch) State() ygnmi.SingletonQuery[*oc.Root]
• type RootPath
  • func Root() *RootPath
  • func (n *RootPath) BgpPeer(Name string) *bgp.BgpPeerPath
  • func (n *RootPath) BgpPeerAny() *bgp.BgpPeerPathAny
  • func (n *RootPath) Config() ygnmi.ConfigQuery[*oc.Root]
  • func (n *RootPath) Flow(Name string) *flow.FlowPath
  • func (n *RootPath) FlowAny() *flow.FlowPathAny
  • func (n *RootPath) Interface(Name string) *discovery.InterfacePath
  • func (n *RootPath) InterfaceAny() *discovery.InterfacePathAny
  • func (n *RootPath) IsisRouter(Name string) *isis.IsisRouterPath
  • func (n *RootPath) IsisRouterAny() *isis.IsisRouterPathAny
  • func (n *RootPath) Lacp() *lacp.LacpPath
  • func (n *RootPath) Lag(Name string) *lag.LagPath
  • func (n *RootPath) LagAny() *lag.LagPathAny
  • func (n *RootPath) LldpInterface(Name string) *lldp.LldpInterfacePath
  • func (n *RootPath) LldpInterfaceAny() *lldp.LldpInterfacePathAny
  • func (n *RootPath) Port(Name string) *port.PortPath
  • func (n *RootPath) PortAny() *port.PortPathAny
  • func (n *RootPath) RsvpteRouter(Name string) *rsvp.RsvpteRouterPath
  • func (n *RootPath) RsvpteRouterAny() *rsvp.RsvpteRouterPathAny
  • func (n *RootPath) State() ygnmi.SingletonQuery[*oc.Root]

Types

type Batch

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

Batch contains a collection of paths. Calling State() or Config() on the batch returns a query that can use to Lookup, Watch, etc on multiple paths at once.

func (*Batch) AddPaths

func (b *Batch) AddPaths(paths ...ygnmi.PathStruct) *Batch

AddPaths adds the paths to the batch.

func (*Batch) Config

func (b *Batch) Config() ygnmi.SingletonQuery[*oc.Root]

Config returns a Query that can be used in gNMI operations. The returned query is immutable, adding paths does not modify existing queries.

func (*Batch) State

func (b *Batch) State() ygnmi.SingletonQuery[*oc.Root]

State returns a Query that can be used in gNMI operations. The returned query is immutable, adding paths does not modify existing queries.

type RootPath

type RootPath struct {
	*ygnmi.DeviceRootBase
}

RootPath represents the /root YANG schema element.

func Root

func Root() *RootPath

Root returns a root path object from which YANG paths can be constructed.

func (*RootPath) BgpPeer

func (n *RootPath) BgpPeer(Name string) *bgp.BgpPeerPath

BgpPeer (list): Each BGP peer is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-bgp"
Instantiating module: "open-traffic-generator-bgp"
Path from parent:     "bgp-peers/bgp-peer"
Path from root:       "/bgp-peers/bgp-peer"

Name: string

func (*RootPath) BgpPeerAny

func (n *RootPath) BgpPeerAny() *bgp.BgpPeerPathAny

BgpPeerAny (list): Each BGP peer is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-bgp"
Instantiating module: "open-traffic-generator-bgp"
Path from parent:     "bgp-peers/bgp-peer"
Path from root:       "/bgp-peers/bgp-peer"

func (*RootPath) Config

func (n *RootPath) Config() ygnmi.ConfigQuery[*oc.Root]

Config returns a Query that can be used in gNMI operations.

func (*RootPath) Flow

func (n *RootPath) Flow(Name string) *flow.FlowPath

Flow (list): A flow of packets between one or more internal and external sources and one or more internal and external destinations that the target is able to track and report statistics on. Each flow is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-flow"
Instantiating module: "open-traffic-generator-flow"
Path from parent:     "flows/flow"
Path from root:       "/flows/flow"

Name: string

func (*RootPath) FlowAny

func (n *RootPath) FlowAny() *flow.FlowPathAny

FlowAny (list): A flow of packets between one or more internal and external sources and one or more internal and external destinations that the target is able to track and report statistics on. Each flow is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-flow"
Instantiating module: "open-traffic-generator-flow"
Path from parent:     "flows/flow"
Path from root:       "/flows/flow"

func (*RootPath) Interface

func (n *RootPath) Interface(Name string) *discovery.InterfacePath

Interface (list): An individual interface defined by an OTG.

Defining module:      "open-traffic-generator-discovery-interfaces"
Instantiating module: "open-traffic-generator-discovery"
Path from parent:     "interfaces/interface"
Path from root:       "/interfaces/interface"

Name: string

func (*RootPath) InterfaceAny

func (n *RootPath) InterfaceAny() *discovery.InterfacePathAny

InterfaceAny (list): An individual interface defined by an OTG.

Defining module:      "open-traffic-generator-discovery-interfaces"
Instantiating module: "open-traffic-generator-discovery"
Path from parent:     "interfaces/interface"
Path from root:       "/interfaces/interface"

func (*RootPath) IsisRouter

func (n *RootPath) IsisRouter(Name string) *isis.IsisRouterPath

IsisRouter (list): Each ISIS router is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-isis"
Instantiating module: "open-traffic-generator-isis"
Path from parent:     "isis-routers/isis-router"
Path from root:       "/isis-routers/isis-router"

Name: string

func (*RootPath) IsisRouterAny

func (n *RootPath) IsisRouterAny() *isis.IsisRouterPathAny

IsisRouterAny (list): Each ISIS router is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-isis"
Instantiating module: "open-traffic-generator-isis"
Path from parent:     "isis-routers/isis-router"
Path from root:       "/isis-routers/isis-router"

func (*RootPath) Lacp

func (n *RootPath) Lacp() *lacp.LacpPath

Lacp (container): LACP telemetry collected by the ATE device.

Defining module:      "open-traffic-generator-lacp"
Instantiating module: "open-traffic-generator-lacp"
Path from parent:     "lacp"
Path from root:       "/lacp"

func (*RootPath) Lag

func (n *RootPath) Lag(Name string) *lag.LagPath

Lag (list): An individual LAG defined by an OTG.

Defining module:      "open-traffic-generator-lag"
Instantiating module: "open-traffic-generator-lag"
Path from parent:     "lags/lag"
Path from root:       "/lags/lag"

Name: string

func (*RootPath) LagAny

func (n *RootPath) LagAny() *lag.LagPathAny

LagAny (list): An individual LAG defined by an OTG.

Defining module:      "open-traffic-generator-lag"
Instantiating module: "open-traffic-generator-lag"
Path from parent:     "lags/lag"
Path from root:       "/lags/lag"

func (*RootPath) LldpInterface

func (n *RootPath) LldpInterface(Name string) *lldp.LldpInterfacePath

LldpInterface (list): Each LLDP interface is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-lldp"
Instantiating module: "open-traffic-generator-lldp"
Path from parent:     "lldps/lldp-interface"
Path from root:       "/lldps/lldp-interface"

Name: string

func (*RootPath) LldpInterfaceAny

func (n *RootPath) LldpInterfaceAny() *lldp.LldpInterfacePathAny

LldpInterfaceAny (list): Each LLDP interface is identified by an arbitrary string identifier.

Defining module:      "open-traffic-generator-lldp"
Instantiating module: "open-traffic-generator-lldp"
Path from parent:     "lldps/lldp-interface"
Path from root:       "/lldps/lldp-interface"

func (*RootPath) Port

func (n *RootPath) Port(Name string) *port.PortPath

Port (list): An individual port defined by an OTG.

Defining module:      "open-traffic-generator-port"
Instantiating module: "open-traffic-generator-port"
Path from parent:     "ports/port"
Path from root:       "/ports/port"

Name: string

func (*RootPath) PortAny

func (n *RootPath) PortAny() *port.PortPathAny

PortAny (list): An individual port defined by an OTG.

Defining module:      "open-traffic-generator-port"
Instantiating module: "open-traffic-generator-port"
Path from parent:     "ports/port"
Path from root:       "/ports/port"

func (*RootPath) RsvpteRouter

func (n *RootPath) RsvpteRouter(Name string) *rsvp.RsvpteRouterPath

RsvpteRouter (list): Each RSVP-TE router is identified by a unique string identifier.

Defining module:      "open-traffic-generator-rsvp"
Instantiating module: "open-traffic-generator-rsvp"
Path from parent:     "rsvpte-routers/rsvpte-router"
Path from root:       "/rsvpte-routers/rsvpte-router"

Name: string

func (*RootPath) RsvpteRouterAny

func (n *RootPath) RsvpteRouterAny() *rsvp.RsvpteRouterPathAny

RsvpteRouterAny (list): Each RSVP-TE router is identified by a unique string identifier.

Defining module:      "open-traffic-generator-rsvp"
Instantiating module: "open-traffic-generator-rsvp"
Path from parent:     "rsvpte-routers/rsvpte-router"
Path from root:       "/rsvpte-routers/rsvpte-router"

func (*RootPath) State

func (n *RootPath) State() ygnmi.SingletonQuery[*oc.Root]

State returns a Query that can be used in gNMI operations.