ocpath

Documentation

Overview

Package ocpath 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.2.3: (ygot: v0.23.0) using the following YANG input files:

• public/release/models/acl/openconfig-acl.yang
• public/release/models/acl/openconfig-packet-match.yang
• public/release/models/aft/openconfig-aft.yang
• public/release/models/bfd/openconfig-bfd.yang
• public/release/models/bgp/openconfig-bgp-policy.yang
• public/release/models/bgp/openconfig-bgp-types.yang
• public/release/models/interfaces/openconfig-if-aggregate.yang
• public/release/models/interfaces/openconfig-if-ethernet.yang
• public/release/models/interfaces/openconfig-if-ip-ext.yang
• public/release/models/interfaces/openconfig-if-ip.yang
• public/release/models/interfaces/openconfig-interfaces.yang
• public/release/models/isis/openconfig-isis.yang
• public/release/models/lacp/openconfig-lacp.yang
• public/release/models/lldp/openconfig-lldp-types.yang
• public/release/models/lldp/openconfig-lldp.yang
• public/release/models/local-routing/openconfig-local-routing.yang
• public/release/models/mpls/openconfig-mpls-types.yang
• public/release/models/multicast/openconfig-pim.yang
• public/release/models/network-instance/openconfig-network-instance.yang
• public/release/models/openconfig-extensions.yang
• public/release/models/optical-transport/openconfig-transport-types.yang
• public/release/models/ospf/openconfig-ospfv2.yang
• public/release/models/platform/openconfig-platform-cpu.yang
• public/release/models/platform/openconfig-platform-integrated-circuit.yang
• public/release/models/platform/openconfig-platform-software.yang
• public/release/models/platform/openconfig-platform-transceiver.yang
• public/release/models/platform/openconfig-platform.yang
• public/release/models/policy-forwarding/openconfig-policy-forwarding.yang
• public/release/models/policy/openconfig-policy-types.yang
• public/release/models/qos/openconfig-qos-elements.yang
• public/release/models/qos/openconfig-qos-interfaces.yang
• public/release/models/qos/openconfig-qos-types.yang
• public/release/models/qos/openconfig-qos.yang
• public/release/models/rib/openconfig-rib-bgp.yang
• public/release/models/segment-routing/openconfig-segment-routing-types.yang
• public/release/models/system/openconfig-system.yang
• public/release/models/types/openconfig-inet-types.yang
• public/release/models/types/openconfig-types.yang
• public/release/models/types/openconfig-yang-types.yang
• public/release/models/vlan/openconfig-vlan.yang
• public/third_party/ietf/iana-if-type.yang
• public/third_party/ietf/ietf-inet-types.yang
• public/third_party/ietf/ietf-interfaces.yang
• public/third_party/ietf/ietf-yang-types.yang

Imported modules were sourced from:

• public/release/models/...
• public/third_party/ietf/...

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) Acl() *acl.AclPath
  • func (n *RootPath) Component(Name string) *platform.ComponentPath
  • func (n *RootPath) ComponentAny() *platform.ComponentPathAny
  • func (n *RootPath) Config() ygnmi.ConfigQuery[*oc.Root]
  • func (n *RootPath) Interface(Name string) *interfaces.InterfacePath
  • func (n *RootPath) InterfaceAny() *interfaces.InterfacePathAny
  • func (n *RootPath) Keychain(Name string) *keychain.KeychainPath
  • func (n *RootPath) KeychainAny() *keychain.KeychainPathAny
  • func (n *RootPath) Lacp() *lacp.LacpPath
  • func (n *RootPath) Lldp() *lldp.LldpPath
  • func (n *RootPath) NetworkInstance(Name string) *networkinstance.NetworkInstancePath
  • func (n *RootPath) NetworkInstanceAny() *networkinstance.NetworkInstancePathAny
  • func (n *RootPath) Qos() *qos.QosPath
  • func (n *RootPath) RoutingPolicy() *routingpolicy.RoutingPolicyPath
  • func (n *RootPath) State() ygnmi.SingletonQuery[*oc.Root]
  • func (n *RootPath) System() *system.SystemPath

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) Acl

func (n *RootPath) Acl() *acl.AclPath

Acl (container): Top level enclosing container for ACL model config and operational state data

Defining module:      "openconfig-acl"
Instantiating module: "openconfig-acl"
Path from parent:     "acl"
Path from root:       "/acl"

func (*RootPath) Component

func (n *RootPath) Component(Name string) *platform.ComponentPath

Component (list): List of components, keyed by component name.

Defining module:      "openconfig-platform"
Instantiating module: "openconfig-platform"
Path from parent:     "components/component"
Path from root:       "/components/component"

Name: string

func (*RootPath) ComponentAny

func (n *RootPath) ComponentAny() *platform.ComponentPathAny

ComponentAny (list): List of components, keyed by component name.

Defining module:      "openconfig-platform"
Instantiating module: "openconfig-platform"
Path from parent:     "components/component"
Path from root:       "/components/component"

func (*RootPath) Config

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

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

func (*RootPath) Interface

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

Interface (list): The list of named interfaces on the device.

Defining module:      "openconfig-interfaces"
Instantiating module: "openconfig-interfaces"
Path from parent:     "interfaces/interface"
Path from root:       "/interfaces/interface"

Name: string

func (*RootPath) InterfaceAny

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

InterfaceAny (list): The list of named interfaces on the device.

Defining module:      "openconfig-interfaces"
Instantiating module: "openconfig-interfaces"
Path from parent:     "interfaces/interface"
Path from root:       "/interfaces/interface"

func (*RootPath) Keychain

func (n *RootPath) Keychain(Name string) *keychain.KeychainPath

Keychain (list): List of defined keychains.

Defining module:      "openconfig-keychain"
Instantiating module: "openconfig-keychain"
Path from parent:     "keychains/keychain"
Path from root:       "/keychains/keychain"

Name: string

func (*RootPath) KeychainAny

func (n *RootPath) KeychainAny() *keychain.KeychainPathAny

KeychainAny (list): List of defined keychains.

Defining module:      "openconfig-keychain"
Instantiating module: "openconfig-keychain"
Path from parent:     "keychains/keychain"
Path from root:       "/keychains/keychain"

func (*RootPath) Lacp

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

Lacp (container): Configuration and operational state data for LACP protocol operation on the aggregate interface

Defining module:      "openconfig-lacp"
Instantiating module: "openconfig-lacp"
Path from parent:     "lacp"
Path from root:       "/lacp"

func (*RootPath) Lldp

func (n *RootPath) Lldp() *lldp.LldpPath

Lldp (container): Top-level container for LLDP configuration and state data

Defining module:      "openconfig-lldp"
Instantiating module: "openconfig-lldp"
Path from parent:     "lldp"
Path from root:       "/lldp"

func (*RootPath) NetworkInstance

func (n *RootPath) NetworkInstance(Name string) *networkinstance.NetworkInstancePath

NetworkInstance (list): Network instances configured on the local system

Defining module:      "openconfig-network-instance"
Instantiating module: "openconfig-network-instance"
Path from parent:     "network-instances/network-instance"
Path from root:       "/network-instances/network-instance"

Name: string

func (*RootPath) NetworkInstanceAny

func (n *RootPath) NetworkInstanceAny() *networkinstance.NetworkInstancePathAny

NetworkInstanceAny (list): Network instances configured on the local system

Defining module:      "openconfig-network-instance"
Instantiating module: "openconfig-network-instance"
Path from parent:     "network-instances/network-instance"
Path from root:       "/network-instances/network-instance"

func (*RootPath) Qos

func (n *RootPath) Qos() *qos.QosPath

Qos (container): Top-level container for QoS data

Defining module:      "openconfig-qos"
Instantiating module: "openconfig-qos"
Path from parent:     "qos"
Path from root:       "/qos"

func (*RootPath) RoutingPolicy

func (n *RootPath) RoutingPolicy() *routingpolicy.RoutingPolicyPath

RoutingPolicy (container): Top-level container for all routing policy configuration

Defining module:      "openconfig-routing-policy"
Instantiating module: "openconfig-routing-policy"
Path from parent:     "routing-policy"
Path from root:       "/routing-policy"

func (*RootPath) State

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

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

func (*RootPath) System

func (n *RootPath) System() *system.SystemPath

System (container): Enclosing container for system-related configuration and operational state data

Defining module:      "openconfig-system"
Instantiating module: "openconfig-system"
Path from parent:     "system"
Path from root:       "/system"