Interface and Hardware Component Command Reference for the Cisco NCS 6000 Series Routers
Ethernet OAM Commands

Ethernet OAM Commands

This module provides command line interface (CLI) commands for configuring Ethernet Operations, Administration, and Maintenance (EOAM) on the Cisco NCS 6000 Series Router.

action capabilities-conflict

To configure what action is taken on an interface when a capabilities-conflict event occurs, use the action capabilities-conflict command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action capabilities-conflict { disable | efd | error-disable-interface | log }

no action capabilities-conflict { disable | efd | error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a capabilities-conflict event occurs.

efd

Puts the line protocol into the down state for an interface when a capabilities-conflict event occurs. The state is removed when the first packet is received without a conflict.

error-disable-interface

Puts the interface into the error-disable state when a capabilities-conflict event occurs.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a capabilities-conflict event occurs. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration  (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a capabilities-conflict event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action capabilities-conflict disable 
   

The following example shows how to configure putting the interface into the line-protocol-down state when a capabilities-conflict event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action capabilities-conflict efd 
   

The following example shows how to configure that the interface is put into the error-disable state when a capabilities-conflict event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action capabilities-conflict error-disable-interface
   

The following example shows how to configure that a syslog entry is created when a capabilities-conflict event occurs. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action capabilities-conflict log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action critical-event

To configure what action is taken on an interface when a critical-event notification is received from the remote Ethernet OAM peer, use the action critical-event command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action critical-event { disable | error-disable-interface | log }

no action critical-event { disable | error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a critical-event notification is received.

error-disable-interface

Puts the interface into the error-disable state when a critical-event notification is received.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a critical-event notification is received. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a critical-event notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action critical-event disable 
   

The following example shows how to configure that the interface is put into the error-disable state when a critical-event notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action critical-event error-disable-interface
   

The following example shows how to configure that a syslog entry is created when a critical-event notification is received. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action critical-event log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action discovery-timeout

To configure what action is taken on an interface when a connection timeout occurs, use the action discovery-timeout command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action discovery-timeout { disable | efd error-disable-interface | log }

no action discovery-timeout { disable | efd error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a connection timeout occurs.

efd

Puts the line protocol into the down state for an interface when a connection timeout occurs. The state is removed when the session is re-established.

error-disable-interface

Puts the interface into the error-disable state when a connection timeout occurs.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a connection timeout occurs. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a connection timeout occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action discovery-timeout disable 

The following example shows how to configure putting the interface into the line-protocol-down state when a connection timeout occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action discovery-timeout efd 
   

The following example shows how to configure that the interface is put into the error-disable state when a connection timeout occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action discovery-timeout error-disable-interface
   

The following example shows how to configure that a syslog entry is created when a connection timeout occurs. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action discovery-timeout log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action dying-gasp

To configure what action is taken on an interface when a dying-gasp notification is received from the remote Ethernet OAM peer, use the action dying-gasp command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action dying-gasp { disable | error-disable-interface | log }

no action dying-gasp { disable | error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a dying-gasp notification is received.

error-disable-interface

Puts the interface into the error-disable state when a dying-gasp notification is received.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a dying-gasp notification is received. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a dying-gasp notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action dying-gasp disable 
   

The following example shows how to configure that the interface is put into the error-disable state when a dying-gasp notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action dying-gasp error-disable-interface
   

The following example shows how to configure that a syslog entry is created when a dying-gasp notification is received. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action dying-gasp log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action high-threshold

To configure what action is taken on an interface when a high threshold is exceeded, use the action high-threshold command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action high-threshold { disable | error-disable-interface | log }

no action high-threshold { disable | error-disable-interface | log }

Syntax Description

disable

(Interface Ethernet OAM configuration only) Performs no action on the interface when a high threshold is exceeded.

error-disable-interface

Puts the interface into the error-disable state when a high threshold is exceeded.

log

Creates a syslog entry when a high threshold is exceeded. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default is that no action is taken when a high threshold is exceeded.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that a syslog entry is created on the interface when a high threshold is exceeded.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action high-threshold log 
   

The following example shows how to configure that the interface is put into the error-disable state when a high threshold is exceeded.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action high-threshold error-disable-interface
   

The following example shows how to configure that no action is taken when a high threshold is exceeded. This configuration overrides the Ethernet OAM profile configuration.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action high-threshold disable 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action remote-loopback

To configure what action is taken on an interface when a remote-loopback event occurs, use the action remote-loopback command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action remote-loopback { disable | log }

no action remote-loopback { disable | log }

Syntax Description

disable

Performs no action on the interface when a remote-loopback event occurs.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a remote-loopback event occurs. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a remote-loopback event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action remote-loopback disable 
   

The following example shows how to configure that a syslog entry is created when a remote-loopback event occurs. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action remote-loopback log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action session-down

To configure what action is taken on an interface when an Ethernet OAM session goes down, use the action session-down command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action session-down { disable | efd | error-disable-interface | log }

no action session-down { disable | efd | error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a capabilities-conflict event occurs.

efd

Puts the line protocol into the down state for an interface when a capabilities-conflict event occurs. The state is removed when the first packet is received without a conflict.

error-disable-interface

Puts the interface into the error-disable state when a capabilities-conflict event occurs.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a capabilities-conflict event occurs. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when an Ethernet OAM session goes down.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action session-down disable 
   

The following example shows how to configure putting the interface into the line-protocol-down state when an Ethernet OAM session goes down.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action session-down efd 
   

The following example shows how to configure that the interface is put into the error-disable state when an Ethernet OAM session goes down.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action session-down error-disable-interface
   

The following example shows how to configure that a syslog entry is created when an Ethernet OAM session goes down. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action session-down log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action session-up

To configure what action is taken on an interface when an Ethernet OAM session is established, use the action session-up command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action session-up { disable | log }

no action session-up { disable | log }

Syntax Description

disable

Performs no action on the interface when an Ethernet OAM session is established.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when an Ethernet OAM session is established. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when an Ethernet OAM session is established.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action session-up disable 
  

The following example shows how to configure that a syslog entry is created when an Ethernet OAM session is established. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action session-up log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action uni-directional link-fault

To configure what action is taken on an interface when a link-fault notification is received from the remote Ethernet OAM peer, use the action uni-directional link-fault command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action uni-directional link-fault { disable | efd | error-disable-interface | log }

no action uni-directional link-fault { disable | efd | error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a capabilities-conflict event occurs.

efd

Puts the line protocol into the down state for an interface when a capabilities-conflict event occurs. The state is removed when the first packet is received without a conflict.

error-disable-interface

Puts the interface into the error-disable state when a capabilities-conflict event occurs.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a capabilities-conflict event occurs. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to create a syslog entry.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

This command only determines the action taken when a uni-directional link fault notification is received from the peer; it does not affect the action taken when a fault is detected locally.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a link-fault notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action uni-directional link-fault disable 
   

The following example shows how to configure putting the interface into the line-protocol-down state when a link-fault notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action uni-directional link-fault efd 
   

The following example shows how to configure that the interface is put into the error-disable state when a link-fault notification is received.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action uni-directional link-fault error-disable-interface
   

The following example shows how to configure that a syslog entry is created when a link-fault notification is received. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# action uni-directional link-fault log 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action wiring-conflict

To configure what action is taken on an interface when a wiring-conflict event occurs, use the action wiring-conflict command in Ethernet OAM configuration mode or interface Ethernet OAM configuration mode. To return to the default, use the no form of this command.

action wiring-conflict { disable | efd | error-disable-interface | log }

no action wiring-conflict { disable | efd | error-disable-interface | log }

Syntax Description

disable

Performs no action on the interface when a capabilities-conflict event occurs.

efd

Puts the line protocol into the down state for an interface when a capabilities-conflict event occurs. The state is removed when the first packet is received without a conflict.

error-disable-interface

Puts the interface into the error-disable state when a capabilities-conflict event occurs.

log

(Interface Ethernet OAM configuration only) Creates a syslog entry when a capabilities-conflict event occurs. This action is available only in interface Ethernet OAM configuration mode to override the OAM profile on a specific interface.

Command Default

The default action is to put the interface into error-disable state.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure that no action is performed on the interface when a wiring-conflict event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action wiring-conflict disable 
   

The following example shows how to configure putting the interface into the line-protocol-down state when a wiring-conflict event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action wiring-conflict efd 
   

The following example shows how to configure that a syslog entry is created when a wiring-conflict event occurs.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# action wiring-conflict log
   

The following example shows how to configure that the interface is put into the error-disable state when a wiring-conflict event occurs. This configuration overrides the interface Ethernet OAM profile.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/0/0 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
(config-if-eoam)# action wiring-conflict error-disable-interface 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

clear ethernet oam statistics

To clear the packet counters on Ethernet OAM interfaces, use the clear ethernet oam statistics command in EXEC mode.

clear ethernet oam statistics [ interface type interface-path-id | location node-id all ]

Syntax Description

interface type interface-path-id 

(Optional) Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

location

Clears the statistics for a specific node.

For more information about the syntax for the router, use the question mark (?) online help function.

node-id

Path ID of the node.

all

Clears the statistics for all nodes on the router.

Command Default

No parameters clears the packet counters on all Ethernet OAM interfaces.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

execute

Examples

The following example shows how to clear the packet counters on a specific interface:

RP/0/RP0/CPU0:router# clear ethernet oam statistics interface gigabitethernet 0/1/5/1 
   

Related Commands

Command

Description

show ethernet oam statistics

Displays the local and remote Ethernet OAM statistics for interfaces.  

show ethernet oam interfaces

 

connection timeout

To configure the timeout value for an Ethernet OAM session, use the connection timeout command in Ethernet OAM configuration mode.

connection timeout seconds

Syntax Description

seconds

Connection timeout period in seconds. The range is 2 to 30.

Command Default

The default value is 5.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

If no packets are received from the OAM peer in the specified time, the OAM session is brought down, and the negotiation phase starts again.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the connection timeout value of an Ethernet OAM session:

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# connection timeout 20 
   

Related Commands

Command

Description

action discovery-timeout

Configures what action is taken on an interface when a connection timeout occurs.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam discovery

Displays the currently configured OAM information of Ethernet OAM sessions on interfaces.  

show ethernet oam interfaces

 

ethernet oam

To enable Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode, use the ethernet oam command in interface configuration mode. To disable Ethernet Link OAM, use the no form of this command.

ethernet oam

no ethernet oam

Syntax Description

This command has no keywords or arguments.

Command Default

When enabled on an interface, the Ethernet Link OAM default values apply.

Command Modes

Interface configuration (config-if)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When you enable Ethernet Link OAM on an interface, the default Ethernet Link OAM values are applied to the interface. For the default Ethernet Link OAM values, see the related Ethernet Link OAM commands.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to enable Ethernet Link OAM and enter interface Ethernet OAM configuration mode.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/5/6 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)#
   

ethernet oam loopback

To start or stop a loopback at the remote end of an Ethernet OAM interface, use the ethernet oam loopback command in EXEC mode.

ethernet oam loopback { enable | disable } type interface-path-id

Syntax Description

enable

Starts a loopback at the remote end.

disable

Stops the loopback at the remote end.

type

Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

Loopback is not enabled.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

This command puts the remote peer device into loopback mode. This means that all traffic sent to the peer is looped back, which means that it is sent back from the peer and received by the router. All traffic received from the peer device is discarded.

This command returns when the OAM client receives confirmation from the remote end that the remote loopback has been enabled or disabled. If no response or a failure response is received, an error is returned.

Task ID

Task ID

Operations

ethernet-services

execute

Examples

The following example shows how to start a loopback at the far end of an Ethernet OAM interface.

RP/0/RP0/CPU0:router# ethernet oam loopback enable tengigabitethernet 0/6/1/0 
   

Related Commands

Command

Description

remote-loopback

Enables a remote loopback on the far end of an Ethernet OAM interface.  

action remote-loopback

Configures what action is taken on an interface when a remote-loopback event occurs.  

snmp-server traps ethernet oam events

 

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

ethernet oam profile

To create an Ethernet Operations, Administration and Maintenance (EOAM) profile and enter EOAM configuration mode, use the ethernet oam profile command in XR Config mode. To delete an EOAM profile, use the no form of this command.

ethernet oam profile profile-name

no ethernet oam profile profile-name

Syntax Description

profile-name

Text string name of the OAM profile. The maximum length is 32 bytes.

Command Default

No default behavior or values

Command Modes

XR config

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Before you can delete an EOAM profile, you must remove the profile from all interfaces to which it is attached.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

This example shows how to create an Ethernet OAM profile and enter Ethernet OAM configuration mode:

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# 
   

frame-period threshold

To configure the thresholds that trigger an Ethernet OAM frame-period error event, use the frame-period threshold command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the threshold to the default value, use the no form of this command.

frame-period threshold low threshold [ high threshold ]

no frame-period threshold low threshold [ high threshold ]

Syntax Description

low threshold

Low threshold, in frames, that triggers a frame-period error event. The range is 0 to 1000000.

high threshold

(Optional) High threshold, in frames, that triggers a frame-period error event. The range is 0 to 1000000. The high threshold value can be configured only in conjunction with the low threshold value.

Command Default

The default low threshold is 1.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When the low threshold is passed, a frame-period error event notification is generated and transmitted to the OAM peer. Additionally, any registered higher level OAM protocols, such as Connectivity Fault Management (CFM), are also notified. When the high threshold is passed, the configured high threshold action is performed in addition to the low threshold actions. The high threshold is optional and is configurable only in conjunction with the low threshold.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the low and high thresholds that trigger a frame-period error event.

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# frame-period threshold low 100 high 600000 
   

frame-period window

To configure the window size for an Ethernet OAM frame-period error event, use the frame-period window command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the window size to the default value, use the no form of this command.

frame-period window window

no frame-period window window

Syntax Description

window

Size of the window for a frame-period error in milliseconds. The range is 100 to 60000.

Command Default

The default value is 1000.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the window size for a frame-period error.

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# frame-period window 60000 
   

frame-seconds threshold

To configure the thresholds that trigger a frame-seconds error event, use the frame-seconds threshold command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the threshold to the default value, use the no form of this command.

frame-seconds threshold low threshold [ high threshold ]

no frame-seconds threshold low threshold [ high threshold ]

Syntax Description

low threshold

Low threshold, in seconds, that triggers a frame-seconds error event. The range is 0 to 900.

high threshold

(Optional) High threshold, in seconds, that triggers a frame-seconds error event. The range is 1 to 900. The high threshold value can be configured only in conjunction with the low threshold value.

Command Default

The default value is 1.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When the low threshold is passed, a frame-seconds error event notification is generated and transmitted to the OAM peer. Additionally, any registered higher level OAM protocols, such as Connectivity Fault Management (CFM), are also notified. When the high threshold is passed, the configured high threshold action is performed in addition to the low threshold actions. The high threshold is optional and is configurable only in conjunction with the low threshold.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the low and high thresholds that trigger a frame-seconds error event:

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor (config-eoam)#  link-monitor
RP/0/RP0/CPU0:router(config-eoam-lm)# frame-seconds threshold low 10 high 900 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

link-monitor

Enters Ethernet OAM link monitor configuration mode.  

frame-seconds window

To configure the window size for the OAM frame-seconds error event, use the frame-seconds window command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the window size to the default value, use the no form of this command.

frame-seconds window window

no frame-seconds window window

Syntax Description

window

Size of the window for a frame-seconds error in milliseconds. The range is 10000 to 900000.

Command Default

The default value is 60000.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the window size for a frame-seconds error.

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# frame-seconds window 900000 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

link-monitor

Enters Ethernet OAM link monitor configuration mode.  

frame threshold

To configure the thresholds that triggers an Ethernet OAM frame error event, use the frame threshold command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the threshold to the default value, use the no form of this command.

frame threshold low threshold [ high threshold ]

no frame threshold low threshold [ high threshold ]

Syntax Description

low threshold

Low threshold, in symbols, that triggers a frame error event. The range is 0 to 12000000.

high threshold

(Optional) High threshold, in symbols, that triggers a frame error event. The range is 0 range is 0 to 12000000. The high threshold value can be configured only in conjunction with the low threshold value.

Command Default

The default low threshold is 1.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When the low threshold is passed, a frame error event notification is generated and transmitted to the OAM peer. Additionally, any registered higher level OAM protocols, such as Connectivity Fault Management (CFM), are also notified. When the high threshold is passed, the configured high threshold action is performed in addition to the low threshold actions. The high threshold is optional and is configurable only in conjunction with the low threshold.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the low and high thresholds that trigger a frame error event:

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# frame threshold low 100 high 60000 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

link-monitor

Enters Ethernet OAM link monitor configuration mode.  

frame window

To configure the frame window size of an OAM frame error event, use the frame window command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the window size to the default value, use the no form of this command.

frame window window

no frame window window

Syntax Description

window

Size of the window for a frame error in seconds. The range is 1000 to 60000.

Command Default

The default value is 1000.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the window size for a frame error.

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# frame window 60 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

link-monitor

Enters Ethernet OAM link monitor configuration mode.  

link-monitor

To enter Ethernet OAM link monitor configuration mode, use the link-monitor command in Ethernet OAM configuration mode. To enter interface Ethernet OAM link monitor configuration mode, use the link-monitor command in interface Ethernet OAM configuration mode.

link-monitor

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

This example shows how to enter the Ethernet OAM link monitor configuration mode.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# 
   

The following example shows how to enter the link monitor configuration mode from interface Ethernet OAM configuration mode.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/5/6 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# link-monitor 
   

mib-retrieval

To enable MIB retrieval in an Ethernet OAM profile or on an Ethernet OAM interface, use the mib-retrieval command in Ethernet OAM or interface Ethernet OAM configuration mode. To return the interface to the default (disabled), use the disable keyword.

mib-retrieval [disable]

Syntax Description

disable

Disables MIB retrieval the Ethernet OAM interface.

Command Default

MIB retrieval is disabled by default.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When MIB retrieval is enabled on an Ethernet OAM interface, the OAM client advertises support for MIB retrieval to the peer.

When MIB retrieval is disabled (the default), only the enable form of the mib-retrieval command is available in interface Ethernet OAM configuration mode. The disable keyword is provided to override the profile when needed.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to enable MIB retrieval on a Gigabit Ethernet interface:

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/5/6 
RP/0/RP0/CPU0:router(config-if)# ethernet oam 
RP/0/RP0/CPU0:router(config-if-eoam)# mib-retrieval 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam interfaces

 

mode (Ethernet OAM)

To configure the Ethernet OAM mode on an interface, use the mode command in Ethernet OAM or interface Ethernet OAM configuration mode. To return to the default, use the no form of the command.

mode { active | passive }

Syntax Description

passive

Specifies that the interface operates in passive mode, where it cannot initiate the discovery process, generate a retrieval PDU, or request loopback.

active

(Interface Ethernet OAM configuration only) Specifies that the interface operates in active mode to initiate processes and make requests.

Command Default

The default is active.

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

If a profile exists on the interface, setting the mode with this command overrides the mode setting in the profile on an interface.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to enable Ethernet OAM passive mode on a Gigabit Ethernet interface:

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/5/6 
RP/0/RP0/CPU0:router(config-if)# ethernet oam 
RP/0/RP0/CPU0:router(config-if-eoam)# profile Profile_1 
RP/0/RP0/CPU0:router(config-if-eoam)# mode passive 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam interfaces

 

monitoring

To enable Ethernet OAM link monitoring, use the monitoring command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return link monitoring to its default state of enabled, use the no form of this command.

monitoring [disable]

no monitoring [disable]

Syntax Description

disable

(Optional) Disables Ethernet OAM link monitoring.

Note   

When configuring on a profile, only the monitoring disable form of the command is supported.

Command Default

Link monitoring is enabled by default.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Monitoring is enabled by default. To disable it either on a profile or an interface, use the monitoring disable form of the command.

If monitoring is disabled on a profile, but you want to override the configuration and enable it for an interface, use the monitoring command in interface Ethernet OAM link monitor configuration mode.

You cannot configure the monitoring command without the disable keyword on a profile.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to disable link-monitoring on an Ethernet OAM interface:

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# monitoring disable 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

link-monitor

Enters Ethernet OAM link monitor configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam statistics

Displays the local and remote Ethernet OAM statistics for interfaces.  

show ethernet oam interfaces

 

profile (EOAM)

To attach an Ethernet OAM profile to an interface, use the profile command in interface Ethernet OAM configuration mode. To remove the profile from the interface, use the no form of this command.

profile name

no profile name

Syntax Description

name

Text name of the Ethernet OAM profile to attach to the interface.

Command Default

No profile is attached.

Command Modes

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When an Ethernet OAM profile is attached to an interface using this command, all of the parameters configured for the profile are applied to the interface.

Individual parameters that are set by the profile configuration can be overridden by configuring them directly on the interface.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to attach an Ethernet OAM profile to a Gigabit Ethernet interface.

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/1/5/6 
RP/0/RP0/CPU0:router(config-if)# ethernet oam   
RP/0/RP0/CPU0:router(config-if-eoam)# profile Profile_1 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam interfaces

 

require-remote

To require that certain features are enabled before an OAM session can become active, or to disable a requirement that is part of an active OAM profile, use the require-remote command in Ethernet OAM configuration or interface Ethernet OAM configuration mode. To remove the configuration and return to the default, use the no form of this command.

require-remote { mode { active | passive } | mib-retrieval | remote-loopback | link-monitoring [disabled] }

no require-remote { mode { active | passive } | mib-retrieval | remote-loopback | link-monitoring [disabled] }

Syntax Description

mode {active | passive}

Requires that active or passive mode is configured on the peer device before the OAM profile can become active.

mib-retrieval

Requires that MIB-retrieval is configured on the peer device before the OAM profile can become active.

remote-loopback

Requires that remote-loopback is configured on the peer device before the OAM profile can become active.

link-monitoring

Requires that link-monitoring feature is configured on the peer device before the OAM profile can become active.

disabled

(Optional—Interface Ethernet OAM configuration only) Overrides the Ethernet OAM profile configuration for this option and disables the feature at the specified interface.

Command Default

No default behavior or values

Command Modes

Ethernet OAM configuration (config-eoam)

Interface Ethernet OAM configuration (config-if-eoam)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The disabled keyword is available only when you are configuring Ethernet OAM on an interface, and is used to override the configuration that is part of an active OAM profile.

The disabled keyword does not remove the configuration of the command. Use the no form of this command to do that.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to require that specific features are enabled before an OAM session can become active

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# require-remote mode active 
RP/0/RP0/CPU0:router(config-eoam)# require-remote mib-retrieval 
RP/0/RP0/CPU0:router(config-eoam)# require-remote link-monitoring 
   

The following example shows how to disable requirements on a particular interface that is part of an active OAM profile:

RP/0/RP0/CPU0:router# configure 
RP/0/RP0/CPU0:router(config)# interface gigabitethernet 0/6/5/0
RP/0/RP0/CPU0:router(config-if)# ethernet oam
RP/0/RP0/CPU0:router(config-if-eoam)# require-remote mode active disabled 
RP/0/RP0/CPU0:router(config-if-eoam)# require-remote mib-retrieval disabled 
RP/0/RP0/CPU0:router(config-if-eoam)# require-remote link-monitoring disabled 
   

Related Commands

Command

Description

ethernet oam profile

Creates an EOAM profile and enters EOAM configuration mode.  

ethernet oam

Enables Ethernet Link OAM, with default values, on an interface and enter interface Ethernet OAM configuration mode.  

profile (EOAM)

Attaches an Ethernet OAM profile to an interface.  

action capabilities-conflict

Configures what action is taken on an interface when a capabilities-conflict event occurs.  

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam discovery

Displays the currently configured OAM information of Ethernet OAM sessions on interfaces.  

show ethernet oam interfaces

 

show efd interface

To display all interfaces that are shut down because of Ethernet Fault Detection (EFD), or to display whether a specific interface is shut down because of EFD, use the show efd interface command in XR EXEC mode.

show efd interface [ type interface-path-id ]

Syntax Description

type

(Optional) Interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

If no parameters are specified, all interfaces that are shut down because of EFD are displayed.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

If this command is issued when no EFD errors are detected, the system displays the following message:

< date time >
No matching interfaces with EFD-shutdown triggered 
   

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to display all interfaces that are shut down because of Ethernet Fault Detection (EFD):

RP/0/RP0/CPU0:router# show efd interfaces 

Server VLAN MA
==============
Interface         Clients
-------------------------
GigE0/0/0/0.0     CFM
   

Related Commands

Command

Description

efd

Enables EFD on all down MEPs in a down MEPs service.  

log efd

Enables logging of EFD state changes to an interface (such as when an interface is shut down or brought up via EFD).  

show ethernet oam configuration

To display the current active Ethernet OAM configuration on an interface, use the show ethernet oam configuration command in EXEC mode.

show ethernet oam configuration [ interface type interface-path-id ]

Syntax Description

interface type

(Optional) Displays information about the specified interface type. For more information, use the question mark (?) online help function.

interface-path-id

(Optional) Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

If no parameters are specified, the configurations for all Ethernet OAM interfaces is displayed.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

This command displays the Ethernet OAM configuration information for all interfaces, or a specified interface.

Task ID

Task ID

Operations

ethernet-services

read

Examples

The following example shows how to display Ethernet OAM configuration information for a specific interface:

RP/0/RP0/CPU0:router# show ethernet oam configuration interface gigabitethernet 0/4/0/0 
Thu Aug  5 21:54:34.050 DST
GigabitEthernet0/4/0/0:
  Hello interval:                                              1s
  Link monitoring enabled:                                      Y
  Remote loopback enabled:                                      N
  Mib retrieval enabled:                                        N
  Uni-directional link-fault detection enabled:                 N
  Configured mode:                                         Active
  Connection timeout:                                           5
  Symbol period window:                                         0
  Symbol period low threshold:                                  1
  Symbol period high threshold:                              None
  Frame window:                                              1000
  Frame low threshold:                                          1
  Frame high threshold:                                      None
  Frame period window:                                       1000
  Frame period low threshold:                                   1
  Frame period high threshold:                               None
  Frame seconds window:                                     60000
  Frame seconds low threshold:                                  1
  Frame seconds high threshold:                              None
  High threshold action:                                     None
  Link fault action:                                          Log
  Dying gasp action:                                          Log
  Critical event action:                                      Log
  Discovery timeout action:                                   Log
  Capabilities conflict action:                               Log
  Wiring conflict action:                           Error-Disable
  Session up action:                                          Log
  Session down action:                                        Log
  Remote loopback action:                                     Log
  Require remote mode:                                     Ignore
  Require remote MIB retrieval:                                 N
  Require remote loopback support:                              N
  Require remote link monitoring:                               N
   

The following example shows how to display the configuration for all EOAM interfaces:

RP/0/RP0/CPU0:router# show ethernet oam configuration
Thu Aug  5 22:07:06.870 DST
GigabitEthernet0/4/0/0:
  Hello interval:                                              1s
  Link monitoring enabled:                                      Y
  Remote loopback enabled:                                      N
  Mib retrieval enabled:                                        N
  Uni-directional link-fault detection enabled:                 N
  Configured mode:                                         Active
  Connection timeout:                                           5
  Symbol period window:                                         0
  Symbol period low threshold:                                  1
  Symbol period high threshold:                              None
  Frame window:                                              1000
  Frame low threshold:                                          1
  Frame high threshold:                                      None
  Frame period window:                                       1000
  Frame period low threshold:                                   1
  Frame period high threshold:                               None
  Frame seconds window:                                     60000
  Frame seconds low threshold:                                  1
  Frame seconds high threshold:                              None
  High threshold action:                                     None
  Link fault action:                                          Log
  Dying gasp action:                                          Log
  Critical event action:                                      Log
  Discovery timeout action:                                   Log
  Capabilities conflict action:                               Log
  Wiring conflict action:                           Error-Disable
  Session up action:                                          Log
  Session down action:                                        Log
  Remote loopback action:                                     Log
  Require remote mode:                                     Ignore
  Require remote MIB retrieval:                                 N
  Require remote loopback support:                              N
  Require remote link monitoring:                               N
   

Related Commands

Command

Description

show ethernet oam discovery

Displays the currently configured OAM information of Ethernet OAM sessions on interfaces.  

show ethernet oam statistics

Displays the local and remote Ethernet OAM statistics for interfaces.  

show ethernet oam interfaces

 

show ethernet oam discovery

To display the currently configured OAM information of Ethernet OAM sessions on interfaces, use the show ethernet oam discovery command in EXEC mode.

show ethernet oam discovery [ brief | interface type interface-path-id [remote] ]

Syntax Description

brief

Displays minimal, currently configured OAM information in table form.

interface type

(Optional) Displays information about the specified interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

remote

(Optional) Retrieves and displays information from a remote device, as if the command was run on the remote device.

Command Default

Displays detailed information for Ethernet OAM sessions on all interfaces.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read

Examples

The following example shows how to display the minimal, currently configured OAM information for Ethernet OAM sessions on all interfaces:

RP/0/RP0/CPU0:router# show ethernet oam discovery brief

Sat Jul  4 13:52:42.949 PST
Flags:
    L - Link Monitoring support
    M - MIB Retrieval support
    R - Remote Loopback support
    U - Unidirectional detection support
    * - data is unavailable

Local                  Remote         Remote                   
Interface              MAC Address    Vendor Mode    Capability
---------------------- -------------- ------ ------- ----------
Gi0/1/5/1              0010.94fd.2bfa 00000A Active  L 
Gi0/1/5/2              0020.95fd.3bfa 00000B Active  M 
Gi0/1/6/1              0030.96fd.6bfa 00000C Passive L R
Fa0/1/3/1              0080.09ff.e4a0 00000C Active  L R
   

The following example shows how to display detailed, currently configured OAM information for the Ethernet OAM session on a specific interface:

RP/0/RP0/CPU0:router# show ethernet oam discovery interface gigabitethernet 0/1/5/1 

Sat Jul  4 13:56:49.967 PST
GigabitEthernet0/1/5/1:
Local client
------------
  Administrative configuration:
    PDU revision:                         1
    Mode:                            Active
    Unidirectional support:               N
    Link monitor support:                 Y
    Remote loopback support:              N
    MIB retrieval support:                N
    Maximum PDU size:                  1500
    Mis-wiring detection key:          5E9D

Operational status:
    Port status:                Active send
    Loopback status:                   None
    Interface mis-wired:                  N

Remote client
-------------
  MAC address:               0030.96fd.6bfa
  Vendor (OUI):            00.00.0C (Cisco)

  Administrative configuration:
    PDU revision:                         5
    Mode:                           Passive
    Unidirectional support:               N
    Link monitor support:                 Y
    Remote loopback support:              Y
    MIB retrieval support:                N
    Maximum PDU size:                  1500
   

Related Commands

Command

Description

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam statistics

Displays the local and remote Ethernet OAM statistics for interfaces.  

show ethernet oam interfaces

 

show ethernet oam interfaces

To display the current state of Ethernet OAM interfaces, use the show ethernet oam interfaces command in EXEC mode.

show ethernet oam interfaces [ interface type interface-path-id ]

Syntax Description

interface type

(Optional) Displays information about the specified interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

Command Default

No parameters displays the current state for all Ethernet OAM interfaces.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read

Examples

The following example shows how to display the current state for all Ethernet OAM interfaces:

RP/0/RP0/CPU0:routershow ethernet oam interfaces
GigabitEthernet0/0/0/0
In REMOTE_OK state
Local MWD key: 80081234
Remote MWD key: 8F08ABCC
EFD triggered: Yes (link-fault)
   
Table 1 show ethernet oam interfaces Field Descriptions

Field

Description

In type state

The possible discovery state type values are:

  • ACTIVE_SEND_LOCAL—The interface is configured in active mode (the default), but no Information PDUs have been received from the peer (except possibly link-fault PDUs). Information PDUs are sent.
  • FAULT—A local unidirectional link fault has been detected. Link-fault PDUs are sent.
  • INACTIVE—The interface is down.
  • PASSIVE_WAIT—The interface is configured in passive mode (mode passive command) but no Information PDUs have been received from the peer (except possibly link-fault PDUs). No PDUs are sent.
  • REMOTE—(Also known as SEND_LOCAL_REMOTE). Information PDUs are being sent and received, but the local device is not satisfied with the remote peer's capabilities (for example, because there is a 'require-remote' configuration and the peer does not have the required capabilities).
  • REMOTE_OK—(Also known as SEND_LOCAL_REMOTE_OK). Information PDUs are being sent and received, and the local device is satisfied with the peer's capabilities, but the remote peer is not satisfied with the local device capabilities (for example, because there is a 'require-remote' configuration on the peer device).
  • SEND_ANY—The discovery process has completed, both devices are satisfied with the configuration and the session is up. All types of PDU can be sent and received.

EFD triggered

Indicates if an Ethernet Fault Detection (EFD) event has occurred on the interface and the type of fault that triggered the interface to be moved to the down state for the line protocol. The possible EFD trigger events are:

  • capabilities-conflict
  • discovery-timeout
  • link-fault
  • session-down
  • wiring-conflict

Related Commands

Command

Description

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam discovery

Displays the currently configured OAM information of Ethernet OAM sessions on interfaces.  

show ethernet oam statistics

Displays the local and remote Ethernet OAM statistics for interfaces.  

show ethernet oam statistics

To display the local and remote Ethernet OAM statistics for interfaces, use the show ethernet oam statistics command in EXEC mode.

show ethernet oam statistics [ interface type interface-path-id [remote] ]

Syntax Description

interface type

(Optional) Displays information about the specified interface type. For more information, use the question mark (?) online help function.

interface-path-id

Physical interface or virtual interface.

Note   

Use the show interfaces command to see a list of all interfaces currently configured on the router.

For more information about the syntax for the router, use the question mark (?) online help function.

remote

(Optional) Retrieves and displays information from a remote device, as if the command was run on the remote device.

Command Default

No parameters displays statistics for all Ethernet OAM interfaces.

Command Modes

XR EXEC

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read

Examples

The following example shows how to display Ethernet OAM statistics for a specific interface:

RP/0/RP0/CPU0:router# show ethernet oam statistics interface gigabitethernet 0/1/5/1 

GigabitEthernet0/1/5/1:
Counters
--------
    Information OAMPDU Tx                        161177
    Information OAMPDU Rx                        151178
    Unique Event Notification OAMPDU Tx               0
    Unique Event Notification OAMPDU Rx               0
    Duplicate Event Notification OAMPDU Tx            0
    Duplicate Event Notification OAMPDU Rx            0
    Loopback Control OAMPDU Tx                        0
    Loopback Control OAMPDU Rx                        0
    Variable Request OAMPDU Tx                        0
    Variable Request OAMPDU Rx                        0
    Variable Response OAMPDU Tx                       0
    Variable Response OAMPDU Rx                       0
    Organization Specific OAMPDU Tx                   0
    Organization Specific OAMPDU Rx                   0
    Unsupported OAMPDU Tx                            45
    Unsupported OAMPDU Rx                             0
    Frames Lost due to OAM                           23
    Fixed frames Rx                                   1

Local event logs
----------------
    Errored Symbol Period records                     0
    Errored Frame records                             0
    Errored Frame Period records                      0
    Errored Frame Second records                      0

Remote event logs
-----------------
    Errored Symbol Period records                     0
    Errored Frame records                             0
    Errored Frame Period records                      0
    Errored Frame Second records                      0
   

Related Commands

Command

Description

show ethernet oam configuration

Displays the current active Ethernet OAM configuration on an interface.  

show ethernet oam discovery

Displays the currently configured OAM information of Ethernet OAM sessions on interfaces.  

show ethernet oam interfaces

 

snmp-server traps ethernet oam events

To enable SNMP traps for Ethernet OAM events, use the snmp-server traps ethernet oam events command in XR Config mode.

snmp-server traps ethernet oam events

Syntax Description

This command has no keywords or arguments.

Command Default

Ethernet OAM event traps are not enabled.

Command Modes

XR config

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

snmp

read, write

Examples

The following example shows how to enable SNMP server traps on an Ethernet OAM interface.

RP/0/RP0/CPU0:router# configure
RP/0/RP0/CPU0:router(config)# snmp-server traps ethernet oam events 
   

symbol-period threshold

To configure the thresholds that trigger an Ethernet OAM symbol-period error event, use the symbol-period threshold command in Ethernet OAM link monitor configuration mode. To return the threshold to the default value, use the no form of this command.

symbol-period threshold low threshold [ high t hreshold ]

no symbol-period threshold low threshold [ high t hreshold ]

Syntax Description

low threshold

Low threshold value, in symbols, that triggers a symbol-period error event. The range is 0 to 60000000.

high threshold

(Optional) High threshold value, in symbols, that triggers a symbol-period error event. The range is 0 to 60000000. The high threshold value can be configured only in conjunction with the low threshold value.

Command Default

The default low threshold is 1.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When the low threshold is passed, a symbol-period error event notification is generated and transmitted to the OAM peer. Additionally, any registered higher level OAM protocols, such as Connectivity Fault Management (CFM), are also notified. When the high threshold is passed, the configured high threshold action is performed in addition to the low threshold actions. The high threshold is optional and is configurable only in conjunction with the low threshold.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the symbol-period low and high thresholds that trigger a symbol-period error event:

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# symbol-period threshold low 100 high 6000 

symbol-period window

To configure the window size for an Ethernet OAM symbol-period error event, use the symbol-period window command in Ethernet OAM link monitor or interface Ethernet OAM link monitor configuration mode. To return the window size to the default value, use the no form of this command.

symbol-period window window

no symbol-period window window

Syntax Description

window

Size of the window for symbol-period error in milliseconds. The range is 1000 to 60000.

Command Default

The default value is 1000.

Command Modes

Ethernet OAM link monitor configuration (config-eoam-lm)

Interface Ethernet OAM link monitor configuration (config-if-eoam-lm)

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

ethernet-services

read, write

Examples

The following example shows how to configure the window size for a symbol-period error.

RP/0/RP0/CPU0:router(config)# ethernet oam profile Profile_1 
RP/0/RP0/CPU0:router(config-eoam)# link-monitor 
RP/0/RP0/CPU0:router(config-eoam-lm)# symbol-period window 60000