Infrastructure Support for Transceiver Online Insertion and Removal (OIR)
Note: The transceiver OIR infrastructure support is available only on NRU03 and NRU-S0301 platforms and is introduced in Netvisor ONE 6.0.1 release.
The transceiver OIR infrastructure supports the following three operations:
- Detecting the insertion or removal of optical devices and cables into or from the front-panel ports, thereby allowing subsequent actions to take place.
- Initializing the optical devices and cables at system start-up, and also as they are inserted into the chassis during run-time.
- Configuring key parameters into the Broadcom hardware based on the required settings for the optical devices and cables as they are detected.
The support for transceiver OIR infrastructure enhances Netvisor ONE to process the transceiver OIR events and apply appropriate configuration and startup sequencing based on the type of module inserted or removed. This infrastructure implementation improves the hardware monitor service to detect OIR events and notify Netvisor ONE.
Prior to version 6.0.1, Netvisor supported initialization of optical devices on NRU03 and NRU-S0301 switches only at power-on. Starting with Netvisor ONE version 6.0.1, with the Transceiver OIR infrastructure support, you can also facilitate run-time initialization of optical devices (hot-swappable) while the switch is powered-on. This provides scalable infrastructure for device-specific initialization requirements upon OIR of the transceiver on NRU03 and NRU-S0301 platforms.
That is, you can remove, insert, swap, or replace the transceivers when the system is functioning. Each transceiver has unique characteristics, parameters, timing requirement, initialization sequence, and configuration impact to the switch port and Netvisor ONE adheres to these characteristics for the transceiver to operate correctly.
With transceiver OIR infrastructure implemented in NRU03 and NRU-S0301 platforms, Netvisor ONE automatically detects the type of device installed in the physical port and the OIR determines the port settings if the eth-mode or pre-emphasis (port-cable-type) settings are not configured already.
An important distinction between 6.0.1 and later releases as compared to earlier releases for platforms which support Transceiver OIR is the use of the sys-default configuration option, as explained in the table:
Behavior in Release Version
Eth-mode set to sys-default
Cable-type set to sys-default
Eth-mode setting is determined by port speed; all ports of that speed will have same eth-mode setting.
Cable-type set to platform default (3m DAC) for all ports, regardless of which cable is plugged in.
6.0.1 behavior (for OIR platforms)
Eth-mode setting is applied per physical port based on the device type that is plugged in.
Cable-type setting is applied per physical port based on the device type that is plugged in.
For example, in Netvisor 6.0.0, a 100G DAC cable and 100G SR4 optic have the same eth-mode configuration if both ports are configured for sys-default. However in Netvisor 6.0.1 (for OIR platforms), these ports have eth-mode configured as CR4 and SR4, respectively.
If you are upgrading Netvisor ONE from a previous release to version 6.0.1, then the original settings are retained unless you revert to the system default settings by using the port-config-modify port <port-num> eth-mode sys-default command or the port-cable-type-modify port <port-list> type sys-default command upon upgrade. The sys-default parameter ensures that the transceiver OIR settings are reverted to the pre-upgrade settings after an upgrade to Netvsior ONE version 6.0.1.
For example, after upgrading to Netvisor ONE version 6.0.1, use the command:
CLI (network-admin@nru03-switch) > port-cable-type-modify port all type sys-default
Warning: updating SI settings will apply to all ports in a port group and will flap enabled ports
Please confirm y/n (Default: n):y
Updated SI settings for port(s) 1-125 to sys-default
CLI (network-admin@nru03-switch) > port-cable-type-show
switch port type cable-sub-type
----------- ----- ----------- --------------
nru03-switch none dac ca-s
nru03-switch none dac ca-l
nru03-switch none dac ca-n
nru03-switch none dac default
nru03-switch none optical default
nru03-switch 1-125 sys-default default
The auto negotiation and the FEC are user configurable features, that is, you can enable or disable these features; Tranceiver OIR will not override those settings.
Note: When you upgrade from an earlier release to Netvisor ONE version 6.0.1, all existing user configuration is preserved.
- At system startup with a fully-populated switch, an initial insertion event is generated for each transceiver, but this has a minimal impact on Netvisor startup time.
- The eth-mode, ER4 is not supported by Broadcom SDK. Per Broadcom recommendation, the OIR infrastructure programs the hardware as SR4 when ER4 device is detected.
- For RDH 72/16 (PSM4) the recommended system default eth-mode is CAUI4 at 100G speed and LR4 for 4x25G speed as determined by the OIR.
- With transceiver OIR infrastructure, it is no longer required to run the recover port-lpmode-lr4-recover ports <port-list> command after the OIR of a Sumitomo LR4 transceiver.
- The transceiver OIR implementation in Netvisor ONE version 6.0.1 has minimal error handling capabilities. Failures in the execution of OIR state machine events may cause port to enter into error state. If you encounter an error, you must remove and re-insert the transceiver to recover.
Note: If for any reason you are unable to recover the transceiver, you must contact Pluribus TAC for support.
- The transceiver OIR infrastructure introduces a new SNMP event when entering and exiting the error state. You can enable the SNMP event by using the snmp-trap-enable-modify port-oir-error-state|no-port-oir-error-state command. Below is a sample SNMP event generated during an enter/exit error state as a reference:
2020-09-23 21:40:39 localhost [UDP: [127.0.0.1]:37190->[127.0.0.1]:162]:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (17946935) 2 days, 1:51:09.35
SNMPv2-MIB::snmpTrapOID.0 = OID: PN-LOG-MIB::pnLogMatchNotification
PN-LOG-MIB::pnLogMatchName.0 = STRING: PortOIRErr PN-LOG-MIB::pnLogFileName.0 = STRING: /nvOS/log/event.log PN-LOG-MIB::pnLogMatchCount.0 = Gauge32: 3
PN-LOG-MIB::pnLogMatchData.0 = STRING: 2020-09-23,21:40:01.352234-07:00
nru02-alpha2 nvOSd(3830) event port_oir_error_enter(11527) : level=warn
event-type=port : port=1 : Port=1 enter xcvr oir error state
2020-09-23 21:41:39 localhost [UDP: [127.0.0.1]:37190->[127.0.0.1]:162]:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (17952935) 2 days, 1:52:09.35
SNMPv2-MIB::snmpTrapOID.0 = OID: PN-LOG-MIB::pnLogMatchNotification
PN-LOG-MIB::pnLogMatchName.0 = STRING: PortOIRErr PN-LOG-MIB::pnLogFileName.0 = STRING: /nvOS/log/event.log PN-LOG-MIB::pnLogMatchCount.0 = Gauge32: 4
PN-LOG-MIB::pnLogMatchData.0 = STRING: 2020-09-23,21:40:46.408637-07:00
nru02-alpha2 nvOSd(3830) event port_oir_error_exit(11528) : level=warn
event-type=port : port=1 : Port=1 exit xcvr oir error state
- Because OIR is detected using a polling loop, there is a short delay of 1-2 seconds between when a transceiver is inserted or removed and when the OIR event is generated. Due to this polling loop delay, it is possible to miss an event if a transceiver is inserted and removed rapidly.
Note: However, you must restrain from removing and inserting a transceiver rapidly because that could cause the port to enter error state in the OIR state machine, especially if a different type of transceiver is inserted.
- Transceiver OIR leverages the device characteristic information maintained in the device EEPROM. The infrastructure has been tested with all devices on the approved device list for NRU03 and NRU-S0301.
Note: The vendors that do not comply with MSA standard may not operate properly when used with OIR. Use only the devices approved by Ericsson for use with NRU03 and NRU-S0301.
- With OIR infrastructure:
- The pre-emphasis and the eth-mode settings are set in accordance with the device type
- The DAC pre-emphasis setting is set in accordance with the DAC cable length
Note: The vendor-provided pre-emphasis settings or all lengths of DAC cables are identical for NRU03 and NRU-S0301 switches.
Use the system-settings-show command to view the details to confirm if OIR is supported on the platform in use:
CLI (network-admin@nru03-switch) > system-settings-show
Note: You should never modify the OIR settings.