Opticd Objects

This page contains descriptions of opticd (optic daemon) or DWDM objects in the FlexSwitch object models.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

DWDMModule

config/DWDMModule

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
AdminState string Reset state of this dwdm module (false (Reset deasserted), true (Reset asserted)) SELECTION: UP/DOWN
DEFAULT: DOWN
IndependentLaneMode bool Network lane configuration for the DWDM Module. true-Independent lanes, false-Coupled lanes DEFAULT:true
PMInterval uint8 Performance monitoring interval, i.e. time interval between successive PM ticks in seconds. DEFAULT:1
EnableExtPMTickSrc bool Enable/Disable external tick source for performance monitoring. DEFAULT:false

DWDMModuleNwIntf

config/DWDMModuleNwIntf

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
NwIntfId [Key] uint8 DWDM Module network interface identifier
ModulationFmt string Modulation format to use for this network interface SELECTION: QPSK/8QAM/16QAM
DEFAULT:"16QAM
TxPower float64 Transmit output power for this network interface in dBm. MIN:0
MAX:4294967295
DEFAULT:0
ChannelNumber uint8 TX Channel number to use for this network interface MIN:1
MAX:100 >/br> DEFAULT:48
FECMode string DWDM Module network interface FEC mode SELECTION: 15%SDFEC/
15%OvrHeadSDFEC/
25%OvrHeadSDFEC
DiffEncoding bool Control to enable/disable DWDM Module network interface encoding type DEFAULT: true
TxPulseShapeFltrType string TX pulse shaping filter type SELECTION: RootRaisedCos/RaisedCos
DEFAULT:RootRaisedCos
TxPulseShapeFltrRollOff float64 TX pulse shape filter roll off factor MIN:0.004
MAX:0.8
DEFAULT:0.301
AdminState string Administrative state of this network interface SELECTION: UP/DOWN
DEFAULT: UP
EnableTxPRBS bool Enable TX PRBS generation on this network interface SELECTION: 2^7/2^15/2^31
DEFAULT: 2^31
TxPRBSPattern string Pattern to use for TX PRBS generation SELECTION: 2^7/2^15/2^31
DEFAULT: 2^31
TxPRBSInvertPattern bool Generate inverted PRBS polynomial pattern DEFAULT:true
EnableRxPRBSChecker bool Enable RX PRBS checker DEFAULT: false
RxPRBSPattern string PRBS pattern to use for checker SELECTION:2^7/
2^15/
2^31
DEFAULT: 2^31
RxPRBSInvertPattern bool Check against inverted PRBS polynomial pattern DEFAULT:true
ClntIntfIdToTributary0Map uint8 Client interface ID to map to network interface tributary 0. MIN:0
MAX:3
ClntIntfIdToTributary1Map uint8 Client interface ID to map to network interface tributary 1. MIN:0
MAX:3
TxPowerRampdBmPerSec float64 Rate of change of tx power on this network interface, UNIT: dBm/s DEFAULT: 1

DWDMModuleClntIntf

config/DWDMModuleClntIntf

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
ClntIntfId [Key] uint8 DWDM Module client interface identifier
EnableFEC bool 802.3bj Fec decoder enable/disable state for RX/TX traffic between Host and DWDM Module DEFAULT: false
HostTxEqLfCtle uint8 Host interface TX deserializer equalization. LELPZRC LF-CTLE LFPZ gain code. MIN:0
MAX:8
DEFAULT:0
HostTxEqCtle uint8 Host interface TX deserializer equalization. LELRC CTLE LE gain code. MIN:0
MAX:20
DEFAULT:18
HostTxEqDfe uint8 Host interface TX deserializer equalization. s-DFE, DFE tap coefficient. MIN:0
MAX:63
DEFAULT:0
HostRxSerializerTap0Gain uint8 Host RX Serializer tap 0 control, gain for equalization filter tap. MIN:0
MAX:7
DEFAULT:7
HostRxSerializerTap0Delay uint8 Host RX Serializer tap 0 control, delay for equalization filter tap MIN:0
MAX:7
DEFAULT:7
HostRxSerializerTap1Gain uint8 Host RX Serializer tap 1 control, gain for equalization filter tap. MIN:0
MAX:7
DEFAULT:7
HostRxSerializerTap2Gain uint8 Host RX Serializer tap 2 control, gain for equalization filter tap. MIN:0
MAX:15
DEFAULT:15
HostRxSerializerTap2Delay uint8 Host RX Serializer tap 2 control, delay for equalization filter tap. MIN:0
MAX:7
DEFAULT:5
AdminState string Administrative state of this client interface. SELECTION: UP/DOWN
DEFAULT: UP
EnableTxPRBSChecker bool Enable/Disable TX PRBS checker for all lanes of this client interface DEFAULT:false
TxPRBSPattern string PRBS pattern to use for checker SELECTION:2^7/
2^15/
2^31
EnableRxPRBS bool Enable/Disable RX PRBS generation for all lanes of this client interface DEFAULT:false
RxPRBSPattern string RX PRBS generator pattern SELECTION:2^7/
2^15/
2^31
EnableIntSerdesNWLoopback bool Enable/Disable serdes internal loopback, N/W RX is looped back to N/W TX. DEFAULT: false
EnableHostLoopback bool Enable/Disable loopback on all host lanes of this client interface. DEFAULT: false
NwLaneTributaryToClntIntfMap uint8 Network lane/tributary id to map to client interface MIN:0
MAX:3

State Objects

DWDMModuleState

state/DWDMModule

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
OperState string Operational state of this dwdm module"
ExtPMTickSrcEnabled bool Current state of using external tick source for performance monitoring
LaneMode string Current network lane configuration of this DWDM module
ModuleState string Current MSA state of dwdm module
ModuleVoltage float64 Module power supply voltage in Volts
ModuleTemp float64 Module temperature in deg Celsius
ModuleHWVersion string HW version of dwdm module
ModuleActiveFWVersion string Firmware version of active partition of dwdm module"
ModuleStandByFWVersion string Firmware version of standby partition of dwdm module
ModuleActiveFWStatus string Firmware image status of active partition of dwdm module
ModuleStandByFWStatus string Firmware image status of standby partition of dwdm module
Populated bool Is module populated
CurrPMInterval uint8 Current performance monitoring interval, i.e. time interval between successive PM ticks in second
VendorName string Vendor name of dwdm module
VendorPartNum string Vendor assigned part number of dwdm module
VendorSerialNum string Vendor assigned serial number of dwdm module
VendorDateCode string Device manufacture data code of dwdm module

DWDMModuleRegState

state/DWDMModuleReg

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
RegAddr uint16 Generic register object address
RegVal uint16 Value of Register denoted by RegAddr

DWDMModuleNwIntfState

state/DWDMModuleNwIntf

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
NwIntfId [Key] uint8 DWDM Module network interface identifier
OperState string Operational state of this DWDM module network interface
CurrChannelNumber uint8 Current Channel number used by the DWDM module network interface
CurrChanFrequency float64 Channel frequency corresponding to selected channel number for the DWDM module network interface, UNIT: GHz
CurrClntIntfIdToTributary0Map uint8 Client Interface ID mapped to tributary 0 of this DWDM module network interface
CurrClntIntfIdToTributary1Map uint8 Client Interface ID mapped to tributary 1 of this DWDM module network interface
CurrentBER float64 Current value of BER on the DWDM module network interface
CurrChromDisp int32 Current RX chromatic dispersion for the DWDM module network interface, UNIT:ps/nm
CurrUncorrectableFECBlkCnt float64 Current value of uncorrectable FEC code block count
CurrUncorrectableFECBlkCntOverPMInt float64 Average value of uncorrectable FEC code block count over the last PM interval
DiffEncodingEnabled bool State of encoding on the DWDM module network interface
CurrFECMode string Current FEC for the DWDM module network interface
CurrModulationFmt string Current modulation format for the DWDM module network interface
MinBEROverPMInterval float64 Minimum value of BER over the last PM interval for the DWDM module network interface
AvgBEROverPMInterval float64 Average value of BER over the last PM interval for the DWDM module network interface
MaxBEROverPMInterval float64 Maximum value of BER over the last PM interval for the DWDM module network interface
MinChromDispOverPMInt int32 Current RX chromatic dispersion over the last PM interval for the DWDM module network interface, UNIT:ps/nm
AvgChromDispOverPMInt int32 Average RX chromatic dispersion over the last PM interval for the DWDM module network interface, UNIT:ps/nm
MaxChromDispOverPMInt int32 Current RX chromatic dispersion over the last PM interval for the DWDM module network interface, UNIT:ps/nm
TxPRBSEnabled bool State of TX PRBS generation for this DWDM module network interface
CurrTxPower float64 Current TX Power for the DWDM module network interface, UNIT:dBm
CurrTxPulseShapeFltrType string Current TX pulse shaping filter type for DWDM module network interface
CurrTxChanGridSpacing string The channel grid spacing used for this DWDM module network interface in GHz, UNIT: GHz
CurrTxPulseShapeFltrRollOff float64 TX pulse shape filter roll off factor for this DWDM module network interface
CurrTxPRBSPattern string TX PRBS pattern currently used by this DWDM module network interface
TxPRBSInvertPatternEnabled bool State of TX inverted PRBS polynomial generation of this DWDM module network interface
CurrTxPowerRampdBmPerSec float64 Current Rate of change of TX power for this DWDM module network interface
RxPRBSCheckerEnabled bool State of RX PRBS checker of this DWDM module network interface
CurrRxPower float64 Current RX power for the DWDM module network interface, UNIT: dBm
CurrRxPRBSPattern string RX PRBS patter currently used by this DWDM module network interface
RxPRBSInvertPatternEnabled bool State of check against inverted PRBS polynomial for this DWDM module network interface
PRBSRxErrCnt float64 RX PRBS error count for this DWDM module network interface
TxTurnup string Network Lane TX Turn-up State where state of TX_OUT_PWR_ADJ indicates that turn-up is complete
RxTurnup string Network Lane RX Turn-up State where state of RX_DEMOD_LOCK indicates that turn-up is complete
CurrAdminState string Admin state of this DWDM module network interface

DWDMModuleClntIntfState

state/DWDMModuleClntIntf

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
ClntIntfId [Key] uint8 DWDM Module client interface identifier
PRBSTxErrCntLane0 float64 Client interface host lane 0 PRBS TX Error count
PRBSTxErrCntLane1 float64 Client interface host lane 1 PRBS TX Error count
PRBSTxErrCntLane2 float64 Client interface host lane 2 PRBS TX Error count
PRBSTxErrCntLane3 float64 Client interface host lane 3 PRBS TX Error count
FECEnabled bool State of FEC decoder for traffic between Host and DWDM Module
CurrHostTxEqLfCtle uint8 Host interface TX deserializer equalization. LELPZRC LF-CTLE LFPZ gain code.
CurrHostTxEqCtle uint8 Host interface TX deserializer equalization. LELRC CTLE LE gain code.
CurrHostTxEqDfe uint8 Host interface TX deserializer equalization. s-DFE, DFE tap coefficient
CurrHostRxSerializerTap0Gain uint8 Host RX Serializer tap 0 control, gain for equalization filter tap
CurrHostRxSerializerTap0Delay uint8 Host RX Serializer tap 0 control, delay for equalization filter tap
CurrHostRxSerializerTap1Gain uint8 Host RX Serializer tap 1 control, gain for equalization filter tap
CurrHostRxSerializerTap2Gain uint8 Host RX Serializer tap 2 control, gain for equalization filter tap
CurrHostRxSerializerTap2Delay uint8 Host RX Serializer tap 2 control, delay for equalization filter tap
OperState string Operational state of this client interface
TxPRBSCheckerEnabled bool State of TX PRBS checker for all lanes of this client interface
CurrTxPRBSPattern string PRBS pattern currently used for checker
RxPRBSEnabled bool State of RX PRBS generation for all lanes of this client interface
CurrRxPRBSPattern string Currenrly used RX PRBS generator pattern
IntSerdesNWLoopbackEnabled bool State of serdes internal loopback, N/W RX is looped back to N/W TX
HostLoopbackEnabled bool State of loopback on all host lanes of this client interface
CurrNwLaneTributaryToClntIntfMap uint8 Network lane/tributary id to map to client interface

DWDMModuleNwIntfPMState

state/DWDMModuleNwIntfPM

Attribute Data Type Description Permitted Values
ModuleId [Key] uint8 DWDM Module identifier
NwIntfId [Key] uint8 DWDM Module network interface identifier
Resource [Key] string Opticd resource name for which PM Data is required
Type [Key] string Min/Max/Avg
Class [Key] string Class of PM Data SELECTION: CLASS-A/CLASS-B/CLASS-B <?br> DEFAULT: CLASS-A
Data []DWDMModulePMData

Structures

DWDMModulePMData

Field Data Type Description
TimeStamp string Timestamp at which data is collected
Value float64 PM Data Value