06-Ethernet OAM Commands
Chapters Download (73.8 KB)
Table of Contents
1 Ethernet OAM Configuration Commands
oam errored-frame-period period
oam errored-frame-period threshold
oam errored-frame-seconds period
oam errored-frame-seconds threshold
Syntax
display oam { local | remote } [ interface interface-type interface-number ]
View
Any view
Default Level
2: System level
Parameters
local: Displays the Ethernet OAM connection information of the local end.
remote: Displays the Ethernet OAM connection information of the remote end.
interface interface-type interface-number: Specify a port by its type and number.
Description
Use the display oam command to display the information about an Ethernet OAM connection, including connection status, information contained in Ethernet OAM packet header, and Ethernet OAM packet statistics.
If you do not specify the interface keyword, this command displays the information about all the Ethernet OAM connections.
Related commands: reset oam.
Examples
# Display the information about the Ethernet OAM connection established on the local port Gigabitethernet 1/0/1.
<Sysname> display oam local interface gigabitethernet1/0/1
Port : GigabitEthernet1/0/1
Link Status : Up
EnableStatus : Enable
Local_oam_mode : Active Local_pdu : ANY
Local_mux_action : FWD Local_par_action : FWD
OAMLocalFlagsField :
--------------------------------------------------------------------------
Link Fault : 0 Dying Gasp : 0
Critical Event : 0 Local Evaluating : COMPLETE
Remote Evaluating : COMPLETE
Packets statistic :
Packets Send Receive
--------------------------------------------------------------------------
OAMPDU 645 648
OAMInformation 645 648
OAMEventNotification 0 --
OAMUniqueEventNotification -- 0
OAMDuplicateEventNotification -- 0
Table 1-1 display oam local command output description
|
Field |
Description |
|
Port |
Port index |
|
Link Status |
Link status |
|
EnableStatus |
Ethernet OAM state (enabled or disabled) |
|
Local_oam_mode |
Local Ethernet OAM mode, which can be: l Active, indicating the port operates in the active Ethernet OAM mode l Passive, indicating the port operates in the passive Ethernet OAM mode |
|
Local_pdu |
The way in which the local end processes Ethernet OAMPDUs: l RX_INFO, indicating the port only receives Information OAMPDUs and does not send any Ethernet OAMPDUs. l LF_INFO, indicating the port only sends the Information OAMPDUs without Information TLV triplets and with their link error flag bits being set. l INFO, indicating the port sends and receives only Information OAMPDUs. l ANY, indicating the port sends and receives Ethernet OAMPDUs of any type. |
|
Local_mux_action |
Working mode of the local transmitter, which can be: l FWD, indicating the port can send any packets. l DISCARD, indicating the port only sends Ethernet OAMPDUs. |
|
Local_par_action |
Working mode of the local receiver, which can be: l FWD, indicating the port can receive any packets. l DISCARD, indicating the port only receives Ethernet OAMPDUs. l LB, indicating the local receiver is in the loopback state. In this case, all the packets other than Ethernet OAMPDUs received on the local receiver are returned to their sources along the ways they come. |
|
OAMLocalFlagsField |
Local flags inserted in the local flag fields of the Ethernet OAMPDUs sent |
|
Link Fault |
Indicates whether an Ethernet OAM link error is present: 0 for no and 1 for yes |
|
Dying Gasp |
Indicates whether a fatal error is present: 0 for no and 1 for yes |
|
Critical Event |
Indicates whether a critical error is present: 0 for no and 1 for yes |
|
Local Evaluating |
Indicates whether the local-to-remote configuration negotiation is complete: l COMPLETE for completed l REVERSED for uncompleted |
|
Remote Evaluating |
Indicates whether the remote-to-local configuration negotiation is complete: l COMPLETE for completed l REVERSED for uncompleted |
|
Packets statistic |
Statistics about Ethernet OAMPDUs sent and received |
|
OAMPDU |
Total number of the Ethernet OAMPDUs sent and received |
|
OAMInformation |
Number of the Information OAMPDUs sent and received |
|
OAMEventNotification |
Number of the Event notification OAMPDUs sent and received |
|
OAMUniqueEventNotification |
Number of the unduplicated Event notification OAMPDUs sent or received uniquely |
|
OAMDuplicateEventNotification |
Number of the duplicate Event notification OAMPDUs sent or received |
# Display the Ethernet OAM information of the peer port Gigabitethernet 1/0/1.
<Sysname> display oam remote interface gigabitethernet 1/0/1
Port : GigabitEthernet1/0/1
Link Status : Up
Information of the latest received OAM packet:
OAMRemoteMACAddress : 00e0-fd73-6502
OAMRemotePDUConfiguration : 1500
OAMRemoteState :
--------------------------------------------------------------------------
Remote_mux_action : FWD Remote_par_action : FWD
OAMRemoteConfiguration :
--------------------------------------------------------------------------
OAM Mode : Active Unidirectional Support : YES
Loopback Support : YES Link Events : YES
Variable Retrieval : NO
OAMRemoteFlagsField :
--------------------------------------------------------------------------
Link Fault : 0 Dying Gasp : 0
Critical Event : 0 Local Evaluating : COMPLETE
Remote Evaluating : COMPLETE
Table 1-2 display oam remote interface command output description
|
Field |
Description |
|
Port |
Port index |
|
Link Status |
Link status |
|
Information of the latest received OAM packet |
Information about the latest received Ethernet OAMPDU |
|
OAMRemoteMACAddress |
MAC address of the Ethernet OAM peer |
|
OAMRemotePDUConfiguration |
Maximum Ethernet OAMPDU size allowed |
|
OAMRemoteState |
State of the Ethernet OAM peer |
|
Remote_mux_action |
Peer sending mode. Refer to Table 1-1 for more. |
|
Remote_par_action |
Peer receiving mode. Refer to Table 1-1 for more. |
|
OAMRemoteConfiguration |
Configuration of the peer Ethernet OAM entity |
|
OAM Mode |
Ethernet OAM mode |
|
Unidirectional Support |
Indicates whether unidirectional transmission is supported (YES or NO) |
|
Loopback Support |
Indicates whether Ethernet OAM remote loopback is supported (YES or NO) |
|
Link Events |
Indicates whether Ethernet OAM link error events are supported (YES or NO) |
|
Variable Retrieval |
Indicates whether MIB variable retrieval is supported (YES or NO) |
|
OAMRemoteFlagsField |
Values of the peer Ethernet OAM flag fields in OAM packets |
|
Link Fault |
Indicates whether a link fault is present: 0 for no and 1 for yes |
|
Dying Gasp |
Indicate whether a fatal fault is present: 0 for no and 1 for yes |
|
Critical Event |
Indicate whether a critical fault is present: 0 for no and 1 for yes |
|
Local Evaluating |
Indicates whether the local-to-remote configuration negotiation is complete: l COMPLETE for completed l REVERSED for uncompleted |
|
Remote Evaluating |
Indicates whether the remote-to-local configuration negotiation is complete: l COMPLETE for completed l REVERSED for uncompleted |
Syntax
display oam configuration
View
Any view
Default Level
2: System level
Parameters
None
Description
Use the display oam configuration command to display global Ethernet OAM configuration, including the periods and thresholds for Ethernet OAM link error event detection.
Related commands: oam errored-symbol period, oam errored-symbol threshold, oam errored-frame period, oam errored-frame threshold, oam errored-frame-period period, oam errored-frame-period threshold, oam errored-frame-seconds period, oam errored-frame-seconds threshold.
Examples
# Display global Ethernet OAM configuration.
<Sysname> display oam configuration
Configuration of the link event window/threshold :
--------------------------------------------------------------------------
Errored-symbol Event period(in seconds) : 1
Errored-symbol Event threshold : 1
Errored-frame Event period(in seconds) : 1
Errored-frame Event threshold : 1
Errored-frame-period Event period(in ms) : 1000
Errored-frame-period Event threshold : 1
Errored-frame-seconds Event period(in seconds) : 60
Errored-frame-seconds Event threshold : 1
Table 1-3 display oam configuration command output description
|
Field |
Description |
|
Configuration of the link event window/threshold |
Detection intervals and triggering thresholds configured for link events |
|
Errored-symbol Event period (in seconds) |
Errored symbol event detection interval, which defaults to one second |
|
Errored-symbol Event threshold |
Errored symbol event triggering threshold, which defaults to 1 |
|
Errored-frame Event period (in seconds) |
Errored frame event detection interval, which defaults to one second |
|
Errored-frame Event threshold |
Errored frame event triggering threshold, which defaults to 1 |
|
Errored-frame-period Event period (in ms) |
Errored frame period event detection interval, which defaults to 1000 milliseconds |
|
Errored-frame-period Event threshold |
Errored frame period event triggering threshold, which defaults to 1 |
|
Errored-frame-seconds Event period (in seconds) |
Errored frame seconds event detection interval, which defaults to 60 seconds |
|
Errored-frame-seconds Event threshold |
Errored frame seconds event triggering threshold, which defaults to 1 |
Syntax
display oam critical-event [ interface interface-type interface-number]
View
Any view
Default Level
2: System level
Parameters
interface interface-type interface-number: Specify a port by its type and number.
Description
Use the display oam critical-event command to display the statistics on critical Ethernet OAM link events occurred on a port.
If you do not specify the interface keyword, this command displays the statistics on the critical Ethernet OAM link events occurred on all the ports of the switch.
Examples
# Display the statistics on critical Ethernet OAM link events occurred on all the ports.
<Sysname> display oam critical-event
Port : GigabitEthernet1/0/1
Link Status : Up
Event statistic :
-------------------------------------------------------------------------
Link Fault :0 Dying Gasp : 0 Critical Event : 0
Table 1-4 display oam critical-event command output description
|
Field |
Description |
|
Port |
Port index |
|
Link Status |
Link status |
|
Event statistic |
Statistics on critical Ethernet OAM link events |
|
Link Fault |
Indicates whether a link fault is present: 0 for no and 1 for yes. |
|
Dying Gasp |
Indicate whether a fatal fault is present: 0 for no and 1 for yes |
|
Critical Event |
Indicate whether a critical fault is present: 0 for no and 1 for yes |
Syntax
display oam link-event { local | remote } [ interface interface-type interface-number ]
View
Any view
Default Level
2: System level
Parameters
local: Displays the statistics on the local Ethernet OAM link error events.
remote: Displays the statistics on the peer Ethernet OAM link error events.
interface interface-type interface-number: Specify a port by its type and number.
Description
Use the display oam link-event command to display the statistics on Ethernet OAM link error events occurred on a local port or a peer port. Ethernet OAM link error events include errored symbol events, errored frame events, errored frame period events, and errored frame seconds events.
If you do not specify the interface keyword, this command displays the statistics on the Ethernet OAM link error events occurred on all the local/peer ports.
Related commands: display oam configuration, reset oam.
Examples
# Display the statistics on Ethernet OAM link error events occurred on all the local ports.
<Sysname> display oam link-event local
Port : GigabitEthernet1/0/1
Link Status : Up
OAMLocalErrFrameEvent : (ms = milliseconds)
--------------------------------------------------------------------------
Event Time Stamp : 3539 Errored Frame Window : 10(100ms)
Errored Frame Threshold : 5 Errored Frame : 1488111
Error Running Total : 260908758 Event Running Total : 307
OAMLocalErrFramePeriodEvent :
--------------------------------------------------------------------------
Event Time Stamp : 3539 Errored Frame Window : 976500
Errored Frame Threshold : 1 Errored Frame : 1042054
Error Running Total : 260909151 Event Running Total : 471
OAMLocalErrFrameSecsSummaryEvent : (ms = milliseconds)
--------------------------------------------------------------------------
Event Time Stamp : 3389
Errored Frame Second Summary Window : 600(100ms)
Errored Frame Second Summary Threshold : 1
Errored Frame Second Summary : 60
Error Running Total : 292 Event Running Total : 5
Table 1-5 display oam link-event local command output description
|
Field |
Description |
|
Port |
Port index |
|
Link Status |
Link status |
|
OAMLocalErrFrameEvent |
Information about local errored frame events. l Event Time Stamp: time when an errored frame event occurred (in 100 milliseconds). l Errored Frame Window: Error frame detection interval (in 100 milliseconds). l Errored Frame Threshold: error threshold that triggers an errored frame event. l Errored Frame: the number of detected error frames over the specific detection interval. l Error Running Total: the total number of error frames. l Event Running Total: the total number of errored frame events that have occurred. |
|
OAMLocalErrFramePeriodEvent |
Information about local errored frame period events: l Event Time Stamp: time when an errored frame event occurred (in 100 milliseconds). l Errored Frame Window: maximum number of 64-byte frames that can be transmitted through an Ethernet port over the configured error frame period detection interval. See oam errored-frame-period period command for more information. l Errored Frame Threshold: error threshold that triggers an error frame period event. l Errored Frame: the number of detected error frames over a detection interval. l Error Running Total: the total number of error frames that have detected. l Event Running Total: the total number of error frame period events. |
|
OAMLocalErrFrameSecsSummaryEvent |
Information about local errored frame seconds events: l Event Time Stamp: time when an error frame seconds event occurred (in terms of 100 milliseconds). l Errored Frame Second Summary Window: error frame second detection interval (in 100 milliseconds). l Errored Frame Second Summary Threshold: error threshold that triggers an error frame seconds event. l Errored Frame Second Summary: the number of detected error frame seconds over a detection interval. l Error Running Total: the total number of error frame seconds. l Event Running Total: the total number of error frame seconds events that have occurred. |
# Display Ethernet OAM link event statistics of the remote ends of all the ports.
<Sysname> display oam link-event remote
Port : GigabitEthernet1/0/1
Link Status :Up
OAMRemoteErrFrameEvent : (ms = milliseconds)
---------------------------------------------------------------------
Event Time Stamp : 5789 Errored Frame Window : 10(100ms)
Errored Frame Threshold : 1 Errored Frame : 3
Error Running Total : 35 Event Running Total : 17
Table 1-6 display oam link-event remote command output description
|
Field |
Description |
|
Port |
Port index |
|
Link Status |
Link status |
|
OAMLocalErrFrameEvent |
Information about remote errored frame events. l Event Time Stamp: Time when an errored frame event occurred (in 100 milliseconds). l Errored Frame Window: Error frame detection interval (in 100 milliseconds). l Errored Frame Threshold: Error threshold that triggers an errored frame event. l Errored Frame: The number of detected error frames over the specific detection interval. l Error Running Total: The total number of error frames. l Event Running Total: The total number of errored frame events that have occurred. |
Syntax
oam enable
undo oam enable
View
Ethernet port view
Default Level
2: System level
Parameters
None
Description
Use the oam enable command to enable Ethernet OAM on the Ethernet port.
Use the undo oam enable command to disable Ethernet OAM on the Ethernet port.
By default, Ethernet OAM is disabled on all Ethernet ports.
Examples
# Enable OAM on port Gigabitethernet 1/0/1.
<Sysname> system-view
[Sysname] interface gigabitethernet1/0/1
[Sysname-GigabitEthernet1/0/1] oam enable
Syntax
oam errored-frame period period-value
undo oam errored-frame period
View
System view
Default Level
2: System level
Parameters
period-value: Errored frame event detection interval, ranging from 1 to 60 (in seconds).
Description
Use the oam errored-frame period command to set the errored frame event detection interval.
Use the undo oam errored-frame period command to restore the default.
By default, the errored frame event detection interval is one second.
Related commands: oam errored-frame threshold, display oam link-event, display oam configuration.
Examples
# Set the errored frame event detection interval to 10 seconds.
<Sysname> system-view
[Sysname] oam errored-frame period 10
Syntax
oam errored-frame threshold threshold-value
undo oam errored-frame threshold
View
System view
Default Level
2: System level
Parameters
threshold-value: Errored frame event triggering threshold, ranging from 0 to 4294967295.
Description
Use the oam errored-frame threshold command to set the errored frame event triggering threshold.
Use the undo oam errored-frame threshold command to restore the default.
By default, the errored frame event triggering threshold is 1.
Related commands: oam errored-frame period, display oam link-event, display oam configuration.
Examples
# Set the errored frame event triggering threshold to 100.
[Sysname] oam errored-frame threshold 100
Syntax
oam errored-frame-period period period-value
undo oam errored-frame-period period
View
System view
Default Level
2: System level
Parameters
period-value: Errored frame period event detection interval, ranging from 100 to 60000 (in milliseconds).
Description
Use the oam errored-frame-period period command to set the errored frame period event detection interval.
Use the undo oam errored-frame-period period command to restore the default.
By default, the errored frame period event detection interval is 1000 milliseconds.
As for errored frame period event detection, the system first uses the following expression to convert the errored frame period event detection interval to the maximum number of 64-byte frames that can be transmitted through an Ethernet port in the period:
bandwidth * period / (64 * 8 * 1000),
where bandwidth is the port bandwidth (in bps) and “period” is the configured period (in milliseconds).
Related commands: oam errored-frame-period threshold, display oam link-event, display oam configuration.
Examples
# Set the errored frame period event detection interval to 10 seconds, that is, 10000 milliseconds.
[Sysname] oam errored-frame-period period 10000
Syntax
oam errored-frame-period threshold threshold-value
undo oam errored-frame-period threshold
View
System view
Default Level
2: System level
Parameters
threshold-value: Errored frame period event triggering threshold, ranging from 0 to 4294967295.
Description
Use the oam errored-frame-period threshold command to set the errored frame period event triggering threshold.
Use the undo oam errored-frame-period threshold command to restore the default.
By default, the errored frame period event triggering threshold is 1.
Related commands: oam errored-frame-period period, display oam link-event, display oam configuration.
Examples
# Set the errored frame period event triggering threshold to 100.
<Sysname> system-view
[Sysname] oam errored-frame-period threshold 100
Syntax
oam errored-frame-seconds period period-value
undo oam errored-frame-seconds period
View
System view
Default Level
2: System level
Parameters
period-value: Errored frame seconds event detection interval, ranging from 10 to 900 (in seconds).
Description
Use the oam errored-frame-seconds period command to set the errored frame seconds event detection interval.
Use the undo oam errored-frame-seconds period command to restore the default.
By default, the errored frame seconds event detection interval is 60 seconds.
Related commands: oam errored-frame-seconds threshold, display oam link-event, display oam configuration.
Examples
# Set the errored frame seconds event detection interval to 100 seconds.
<Sysname> system-view
[Sysname] oam errored-frame-seconds period 100
Syntax
oam errored-frame-seconds threshold threshold-value
undo oam errored-frame-seconds threshold
View
System view
Default Level
2: System level
Parameters
threshold-value: Errored frame seconds event triggering threshold, ranging from 0 to 900.
Description
Use the oam errored-frame-seconds threshold command to set the errored frame seconds event triggering threshold.
Use the undo oam errored-frame-seconds threshold command to restore the default.
By default, the errored frame seconds event triggering threshold is 1.
Related commands: oam errored-frame-seconds period, display oam link-event, display oam configuration.
Examples
# Set the errored frame seconds event triggering threshold to 100.
[Sysname] oam errored-frame-seconds threshold 100
Syntax
oam errored-symbol period period-value
undo oam errored-symbol period
View
System view
Default Level
2: System level
Parameters
period-value: Errored symbol event detection interval, ranging from 1 to 60 (in seconds).
Description
Use the oam errored-symbol period command to set the errored symbol event detection interval.
Use the undo oam errored-symbol period command to restore the default.
By default, the errored symbol event detection interval is one second.
Related commands: oam errored-symbol threshold, display oam link-event, display oam configuration.
Examples
# Set the errored symbol event detection interval to 10 seconds.
[Sysname] oam errored-symbol period 10
Syntax
oam errored-symbol threshold threshold-value
undo oam errored-symbol threshold
View
System view
Default Level
2: System level
Parameters
threshold-value: Errored symbol event triggering threshold, ranging from 0 to 4,294,967,295.
Description
Use the oam errored-symbol threshold command to set the errored symbol event triggering threshold.
Use the undo oam errored-symbol threshold command to restore the default.
By default, the errored symbol event triggering threshold is 1.
Related commands: oam errored-symbol period, display oam link-event, display oam configuration.
Examples
# Set the errored symbol event triggering threshold to 100.
[Sysname] oam errored-symbol threshold 100
Syntax
oam loopback
undo oam loopback
View
Ethernet port view
Default Level
2: System level
Parameters
None
Description
Use the oam loopback command to enable Ethernet OAM remote loopback on an Ethernet port.
Use the undo loopback command to disable Ethernet OAM remote loopback.
By default, Ethernet OAM remote loopback is disabled.
Ethernet OAM remote loopback is available only after the Ethernet OAM connection is established and can be performed only by the Ethernet OAM entities operating in active Ethernet OAM mode.
Related commands: oam enable, oam mode.
Examples
# Configure the active Ethernet OAM mode, enable Ethernet OAM, and enable Ethernet OAM remote loopback on GigabitEthernet1/0/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/0/1
[Sysname-GigabitEthernet1/0/1] oam mode active
[Sysname-GigabitEthernet1/0/1] oam enable
[Sysname-GigabitEthernet1/0/1] oam loopback
Syntax
oam mode { active | passive }
View
Ethernet port view
Default Level
2: System level
Parameters
active: Specifies the active Ethernet OAM mode.
passive: Specifies the passive Ethernet OAM mode.
Description
Use the oam mode command to set the Ethernet OAM operating mode for an Ethernet port.
By default, an Ethernet OAM-enabled Ethernet port operates in the active Ethernet OAM mode.
To change the Ethernet OAM operating mode of an Ethernet OAM-enabled Ethernet port, you need to disable Ethernet OAM on the port first.
Related commands: oam enable.
Examples
# Disable Ethernet OAM on Gigabitethernet 1/0/1, and then configure Gigabitethernet 1/0/1 to operate in passive Ethernet OAM mode.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/0/1
[Sysname-GigabitEthernet1/0/1] undo oam enable
[Sysname-GigabitEthernet1/0/1] oam mode passive
Syntax
reset oam [ interface interface-type interface-number ]
View
User view
Default Level
2: System level
Parameters
interface interface-type interface-number: Specify a port by its type and number.
Description
Use the reset oam command to clear the statistics on Ethernet OAM packets and Ethernet OAM link error events of an Ethernet port.
If you do not specify the interface keyword, this command clears the statistics on Ethernet OAM packets and Ethernet OAM link error events of all the ports.
Related commands: display oam, display oam link-event.
Examples
# Clear the statistics on Ethernet OAM packets and Ethernet OAM link error events of all the ports.
<Sysname> reset oam
