mdt_oper

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

This module contains a collection of YANG definitions for operational data of streaming telemetry. Copyright (c) 2016-2018 by Cisco Systems, Inc. All rights reserved.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MdtConState

type MdtConState string

MdtConState represents Connection states.

const (
	// The connection is active and usable.
	MdtConState_con_state_active MdtConState = "con-state-active"

	// An attempt is being made to set the connection up.
	MdtConState_con_state_connecting MdtConState = "con-state-connecting"

	// The connection is down, but between connection
	// attempts. It is in this state, for example, during
	// the idle time between retries.
	MdtConState_con_state_pending MdtConState = "con-state-pending"

	// The connection is the process of being disconnected.
	MdtConState_con_state_disconnecting MdtConState = "con-state-disconnecting"
)

type MdtOperData

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

	// MDT streams table. The list of supported streams.
	MdtStreams MdtOperData_MdtStreams

	// MDT subscription operational data. The type is slice of
	// MdtOperData_MdtSubscriptions.
	MdtSubscriptions []*MdtOperData_MdtSubscriptions

	// MDT subscription connection operational data. The type is slice of
	// MdtOperData_MdtConnections.
	MdtConnections []*MdtOperData_MdtConnections
}

MdtOperData MDT operational data.

func (*MdtOperData) GetEntityData

func (mdtOperData *MdtOperData) GetEntityData() *types.CommonEntityData

type MdtOperData_MdtConnections

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

	// This attribute is a key. IP address. 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}]+)?.
	Address interface{}

	// This attribute is a key. Network port. The type is interface{} with range:
	// 0..65535.
	Port interface{}

	// This attribute is a key. Network instance name for the VRF that the
	// connection originates from. The type is string.
	SourceVrf interface{}

	// This attribute is a key. The source address used for the connection. 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}]+)?.
	SourceAddress interface{}

	// Transport protocol on this connection See transport-protocol from
	// subscribed-notifications for possible values. The type is string.
	Transport interface{}

	// Identity of the peer at the other end of the connection. May be empty,
	// depending on connection state. The type is string.
	PeerId interface{}

	// Connection state. The type is MdtConState.
	State interface{}

	// Protocol profile used with this connection. The type is string.
	Profile interface{}

	// List of subscription specific statistics for this connection. The type is
	// slice of MdtOperData_MdtConnections_MdtSubConStats.
	MdtSubConStats []*MdtOperData_MdtConnections_MdtSubConStats
}

MdtOperData_MdtConnections MDT subscription connection operational data.

func (*MdtOperData_MdtConnections) GetEntityData

func (mdtConnections *MdtOperData_MdtConnections) GetEntityData() *types.CommonEntityData

type MdtOperData_MdtConnections_MdtSubConStats

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

	// This attribute is a key. Subscription identifier. The type is interface{}
	// with range: 0..4294967295.
	SubId interface{}

	// Number of update notifications sent to the receiver using this
	// subscription. The type is interface{} with range: 0..18446744073709551615.
	UpdatesSent interface{}

	// Number of dropped update notifications due to error or events not in other
	// counters using this subscription. The type is interface{} with range:
	// 0..18446744073709551615.
	UpdatesDropped interface{}
}

MdtOperData_MdtConnections_MdtSubConStats List of subscription specific statistics for this connection.

func (*MdtOperData_MdtConnections_MdtSubConStats) GetEntityData

func (mdtSubConStats *MdtOperData_MdtConnections_MdtSubConStats) GetEntityData() *types.CommonEntityData

type MdtOperData_MdtStreams

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

	// Name of a supported stream. The type is slice of string.
	Stream []interface{}
}

MdtOperData_MdtStreams MDT streams table. The list of supported streams.

func (*MdtOperData_MdtStreams) GetEntityData

func (mdtStreams *MdtOperData_MdtStreams) GetEntityData() *types.CommonEntityData

type MdtOperData_MdtSubscriptions

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

	// This attribute is a key. Unique subscription identifier. The type is
	// interface{} with range: 0..4294967295.
	SubscriptionId interface{}

	// Subscription type. The type is MdtSubType.
	Type interface{}

	// Subscription state. The type is MdtSubState.
	State interface{}

	// Comments related to subcription state. The type is string.
	Comments interface{}

	// Number of updates received from sensors as candidates for notifications.
	// The type is interface{} with range: 0..18446744073709551615.
	UpdatesIn interface{}

	// Number of updates dropped due to dampening. The type is interface{} with
	// range: 0..18446744073709551615.
	UpdatesDampened interface{}

	// Number of updates dropped to other causes. The type is interface{} with
	// range: 0..18446744073709551615.
	UpdatesDropped interface{}

	// Common subscription information.
	Base MdtOperData_MdtSubscriptions_Base

	// List of MDT receivers. The type is slice of
	// MdtOperData_MdtSubscriptions_MdtReceivers.
	MdtReceivers []*MdtOperData_MdtSubscriptions_MdtReceivers
}

MdtOperData_MdtSubscriptions MDT subscription operational data.

func (*MdtOperData_MdtSubscriptions) GetEntityData

func (mdtSubscriptions *MdtOperData_MdtSubscriptions) GetEntityData() *types.CommonEntityData

type MdtOperData_MdtSubscriptions_Base

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

	// The name of the event stream being subscribed to. The type is string. The
	// default value is NETCONF.
	Stream interface{}

	// Update notification encoding. The type is string. The default value is
	// encode-xml.
	Encoding interface{}

	// Network instance name for the VRF. The type is string.
	SourceVrf interface{}

	// The source address for the notifications. 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}]+)?.
	SourceAddress interface{}

	// Placeholder for unset value. The type is interface{} with range:
	// 0..4294967295. The default value is 0.
	NoTrigger interface{}

	// Period of update notifications in 100ths of a second. The type is
	// interface{} with range: 0..4294967295. This attribute is mandatory. Units
	// are centiseconds.
	Period interface{}

	// If true, there is no initial update notification with the current value of
	// all the data. NOT CURRENTLY SUPPORTED. If specified, must be false. The
	// type is bool.
	NoSynchOnStart interface{}

	// Placeholder for unset value. The type is interface{} with range:
	// 0..4294967295. The default value is 0.
	NoFilter interface{}

	// XPath expression describing the set of objects wanted as part of the
	// subscription. The type is string.
	Xpath interface{}

	// TDL-URI expression describing the set of objects wanted as part of the
	// subscription. The type is string.
	TdlUri interface{}

	// Transform name is the reference to  tdl transform scheme. The type is
	// string.
	TransformName interface{}
}

MdtOperData_MdtSubscriptions_Base Common subscription information.

func (*MdtOperData_MdtSubscriptions_Base) GetEntityData

type MdtOperData_MdtSubscriptions_MdtReceivers

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

	// This attribute is a key. IP address of the receiver. 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}]+)?
	// This attribute is mandatory., 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}]+)?
	// This attribute is mandatory..
	Address interface{}

	// This attribute is a key. Network port of the receiver. The type is
	// interface{} with range: 0..65535. This attribute is mandatory.
	Port interface{}

	// Receiver transport protocol. The type is string.
	Protocol interface{}

	// Receiver state. The type is MdtReceiverState.
	State interface{}

	// Comments related to receiver state. The type is string.
	Comments interface{}

	// Receiver's protocol profile name. The type is string.
	Profile interface{}
}

MdtOperData_MdtSubscriptions_MdtReceivers List of MDT receivers.

func (*MdtOperData_MdtSubscriptions_MdtReceivers) GetEntityData

func (mdtReceivers *MdtOperData_MdtSubscriptions_MdtReceivers) GetEntityData() *types.CommonEntityData

type MdtReceiverState

type MdtReceiverState string

MdtReceiverState represents Receiver states.

const (
	// The receiver configuration is invalid and
	// cannot be used.
	MdtReceiverState_rcvr_state_invalid MdtReceiverState = "rcvr-state-invalid"

	// The receiver is disconnected and there is no
	// attempt being made to connect to it.
	MdtReceiverState_rcvr_state_disconnected MdtReceiverState = "rcvr-state-disconnected"

	// An attempt is being made to connect to the receiver.
	MdtReceiverState_rcvr_state_connecting MdtReceiverState = "rcvr-state-connecting"

	// The receiver is connected, and update notifications
	// are being sent to the receiver when they occur
	MdtReceiverState_rcvr_state_connected MdtReceiverState = "rcvr-state-connected"
)

type MdtSubState

type MdtSubState string

MdtSubState represents Subscription states

const (
	// The subscription is valid and may be sending updates.
	MdtSubState_sub_state_valid MdtSubState = "sub-state-valid"

	// The subscription has been suspended and is not
	// sending notifications even if there are updates.
	MdtSubState_sub_state_suspended MdtSubState = "sub-state-suspended"

	// The subscription is terminated. This state is valid
	// only for static subscriptions.
	MdtSubState_sub_state_terminated MdtSubState = "sub-state-terminated"

	// The subscription is invalid. This state is valid
	// only for static subscriptions.
	MdtSubState_sub_state_invalid MdtSubState = "sub-state-invalid"
)

type MdtSubType

type MdtSubType string

MdtSubType represents Subscription types

const (
	// Dynamic subscriptions
	// -do not survive reboot
	// -existence tied to connection they are created on
	// -send updates only to peer that creates them
	MdtSubType_sub_type_dynamic MdtSubType = "sub-type-dynamic"

	// Static subscriptions
	// -created, (modified), and deleted by management operations
	// -survive reboot
	// -receivers are configured
	MdtSubType_sub_type_static MdtSubType = "sub-type-static"

	// Permanent subscriptions
	// -created during system startup, can not be modified
	MdtSubType_sub_type_permanent MdtSubType = "sub-type-permanent"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL