State¶

Leafs

• amp_mode
• component
• egress_port
• enabled
• fiber_type_profile
• gain_range
• ingress_port
• name
• target_gain
• target_gain_tilt
• target_output_power
• type

Children

• actual_gain
• actual_gain_tilt
• input_power_c_band
• input_power_l_band
• input_power_total
• laser_bias_current
• optical_return_loss
• output_power_c_band
• output_power_l_band
• output_power_total

class OpticalAmplifier.Amplifiers.Amplifier.State¶

Bases: Entity

Class Hierarchy: OpticalAmplifier Amplifiers Amplifier State

This class represents state data.

Operational state data for the amplifier

name¶

User-defined name assigned to identify a specific amplifier in the device

type: str

config: False

type¶

Type of the amplifier

type: one of the below values: EDFA

FORWARDRAMAN

BACKWARDRAMAN

HYBRID

config: False

target_gain¶

Positive gain applied by the amplifier

type: Decimal64

range: 0..92233720368547758.07

config: False

units: dB

target_gain_tilt¶

Gain tilt control

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dB

gain_range¶

Selected gain range. The gain range is a platform-defined value indicating the switched gain amplifier setting

type: one of the below values: LOWGAINRANGE

MIDGAINRANGE

HIGHGAINRANGE

FIXEDGAINRANGE

config: False

amp_mode¶

The operating mode of the amplifier

type: one of the below values: CONSTANTPOWER

CONSTANTGAIN

config: False

target_output_power¶

Output optical power of the amplifier

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dBm

enabled¶

Turns power on / off to the amplifiers gain module

type: bool

config: False

fiber_type_profile¶

The fiber type profile specifies details about the fiber type which are needed to accurately determine the gain and perform efficient amplification. This is only needed for Raman type amplifiers

type: one of the below values: DSF

LEAF

SSMF

TWC

TWRS

config: False

component¶

Reference to the system-supplied physical component that the amplifier gain block is contained within. Multiple amplifier gain blocks may be contained within the same physical component

type: str

refers to: name

config: False

ingress_port¶

Reference to system-supplied name of the amplifier ingress port. This leaf is only valid for ports of type INGRESS

type: str

refers to: name

config: False

egress_port¶

Reference to system-supplied name of the amplifier egress port. This leaf is only valid for ports of type EGRESS

type: str

refers to: name

config: False

actual_gain¶

The actual gain applied by the amplifier in units of 0.01dB. If avg/min/max statistics are not supported, just supply the instant value

type: ActualGain

config: False

actual_gain_tilt¶

The actual tilt applied by the amplifier in units of 0.01dB. If avg/min/max statistics are not supported, just supply the instant value

type: ActualGainTilt

config: False

input_power_total¶

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

type: InputPowerTotal

config: False

input_power_c_band¶

The C band (consisting of approximately 191 to 195 THz or 1530nm to 1565 nm) input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

type: InputPowerCBand

config: False

input_power_l_band¶

The L band (consisting of approximately 184 to 191 THz or 1565 to 1625 nm) input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

type: InputPowerLBand

config: False

output_power_total¶

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

type: OutputPowerTotal

config: False

output_power_c_band¶

The C band (consisting of approximately 191 to 195 THz or 1530nm to 1565 nm)output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

type: OutputPowerCBand

config: False

output_power_l_band¶

The L band (consisting of approximately 184 to 191 THz or 1565 to 1625 nm)output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

type: OutputPowerLBand

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. If avg/min/max statistics are not supported, just supply the instant value

type: LaserBiasCurrent

config: False

optical_return_loss¶

The optical return loss (ORL) is the ratio of the light reflected back into the port to the light launched out of the port. ORL is in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

type: OpticalReturnLoss

config: False