transceiver
transceiver - configure the TCL transceiver parameters for transceivers.
SYNOPSIS
transceiver sub-command options.
DESCRIPTION
The transceiver command is used to configure the TCL transceiver-specific information of the SFPPlus, CfpQsfp, QSFP, CfpCxp,Cxp, and FCPhy transceivers.
STANDARD OPTIONS
enableMonitorLosProperty
Indicates whether the MonitorLosProperty is enabled.
enableMonitorModuleReadySignalProperty
Indicates whether the MonitorModuleReadySignalProperty is enabled.
enableAutomaticDetectProperty
Indicates whether the AutomaticDetectProperty is enabled.
typeProperty
Indicates the type of transceiver. Possible values are the following:
Option | Values | Usage |
---|---|---|
kLimiting |
0 |
|
kLinear |
1 |
|
kTwinax |
2 |
Active copper |
kPassiveCopper |
3 |
Passive copper |
kNotDetected |
4 |
|
kInvalid |
5 |
|
When set, you need to use the number corresponding to the desired option.
lockedtypeProperty
Indicates the lockedtype property. Possible values are the following:
Option | Vaues | Usage |
---|---|---|
kLimiting |
0 |
|
kLinear |
1 |
|
kTwinax |
2 |
Active copper |
kPassiveCopper |
3 |
Passive copper |
kNotDetected |
4 |
|
kInvalid |
5 |
|
When set, you need to use the number corresponding to the desired option.
laneSelectionProperty
Indicates the selection of available lanes. Possible values are the following:
Option | Values |
---|---|
kAllLane |
0 |
kLane1 |
|
kLane2 |
|
kLane3 |
|
kLane4 |
|
kLane5 |
|
kLane6 |
|
kLane7 |
|
kLane8 |
|
kLane9 |
|
kLane10 |
|
Currently, only 4 and 10 lines are supported. For 4 lines, the valid range is from the following:
Option | values |
---|---|
kAllLane |
0 |
kLane1 |
|
kLane2 |
|
kLane3 |
|
kLane4 |
|
When set, you can use both the number corresponding to the option and the option name.
laneCountProperty
Signifies the number of lanes available for a specific transceiver. Currently only 4 and 10 lines are supported.
txMainTapControlValueProperty
Represents the current set value for txMainTapControl. Valid range is between txMainTapControlValueMinProperty and txMainTapControlValueMaxProperty.
txMainTapControlValueMinProperty
Represents the minimum value for txMainTapControl property.
txMainTapControlValueMaxProperty
Represents the maximum value for txMainTapControl property.
txMainTapControlValueDefaultProperty
Represents the default recommended value for txMainTapControl.
txMainTapControlValuePassiveCuLengthProperty
Represents default recommended values for 1, 3, 5 meter copper for txMainTapControl.
When reading values from a transceiver that supports multiple lines the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4 or 10. These are the values for the same property but on different lines(line1 to lineN). Applies only for current values.
txPreTapControlValueProperty
Represents the current set value for txPreTapControlValue. Valid range is between txPreTapControlValueMinProperty and txPreTapControlValueMaxProperty.
txPreTapControlValueMinProperty
Represents the minimum value for txPreTapControlValue property.
txPreTapControlValueMaxProperty
Represents the maximum value for txPreTapControlValue property.
txPreTapControlValueDefaultProperty
The default recommended value for txPreTapControlValue.
txPreTapControlValuePassiveCuLengthProperty
The default recommended values for 1, 3, 5 meter copper for txPreTapControlValue.
When reading values from a transceiver that supports multiple lines the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4 or 10. These are the values for the same property but on different lines (line1 to lineN). Applies only for current values.
txPostTapControlValueProperty
Represents the current set value for txPostTapControlValue. Valid range is between txPostTapControlValueMinProperty and txPostTapControlValueMaxProperty.
txPostTapControlValueMinProperty
Represents the minimum value for txPostTapControlValue.
txPostTapControlValueMaxProperty
Represents the maximum value for txPostTapControlValue.
maximum value for txPostTapControlValue
The default recommended value for txPostTapControlValue.
txPostTapControlValuePassiveCuLengthProperty
The default recommended values for 1, 3, 5 meter copper for txPostTapControlValue.
When reading values from a transceiver that supports multiple lines the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4 or 10. These are the values for the same property but on different lines(line1 to lineN). Applies only for current values.
txIcRefControlValueProperty
Represents the output voltage swing of the transmitter. The control is the coefficient for the voltage swing.
The minimum and maximum values are 0 and 3 respectively. The default value is 0.
txEyeModControlValueProperty
Represents the difference between optical power levels of a digital signal. The control is the coefficient for how high or low the modulation should be.
The minimum and maximum values are 0 and 16 respectively. The default value is 8.
For K400 QSFP-DD, the default value is 9.
When reading values from a transceiver that supports multiple lines the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4, 8, or 10.
rxCtleControlValueProperty
Represents the receive sides continuous time linear equalizer. The control is the coefficient for how strong or weak the equalization should be.
The minimum and maximum values are 0 and 7 respectively. The default value is 7.
Here the values of K400 and T400 cards:
Cardname | Minimum value | Maximum value | Default value |
---|---|---|---|
K400 QSFP-DD |
0 |
7 |
5 |
T400 QDD |
0 |
31 |
8 |
T400 OSFP |
0 |
31 |
7 |
rxDspModeControlValueProperty
Represents the digital signal processing modes. The controls are different channel descriptions corresponding to different operation modes.
The possible values for K400 QSFP-DD are the following:
Option | Values |
---|---|
Short non strenuous links |
0 |
Non-strenuous optical links |
1 |
Non-strenuous links w/ strong reflections |
2 |
Non-strenuous optical links w/ strong reflections |
3 |
Strenuous links |
4 |
Strenuous optical links w/ strong reflections |
6 |
For T400 QDD and T400 OSFP, there are two DSP modes:
- 0 - short channel Rx precoder
- 1 - long channel with Rx precoder
The default value is 0.
precoderControlValueProperty
Represents an encoding scheme to reduce DFE bit errors. This is similar to FEC in operation. This also means that both sides of the link must have this enabled for link to up.
The default value is 0.
txSlewRateProperty
Represents the current set value for txSlewRate. Valid range is between txSlewRateMinProperty and txSlewRateMaxProperty.
txSlewRateMinProperty
Represents the minimum value for txSlewRate.
txSlewRateMaxProperty
Represents the maximum value for txSlewRate.
txSlewRateDefaultProperty
Represents the default recommended value for txSlewRate.
txSlewRateTapControlValuePassiveCuLengthProperty
Represents the default recommended values for 1, 3, 5 meter copper for txSlewRate.
When reading values from a transceiver that supports multiple lines, the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4 or 10. These are the values for the same property but on different lines (line1 to lineN). Applies only for current values.
txRiseFallTimeProperty
Represents the current set value for txRiseFallTime. Valid range is between txRiseFallTimeMinProperty and txRiseFallTimeMaxProperty.
txRiseFallTimeMinProperty
Represents the minimum value for txRiseFallTime.
txRiseFallTimeMaxProperty
Represents the maximum value for txRiseFallTime.
txRiseFallTimeDefaultProperty
Represents the default recommended value for txRiseFallTime.
txRiseFallTimeTapControlValuePassiveCuLengthProperty
Represents the default recommended values for 1, 3, 5 meter copper for txRiseFallTime.
When reading values from a transceiver that supports multiple lines, the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4 or 10. These are the values for the same property but on different lines (line1 to lineN). Applies only for current values.
rxEqualizerControlValueProperty
Represents the current set value for rxEqualizerControlValue. Valid range is between rxEqualizerControlValueMinProperty and rxEqualizerControlValueMaxProperty.
rxEqualizerControlValueMinProperty
Represents the minimum value for rxEqualizerContrlValue.
rxEqualizerControlValueMaxProperty
Represents the maximum value for rxEqualizerControlValue.
rxEqualizerControlValueDefaultProperty
Represents the default recommended value for rxEqualizerControlValue.
rxEqualizerTapControlValuePassiveCuLengthProperty
Represents the default recommended values for 1, 3, 5 meter copper for rxEqualizerControlValue.
When reading values from a transceiver that supports multiple lines, the value will be in the following format:
:val1:val2:val3:val4...:valN, where N can be 4 or 10. These are the values for the same property but on different lines (line1 to lineN). Applies only for current values.
carrierPowerOnProperty
This is a boolean, should be 1 or 0.
loopbackModeProperty
Valid values are one of the following:
Option | Values |
---|---|
cpfQsfpLoopbackNormal |
0 |
cpfQsfpInternalLoopback |
1 |
cpfQsfpLineLoopback |
2 |
kLane3 |
|
kLane4 |
|
When set, either value or the option name can be used.
manufacturerProperty
Indicates a string representing the manufacturer name.
modelProperty
Indicates a string representing the model name.
laserOnProperty
Indicates a boolean value. The value should be 1 to enable the laser and 0 to disable the laser.
COMMANDS
The Transceiver command is invoked with the following sub-commands.
transceiver cget option
This command is automatically generated by TCL parser. Since there are no public members to read directly from transceiver object, this command is not used to read properties.
It returns the current value of the configuration option given by option. You can get the manufacturer, model, and serial number of the transceivers using the following options:
- transceiver cget manufacturer
- transceiver cget model
- transceiver cget serialNumber
transceiverconfigure
This command is automatically generated by TCL parser. Because there are no public members to configure directly from transceiver object, this command is not used to write properties.
transceiver setDefault chasID cardID portID
Sets a specific transceiver from a specific port in the default state. It is used for initializing the local TCL transceiver object; this default state is only local and the default values set with this command are not necessary the same as the ones recovered from default properties (like txMainTapControlValueDefaultProperty, txPreTapControlValueDefaultProperty, txPostTapControlValueDefaultProperty, rxEqualizerControlValueDefaultProperty).
transceiver set chasID cardID portID
Moves the information set in the transceiver (with setDefault or setValue) from local TCLHal object to Hal object, just before calling a write command (writePluginToServer, saveCustomSetting).
Specific errors are:
- No connection to a chassis
- Invalid port number
- The port is being used by another user
- The configured parameters are not valid for this port
- Insufficient memory to add data
transceiver get chasID cardID portID
Gets whatever information was received in the transceiver from IxServer, from loGal Hal object to local TClHal object, just after calling a read command (getCurrentSettings, getCustomSettings); in case this command is forgotten, the property's value will not be changed, when using getValue.
transceiver getReadAvailableProps chasID cardID portID
Returns a list of available properties which can be read for a specific transceiver on a specific port.
transceiver getWriteAvailableProps chasID cardID portID
Returns a list of available properties which can be written for a specific transceiver on a specific port.
transceiver getValue option
Returns the current value from TCLHal object for the specific property. See STANDARD OPTIONS for the available properties.
transceiver setValue option value
Sets the specified value for the specified property. See STANDARD OPTIONS for the available properties.
transceiver getTransceiverType chasID cardID portID
Returns the transceiver type or unsupported type in case neither transceiver type is supported by that port.
Possible values:
- cfpQsfpType
- cfpCxpType
- cxpType
- qsfpType
- sfpPlusType
- fcPhyType
- unsuportedType
- cfp4Qsfp28Type
transceiver writePluginToServer chasID cardID portID
Commits whatever information was set in the Hal object to IxServer. In order to save those properties values, you need to call setValue, set followed by current command.
Specific errors are:
- No connection to a chassis
- Invalid port number
- The port is being used by another user
- The configured parameters are not valid for this port
- Insufficient memory to add data
transceiver saveCustomSetting chasID cardID portID
Triggers a save custom default command which will save whatever information related to TAP is in the Hal object, into an xml at IxServer level. In order to save those properties values, you need to call setValue, than set followed by current command.
transceiver applyDefaultSetting chasID cardID portID
This is similar in functionality with the applyDefaultSettings button from IxExplorer. This sets the Tap properties to the values which those properties had taken before the Ok button was clicked.
transceiver applyCustomSetting chasID cardID portID
Apply the custom settings (if existing) to the current settings; same behavior as the applyCustomSettings from IxExplorer.
transceiver findCustomSetting chasID cardID portID
Returns if customSettings are available for a specific command (deleteCustom, getCustom, applyCustom, saveCustom).
transceiver deleteCustomSetting chasID cardID portID
Removes the existing custom settings from the xml in IxServer; similar behavior as the deleteCustomSettings button.
transceiver getCurrentSettings
Updates the local hal with a copy of current tap values from IxServer. In order to check the values of these properties, you need to run the get command followed by getValue.
transceiver getCustomSettings chasID cardID portID
Updates the local hal with a copy of custom tap values from IxServer. In order to check those properties values you need to run the get command followed by getValue.
transceiver getResponseResult
Return the response to findCustomSetting. Depending on the signature parameter of findCustomSetting, its values can be :
Option | Values |
---|---|
kDefaultResult |
0 |
kTCLApplyCustomSettingSucceded |
1 |
kTCLApplyCustomSettingFailed |
2 |
kTCLSaveCustomSettingSucceded |
3 |
kTCLSaveCustomSettingFailed |
4 |
kTCLDeleteCustomSettingSucceded |
5 |
kTCLDeleteCustomSettingFailed |
6 |
kTCLGetCustomSettingsSucceded |
7 |
kTCLGetCustomSettingsFailed |
8 |
kTCLGetCurrentSettingsSucceded |
9 |
kTCLGetCurrentSettingsFailed |
10 |
EXAMPLES
package require IxTclHal
ixConnectToChassis localhost
set chassisId [chassis cget -id]
set cardId 171
set portId 1
transceiver setDefault $chassisId $cardId $portId
transceiver getCurrentSettings $chassisId $cardId $portId
transceiver get $chassisId $cardId $portId
transceiver cget $manufacturer $model $serialNumber
set propList [transceiver getReadAvailableProps $chassisId $cardId $portId]
foreach element $propList {
puts $element
puts [transceiver getValue $element]
}
transceiver get $chassisId $cardId $portId
transceiver getWriteAvailableProps $chassisId $cardId $portId
transceiver getValue laserOnProperty
transceiver setValue laserOnProperty 0
transceiver set $chassisId $cardId $portId
transceiver writePluginToServer $chassisId $cardId $portId
transceiver get $chassisId $cardId $portId
transceiver getValue laserOnProperty