platform

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 defines a data model for representing a system component inventory, which can include hardware or software elements arranged in an arbitrary structure. The primary relationship supported by the model is containment, e.g., components containing subcomponents. It is expected that this model reflects every field replacable unit on the device at a minimum (i.e., additional information may be supplied about non-replacable components). Every element in the inventory is termed a 'component' with each component expected to have a unique name and type, and optionally a unique system-assigned identifier and FRU number. The uniqueness is guaranteed by the system within the device. Components may have properties defined by the system that are modeled as a list of key-value pairs. These may or may not be user-configurable. The model provides a flag for the system to optionally indicate which properties are user configurable. Each component also has a list of 'subcomponents' which are references to other components. Appearance in a list of subcomponents indicates a containment relationship as described above. For example, a linecard component may have a list of references to port components that reside on the linecard. This schema is generic to allow devices to express their own platform-specific structure. It may be augmented by additional component type-specific schemas that provide a common structure for well-known component types. In these cases, the system is expected to populate the common component schema, and may optionally also represent the component and its properties in the generic structure. The properties for each component may include dynamic values, e.g., in the 'state' part of the schema. For example, a CPU component may report its utilization, temperature, or other physical properties. The intent is to capture all platform- specific physical data in one location, including inventory (presence or absence of a component) and state (physical attributes or status).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Components 

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

	// List of components, keyed by component name. The type is slice of
	// Components_Component.
	Component []*Components_Component
}

Components Enclosing container for the components in the system.

func (*Components) GetEntityData 

func (components *Components) GetEntityData() *types.CommonEntityData

type Components_Component 

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

	// This attribute is a key. References the component name. The type is string.
	// Refers to platform.Components_Component_Config_Name
	Name interface{}

	// Configuration data for each component.
	Config Components_Component_Config

	// Operational state data for each component.
	State Components_Component_State

	// Enclosing container .
	Properties Components_Component_Properties

	// Enclosing container for subcomponent references.
	Subcomponents Components_Component_Subcomponents

	// Top-level container for client port transceiver data.
	Transceiver Components_Component_Transceiver

	// Enclosing container for the list of optical channels.
	OpticalChannel Components_Component_OpticalChannel

	// Top-level container .
	OpticalPort Components_Component_OpticalPort
}

Components_Component List of components, keyed by component name.

func (*Components_Component) GetEntityData 

func (component *Components_Component) GetEntityData() *types.CommonEntityData

type Components_Component_Config 

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

	// Device name for the component -- this will not be a configurable parameter
	// on many implementations. The type is string.
	Name interface{}
}

Components_Component_Config Configuration data for each component

func (*Components_Component_Config) GetEntityData 

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

type Components_Component_OpticalChannel 

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

	// Configuration data for optical channels.
	Config Components_Component_OpticalChannel_Config

	// Operational state data for optical channels.
	State Components_Component_OpticalChannel_State
}

Components_Component_OpticalChannel Enclosing container for the list of optical channels

func (*Components_Component_OpticalChannel) GetEntityData 

func (opticalChannel *Components_Component_OpticalChannel) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_Config 

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

	// Frequency of the optical channel, expressed in MHz. The type is interface{}
	// with range: 0..18446744073709551615.
	Frequency interface{}

	// Target output optical power level of the optical channel, expressed in
	// increments of 0.01 dBm (decibel-milliwats). The type is string with range:
	// -92233720368547758.08..92233720368547758.07. Units are dBm.
	TargetOutputPower interface{}

	// Vendor-specific mode identifier -- sets the operational mode for the
	// channel. The type is interface{} with range: 0..65535.
	OperationalMode interface{}

	// Reference to the line-side physical port that carries this optical channel.
	// The target port should be a component in the physical inventory data model.
	// The type is string. Refers to platform.Components_Component_Name
	LinePort interface{}
}

Components_Component_OpticalChannel_Config Configuration data for optical channels

func (*Components_Component_OpticalChannel_Config) GetEntityData 

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

type Components_Component_OpticalChannel_State 

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

	// Frequency of the optical channel, expressed in MHz. The type is interface{}
	// with range: 0..18446744073709551615.
	Frequency interface{}

	// Target output optical power level of the optical channel, expressed in
	// increments of 0.01 dBm (decibel-milliwats). The type is string with range:
	// -92233720368547758.08..92233720368547758.07. Units are dBm.
	TargetOutputPower interface{}

	// Vendor-specific mode identifier -- sets the operational mode for the
	// channel. The type is interface{} with range: 0..65535.
	OperationalMode interface{}

	// Reference to the line-side physical port that carries this optical channel.
	// The target port should be a component in the physical inventory data model.
	// The type is string. Refers to platform.Components_Component_Name
	LinePort interface{}

	// If the device places constraints on which optical channels must be managed
	// together (e.g., transmitted on the same line port), it can indicate that by
	// setting the group-id to the same value across related optical channels. The
	// type is interface{} with range: 0..4294967295.
	GroupId interface{}

	// The output optical power of this port in units of 0.01dBm. If the port is
	// an aggregate of multiple physical channels, this attribute is the total
	// power or sum of all channels. If avg/min/max statistics are not supported,
	// the target is expected to just supply the instant value.
	OutputPower Components_Component_OpticalChannel_State_OutputPower

	// The input optical power of this port in units of 0.01dBm. If the port is an
	// aggregate of multiple physical channels, this attribute is the total power
	// or sum of all channels. If avg/min/max statistics are not supported, the
	// target is expected to just supply the instant value.
	InputPower Components_Component_OpticalChannel_State_InputPower

	// The current applied by the system to the transmit laser to achieve the
	// output power.  The current is expressed in mA with up to one decimal
	// precision. If avg/min/max statistics are not supported, the target is
	// expected to just supply the instant value.
	LaserBiasCurrent Components_Component_OpticalChannel_State_LaserBiasCurrent

	// Chromatic Dispersion of an optical channel in ps/nm as reported by
	// receiver.
	ChromaticDispersion Components_Component_OpticalChannel_State_ChromaticDispersion

	// Polarization Mode Dispersion of an optical channel in ps as reported by
	// receiver.
	PolarizationModeDispersion Components_Component_OpticalChannel_State_PolarizationModeDispersion

	// Second Order Polarization Mode Dispersion of an optical channel in ps^2 as
	// reported by receiver.
	SecondOrderPolarizationModeDispersion Components_Component_OpticalChannel_State_SecondOrderPolarizationModeDispersion

	// Polarization Dependent Loss of an optical channel in dB as reported by
	// receiver.
	PolarizationDependentLoss Components_Component_OpticalChannel_State_PolarizationDependentLoss
}

Components_Component_OpticalChannel_State Operational state data for optical channels

func (*Components_Component_OpticalChannel_State) GetEntityData 

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

type Components_Component_OpticalChannel_State_ChromaticDispersion 

type Components_Component_OpticalChannel_State_ChromaticDispersion 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{}
}

Components_Component_OpticalChannel_State_ChromaticDispersion Chromatic Dispersion of an optical channel in ps/nm as reported by receiver

func (*Components_Component_OpticalChannel_State_ChromaticDispersion) GetEntityData 

func (chromaticDispersion *Components_Component_OpticalChannel_State_ChromaticDispersion) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_State_InputPower 

type Components_Component_OpticalChannel_State_InputPower 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{}
}

Components_Component_OpticalChannel_State_InputPower The input optical power of this port in units of 0.01dBm. If the port is an aggregate of multiple physical channels, this attribute is the total power or sum of all channels. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

func (*Components_Component_OpticalChannel_State_InputPower) GetEntityData 

func (inputPower *Components_Component_OpticalChannel_State_InputPower) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_State_LaserBiasCurrent 

type Components_Component_OpticalChannel_State_LaserBiasCurrent 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{}
}

Components_Component_OpticalChannel_State_LaserBiasCurrent The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to one decimal precision. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

func (*Components_Component_OpticalChannel_State_LaserBiasCurrent) GetEntityData 

func (laserBiasCurrent *Components_Component_OpticalChannel_State_LaserBiasCurrent) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_State_OutputPower 

type Components_Component_OpticalChannel_State_OutputPower 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{}
}

Components_Component_OpticalChannel_State_OutputPower The output optical power of this port in units of 0.01dBm. If the port is an aggregate of multiple physical channels, this attribute is the total power or sum of all channels. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

func (*Components_Component_OpticalChannel_State_OutputPower) GetEntityData 

func (outputPower *Components_Component_OpticalChannel_State_OutputPower) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_State_PolarizationDependentLoss 

type Components_Component_OpticalChannel_State_PolarizationDependentLoss 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{}
}

Components_Component_OpticalChannel_State_PolarizationDependentLoss Polarization Dependent Loss of an optical channel in dB as reported by receiver

func (*Components_Component_OpticalChannel_State_PolarizationDependentLoss) GetEntityData 

func (polarizationDependentLoss *Components_Component_OpticalChannel_State_PolarizationDependentLoss) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_State_PolarizationModeDispersion 

type Components_Component_OpticalChannel_State_PolarizationModeDispersion 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{}
}

Components_Component_OpticalChannel_State_PolarizationModeDispersion Polarization Mode Dispersion of an optical channel in ps as reported by receiver

func (*Components_Component_OpticalChannel_State_PolarizationModeDispersion) GetEntityData 

func (polarizationModeDispersion *Components_Component_OpticalChannel_State_PolarizationModeDispersion) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalChannel_State_SecondOrderPolarizationModeDispersion 

type Components_Component_OpticalChannel_State_SecondOrderPolarizationModeDispersion 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{}
}

Components_Component_OpticalChannel_State_SecondOrderPolarizationModeDispersion Second Order Polarization Mode Dispersion of an optical channel in ps^2 as reported by receiver

func (*Components_Component_OpticalChannel_State_SecondOrderPolarizationModeDispersion) GetEntityData 

func (secondOrderPolarizationModeDispersion *Components_Component_OpticalChannel_State_SecondOrderPolarizationModeDispersion) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalPort 

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

	// Operational config data for optical line ports.
	Config Components_Component_OpticalPort_Config

	// Operational state data for optical line ports.
	State Components_Component_OpticalPort_State
}

Components_Component_OpticalPort Top-level container

func (*Components_Component_OpticalPort) GetEntityData 

func (opticalPort *Components_Component_OpticalPort) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalPort_Config 

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

	// Sets the admin state of the optical-port. The type is AdminStateType.
	AdminState interface{}
}

Components_Component_OpticalPort_Config Operational config data for optical line ports

func (*Components_Component_OpticalPort_Config) GetEntityData 

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

type Components_Component_OpticalPort_State 

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

	// Sets the admin state of the optical-port. The type is AdminStateType.
	AdminState interface{}

	// Indicates the type of transport line port.  This is an informational field
	// that should be made available by the device (e.g., in the
	// openconfig-platform model). The type is one of the following:
	// INGRESSMONITORDROPADDEGRESS.
	OpticalPortType interface{}

	// The total input optical power of this port in units of 0.01dBm. If
	// avg/min/max statistics are not supported, just supply the instant value.
	InputPower Components_Component_OpticalPort_State_InputPower

	// The total output optical power of this port in units of 0.01dBm. If
	// avg/min/max statistics are not supported, just supply the instant value.
	OutputPower Components_Component_OpticalPort_State_OutputPower
}

Components_Component_OpticalPort_State Operational state data for optical line ports

func (*Components_Component_OpticalPort_State) GetEntityData 

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

type Components_Component_OpticalPort_State_InputPower 

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

	// The instantaneous value of the statistic. The type is string with range:
	// -92233720368547758.08..92233720368547758.07. Units are dBm.
	Instant interface{}

	// The arithmetic mean value of the statistic over the sampling period. The
	// type is string with range: -92233720368547758.08..92233720368547758.07.
	// Units are dBm.
	Avg interface{}

	// The minimum value of the statistic over the sampling period. The type is
	// string with range: -92233720368547758.08..92233720368547758.07. Units are
	// dBm.
	Min interface{}

	// The maximum value of the statistic over the sampling period. The type is
	// string with range: -92233720368547758.08..92233720368547758.07. Units are
	// dBm.
	Max interface{}
}

Components_Component_OpticalPort_State_InputPower The total input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

func (*Components_Component_OpticalPort_State_InputPower) GetEntityData 

func (inputPower *Components_Component_OpticalPort_State_InputPower) GetEntityData() *types.CommonEntityData

type Components_Component_OpticalPort_State_OutputPower 

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

	// The instantaneous value of the statistic. The type is string with range:
	// -92233720368547758.08..92233720368547758.07. Units are dBm.
	Instant interface{}

	// The arithmetic mean value of the statistic over the sampling period. The
	// type is string with range: -92233720368547758.08..92233720368547758.07.
	// Units are dBm.
	Avg interface{}

	// The minimum value of the statistic over the sampling period. The type is
	// string with range: -92233720368547758.08..92233720368547758.07. Units are
	// dBm.
	Min interface{}

	// The maximum value of the statistic over the sampling period. The type is
	// string with range: -92233720368547758.08..92233720368547758.07. Units are
	// dBm.
	Max interface{}
}

Components_Component_OpticalPort_State_OutputPower The total output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

func (*Components_Component_OpticalPort_State_OutputPower) GetEntityData 

func (outputPower *Components_Component_OpticalPort_State_OutputPower) GetEntityData() *types.CommonEntityData

type Components_Component_Properties 

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

	// List of system properties for the component. The type is slice of
	// Components_Component_Properties_Property.
	Property []*Components_Component_Properties_Property
}

Components_Component_Properties Enclosing container

func (*Components_Component_Properties) GetEntityData 

func (properties *Components_Component_Properties) GetEntityData() *types.CommonEntityData

type Components_Component_Properties_Property 

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

	// This attribute is a key. Reference to the property name. The type is
	// string. Refers to
	// platform.Components_Component_Properties_Property_Config_Name
	Name interface{}

	// Configuration data for each property.
	Config Components_Component_Properties_Property_Config

	// Operational state data for each property.
	State Components_Component_Properties_Property_State
}

Components_Component_Properties_Property List of system properties for the component

func (*Components_Component_Properties_Property) GetEntityData 

func (property *Components_Component_Properties_Property) GetEntityData() *types.CommonEntityData

type Components_Component_Properties_Property_Config 

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

	// System-supplied name of the property -- this is typically non-configurable.
	// The type is string.
	Name interface{}

	// Property values can take on a variety of types.  Signed and unsigned
	// integer types may be provided in smaller sizes, e.g., int8, uint16, etc.
	// The type is one of the following types: string, or bool, or int with range:
	// -9223372036854775808..9223372036854775807, or int with range:
	// 0..18446744073709551615, or :go:struct:`Decimal64<Ydk_Decimal64>` with
	// range: -92233720368547758.08..92233720368547758.07.
	Value interface{}
}

Components_Component_Properties_Property_Config Configuration data for each property

func (*Components_Component_Properties_Property_Config) GetEntityData 

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

type Components_Component_Properties_Property_State 

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

	// System-supplied name of the property -- this is typically non-configurable.
	// The type is string.
	Name interface{}

	// Property values can take on a variety of types.  Signed and unsigned
	// integer types may be provided in smaller sizes, e.g., int8, uint16, etc.
	// The type is one of the following types: string, or bool, or int with range:
	// -9223372036854775808..9223372036854775807, or int with range:
	// 0..18446744073709551615, or :go:struct:`Decimal64<Ydk_Decimal64>` with
	// range: -92233720368547758.08..92233720368547758.07.
	Value interface{}

	// Indication whether the property is user-configurable. The type is bool.
	Configurable interface{}
}

Components_Component_Properties_Property_State Operational state data for each property

func (*Components_Component_Properties_Property_State) GetEntityData 

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

type Components_Component_State 

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

	// Device name for the component -- this will not be a configurable parameter
	// on many implementations. The type is string.
	Name interface{}

	// Type of component as identified by the system. The type is one of the
	// following types: :go:struct:`OPENCONFIGHARDWARECOMPONENT
	// <ydk/models/platform_types/OPENCONFIGHARDWARECOMPONENT>`, or
	// :go:struct:`OPENCONFIGSOFTWARECOMPONENT
	// <ydk/models/platform_types/OPENCONFIGSOFTWARECOMPONENT>`.
	Type interface{}

	// Unique identifier assigned by the system for the component. The type is
	// string.
	Id interface{}

	// System-supplied description of the component. The type is string.
	Description interface{}

	// System-supplied identifier for the manufacturer of the component.  This
	// data is particularly useful when a component manufacturer is different than
	// the overall device vendor. The type is string.
	MfgName interface{}

	// System-defined version string for a hardware, firmware, or software
	// component. The type is string.
	Version interface{}

	// System-assigned serial number of the component. The type is string.
	SerialNo interface{}

	// System-assigned part number for the component.  This should be present in
	// particular if the component is also an FRU (field replacable unit). The
	// type is string.
	PartNo interface{}
}

Components_Component_State Operational state data for each component

func (*Components_Component_State) GetEntityData 

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

type Components_Component_Subcomponents 

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

	// List of subcomponent references. The type is slice of
	// Components_Component_Subcomponents_Subcomponent.
	Subcomponent []*Components_Component_Subcomponents_Subcomponent
}

Components_Component_Subcomponents Enclosing container for subcomponent references

func (*Components_Component_Subcomponents) GetEntityData 

func (subcomponents *Components_Component_Subcomponents) GetEntityData() *types.CommonEntityData

type Components_Component_Subcomponents_Subcomponent 

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

	// This attribute is a key. Reference to the name list key. The type is
	// string. Refers to
	// platform.Components_Component_Subcomponents_Subcomponent_Config_Name
	Name interface{}

	// Configuration data .
	Config Components_Component_Subcomponents_Subcomponent_Config

	// Operational state data .
	State Components_Component_Subcomponents_Subcomponent_State
}

Components_Component_Subcomponents_Subcomponent List of subcomponent references

func (*Components_Component_Subcomponents_Subcomponent) GetEntityData 

func (subcomponent *Components_Component_Subcomponents_Subcomponent) GetEntityData() *types.CommonEntityData

type Components_Component_Subcomponents_Subcomponent_Config 

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

	// Reference to the name of the subcomponent. The type is string. Refers to
	// platform.Components_Component_Config_Name
	Name interface{}
}

Components_Component_Subcomponents_Subcomponent_Config Configuration data

func (*Components_Component_Subcomponents_Subcomponent_Config) GetEntityData 

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

type Components_Component_Subcomponents_Subcomponent_State 

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

	// Reference to the name of the subcomponent. The type is string. Refers to
	// platform.Components_Component_Config_Name
	Name interface{}
}

Components_Component_Subcomponents_Subcomponent_State Operational state data

func (*Components_Component_Subcomponents_Subcomponent_State) GetEntityData 

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

type Components_Component_Transceiver 

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

	// Configuration data for client port transceivers.
	Config Components_Component_Transceiver_Config

	// Operational state data for client port transceivers.
	State Components_Component_Transceiver_State

	// Enclosing container for client channels.
	PhysicalChannels Components_Component_Transceiver_PhysicalChannels
}

Components_Component_Transceiver Top-level container for client port transceiver data

func (*Components_Component_Transceiver) GetEntityData 

func (transceiver *Components_Component_Transceiver) GetEntityData() *types.CommonEntityData

type Components_Component_Transceiver_Config 

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

	// Turns power on / off to the transceiver -- provides a means to power on/off
	// the transceiver (in the case of SFP, SFP+, QSFP,...) or enable high-power
	// mode (in the case of CFP, CFP2, CFP4) and is optionally supported (device
	// can choose to always enable).  True = power on / high power, False =
	// powered off. The type is bool.
	Enabled interface{}

	// Indicates the type of optical transceiver used on this port.  If the client
	// port is built into the device and not plugable, then non-pluggable is the
	// corresponding state. If a device port supports multiple form factors (e.g.
	// QSFP28 and QSFP+, then the value of the transceiver installed shall be
	// reported. If no transceiver is present, then the value of the highest rate
	// form factor shall be reported (QSFP28, for example).  The form factor is
	// included in configuration data to allow pre-configuring a device with the
	// expected type of transceiver ahead of deployment.  The corresponding state
	// leaf should reflect the actual transceiver type plugged into the system.
	// The type is one of the following:
	// CFP2QSFP28CFP4CFP2ACOX2XFPSFPPLUSNONPLUGGABLEOTHERQSFPSFPCFP.
	FormFactor interface{}
}

Components_Component_Transceiver_Config Configuration data for client port transceivers

func (*Components_Component_Transceiver_Config) GetEntityData 

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

type Components_Component_Transceiver_PhysicalChannels 

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

	// List of client channels, keyed by index within a physical client port.  A
	// physical port with a single channel would have a single zero-indexed
	// element. The type is slice of
	// Components_Component_Transceiver_PhysicalChannels_Channel.
	Channel []*Components_Component_Transceiver_PhysicalChannels_Channel
}

Components_Component_Transceiver_PhysicalChannels Enclosing container for client channels

func (*Components_Component_Transceiver_PhysicalChannels) GetEntityData 

func (physicalChannels *Components_Component_Transceiver_PhysicalChannels) GetEntityData() *types.CommonEntityData

type Components_Component_Transceiver_PhysicalChannels_Channel 

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

	// This attribute is a key. Reference to the index number of the channel. The
	// type is string with range: 0..65535. Refers to
	// platform.Components_Component_Transceiver_PhysicalChannels_Channel_Config_Index
	Index interface{}

	// Configuration data for physical channels.
	Config Components_Component_Transceiver_PhysicalChannels_Channel_Config

	// Operational state data for channels.
	State Components_Component_Transceiver_PhysicalChannels_Channel_State
}

Components_Component_Transceiver_PhysicalChannels_Channel List of client channels, keyed by index within a physical client port. A physical port with a single channel would have a single zero-indexed element

func (*Components_Component_Transceiver_PhysicalChannels_Channel) GetEntityData 

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

type Components_Component_Transceiver_PhysicalChannels_Channel_Config 

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

	// Index of the physical channnel or lane within a physical client port. The
	// type is interface{} with range: 0..65535.
	Index interface{}

	// Text description for the client physical channel. The type is string.
	Description interface{}

	// Enable (true) or disable (false) the transmit label for the channel. The
	// type is bool.
	TxLaser interface{}

	// Target output optical power level of the optical channel, expressed in
	// increments of 0.01 dBm (decibel-milliwats). The type is string with range:
	// -92233720368547758.08..92233720368547758.07. Units are dBm.
	TargetOutputPower interface{}
}

Components_Component_Transceiver_PhysicalChannels_Channel_Config Configuration data for physical channels

func (*Components_Component_Transceiver_PhysicalChannels_Channel_Config) GetEntityData 

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

type Components_Component_Transceiver_PhysicalChannels_Channel_State 

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

	// Index of the physical channnel or lane within a physical client port. The
	// type is interface{} with range: 0..65535.
	Index interface{}

	// Text description for the client physical channel. The type is string.
	Description interface{}

	// Enable (true) or disable (false) the transmit label for the channel. The
	// type is bool.
	TxLaser interface{}

	// Target output optical power level of the optical channel, expressed in
	// increments of 0.01 dBm (decibel-milliwats). The type is string with range:
	// -92233720368547758.08..92233720368547758.07. Units are dBm.
	TargetOutputPower interface{}

	// The frequency in MHz of the individual physical channel (e.g. ITU C50 -
	// 195.0THz and would be reported as 195,000,000 MHz in this model). This
	// attribute is not configurable on most client ports. The type is interface{}
	// with range: 0..18446744073709551615.
	OutputFrequency interface{}

	// The output optical power of this port in units of 0.01dBm. If the port is
	// an aggregate of multiple physical channels, this attribute is the total
	// power or sum of all channels. If avg/min/max statistics are not supported,
	// the target is expected to just supply the instant value.
	OutputPower Components_Component_Transceiver_PhysicalChannels_Channel_State_OutputPower

	// The input optical power of this port in units of 0.01dBm. If the port is an
	// aggregate of multiple physical channels, this attribute is the total power
	// or sum of all channels. If avg/min/max statistics are not supported, the
	// target is expected to just supply the instant value.
	InputPower Components_Component_Transceiver_PhysicalChannels_Channel_State_InputPower

	// The current applied by the system to the transmit laser to achieve the
	// output power.  The current is expressed in mA with up to one decimal
	// precision. If avg/min/max statistics are not supported, the target is
	// expected to just supply the instant value.
	LaserBiasCurrent Components_Component_Transceiver_PhysicalChannels_Channel_State_LaserBiasCurrent
}

Components_Component_Transceiver_PhysicalChannels_Channel_State Operational state data for channels

func (*Components_Component_Transceiver_PhysicalChannels_Channel_State) GetEntityData 

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

type Components_Component_Transceiver_PhysicalChannels_Channel_State_InputPower 

type Components_Component_Transceiver_PhysicalChannels_Channel_State_InputPower 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{}
}

Components_Component_Transceiver_PhysicalChannels_Channel_State_InputPower The input optical power of this port in units of 0.01dBm. If the port is an aggregate of multiple physical channels, this attribute is the total power or sum of all channels. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

func (*Components_Component_Transceiver_PhysicalChannels_Channel_State_InputPower) GetEntityData 

func (inputPower *Components_Component_Transceiver_PhysicalChannels_Channel_State_InputPower) GetEntityData() *types.CommonEntityData

type Components_Component_Transceiver_PhysicalChannels_Channel_State_LaserBiasCurrent 

type Components_Component_Transceiver_PhysicalChannels_Channel_State_LaserBiasCurrent 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{}
}

Components_Component_Transceiver_PhysicalChannels_Channel_State_LaserBiasCurrent The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to one decimal precision. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

func (*Components_Component_Transceiver_PhysicalChannels_Channel_State_LaserBiasCurrent) GetEntityData 

func (laserBiasCurrent *Components_Component_Transceiver_PhysicalChannels_Channel_State_LaserBiasCurrent) GetEntityData() *types.CommonEntityData

type Components_Component_Transceiver_PhysicalChannels_Channel_State_OutputPower 

type Components_Component_Transceiver_PhysicalChannels_Channel_State_OutputPower 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{}
}

Components_Component_Transceiver_PhysicalChannels_Channel_State_OutputPower The output optical power of this port in units of 0.01dBm. If the port is an aggregate of multiple physical channels, this attribute is the total power or sum of all channels. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

func (*Components_Component_Transceiver_PhysicalChannels_Channel_State_OutputPower) GetEntityData 

func (outputPower *Components_Component_Transceiver_PhysicalChannels_Channel_State_OutputPower) GetEntityData() *types.CommonEntityData

type Components_Component_Transceiver_State 

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

	// Turns power on / off to the transceiver -- provides a means to power on/off
	// the transceiver (in the case of SFP, SFP+, QSFP,...) or enable high-power
	// mode (in the case of CFP, CFP2, CFP4) and is optionally supported (device
	// can choose to always enable).  True = power on / high power, False =
	// powered off. The type is bool.
	Enabled interface{}

	// Indicates the type of optical transceiver used on this port.  If the client
	// port is built into the device and not plugable, then non-pluggable is the
	// corresponding state. If a device port supports multiple form factors (e.g.
	// QSFP28 and QSFP+, then the value of the transceiver installed shall be
	// reported. If no transceiver is present, then the value of the highest rate
	// form factor shall be reported (QSFP28, for example).  The form factor is
	// included in configuration data to allow pre-configuring a device with the
	// expected type of transceiver ahead of deployment.  The corresponding state
	// leaf should reflect the actual transceiver type plugged into the system.
	// The type is one of the following:
	// CFP2QSFP28CFP4CFP2ACOX2XFPSFPPLUSNONPLUGGABLEOTHERQSFPSFPCFP.
	FormFactor interface{}

	// Indicates whether a transceiver is present in the specified client port.
	// The type is Present.
	Present interface{}

	// Connector type used on this port. The type is one of the following:
	// SCCONNECTORMPOCONNECTORLCCONNECTOR.
	ConnectorType interface{}

	// Internally measured temperature in degrees Celsius. MSA valid range is
	// between -40 and +125C. Accuracy shall be better than +/- 3 degC over the
	// whole temperature range. The type is interface{} with range: -40..125.
	InternalTemp interface{}

	// Full name of transceiver vendor. 16-octet field that contains ASCII
	// characters, left-aligned and padded on the right with ASCII spaces (20h).
	// The type is string with length: 1..16.
	Vendor interface{}

	// Transceiver vendor's part number. 16-octet field that contains ASCII
	// characters, left-aligned and padded on the right with ASCII spaces (20h).
	// If part number is undefined, all 16 octets = 0h. The type is string with
	// length: 1..16.
	VendorPart interface{}

	// Transceiver vendor's revision number. 2-octet field that contains ASCII
	// characters, left-aligned and padded on the right with ASCII spaces (20h).
	// The type is string with length: 1..2.
	VendorRev interface{}

	// Ethernet PMD that the transceiver supports. The SFF/QSFP MSAs have
	// registers for this and CFP MSA has similar. The type is one of the
	// following:
	// ETH40GBASESR4ETH10GBASELRMETH4X10GBASESRETH100GAOCETH100GBASESR4ETH10GBASEZRETH100GBASEER4ETH40GBASEER4ETH100GACCETHUNDEFINEDETH40GBASELR4ETH40GBASEPSM4ETH10GBASELRETH100GBASESR10ETH4X10GBASELRETH100GBASELR4ETH100GBASECLR4ETH10GBASESRETH100GBASECWDM4ETH100GBASEPSM4ETH40GBASECR4ETH100GBASECR4ETH10GBASEER.
	EthernetComplianceCode interface{}

	// SONET/SDH application code supported by the port. The type is one of the
	// following: SONETUNDEFINEDVSR20003R3VSR20003R2VSR20003R5.
	SonetSdhComplianceCode interface{}

	// OTN application code supported by the port. The type is one of the
	// following: P1L12D2P1L12D1OTNUNDEFINEDP1S12D2.
	OtnComplianceCode interface{}

	// Transceiver serial number. 16-octet field that contains ASCII characters,
	// left-aligned and padded on the right with ASCII spaces (20h). If part
	// serial number is undefined, all 16 octets = 0h. The type is string with
	// length: 1..16.
	SerialNo interface{}

	// Representation of the transceiver date code, typically stored as YYMMDD.
	// The time portion of the value is undefined and not intended to be read. The
	// type is string with pattern:
	// \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}).
	DateCode interface{}

	// Indicates if a fault condition exists in the transceiver. The type is bool.
	FaultCondition interface{}
}

Components_Component_Transceiver_State Operational state data for client port transceivers

func (*Components_Component_Transceiver_State) GetEntityData 

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

type Components_Component_Transceiver_State_Present 

type Components_Component_Transceiver_State_Present string

Components_Component_Transceiver_State_Present represents the specified client port. 

const (
	// Transceiver is present on the port
	Components_Component_Transceiver_State_Present_PRESENT Components_Component_Transceiver_State_Present = "PRESENT"

	// Transceiver is not present on the port
	Components_Component_Transceiver_State_Present_NOT_PRESENT Components_Component_Transceiver_State_Present = "NOT_PRESENT"
)

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.