State

Leafs

Children

Enum Classes

class Components.Component.Transceiver.State

Bases: Entity

Class Hierarchy: Components Component Transceiver State

This class represents state data.

Operational state data for client port transceivers

enabled

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

type: bool

config: False

form_factor_preconf

Indicates the type of optical transceiver used on this port. If the client port is built into the device and not pluggable, 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

type: one of the below values: CFP

config: False

ethernet_pmd_preconf

The Ethernet PMD is a property of the optical transceiver used on the port, indicating the type of physical connection. It is included in configuration data to allow pre-configuring a port/transceiver with the expected PMD. The actual PMD is indicated by the ethernet-pmd state leaf

type: one of the below values: ETH10GBASELRM

config: False

fec_mode

The FEC mode indicates the mode of operation for the transceiver’s FEC. This defines typical operational modes and does not aim to specify more granular FEC capabilities

type: one of the below values: FECENABLED

config: False

present

Indicates whether a transceiver is present in the specified client port

type: Present

config: False

form_factor

Indicates the type of optical transceiver used on this port. If the client port is built into the device and not pluggable, 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)

type: one of the below values: CFP

config: False

connector_type

Connector type used on this port

type: one of the below values: SCCONNECTOR

config: False

vendor

Full name of transceiver vendor. 16-octet field that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (20h)

type: str

length: 1..16

config: False

vendor_part

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

type: str

length: 1..16

config: False

vendor_rev

Transceiver vendor’s revision number. 2-octet field that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (20h)

type: str

length: 1..2

config: False

ethernet_pmd

Ethernet PMD (physical medium dependent sublayer) that the transceiver supports. The SFF/QSFP MSAs have registers for this and CFP MSA has similar

type: one of the below values: ETH10GBASELRM

config: False

sonet_sdh_compliance_code

SONET/SDH application code supported by the port

type: one of the below values: VSR20003R2

config: False

otn_compliance_code

OTN application code supported by the port

type: one of the below values: P1L12D1

config: False

serial_no

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

type: str

length: 1..16

config: False

date_code

Representation of the transceiver date code, typically stored as YYMMDD. The time portion of the value is undefined and not intended to be read

type: str

pattern: ^[0-9]{4}\-[0-9]{2}\-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?Z[+-][0-9]{2}:[0-9]{2}$

config: False

fault_condition

Indicates if a fault condition exists in the transceiver

type: bool

config: False

fec_status

Operational status of FEC

type: one of the below values: FECSTATUSLOCKED

config: False

fec_uncorrectable_blocks

The number of blocks that were uncorrectable by the FEC

type: int

range: 0..18446744073709551615

config: False

fec_uncorrectable_words

The number of words that were uncorrectable by the FEC

type: int

range: 0..18446744073709551615

config: False

fec_corrected_bytes

The number of bytes that were corrected by the FEC

type: int

range: 0..18446744073709551615

config: False

fec_corrected_bits

The number of bits that were corrected by the FEC

type: int

range: 0..18446744073709551615

config: False

pre_fec_ber

Bit error rate before forward error correction – computed value with 18 decimal precision. Note that decimal64 supports values as small as i x 10^-18 where i is an integer. Values smaller than this should be reported as 0 to inidicate error free or near error free performance. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

type: PreFecBer

config: False

post_fec_ber

Bit error rate after forward error correction – computed value with 18 decimal precision. Note that decimal64 supports values as small as i x 10^-18 where i is an integer. Values smaller than this should be reported as 0 to inidicate error free or near error free performance. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

type: PostFecBer

config: False

output_power

The output optical power of a physical channel in units of 0.01dBm, which may be associated with individual physical channels, or an aggregate of multiple physical channels (i.e., for the overall transceiver). For an aggregate, this may be a measurement from a photodetector or a a calculation performed on the device by summing up all of the related individual physical channels. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

type: OutputPower

config: False

input_power

The input optical power of a physical channel in units of 0.01dBm, which may be associated with individual physical channels, or an aggregate of multiple physical channels (i.e., for the overall transceiver). For an aggregate, this may be a measurement from a photodetector or a a calculation performed on the device by summing up all of the related individual physical channels. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

type: InputPower

config: False

laser_bias_current

The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to two decimal precision. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

type: LaserBiasCurrent

config: False