telemetry

package
v0.0.0-...-50def94 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Data model which creates the configuration for the telemetry systems and functions on the device.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type TelemetryStreamProtocol 

type TelemetryStreamProtocol string

TelemetryStreamProtocol represents of the telemetry stream 

const (
	// TCP protocol transport for the stream
	TelemetryStreamProtocol_TCP TelemetryStreamProtocol = "TCP"

	// UDP protocol transport for the stream
	TelemetryStreamProtocol_UDP TelemetryStreamProtocol = "UDP"
)

type TelemetrySystem 

type TelemetrySystem struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Top level container for sensor-groups.
	SensorGroups TelemetrySystem_SensorGroups

	// Top level container for destination group configuration and state.
	DestinationGroups TelemetrySystem_DestinationGroups

	// This container holds information for both persistent and dynamic telemetry
	// subscriptions.
	Subscriptions TelemetrySystem_Subscriptions
}

TelemetrySystem Top level configuration and state for the device's telemetry system.

func (*TelemetrySystem) GetEntityData 

func (telemetrySystem *TelemetrySystem) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups 

type TelemetrySystem_DestinationGroups struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of destination-groups. Destination groups allow the reuse of common
	// telemetry destinations across the telemetry configuration. An operator
	// references a set of destinations via the configurable
	// destination-group-identifier.  A destination group may contain one or more
	// telemetry destinations. The type is slice of
	// TelemetrySystem_DestinationGroups_DestinationGroup.
	DestinationGroup []*TelemetrySystem_DestinationGroups_DestinationGroup
}

TelemetrySystem_DestinationGroups Top level container for destination group configuration and state.

func (*TelemetrySystem_DestinationGroups) GetEntityData 

func (destinationGroups *TelemetrySystem_DestinationGroups) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup 

type TelemetrySystem_DestinationGroups_DestinationGroup struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Unique identifier for the destination group. The
	// type is string. Refers to
	// telemetry.TelemetrySystem_DestinationGroups_DestinationGroup_Config_GroupId
	GroupId interface{}

	// Top level config container for destination groups.
	Config TelemetrySystem_DestinationGroups_DestinationGroup_Config

	// Top level state container for destination groups.
	State TelemetrySystem_DestinationGroups_DestinationGroup_State

	// The destination container lists the destination information such as IP
	// address and port of the telemetry messages from the network element.
	Destinations TelemetrySystem_DestinationGroups_DestinationGroup_Destinations
}

TelemetrySystem_DestinationGroups_DestinationGroup List of destination-groups. Destination groups allow the reuse of common telemetry destinations across the telemetry configuration. An operator references a set of destinations via the configurable destination-group-identifier.

A destination group may contain one or more telemetry destinations

func (*TelemetrySystem_DestinationGroups_DestinationGroup) GetEntityData 

func (destinationGroup *TelemetrySystem_DestinationGroups_DestinationGroup) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup_Config 

type TelemetrySystem_DestinationGroups_DestinationGroup_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Unique identifier for the destination group. The type is string.
	GroupId interface{}
}

TelemetrySystem_DestinationGroups_DestinationGroup_Config Top level config container for destination groups

func (*TelemetrySystem_DestinationGroups_DestinationGroup_Config) GetEntityData 

func (config *TelemetrySystem_DestinationGroups_DestinationGroup_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations 

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of telemetry stream destinations. The type is slice of
	// TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination.
	Destination []*TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination
}

TelemetrySystem_DestinationGroups_DestinationGroup_Destinations The destination container lists the destination information such as IP address and port of the telemetry messages from the network element.

func (*TelemetrySystem_DestinationGroups_DestinationGroup_Destinations) GetEntityData 

func (destinations *TelemetrySystem_DestinationGroups_DestinationGroup_Destinations) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination 

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the destination address of the
	// telemetry stream. The type is one of the following types: string with
	// pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.
	DestinationAddress interface{}

	// This attribute is a key. Reference to the port number of the stream
	// destination. The type is string with range: 0..65535. Refers to
	// telemetry.TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config_DestinationPort
	DestinationPort interface{}

	// Configuration parameters relating to telemetry destinations.
	Config TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config

	// State information associated with telemetry destinations.
	State TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_State
}

TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination List of telemetry stream destinations

func (*TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination) GetEntityData 

func (destination *TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config 

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// IP address of the telemetry stream destination. The type is one of the
	// following types: string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.
	DestinationAddress interface{}

	// Protocol (udp or tcp) port number for the telemetry stream destination. The
	// type is interface{} with range: 0..65535.
	DestinationPort interface{}

	// Protocol used to transmit telemetry data to the collector. The type is
	// TelemetryStreamProtocol.
	DestinationProtocol interface{}
}

TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config Configuration parameters relating to telemetry destinations

func (*TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config) GetEntityData 

func (config *TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_State 

type TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// IP address of the telemetry stream destination. The type is one of the
	// following types: string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.
	DestinationAddress interface{}

	// Protocol (udp or tcp) port number for the telemetry stream destination. The
	// type is interface{} with range: 0..65535.
	DestinationPort interface{}

	// Protocol used to transmit telemetry data to the collector. The type is
	// TelemetryStreamProtocol.
	DestinationProtocol interface{}
}

TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_State State information associated with telemetry destinations

func (*TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_State) GetEntityData 

func (state *TelemetrySystem_DestinationGroups_DestinationGroup_Destinations_Destination_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_DestinationGroups_DestinationGroup_State 

type TelemetrySystem_DestinationGroups_DestinationGroup_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Unique identifier for destination group. The type is string.
	GroupId interface{}
}

TelemetrySystem_DestinationGroups_DestinationGroup_State Top level state container for destination groups

func (*TelemetrySystem_DestinationGroups_DestinationGroup_State) GetEntityData 

func (state *TelemetrySystem_DestinationGroups_DestinationGroup_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups 

type TelemetrySystem_SensorGroups struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of telemetry sensory groups on the local system, where a sensor
	// grouping represents a resuable grouping of multiple paths and exclude
	// filters. The type is slice of TelemetrySystem_SensorGroups_SensorGroup.
	SensorGroup []*TelemetrySystem_SensorGroups_SensorGroup
}

TelemetrySystem_SensorGroups Top level container for sensor-groups.

func (*TelemetrySystem_SensorGroups) GetEntityData 

func (sensorGroups *TelemetrySystem_SensorGroups) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup 

type TelemetrySystem_SensorGroups_SensorGroup struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the name or identifier of the sensor
	// grouping. The type is string. Refers to
	// telemetry.TelemetrySystem_SensorGroups_SensorGroup_Config_SensorGroupId
	SensorGroupId interface{}

	// Configuration parameters relating to the telemetry sensor grouping.
	Config TelemetrySystem_SensorGroups_SensorGroup_Config

	// State information relating to the telemetry sensor group.
	State TelemetrySystem_SensorGroups_SensorGroup_State

	// Top level container to hold a set of sensor paths grouped together.
	SensorPaths TelemetrySystem_SensorGroups_SensorGroup_SensorPaths
}

TelemetrySystem_SensorGroups_SensorGroup List of telemetry sensory groups on the local system, where a sensor grouping represents a resuable grouping of multiple paths and exclude filters.

func (*TelemetrySystem_SensorGroups_SensorGroup) GetEntityData 

func (sensorGroup *TelemetrySystem_SensorGroups_SensorGroup) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup_Config 

type TelemetrySystem_SensorGroups_SensorGroup_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Name or identifier for the sensor group itself. Will be referenced by other
	// configuration specifying a sensor group. The type is string.
	SensorGroupId interface{}
}

TelemetrySystem_SensorGroups_SensorGroup_Config Configuration parameters relating to the telemetry sensor grouping

func (*TelemetrySystem_SensorGroups_SensorGroup_Config) GetEntityData 

func (config *TelemetrySystem_SensorGroups_SensorGroup_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths 

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of paths in the model which together comprise a sensor grouping.
	// Filters for each path to exclude items are also provided. The type is slice
	// of TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath.
	SensorPath []*TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath
}

TelemetrySystem_SensorGroups_SensorGroup_SensorPaths Top level container to hold a set of sensor paths grouped together

func (*TelemetrySystem_SensorGroups_SensorGroup_SensorPaths) GetEntityData 

func (sensorPaths *TelemetrySystem_SensorGroups_SensorGroup_SensorPaths) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath 

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the path of interest. The type is
	// string. Refers to
	// telemetry.TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config_Path
	Path interface{}

	// Configuration parameters to configure a set of data model paths as a sensor
	// grouping.
	Config TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config

	// Configuration parameters to configure a set of data model paths as a sensor
	// grouping.
	State TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_State
}

TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath List of paths in the model which together comprise a sensor grouping. Filters for each path to exclude items are also provided.

func (*TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath) GetEntityData 

func (sensorPath *TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config 

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Path to a section of operational state of interest (the sensor). The type
	// is string.
	Path interface{}

	// Filter to exclude certain values out of the state values. The type is
	// string.
	ExcludeFilter interface{}
}

TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config Configuration parameters to configure a set of data model paths as a sensor grouping

func (*TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config) GetEntityData 

func (config *TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_State 

type TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Path to a section of operational state of interest (the sensor). The type
	// is string.
	Path interface{}

	// Filter to exclude certain values out of the state values. The type is
	// string.
	ExcludeFilter interface{}
}

TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_State Configuration parameters to configure a set of data model paths as a sensor grouping

func (*TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_State) GetEntityData 

func (state *TelemetrySystem_SensorGroups_SensorGroup_SensorPaths_SensorPath_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_SensorGroups_SensorGroup_State 

type TelemetrySystem_SensorGroups_SensorGroup_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Name or identifier for the sensor group itself. Will be referenced by other
	// configuration specifying a sensor group. The type is string.
	SensorGroupId interface{}
}

TelemetrySystem_SensorGroups_SensorGroup_State State information relating to the telemetry sensor group

func (*TelemetrySystem_SensorGroups_SensorGroup_State) GetEntityData 

func (state *TelemetrySystem_SensorGroups_SensorGroup_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions 

type TelemetrySystem_Subscriptions struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// This container holds information relating to persistent telemetry
	// subscriptions. A persistent telemetry subscription is configued locally on
	// the device through configuration, and is persistent across device restarts
	// or other redundancy changes.
	Persistent TelemetrySystem_Subscriptions_Persistent

	// This container holds information relating to dynamic telemetry
	// subscriptions. A dynamic subscription is typically configured through an
	// RPC channel, and does not persist across device restarts, or if the RPC
	// channel is reset or otherwise torn down.
	Dynamic TelemetrySystem_Subscriptions_Dynamic
}

TelemetrySystem_Subscriptions This container holds information for both persistent and dynamic telemetry subscriptions.

func (*TelemetrySystem_Subscriptions) GetEntityData 

func (subscriptions *TelemetrySystem_Subscriptions) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Dynamic 

type TelemetrySystem_Subscriptions_Dynamic struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List representation of telemetry subscriptions that are configured via an
	// inline RPC, otherwise known as dynamic telemetry subscriptions. The type is
	// slice of TelemetrySystem_Subscriptions_Dynamic_Subscription.
	Subscription []*TelemetrySystem_Subscriptions_Dynamic_Subscription
}

TelemetrySystem_Subscriptions_Dynamic This container holds information relating to dynamic telemetry subscriptions. A dynamic subscription is typically configured through an RPC channel, and does not persist across device restarts, or if the RPC channel is reset or otherwise torn down.

func (*TelemetrySystem_Subscriptions_Dynamic) GetEntityData 

func (dynamic *TelemetrySystem_Subscriptions_Dynamic) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Dynamic_Subscription 

type TelemetrySystem_Subscriptions_Dynamic_Subscription struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the identifier of the subscription
	// itself. The id will be the handle to refer to the subscription once
	// created. The type is string with range: 0..18446744073709551615. Refers to
	// telemetry.TelemetrySystem_Subscriptions_Dynamic_Subscription_State_SubscriptionId
	SubscriptionId interface{}

	// State information relating to dynamic telemetry subscriptions.
	State TelemetrySystem_Subscriptions_Dynamic_Subscription_State

	// Top level container to hold a set of sensor paths grouped together.
	SensorPaths TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths
}

TelemetrySystem_Subscriptions_Dynamic_Subscription List representation of telemetry subscriptions that are configured via an inline RPC, otherwise known as dynamic telemetry subscriptions.

func (*TelemetrySystem_Subscriptions_Dynamic_Subscription) GetEntityData 

func (subscription *TelemetrySystem_Subscriptions_Dynamic_Subscription) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths 

type TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of paths in the model which together comprise a sensor grouping.
	// Filters for each path to exclude items are also provided. The type is slice
	// of
	// TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath.
	SensorPath []*TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath
}

TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths Top level container to hold a set of sensor paths grouped together

func (*TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths) GetEntityData 

func (sensorPaths *TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath 

type TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the path of interest. The type is
	// string. Refers to
	// telemetry.TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State_Path
	Path interface{}

	// State information for a dynamic subscription's paths of interest.
	State TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State
}

TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath List of paths in the model which together comprise a sensor grouping. Filters for each path to exclude items are also provided.

func (*TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath) GetEntityData 

func (sensorPath *TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State 

type TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Path to a section of operational state of interest (the sensor). The type
	// is string.
	Path interface{}

	// Filter to exclude certain values out of the state values. The type is
	// string.
	ExcludeFilter interface{}
}

TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State State information for a dynamic subscription's paths of interest

func (*TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State) GetEntityData 

func (state *TelemetrySystem_Subscriptions_Dynamic_Subscription_SensorPaths_SensorPath_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Dynamic_Subscription_State 

type TelemetrySystem_Subscriptions_Dynamic_Subscription_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Identifer of the telemetry subscription. Will be used by configuration
	// operations needing to modify or delete the telemetry subscription. The type
	// is interface{} with range: 0..18446744073709551615.
	SubscriptionId interface{}

	// IP address of the telemetry stream destination. The type is one of the
	// following types: string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.
	DestinationAddress interface{}

	// Protocol (udp or tcp) port number for the telemetry stream destination. The
	// type is interface{} with range: 0..65535.
	DestinationPort interface{}

	// Protocol used to transmit telemetry data to the collector. The type is
	// TelemetryStreamProtocol.
	DestinationProtocol interface{}

	// Time in milliseconds between the device's sample of a telemetry data
	// source. For example, setting this to 100 would require the local device to
	// collect the telemetry data every 100 milliseconds. There can be latency or
	// jitter in transmitting the data, but the sample must occur at the specified
	// interval.  The timestamp must reflect the actual time when the data was
	// sampled, not simply the previous sample timestamp + sample-interval.  If
	// sample-interval is set to 0, the telemetry sensor becomes event based. The
	// sensor must then emit data upon every change of the underlying data source.
	// The type is interface{} with range: 0..18446744073709551615.
	SampleInterval interface{}

	// Maximum time interval in seconds that may pass between updates from a
	// device to a telemetry collector. If this interval expires, but there is no
	// updated data to send (such as if suppress_updates has been configured), the
	// device must send a telemetry message to the collector. The type is
	// interface{} with range: 0..18446744073709551615.
	HeartbeatInterval interface{}

	// Boolean flag to control suppression of redundant telemetry updates to the
	// collector platform. If this flag is set to TRUE, then the collector will
	// only send an update at the configured interval if a subscribed data value
	// has changed. Otherwise, the device will not send an update to the collector
	// until expiration of the heartbeat interval. The type is bool.
	SuppressRedundant interface{}

	// DSCP marking of packets generated by the telemetry subsystem on the network
	// device. The type is interface{} with range: 0..63.
	OriginatedQosMarking interface{}
}

TelemetrySystem_Subscriptions_Dynamic_Subscription_State State information relating to dynamic telemetry subscriptions.

func (*TelemetrySystem_Subscriptions_Dynamic_Subscription_State) GetEntityData 

func (state *TelemetrySystem_Subscriptions_Dynamic_Subscription_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent 

type TelemetrySystem_Subscriptions_Persistent struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of telemetry subscriptions. A telemetry subscription consists of a set
	// of collection destinations, stream attributes, and associated paths to
	// state information in the model (sensor data). The type is slice of
	// TelemetrySystem_Subscriptions_Persistent_Subscription.
	Subscription []*TelemetrySystem_Subscriptions_Persistent_Subscription
}

TelemetrySystem_Subscriptions_Persistent This container holds information relating to persistent telemetry subscriptions. A persistent telemetry subscription is configued locally on the device through configuration, and is persistent across device restarts or other redundancy changes.

func (*TelemetrySystem_Subscriptions_Persistent) GetEntityData 

func (persistent *TelemetrySystem_Subscriptions_Persistent) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription 

type TelemetrySystem_Subscriptions_Persistent_Subscription struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the identifier of the subscription
	// itself. The id will be the handle to refer to the subscription once
	// created. The type is string with range: 0..18446744073709551615. Refers to
	// telemetry.TelemetrySystem_Subscriptions_Persistent_Subscription_Config_SubscriptionId
	SubscriptionId interface{}

	// Config parameters relating to the telemetry subscriptions on the local
	// device.
	Config TelemetrySystem_Subscriptions_Persistent_Subscription_Config

	// State parameters relating to the telemetry subscriptions on the local
	// device.
	State TelemetrySystem_Subscriptions_Persistent_Subscription_State

	// A sensor profile is a set of sensor groups or individual sensor paths which
	// are associated with a telemetry subscription. This is the source of the
	// telemetry data for the subscription to send to the defined collectors.
	SensorProfiles TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles

	// A subscription may specify destination addresses. If the subscription
	// supplies destination addresses, the network element will be the initiator
	// of the telemetry streaming, sending it to the destination(s) specified.  If
	// the destination set is omitted, the subscription preconfigures certain
	// elements such as paths and sample intervals under a specified subscription
	// ID. In this case, the network element will NOT initiate an outbound
	// connection for telemetry, but will wait for an inbound connection from a
	// network management system.  It is expected that the network management
	// system connecting to the network element will reference the preconfigured
	// subscription ID when initiating a subscription.
	DestinationGroups TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups
}

TelemetrySystem_Subscriptions_Persistent_Subscription List of telemetry subscriptions. A telemetry subscription consists of a set of collection destinations, stream attributes, and associated paths to state information in the model (sensor data)

func (*TelemetrySystem_Subscriptions_Persistent_Subscription) GetEntityData 

func (subscription *TelemetrySystem_Subscriptions_Persistent_Subscription) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_Config 

type TelemetrySystem_Subscriptions_Persistent_Subscription_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Identifer of the telemetry subscription. Will be used by configuration
	// operations needing to modify or delete the telemetry subscription. The type
	// is interface{} with range: 0..18446744073709551615.
	SubscriptionId interface{}

	// The IP address which will be the source of packets from the device to a
	// telemetry collector destination. The type is one of the following types:
	// string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.
	LocalSourceAddress interface{}

	// DSCP marking of packets generated by the telemetry subsystem on the network
	// device. The type is interface{} with range: 0..63.
	OriginatedQosMarking interface{}
}

TelemetrySystem_Subscriptions_Persistent_Subscription_Config Config parameters relating to the telemetry subscriptions on the local device

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_Config) GetEntityData 

func (config *TelemetrySystem_Subscriptions_Persistent_Subscription_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups 

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Identifier of the previously defined destination group. The type is slice
	// of
	// TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup.
	DestinationGroup []*TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup
}

TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups A subscription may specify destination addresses. If the subscription supplies destination addresses, the network element will be the initiator of the telemetry streaming, sending it to the destination(s) specified.

If the destination set is omitted, the subscription preconfigures certain elements such as paths and sample intervals under a specified subscription ID. In this case, the network element will NOT initiate an outbound connection for telemetry, but will wait for an inbound connection from a network management system.

It is expected that the network management system connecting to the network element will reference the preconfigured subscription ID when initiating a subscription.

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups) GetEntityData 

func (destinationGroups *TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup 

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The destination group id references a configured
	// group of destinations for the telemetry stream. The type is string. Refers
	// to
	// telemetry.TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config_GroupId
	GroupId interface{}

	// Configuration parameters related to telemetry destinations.
	Config TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config

	// State information related to telemetry destinations.
	State TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_State
}

TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup Identifier of the previously defined destination group

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup) GetEntityData 

func (destinationGroup *TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config 

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The destination group id references a reusable group of destination
	// addresses and ports for the telemetry stream. The type is string. Refers to
	// telemetry.TelemetrySystem_DestinationGroups_DestinationGroup_GroupId
	GroupId interface{}
}

TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config Configuration parameters related to telemetry destinations.

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config) GetEntityData 

func (config *TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_State 

type TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The destination group id references a reusable group of destination
	// addresses and ports for the telemetry stream. The type is string. Refers to
	// telemetry.TelemetrySystem_DestinationGroups_DestinationGroup_GroupId
	GroupId interface{}
}

TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_State State information related to telemetry destinations

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_State) GetEntityData 

func (state *TelemetrySystem_Subscriptions_Persistent_Subscription_DestinationGroups_DestinationGroup_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles 

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of telemetry sensor groups used in the subscription. The type is slice
	// of
	// TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile.
	SensorProfile []*TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile
}

TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles A sensor profile is a set of sensor groups or individual sensor paths which are associated with a telemetry subscription. This is the source of the telemetry data for the subscription to send to the defined collectors.

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles) GetEntityData 

func (sensorProfiles *TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile 

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the telemetry sensor group name. The
	// type is string. Refers to
	// telemetry.TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config_SensorGroup
	SensorGroup interface{}

	// Configuration parameters related to the sensor profile for a subscription.
	Config TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config

	// State information relating to the sensor profile for a subscription.
	State TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_State
}

TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile List of telemetry sensor groups used in the subscription

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile) GetEntityData 

func (sensorProfile *TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config 

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Reference to the sensor group which is used in the profile. The type is
	// string. Refers to
	// telemetry.TelemetrySystem_SensorGroups_SensorGroup_Config_SensorGroupId
	SensorGroup interface{}

	// Time in milliseconds between the device's sample of a telemetry data
	// source. For example, setting this to 100 would require the local device to
	// collect the telemetry data every 100 milliseconds. There can be latency or
	// jitter in transmitting the data, but the sample must occur at the specified
	// interval.  The timestamp must reflect the actual time when the data was
	// sampled, not simply the previous sample timestamp + sample-interval.  If
	// sample-interval is set to 0, the telemetry sensor becomes event based. The
	// sensor must then emit data upon every change of the underlying data source.
	// The type is interface{} with range: 0..18446744073709551615.
	SampleInterval interface{}

	// Maximum time interval in seconds that may pass between updates from a
	// device to a telemetry collector. If this interval expires, but there is no
	// updated data to send (such as if suppress_updates has been configured), the
	// device must send a telemetry message to the collector. The type is
	// interface{} with range: 0..18446744073709551615.
	HeartbeatInterval interface{}

	// Boolean flag to control suppression of redundant telemetry updates to the
	// collector platform. If this flag is set to TRUE, then the collector will
	// only send an update at the configured interval if a subscribed data value
	// has changed. Otherwise, the device will not send an update to the collector
	// until expiration of the heartbeat interval. The type is bool.
	SuppressRedundant interface{}
}

TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config Configuration parameters related to the sensor profile for a subscription

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config) GetEntityData 

func (config *TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_Config) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_State 

type TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Reference to the sensor group which is used in the profile. The type is
	// string. Refers to
	// telemetry.TelemetrySystem_SensorGroups_SensorGroup_Config_SensorGroupId
	SensorGroup interface{}

	// Time in milliseconds between the device's sample of a telemetry data
	// source. For example, setting this to 100 would require the local device to
	// collect the telemetry data every 100 milliseconds. There can be latency or
	// jitter in transmitting the data, but the sample must occur at the specified
	// interval.  The timestamp must reflect the actual time when the data was
	// sampled, not simply the previous sample timestamp + sample-interval.  If
	// sample-interval is set to 0, the telemetry sensor becomes event based. The
	// sensor must then emit data upon every change of the underlying data source.
	// The type is interface{} with range: 0..18446744073709551615.
	SampleInterval interface{}

	// Maximum time interval in seconds that may pass between updates from a
	// device to a telemetry collector. If this interval expires, but there is no
	// updated data to send (such as if suppress_updates has been configured), the
	// device must send a telemetry message to the collector. The type is
	// interface{} with range: 0..18446744073709551615.
	HeartbeatInterval interface{}

	// Boolean flag to control suppression of redundant telemetry updates to the
	// collector platform. If this flag is set to TRUE, then the collector will
	// only send an update at the configured interval if a subscribed data value
	// has changed. Otherwise, the device will not send an update to the collector
	// until expiration of the heartbeat interval. The type is bool.
	SuppressRedundant interface{}
}

TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_State State information relating to the sensor profile for a subscription

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_State) GetEntityData 

func (state *TelemetrySystem_Subscriptions_Persistent_Subscription_SensorProfiles_SensorProfile_State) GetEntityData() *types.CommonEntityData

type TelemetrySystem_Subscriptions_Persistent_Subscription_State 

type TelemetrySystem_Subscriptions_Persistent_Subscription_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Identifer of the telemetry subscription. Will be used by configuration
	// operations needing to modify or delete the telemetry subscription. The type
	// is interface{} with range: 0..18446744073709551615.
	SubscriptionId interface{}

	// The IP address which will be the source of packets from the device to a
	// telemetry collector destination. The type is one of the following types:
	// string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.
	LocalSourceAddress interface{}

	// DSCP marking of packets generated by the telemetry subsystem on the network
	// device. The type is interface{} with range: 0..63.
	OriginatedQosMarking interface{}
}

TelemetrySystem_Subscriptions_Persistent_Subscription_State State parameters relating to the telemetry subscriptions on the local device

func (*TelemetrySystem_Subscriptions_Persistent_Subscription_State) GetEntityData 

func (state *TelemetrySystem_Subscriptions_Persistent_Subscription_State) GetEntityData() *types.CommonEntityData

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.