terminal_device

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 describes a terminal optics device model for managing the terminal systems (client and line side) in a DWDM transport network.

Elements of the model:

physical port: corresponds to a physical, pluggable client port on the terminal device. Examples includes 10G, 40G, 100G (e.g., 10x10G, 4x25G or 1x100G) and 400G/1T in the future. Physical client ports will have associated operational state or PMs.

physical channel: a physical lane or channel in the physical client port. Each physical client port has 1 or more channels. An example is 100GBASE-LR4 client physical port having 4x25G channels. Channels have their own optical PMs and can be monitored independently within a client physical port (e.g., channel power). Physical client channels are defined in the model as part of a physical client port, and are modeled primarily for reading their PMs.

logical channel: a logical grouping of logical grooming elements that may be assigned to subsequent grooming stages for multiplexing / de-multiplexing, or to an optical channel for line side transmission. The logical channels can represent, for example, an ODU/OTU logical packing of the client data onto the line side. Tributaries are similarly logical groupings of demand that can be represented in this structure and assigned to an optical channel. Note that different types of logical channels may be present, each with their corresponding PMs.

optical channel: corresponds to an optical carrier and is assigned a wavelength/frequency. Optical channels have PMs such as power, BER, and operational mode.

Directionality:

To maintain simplicity in the model, the configuration is described from client-to-line direction. The assumption is that equivalent reverse configuration is implicit, resulting in the same line-to-client configuration.

Physical layout:

The model does not assume a particular physical layout of client and line ports on the terminal device (e.g., such as number of ports per linecard, separate linecards for client and line ports, etc.).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type TerminalDevice 

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

	// Configuration data for global terminal-device.
	Config TerminalDevice_Config

	// Operational state data for global terminal device.
	State TerminalDevice_State

	// Enclosing container the list of logical channels.
	LogicalChannels TerminalDevice_LogicalChannels

	// Enclosing container for list of operational modes.
	OperationalModes TerminalDevice_OperationalModes
}

TerminalDevice Top-level container for the terminal device

func (*TerminalDevice) GetEntityData 

func (terminalDevice *TerminalDevice) GetEntityData() *types.CommonEntityData

type TerminalDevice_Config 

type TerminalDevice_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
}

TerminalDevice_Config Configuration data for global terminal-device

func (*TerminalDevice_Config) GetEntityData 

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

type TerminalDevice_LogicalChannels 

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

	// List of logical channels. The type is slice of
	// TerminalDevice_LogicalChannels_Channel.
	Channel []*TerminalDevice_LogicalChannels_Channel
}

TerminalDevice_LogicalChannels Enclosing container the list of logical channels

func (*TerminalDevice_LogicalChannels) GetEntityData 

func (logicalChannels *TerminalDevice_LogicalChannels) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel 

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

	// This attribute is a key. Reference to the index of the logical channel. The
	// type is string with range: 0..4294967295. Refers to
	// terminal_device.TerminalDevice_LogicalChannels_Channel_Config_Index
	Index interface{}

	// Configuration data for logical channels.
	Config TerminalDevice_LogicalChannels_Channel_Config

	// Operational state data for logical channels.
	State TerminalDevice_LogicalChannels_Channel_State

	// Top level container for OTU configuration when logical channel framing is
	// using an OTU protocol, e.g., OTU1, OTU3, etc.
	Otn TerminalDevice_LogicalChannels_Channel_Otn

	// Top level container for data related to Ethernet framing for the logical
	// channel.
	Ethernet TerminalDevice_LogicalChannels_Channel_Ethernet

	// Top-level container for specifying references to the source of signal for
	// the logical channel, either a transceiver or individual physical channels.
	Ingress TerminalDevice_LogicalChannels_Channel_Ingress

	// Enclosing container for tributary assignments.
	LogicalChannelAssignments TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments
}

TerminalDevice_LogicalChannels_Channel List of logical channels

func (*TerminalDevice_LogicalChannels_Channel) GetEntityData 

func (channel *TerminalDevice_LogicalChannels_Channel) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Config 

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

	// Index of the current logical channel. The type is interface{} with range:
	// 0..4294967295.
	Index interface{}

	// Description of the logical channel. The type is string.
	Description interface{}

	// Sets the admin state of the logical channel. The type is AdminStateType.
	AdminState interface{}

	// Rounded bit rate of the tributary signal. Exact bit rate will be refined by
	// protocol selection. The type is one of the following:
	// TRIBRATE10GTRIBRATE40GTRIBRATE100GTRIBRATE1GTRIBRATE2DOT5G.
	RateClass interface{}

	// Protocol framing of the tributary signal. If this LogicalChannel is
	// directly connected to a Client-Port or Optical-Channel, this is the
	// protocol of the associated port. If the LogicalChannel is connected to
	// other LogicalChannels, the TributaryProtocol of the LogicalChannels will
	// define a specific mapping/demapping or multiplexing/demultiplexing
	// function.  Not all protocols are valid, depending on the value of
	// trib-rate-class.  The expectation is that the NMS will validate that a
	// correct combination of rate class and protocol are specfied.  Basic
	// combinations are:  rate class: 1G protocols: 1GE  rate class: 2.5G
	// protocols: OC48, STM16  rate class: 10G protocols:  10GE LAN, 10GE WAN,
	// OC192, STM64, OTU2, OTU2e,            OTU1e, ODU2, ODU2e, ODU1e  rate
	// class: 40G protocols:  40GE, OC768, STM256, OTU3, ODU3  rate class: 100G
	// protocols:  100GE, 100G MLG, OTU4, OTUCn, ODU4. The type is one of the
	// following:
	// PROTOTU2EPROTODU2EPROTOC768PROT10GEWANPROTSTM16PROTOTUCNPROT1GEPROT100GEPROTOTU3PROTOTU2PROTOTU4PROTSTM256PROT10GELANPROTOC48PROTOC192PROT40GEPROT100GMLGPROTODU3PROTODU2PROTODU4PROTSTM64PROTOTU1E.
	TribProtocol interface{}

	// The type / stage of the logical element determines the configuration and
	// operational state parameters (PMs) available for the logical element. The
	// type is one of the following: PROTETHERNETPROTOTN.
	LogicalChannelType interface{}

	// Sets the loopback type on the logical channel. Setting the mode to
	// something besides NONE activates the loopback in the specified mode. The
	// type is LoopbackModeType.
	LoopbackMode interface{}
}

TerminalDevice_LogicalChannels_Channel_Config Configuration data for logical channels

func (*TerminalDevice_LogicalChannels_Channel_Config) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_Ethernet 

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

	// Configuration data for Ethernet protocol framing on logical channels.
	Config TerminalDevice_LogicalChannels_Channel_Ethernet_Config

	// Operational state data for Ethernet protocol framing on logical channels.
	State TerminalDevice_LogicalChannels_Channel_Ethernet_State
}

TerminalDevice_LogicalChannels_Channel_Ethernet Top level container for data related to Ethernet framing for the logical channel

func (*TerminalDevice_LogicalChannels_Channel_Ethernet) GetEntityData 

func (ethernet *TerminalDevice_LogicalChannels_Channel_Ethernet) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Ethernet_Config 

type TerminalDevice_LogicalChannels_Channel_Ethernet_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
}

TerminalDevice_LogicalChannels_Channel_Ethernet_Config Configuration data for Ethernet protocol framing on logical channels

func (*TerminalDevice_LogicalChannels_Channel_Ethernet_Config) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_Ethernet_State 

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

	// MAC layer control frames received on the interface. The type is interface{}
	// with range: 0..18446744073709551615.
	InMacControlFrames interface{}

	// MAC layer PAUSE frames received on the interface. The type is interface{}
	// with range: 0..18446744073709551615.
	InMacPauseFrames interface{}

	// Number of oversize frames received on the interface. The type is
	// interface{} with range: 0..18446744073709551615.
	InOversizeFrames interface{}

	// Number of jabber frames received on the interface.  Jabber frames are
	// typically defined as oversize frames which also have a bad CRC.
	// Implementations may use slightly different definitions of what constitutes
	// a jabber frame.  Often indicative of a NIC hardware problem. The type is
	// interface{} with range: 0..18446744073709551615.
	InJabberFrames interface{}

	// Number of fragment frames received on the interface. The type is
	// interface{} with range: 0..18446744073709551615.
	InFragmentFrames interface{}

	// Number of 802.1q tagged frames received on the interface. The type is
	// interface{} with range: 0..18446744073709551615.
	In8021qFrames interface{}

	// Number of receive error events due to FCS/CRC check failure. The type is
	// interface{} with range: 0..18446744073709551615.
	InCrcErrors interface{}

	// MAC layer control frames sent on the interface. The type is interface{}
	// with range: 0..18446744073709551615.
	OutMacControlFrames interface{}

	// MAC layer PAUSE frames sent on the interface. The type is interface{} with
	// range: 0..18446744073709551615.
	OutMacPauseFrames interface{}

	// Number of 802.1q tagged frames sent on the interface. The type is
	// interface{} with range: 0..18446744073709551615.
	Out8021qFrames interface{}
}

TerminalDevice_LogicalChannels_Channel_Ethernet_State Operational state data for Ethernet protocol framing on logical channels

func (*TerminalDevice_LogicalChannels_Channel_Ethernet_State) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_Ingress 

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

	// Configuration data for the signal source for the logical channel.
	Config TerminalDevice_LogicalChannels_Channel_Ingress_Config

	// Operational state data for the signal source for the logical channel.
	State TerminalDevice_LogicalChannels_Channel_Ingress_State
}

TerminalDevice_LogicalChannels_Channel_Ingress Top-level container for specifying references to the source of signal for the logical channel, either a transceiver or individual physical channels

func (*TerminalDevice_LogicalChannels_Channel_Ingress) GetEntityData 

func (ingress *TerminalDevice_LogicalChannels_Channel_Ingress) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Ingress_Config 

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

	// Reference to the transceiver carrying the input signal for the logical
	// channel.  If specific physical channels are mapped to the logical channel
	// (as opposed to all physical channels carried by the transceiver), they can
	// be specified in the list of physical channel references. The type is
	// string. Refers to platform.Components_Component_Name
	Transceiver interface{}

	// This list should be populated with references to the client physical
	// channels that feed this logical channel from the transceiver specified in
	// the 'transceiver' leaf, which must be specified.  If this leaf-list is
	// empty, all physical channels in the transceiver are assumed to be mapped to
	// the logical channel. The type is slice of string with range: 0..65535.
	// Refers to
	// platform.Components_Component_Transceiver_PhysicalChannels_Channel_Index
	PhysicalChannel []interface{}
}

TerminalDevice_LogicalChannels_Channel_Ingress_Config Configuration data for the signal source for the logical channel

func (*TerminalDevice_LogicalChannels_Channel_Ingress_Config) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_Ingress_State 

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

	// Reference to the transceiver carrying the input signal for the logical
	// channel.  If specific physical channels are mapped to the logical channel
	// (as opposed to all physical channels carried by the transceiver), they can
	// be specified in the list of physical channel references. The type is
	// string. Refers to platform.Components_Component_Name
	Transceiver interface{}

	// This list should be populated with references to the client physical
	// channels that feed this logical channel from the transceiver specified in
	// the 'transceiver' leaf, which must be specified.  If this leaf-list is
	// empty, all physical channels in the transceiver are assumed to be mapped to
	// the logical channel. The type is slice of string with range: 0..65535.
	// Refers to
	// platform.Components_Component_Transceiver_PhysicalChannels_Channel_Index
	PhysicalChannel []interface{}
}

TerminalDevice_LogicalChannels_Channel_Ingress_State Operational state data for the signal source for the logical channel

func (*TerminalDevice_LogicalChannels_Channel_Ingress_State) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments 

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

	// Logical channel elements may be assigned directly to optical channels for
	// line-side transmission, or can be further groomed into additional stages of
	// logical channel elements.  The grooming can multiplex (i.e., split the
	// current element into multiple elements in the subsequent stage) or
	// de-multiplex (i.e., combine the current element with other elements into
	// the same element in the subsequent stage) logical elements in each stage.
	// Note that to support the ability to groom the logical elements, the list of
	// logical channel elements should be populated with an entry for the logical
	// elements at each stage, starting with the initial assignment from the
	// respective client physical port.  Each logical element assignment consists
	// of a pointer to an element in the next stage, or to an optical channel,
	// along with a bandwidth allocation for the corresponding assignment (e.g.,
	// to split or combine signal). The type is slice of
	// TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment.
	Assignment []*TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment
}

TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments Enclosing container for tributary assignments

func (*TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments) GetEntityData 

func (logicalChannelAssignments *TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment 

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

	// This attribute is a key. Reference to the index for the current tributary
	// assignment. The type is string with range: 0..4294967295. Refers to
	// terminal_device.TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_Index
	Index interface{}

	// Configuration data for tributary assignments.
	Config TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config

	// Operational state data for tributary assignments.
	State TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State
}

TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment Logical channel elements may be assigned directly to optical channels for line-side transmission, or can be further groomed into additional stages of logical channel elements. The grooming can multiplex (i.e., split the current element into multiple elements in the subsequent stage) or de-multiplex (i.e., combine the current element with other elements into the same element in the subsequent stage) logical elements in each stage.

Note that to support the ability to groom the logical elements, the list of logical channel elements should be populated with an entry for the logical elements at each stage, starting with the initial assignment from the respective client physical port.

Each logical element assignment consists of a pointer to an element in the next stage, or to an optical channel, along with a bandwidth allocation for the corresponding assignment (e.g., to split or combine signal).

func (*TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment) GetEntityData 

func (assignment *TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config 

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

	// Index of the current logical client channel to tributary mapping. The type
	// is interface{} with range: 0..4294967295.
	Index interface{}

	// Name assigned to the logical client channel. The type is string.
	Description interface{}

	// Each logical channel element may be assigned to subsequent stages of
	// logical elements to implement further grooming, or can be assigned to a
	// line-side optical channel for transmission.  Each assignment also has an
	// associated bandwidth allocation. The type is AssignmentType.
	AssignmentType interface{}

	// Reference to another stage of logical channel elements. The type is string
	// with range: 0..4294967295. Refers to
	// terminal_device.TerminalDevice_LogicalChannels_Channel_Index
	LogicalChannel interface{}

	// Reference to the line-side optical channel that should carry the current
	// logical channel element.  Use this reference to exit the logical element
	// stage. The type is string. Refers to platform.Components_Component_Name
	OpticalChannel interface{}

	// Allocation of the logical client channel to the tributary or sub-channel,
	// expressed in Gbps. The type is string with range:
	// -9223372036854775.808..9223372036854775.807. Units are Gbps.
	Allocation interface{}
}

TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config Configuration data for tributary assignments

func (*TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType 

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType string

TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType represents bandwidth allocation. 

const (
	// Subsequent channel is a logical channel
	TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType_LOGICAL_CHANNEL TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType = "LOGICAL_CHANNEL"

	// Subsequent channel is a optical channel / carrier
	TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType_OPTICAL_CHANNEL TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_Config_AssignmentType = "OPTICAL_CHANNEL"
)

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State 

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

	// Index of the current logical client channel to tributary mapping. The type
	// is interface{} with range: 0..4294967295.
	Index interface{}

	// Name assigned to the logical client channel. The type is string.
	Description interface{}

	// Each logical channel element may be assigned to subsequent stages of
	// logical elements to implement further grooming, or can be assigned to a
	// line-side optical channel for transmission.  Each assignment also has an
	// associated bandwidth allocation. The type is AssignmentType.
	AssignmentType interface{}

	// Reference to another stage of logical channel elements. The type is string
	// with range: 0..4294967295. Refers to
	// terminal_device.TerminalDevice_LogicalChannels_Channel_Index
	LogicalChannel interface{}

	// Reference to the line-side optical channel that should carry the current
	// logical channel element.  Use this reference to exit the logical element
	// stage. The type is string. Refers to platform.Components_Component_Name
	OpticalChannel interface{}

	// Allocation of the logical client channel to the tributary or sub-channel,
	// expressed in Gbps. The type is string with range:
	// -9223372036854775.808..9223372036854775.807. Units are Gbps.
	Allocation interface{}
}

TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State Operational state data for tributary assignments

func (*TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType 

type TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType string

TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType represents bandwidth allocation. 

const (
	// Subsequent channel is a logical channel
	TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType_LOGICAL_CHANNEL TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType = "LOGICAL_CHANNEL"

	// Subsequent channel is a optical channel / carrier
	TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType_OPTICAL_CHANNEL TerminalDevice_LogicalChannels_Channel_LogicalChannelAssignments_Assignment_State_AssignmentType = "OPTICAL_CHANNEL"
)

type TerminalDevice_LogicalChannels_Channel_Otn 

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

	// Configuration data for OTN protocol framing.
	Config TerminalDevice_LogicalChannels_Channel_Otn_Config

	// Operational state data for OTN protocol PMs, statistics, etc.
	State TerminalDevice_LogicalChannels_Channel_Otn_State
}

TerminalDevice_LogicalChannels_Channel_Otn Top level container for OTU configuration when logical channel framing is using an OTU protocol, e.g., OTU1, OTU3, etc.

func (*TerminalDevice_LogicalChannels_Channel_Otn) GetEntityData 

func (otn *TerminalDevice_LogicalChannels_Channel_Otn) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Otn_Config 

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

	// Trail trace identifier (TTI) message transmitted. The type is string.
	TtiMsgTransmit interface{}

	// Trail trace identifier (TTI) message expected. The type is string.
	TtiMsgExpected interface{}

	// Trail trace identifier (TTI) transmit message automatically created. If
	// True, then setting a custom transmit message would be invalid. The type is
	// bool.
	TtiMsgAuto interface{}
}

TerminalDevice_LogicalChannels_Channel_Otn_Config Configuration data for OTN protocol framing

func (*TerminalDevice_LogicalChannels_Channel_Otn_Config) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_Otn_State 

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

	// Trail trace identifier (TTI) message transmitted. The type is string.
	TtiMsgTransmit interface{}

	// Trail trace identifier (TTI) message expected. The type is string.
	TtiMsgExpected interface{}

	// Trail trace identifier (TTI) transmit message automatically created. If
	// True, then setting a custom transmit message would be invalid. The type is
	// bool.
	TtiMsgAuto interface{}

	// Trail trace identifier (TTI) message received. The type is string.
	TtiMsgRecv interface{}

	// Remote defect indication (RDI) message received. The type is string.
	RdiMsg interface{}

	// The number of seconds that at least one errored blocks occurs, at least one
	// code violation occurs, loss of sync is detected or loss of signal is
	// detected. The type is interface{} with range: 0..18446744073709551615.
	ErroredSeconds interface{}

	// The number of seconds that loss of frame is detected OR the number of
	// errored blocks, code violations, loss of sync or loss of signal is detected
	// exceeds a predefined threshold. The type is interface{} with range:
	// 0..18446744073709551615.
	SeverelyErroredSeconds interface{}

	// The number of seconds during which the link is unavailable. The type is
	// interface{} with range: 0..18446744073709551615.
	UnavailableSeconds interface{}

	// For ethernet or fiberchannel links, the number of 8b/10b coding violations.
	// For SONET/SDH, the number of BIP (bit interleaved parity) errors. The type
	// is interface{} with range: 0..18446744073709551615.
	CodeViolations interface{}

	// The number words that were uncorrectable by the FEC. The type is
	// interface{} with range: 0..18446744073709551615.
	FecUncorrectableWords interface{}

	// The number of bytes that were corrected by the FEC. The type is interface{}
	// with range: 0..18446744073709551615.
	FecCorrectedBytes interface{}

	// The number of bits that were corrected by the FEC. The type is interface{}
	// with range: 0..18446744073709551615.
	FecCorrectedBits interface{}

	// The number of background block errors. The type is interface{} with range:
	// 0..18446744073709551615.
	BackgroundBlockErrors interface{}

	// Bit error rate before forward error correction -- computed value.
	PreFecBer TerminalDevice_LogicalChannels_Channel_Otn_State_PreFecBer

	// Bit error rate after forward error correction -- computed value.
	PostFecBer TerminalDevice_LogicalChannels_Channel_Otn_State_PostFecBer

	// Quality value (factor) of a channel.
	QValue TerminalDevice_LogicalChannels_Channel_Otn_State_QValue

	// Electrical signal to noise ratio. Baud rate normalized signal to noise
	// ratio based on error vector magnitude.
	Esnr TerminalDevice_LogicalChannels_Channel_Otn_State_Esnr
}

TerminalDevice_LogicalChannels_Channel_Otn_State Operational state data for OTN protocol PMs, statistics, etc.

func (*TerminalDevice_LogicalChannels_Channel_Otn_State) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_Otn_State_Esnr 

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

	// The instantaneous value of the statistic. The type is string with range:
	// -922337203685477580.8..922337203685477580.7.
	Instant interface{}

	// The arithmetic mean value of the statistic over the sampling period. The
	// type is string with range: -922337203685477580.8..922337203685477580.7.
	Avg interface{}

	// The minimum value of the statistic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Min interface{}

	// The maximum value of the statitic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Max interface{}
}

TerminalDevice_LogicalChannels_Channel_Otn_State_Esnr Electrical signal to noise ratio. Baud rate normalized signal to noise ratio based on error vector magnitude

func (*TerminalDevice_LogicalChannels_Channel_Otn_State_Esnr) GetEntityData 

func (esnr *TerminalDevice_LogicalChannels_Channel_Otn_State_Esnr) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Otn_State_PostFecBer 

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

	// The instantaneous value of the statistic. The type is string with range:
	// -922337203685477580.8..922337203685477580.7.
	Instant interface{}

	// The arithmetic mean value of the statistic over the sampling period. The
	// type is string with range: -922337203685477580.8..922337203685477580.7.
	Avg interface{}

	// The minimum value of the statistic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Min interface{}

	// The maximum value of the statitic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Max interface{}
}

TerminalDevice_LogicalChannels_Channel_Otn_State_PostFecBer Bit error rate after forward error correction -- computed value

func (*TerminalDevice_LogicalChannels_Channel_Otn_State_PostFecBer) GetEntityData 

func (postFecBer *TerminalDevice_LogicalChannels_Channel_Otn_State_PostFecBer) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Otn_State_PreFecBer 

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

	// The instantaneous value of the statistic. The type is string with range:
	// -922337203685477580.8..922337203685477580.7.
	Instant interface{}

	// The arithmetic mean value of the statistic over the sampling period. The
	// type is string with range: -922337203685477580.8..922337203685477580.7.
	Avg interface{}

	// The minimum value of the statistic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Min interface{}

	// The maximum value of the statitic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Max interface{}
}

TerminalDevice_LogicalChannels_Channel_Otn_State_PreFecBer Bit error rate before forward error correction -- computed value

func (*TerminalDevice_LogicalChannels_Channel_Otn_State_PreFecBer) GetEntityData 

func (preFecBer *TerminalDevice_LogicalChannels_Channel_Otn_State_PreFecBer) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_Otn_State_QValue 

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

	// The instantaneous value of the statistic. The type is string with range:
	// -922337203685477580.8..922337203685477580.7.
	Instant interface{}

	// The arithmetic mean value of the statistic over the sampling period. The
	// type is string with range: -922337203685477580.8..922337203685477580.7.
	Avg interface{}

	// The minimum value of the statistic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Min interface{}

	// The maximum value of the statitic over the sampling period. The type is
	// string with range: -922337203685477580.8..922337203685477580.7.
	Max interface{}
}

TerminalDevice_LogicalChannels_Channel_Otn_State_QValue Quality value (factor) of a channel

func (*TerminalDevice_LogicalChannels_Channel_Otn_State_QValue) GetEntityData 

func (qValue *TerminalDevice_LogicalChannels_Channel_Otn_State_QValue) GetEntityData() *types.CommonEntityData

type TerminalDevice_LogicalChannels_Channel_State 

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

	// Index of the current logical channel. The type is interface{} with range:
	// 0..4294967295.
	Index interface{}

	// Description of the logical channel. The type is string.
	Description interface{}

	// Sets the admin state of the logical channel. The type is AdminStateType.
	AdminState interface{}

	// Rounded bit rate of the tributary signal. Exact bit rate will be refined by
	// protocol selection. The type is one of the following:
	// TRIBRATE10GTRIBRATE40GTRIBRATE100GTRIBRATE1GTRIBRATE2DOT5G.
	RateClass interface{}

	// Protocol framing of the tributary signal. If this LogicalChannel is
	// directly connected to a Client-Port or Optical-Channel, this is the
	// protocol of the associated port. If the LogicalChannel is connected to
	// other LogicalChannels, the TributaryProtocol of the LogicalChannels will
	// define a specific mapping/demapping or multiplexing/demultiplexing
	// function.  Not all protocols are valid, depending on the value of
	// trib-rate-class.  The expectation is that the NMS will validate that a
	// correct combination of rate class and protocol are specfied.  Basic
	// combinations are:  rate class: 1G protocols: 1GE  rate class: 2.5G
	// protocols: OC48, STM16  rate class: 10G protocols:  10GE LAN, 10GE WAN,
	// OC192, STM64, OTU2, OTU2e,            OTU1e, ODU2, ODU2e, ODU1e  rate
	// class: 40G protocols:  40GE, OC768, STM256, OTU3, ODU3  rate class: 100G
	// protocols:  100GE, 100G MLG, OTU4, OTUCn, ODU4. The type is one of the
	// following:
	// PROTOTU2EPROTODU2EPROTOC768PROT10GEWANPROTSTM16PROTOTUCNPROT1GEPROT100GEPROTOTU3PROTOTU2PROTOTU4PROTSTM256PROT10GELANPROTOC48PROTOC192PROT40GEPROT100GMLGPROTODU3PROTODU2PROTODU4PROTSTM64PROTOTU1E.
	TribProtocol interface{}

	// The type / stage of the logical element determines the configuration and
	// operational state parameters (PMs) available for the logical element. The
	// type is one of the following: PROTETHERNETPROTOTN.
	LogicalChannelType interface{}

	// Sets the loopback type on the logical channel. Setting the mode to
	// something besides NONE activates the loopback in the specified mode. The
	// type is LoopbackModeType.
	LoopbackMode interface{}

	// Link-state of the Ethernet protocol on the logical channel, SONET / SDH
	// framed signal, etc. The type is LinkState.
	LinkState interface{}
}

TerminalDevice_LogicalChannels_Channel_State Operational state data for logical channels

func (*TerminalDevice_LogicalChannels_Channel_State) GetEntityData 

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

type TerminalDevice_LogicalChannels_Channel_State_LinkState 

type TerminalDevice_LogicalChannels_Channel_State_LinkState string

TerminalDevice_LogicalChannels_Channel_State_LinkState represents SONET / SDH framed signal, etc. 

const (
	// Logical channel is operationally up
	TerminalDevice_LogicalChannels_Channel_State_LinkState_UP TerminalDevice_LogicalChannels_Channel_State_LinkState = "UP"

	// Logical channel is operationally down
	TerminalDevice_LogicalChannels_Channel_State_LinkState_DOWN TerminalDevice_LogicalChannels_Channel_State_LinkState = "DOWN"
)

type TerminalDevice_OperationalModes 

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

	// List of operational modes supported by the platform. The operational mode
	// provides a platform-defined summary of information such as symbol rate,
	// modulation, pulse shaping, etc. The type is slice of
	// TerminalDevice_OperationalModes_Mode.
	Mode []*TerminalDevice_OperationalModes_Mode
}

TerminalDevice_OperationalModes Enclosing container for list of operational modes

func (*TerminalDevice_OperationalModes) GetEntityData 

func (operationalModes *TerminalDevice_OperationalModes) GetEntityData() *types.CommonEntityData

type TerminalDevice_OperationalModes_Mode 

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

	// This attribute is a key. Reference to mode-id. The type is string with
	// range: 0..65535. Refers to
	// terminal_device.TerminalDevice_OperationalModes_Mode_State_ModeId
	ModeId interface{}

	// Configuration data for operational mode.
	Config TerminalDevice_OperationalModes_Mode_Config

	// Operational state data for the platform-defined operational mode.
	State TerminalDevice_OperationalModes_Mode_State
}

TerminalDevice_OperationalModes_Mode List of operational modes supported by the platform. The operational mode provides a platform-defined summary of information such as symbol rate, modulation, pulse shaping, etc.

func (*TerminalDevice_OperationalModes_Mode) GetEntityData 

func (mode *TerminalDevice_OperationalModes_Mode) GetEntityData() *types.CommonEntityData

type TerminalDevice_OperationalModes_Mode_Config 

type TerminalDevice_OperationalModes_Mode_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
}

TerminalDevice_OperationalModes_Mode_Config Configuration data for operational mode

func (*TerminalDevice_OperationalModes_Mode_Config) GetEntityData 

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

type TerminalDevice_OperationalModes_Mode_State 

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

	// Two-octet encoding of the vendor-defined operational mode. The type is
	// interface{} with range: 0..65535.
	ModeId interface{}

	// Vendor-supplied textual description of the characteristics of this
	// operational mode to enable operators to select the appropriate mode for the
	// application. The type is string.
	Description interface{}

	// Identifier to represent the vendor / supplier of the platform and the
	// associated operational mode information. The type is string.
	VendorId interface{}
}

TerminalDevice_OperationalModes_Mode_State Operational state data for the platform-defined operational mode

func (*TerminalDevice_OperationalModes_Mode_State) GetEntityData 

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

type TerminalDevice_State 

type TerminalDevice_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
}

TerminalDevice_State Operational state data for global terminal device

func (*TerminalDevice_State) GetEntityData 

func (state *TerminalDevice_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.