State

Leafs

Enum Classes

class Aps.ApsModules.ApsModule.State

Bases: Entity

Class Hierarchy: Aps ApsModules ApsModule State

This class represents state data.

Operational state data for an automatic protection

switch module

name

Reference to the component name (in the platform model) corresponding to this automatic protection switch module in the device

type: str

refers to: name

config: False

revertive

Revertive behavior of the module. If True, then automatically revert after protection switch once the fault is restored. This leaf is not valid when the relative-switch-threshold is in effect

type: bool

config: False

wait_to_restore_time

The time that must elapse before an APS path that has recovered from an signal failure (SF) or signal degradation (SD) condition can be used again to transport the normal traffic signal. During this time period, an SF or SD condition shall override the wait-to-restore time period. This leaf can only take effect when the revertive leaf equals true

type: int

range: 0..4294967295

config: False

units: milliseconds

hold_off_time

The time delay between the declaration of an SF or SD condition and the initiation of the protection switching algorithm

type: int

range: 0..4294967295

config: False

units: milliseconds

primary_switch_threshold

The threshold at which the primary line port will switch to the opposite line port in increments of 0.01 dBm. If the hardware supports only one switch threshold for primary and and secondary ports then it is recommended to set both primary-switch-threshold and secondary-switch-threshold to the same value to be explicit. When the relative switch threshold is enabled, i.e. set to a non-zero value, the primary switch threshold will be overridden

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dBm

primary_switch_hysteresis

The delta in dB between the primary-switch-threshold and the signal received on the primary APS_PATH before initiating a switch from the secondary APS_PATH to the primary APS_PATH, in order to prevent toggling between ports when an input signal is very close to the threshold. A zero value means the switch hysteresis is disabled

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dB

default value: 0

secondary_switch_threshold

The threshold at which the secondary line port will switch to the opposite line port in increments of 0.01 dBm. If the hardware supports only one switch threshold for primary and and secondary ports then it is recommended to set both primary-switch-threshold and secondary-switch-threshold to the same value to be explicit. When the relative switch threshold is enabled, i.e. set to a non-zero value, the secondary switch threshold will be overridden

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dBm

relative_switch_threshold

The delta threshold in dB at which the current line port will switch to the opposite line port. It can be set to the value of 0dB. When set to 0dB, the threshold is ignored and the system automatically applies the primary and secondary switch thresholds. When set to a non-zero value, it overrides the primary and secondary switch thresholds

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dB

default value: 0

relative_switch_threshold_offset

The offset of the relative switch threshold that compensates the normal difference of receiving power between the primary and secondary line ports. A negative offset corresponds to the situation where the secondary line port receives a higher power than the primary line port in normal condition, and a positive offset means the opposite. The offset will only work when the relative switch threshold is set to a non-zero value

type: Decimal64

range: -92233720368547758.08..92233720368547758.07

config: False

units: dB

default value: 0

force_to_port

Explicitly set the switch to stay on a port regardless of its operational condition

type: ForceToPort

config: False

default value: NONE

active_path

Indicates which line path on the protection switch is currently the active path connected to the common port

type: one of the below values: PRIMARY

config: False