13.2. EFM Commands

Command Purpose

Use this command to enable Ethernet operations, maintenance, and administration (OAM) on an interface.

Use the no form of this command to disable OAM on an interface.

Prerequisites

Command Syntax

ethernet oam enable

no ethernet oam enable

Command Mode

Interface Configuration

Default

The default status of Ethernet OAM is disabled.

Usage

This command is used to enable the Ethernet OAM module on a port.

Examples

The following example shows how to enable Ethernet OAM:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam enable

Related Commands

no ethernet oam enable

Command Purpose

Use the command to configure Ethernet OAM mode on an interface.

Prerequisites

Command Syntax

ethernet oam mode active

ethernet oam mode passive

no ethernet oam mode

Command Mode

Interface Configuration.

Default

The default Ethernet OAM mode for the DTE is passive.

Usage

This command is used to set the DTE to active mode or passive mode.

Examples

The following example shows how to set EFM mode:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam mode active
Switch(config-if)# ethernet oam mode passive

Related Commands

None

Command Purpose

Use this command to set the OAMPDU timer. Use the no form of the command to reset to default value.

Prerequisites

Command Syntax

ethernet oam min-rate *SECONDS*

no ethernet oam min-rate

Command Mode

Interface Configuration.

Default

The default value of the OAMPDU timer is 1 second.

Usage

Set the timer to emit at least one OAMPDU per second and ensure that the sublayer adheres to the maximum number of OAMPDUs per second. The minimum is 1 OAMPDU per second and the maximum is 10 OAMPDU per second.

Examples

The following example shows how to set the OAMPDU timer to 1:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam min-rate 1

Related Commands

show ethernet oam status

Command Purpose

Use this command to set the OAMPDU maximum number of PDUS per second. Use the no form of the command to reset max-rate to the default value.

Prerequisites

Command Syntax

ethernet oam max-rate *PDUS*

no ethernet oam max-rate

Command Mode

Interface Configuration.

Default

The default value of the max-rate is 10 PDUs per second.

Usage

This command is to ensure that the sublayer adheres to the maximum number of OAMPDUs per second. The minimum is 1 OAMPDU per second and the maximum is 10 OAMPDUs per second.

Examples

The following example shows how to set the OAMPDU maximum number to 10 per second:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam max-rate 10

Related Commands

show ethernet oam status

Command Purpose

Use this command to turn on link monitoring on an interface. Use the no form of this command to turn link monitoring off.

Prerequisites

Command Syntax

ethernet oam link-monitor on

no ethernet oam link-monitor on

Command Mode

Interface Configuration.

Default

When link monitor is supported, link monitoring is automatically turned on.

Usage

None

Examples

The following example shows how to turn on link monitoring on interface eth-0-1:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam link-monitor on

Related Commands

show ethernet oam status

Command Purpose

Use this command to configure link monitoring on an interface. Use the no form of this command to remove support for link monitoring on an interface.

Prerequisites

Command Syntax

ethernet oam link-monitor supported

no ethernet oam link-monitor supported

Command Mode

Interface Configuration.

Default

The default state of the link monitor is supported

Usage

None

Examples

The following example shows how to configure link monitoring on interface eth-0-1:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam link-monitor supported

Related Commands

show ethernet oam status

Command Purpose

Use this command to configure the low and high threshold and the window for the frame event. If the low threshold is exceeded, an error frame link event is generated. If the high threshold is exceeded, the action defined using the command ethernet oam link-monitor high threshold action is taken.

Prerequisites

Command Syntax

ethernet oam link-monitor frame threshold high (*HIGH_THRES*|none) low *LOW_THRES* window *WINDOW*

no ethernet oam link-monitor frame threshold

Command Mode

Interface Configuration

Default

The default value for high threshold is none, meaning that no high threshold is configured.

The default value of low threshold is 1.

The default value for the frame event window is 100.

Usage

None

Examples

The following example shows how to configure the low and high threshold and the window for the frame event:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam link-monitor frame threshold high 5 low 2 window 200

Related Commands

show ethernet oam status

Command Purpose

Use this command to configure the low and high threshold and the window for the frame-seconds event. If the low threshold is exceeded, an error-frame-seconds link event is generated. If the high threshold is exceeded then action defined through the command ethernet oam link-monitor high threshold action will be taken.

Prerequisites

Command Syntax

ethernet oam link-monitor frame-seconds threshold high (*HIGH_THRES*|none) low *LOW_THRES* window *WINDOW*

no ethernet oam link-monitor frame-seconds threshold high

Command Mode

Interface Configuration.

Default

The default value for high threshold is none, meaning that no high threshold is configure. The default value for the low threshold is 1. The default value of frame event window is 1000.

Usage

None

Examples

The following example shows how to configure the threshold and window for the frame-seconds event:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam link-monitor frame-seconds threshold high 5 low 2 window 200

Related Commands

show ethernet oam status

Command Purpose

Use this command to define action when high threshold is detected. Use no form of the command to reset the action.

Prerequisites

Command Syntax

ethernet oam link-monitor high threshold action error-disable-interface

no ethernet oam link-monitor high threshold action error-disable-interface

Command Mode

Interface Configuration

Default

When high threshold is exceeded it will generate only the corresponding link event and will not trigger any interface events by default.

Usage

None

Examples

The following example shows how to define action of error-disable interface when high threshold is detected:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam link-monitor high-threshold action error-disable-interface

Related Commands

show ethernet oam status

Command Purpose

Use this command to configure remote loopback on an interface. This command can be used to enable or disable remote loopback and also configure the remote loopback timeout, which is the number of seconds the DTE will wait for the remote DTE to respond to the ethernet oam remote-loopback enable command. Use the no form of this command to remove remote-loopback support from the interface.

Prerequisites

Command Syntax

ethernet oam remote-loopback {supported|timeout *SECS*}

no ethernet oam remote-loopback {supported|timeout}

Command Mode

Interface Configuration

Default

The default state for the remote loopback is not supported. If a timeout is not configured, the local DTE remains in remote loopback state until the remote DTE responds or the user stops remote loopback administratively.

One switch supports 4 interfaces in “local Loopback” status at the same time.

Usage

None

Examples

The following example shows how to support remote-loopback on interface eth-0-1:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam remote-loopback supported

Related Commands

show ethernet oam status

Command Purpose

Use this command to start an Ethernet OAM remote-loopback mechanism.

Prerequisites

Command Syntax

ethernet oam remote-loopback start interface *IFNAME*

Command Mode

Privileged EXEC

Default

The default state of the remote loopback function is disabled.

Usage

This command is used to start a remote loopback mechanism.

Examples

The following example shows how to start an Ethernet OAM remote-loopback mechanism:

Switch# ethernet oam remote-loopback start interface eth-0-1

Related Commands

show ethernet oam state-machine

Command Purpose

Use this command to stop an Ethernet OAM remote-loopback process.

Prerequisites

Command Syntax

ethernet oam remote-loopback stop interface *IFNAME*

Command Mode

Privileged EXEC

Default

Use this command to stop an Ethernet OAM remote loopback mechanism.

Usage

Use this command to stop an Ethernet OAM remote loopback mechanism.

Examples

The following example shows how to stop an Ethernet OAM remote-loopback process:

Switch# ethernet oam remote-loopback stop interface eth-0-9

Related Commands

show ethernet oam state-machine

Command Purpose

Use this command to reset the LOCAL_LOST_LINK_TIMER and start an Ethernet OAM discovery process. Use the no form of the command to reset to the default value.

Prerequisites

Command Syntax

ethernet oam timeout *SECONDS*

no ethernet oam timeout

Command Mode

Interface Configuration

Default

The default value of the timeout is 5 seconds.

Usage

This command is used to start a discovery process by resetting the LOCAL_LOST_LINK_TIMER.

Examples

The following example shows how to set the timeout to 5s:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam timeout 5

Related Commands

None

Command Purpose

Use this command to error-disable port when get remote failure item form peer. Use the no form of the command to unset the action.

Prerequisites

Command Syntax

ethernet oam remote-failure (link-fault|critical-event|dying-gasp) action error-disable-interface

no ethernet oam remote-failure (link-fault|critical-event|dying-gasp) action error-disable-interface

Command Mode

Interface Configuration

Default

None

Usage

This command is used to error-disable port when get remote failure item form peer.

Examples

The following example shows how to error-disable port when get remote failure item form peer on interface eth-0-1:

Switch# configure terminal
Switch(config)# interface eth-0-1
Switch(config-if)# ethernet oam remote-failure link-fault action error-disable-interface

Related Commands

None

Command Purpose

Use this command to display the ethernet oam administrative and operation configuration for local and remote DTE.

Prerequisites

Command Syntax

show ethernet oam discovery (interface *IFNAME*)

Command Mode

Privileged EXEC

Default

None

Usage

The following sample output from this command displays ethernet oam administrative and operation configurations for local and remote DTE.

Examples

The following example shows how to display the ethernet oam administrative and operation configuration for local and remote DTE of interface eth-0-1:

Switch# show ethernet oam discovery interface eth-0-1

Related Commands

None

Command Purpose

Use this command to display the runtime settings of link-monitoring and general OAM operations for all interfaces or for a specific interface.

Prerequisites

Command Syntax

show ethernet oam status (interface *IFNAME*)

Command Mode

Privileged EXEC

Default

None

Usage

None

Examples

The following example shows how to display the runtime settings of link-monitoring and general OAM operations of interface eth-0-1:

Switch# show ethernet oam status interface eth-0-1

Related Commands

None

Command Purpose

Use this command to display the state machine information.

Prerequisites

Command Syntax

show ethernet oam state-machine (interface *IFNAME*)

Command Mode

Privileged EXEC

Default

None

Usage

The command displays the state of the interface.

Examples

The following example shows how to display the state machine information of eth-0-1:

Switch# show ethernet oam state-machine interface eth-0-1

Related Commands

None

Command Purpose

Use this command to display the statistics information.

Prerequisites

Command Syntax

show ethernet oam statistics (interface *IFNAME*)

Command Mode

Privileged EXEC

Default

None

Usage

The command displays the statistics of the interface.

Examples

The following example shows how to display the statistics information of eth-0-1:

Switch# show ethernet oam statistics interface eth-0-1

Related Commands

None