Interfaces and Hardware Component Configuration Guide for Cisco 8000 Series Routers, Cisco IOS XR Releases

PDF

Interfaces and Hardware Component Configuration Guide for Cisco 8000 Series Routers, Cisco IOS XR Releases

Configure an Ethernet OAM profile

Updated: September 8, 2026

Want to summarize with AI?

This topic describes how to configure an Ethernet OAM profile by initializing the profile, configuring link monitoring error events, configuring session parameters and remote requirements, configuring interface actions for OAM events, and finalizing the OAM configuration.

You can configure custom EOAM settings in an EOAM profile in Ethernet configuration mode and apply the profile to multiple interfaces by attaching it to individual interfaces. The profile configuration takes effect only after you attach the profile to an interface. After you attach the profile, you can configure individual EOAM features on the interface to override the profile settings when needed.

Perform these steps to configure an Ethernet OAM profile.

Procedure

Initialize an Ethernet OAM profile

Perform these steps to initialize an Ethernet OAM profile before you configure link monitoring, session parameters, and interface actions.

Procedure

Enter global configuration mode.
Example:
```
Router# configure terminal
```
Create a new Ethernet Operations, Administration and Maintenance (OAM) profile and enter Ethernet OAM configuration mode by using the ethernet oam profile profile-name command.
Example:
```
Router(config)# ethernet oam profile Profile_1
```

Configure link monitoring error events

Perform these steps in Ethernet OAM link monitor configuration mode to configure the window sizes and thresholds that trigger symbol-period, frame, frame-period, and frame-seconds error events.

Before you begin

Refer the configuration guidelines.

Procedure

Enter the Ethernet OAM link monitor configuration mode.
Example:
```
Router(config-eoam)# link-monitor
```
Configure the window size (in milliseconds) for an Ethernet OAM symbol-period error event by using the symbol-period window { milliseconds window | symbols window [ thousand | million | billion ]} command.
Example:
```
Router(config-eoam-lm)# symbol-period window 60000
```
Configure the thresholds that trigger an Ethernet OAM symbol-period error event, in symbols or ppm (errors per million symbols) by using the symbol-period threshold { ppm[ low threshold ] [ high threshold ] | symbols [ low threshold [ thousand | million | billion ]] [ high threshold [ thousand | million | billion ]]} command.
Example:
```
Router(config-eoam-lm)# symbol-period threshold ppm low 100 high 1000000
```
Configure the frame window size (in milliseconds) of an OAM frame error event by using the frame window milliseconds window
Example:
```
Router(config-eoam-lm)# frame window milliseconds 60
```
- The range is from 1000 to 60000.
- The default value is 1000.
Configure the thresholds (in symbols) that trigger an Ethernet OAM symbol-period error event by using the symbol-period threshold low threshold high threshold command.
Example:
```
Router(config-eoam-lm)# symbol-period threshold low 10000000 high 60000000
```
High threshold is optional and is configurable only in conjunction with low threshold.
- The range is 1 to 60000000.
- The default low threshold is 1.
Configure the window size (in milliseconds) for an Ethernet OAM frame-period error event by using the frame-period window { milliseconds window | frames window [ thousand | million | billion ]} command.
Example:
```
Router(config-eoam-lm)# frame-period window milliseconds 60000
```
Configure the thresholds (in errors per million frames ) that trigger an Ethernet OAM frame-period error event by using the frame-period threshold { ppm [ low threshold ] [ high threshold ] | frames [ low threshold [ thousand | million | billion ]] [ high threshold [ thousand | million | billion ]]} command.
Example:
```
Router(config-eoam-lm)# frame-period threshold ppm low 100 high 1000000
```
Configure the window size (in milliseconds) for the OAM frame-seconds error event by using the frame-seconds window milliseconds window command.
Example:
```
Router(config-eoam-lm)# frame-seconds window milliseconds 900000
```
- The range is 10000 to 900000.
- The default value is 6000.
Configure the thresholds (in seconds) that trigger a frame-seconds error event by using the frame-seconds threshold [ low threshold ] [ high threshold ] command and exit back to Ethernet OAM mode.
Example:
```
Router(config-eoam-lm)# frame-seconds threshold low 3 threshold high 900
Router(config-eoam-lm)#exit
```
- The range is 1 to 900
- The default value is 1.

Configure session parameters and remote requirements

Use this procedure in Ethernet OAM configuration mode to configure the session parameters and remote requirements for an Ethernet OAM profile.

Procedure

Enable MIB retrieval in an Ethernet OAM profile or on an Ethernet OAM interface.
Example:
```
Router(config-eoam)# mib-retrieval
```
Configure the connection timeout period for an Ethernet OAM session by using the connection timeout <timeout> command.
Example:
```
Router(config-eoam)# connection timeout 30
```
- The range is 2 to 30.
- The default value is 5.
Configure the time interval between hello packets for an Ethernet OAM session. The default is 1 second.
Example:
```
Router(config-eoam)# hello-interval 1s
```
Configure the Ethernet OAM mode by using the mode {active|passive} command. The default is active.
Example:
```
Router(config-eoam)# mode passive
```
Configure the require-remote mode {active|passive} mode on the remote end before the OAM session becomes active.
Example:
```
Router(config-eoam)# require-remote mode active
```
Configure require-remote mib-retrieval on the remote end before the OAM session becomes active.
Example:
```
Router(config-eoam)# require-remote mib-retrieval
```

Configure interface actions for OAM events

Use this procedure in Ethernet OAM configuration mode to specify the action taken on an interface for each Ethernet OAM event.

Procedure

Use the action capabilities-conflict {disable | efd | error-disable-interface | log} command to specify the action that is taken on an interface when a capabilities-conflict event occurs.
Example:
```
Router(config-eoam)# action capabilities-conflict efd
```
The default action is to create a syslog entry.
Use the action critical-event {disable | error-disable-interface | log} command to specify the action that is taken on an interface when a critical-event notification is received from the remote Ethernet OAM peer.
Example:
```
Router(config-eoam)# action critical-event error-disable-interface
```
The default action is to create a syslog entry.
Use the action discovery-timeout {disable | efd | error-disable-interface | log} command to specify the action that is taken on an interface when a connection timeout occurs.
Example:
```
Router(config-eoam)# action discovery-timeout efd
```
The default action is to create a syslog entry.
Use the action dying-gasp {disable | error-disable-interface | log} command to specify the action that is taken on an interface when a dying-gasp notification is received from the remote Ethernet OAM peer.
Example:
```
Router(config-eoam)# action dying-gasp error-disable-interface
```
The default action is to create a syslog entry.
Use the action high-threshold {disable | error-disable-interface | log} command to specify the action that is taken on an interface when a high threshold is exceeded.
Example:
```
Router(config-eoam)# action high-threshold error-disable-interface
```
The default is to take no action when a high threshold is exceeded.
Use the action session-down {disable | efd | error-disable-interface | log} command to specify the action that is taken on an interface when an Ethernet OAM session goes down.
Example:
```
Router(config-eoam)# action session-down efd
```
Use the action session-up { disable | log } command to pecify that no action is taken on an interface when an Ethernet OAM session is established.
Example:
```
Router(config-eoam)# action session-up disable
```
The default action is to create a syslog entry.
Use the action uni-directional link-fault {disable | efd | error-disable-interface | log} command to specify the action that is taken on an interface when a link-fault notification is received from the remote Ethernet OAM peer.

The default action is to create a syslog entry.
Use the action wiring-conflict {disable | efd | error-disable-interface | log} command to specify the action that is taken on an interface when a wiring-conflict event occurs.
Example:
```
Router(config-eoam)# action session-down efd
```
The default is to put the interface into error-disable state.

Finalize the OAM configuration

Perform these steps to finalize the Ethernet OAM configuration.

Procedure

Enable detection of a local, unidirectional link fault and send notification of that fault to an Ethernet OAM peer.
Example:
```
Router(config-eoam)# uni-directional link-fault detection
```
Save the configuration changes to the running configuration file. The changes remain within the configuration session.
Example:
```
Router(config-if)# commit
```
End the configuration session and exit to the EXEC mode.
Example:
```
Router(config-if)# end
```

Attach an Ethernet OAM profile to an interface

Use this procedure to attach an Ethernet OAM profile to an interface.

Procedure

Enter global configuration mode.
Example:
```
Router# configure terminal
```
Enter the interface configuration mode and specify the Ethernet interface name and notation rack/slot/module/port.
Example:
```
Router(config)# interface TenGigE 0/1/0/0
```
The example indicates an 8-port 10-Gigabit Ethernet interface in modular services card slot 1.
Enable Ethernet OAM and enter interface Ethernet OAM configuration mode.
Example:
```
Router(config-if)# ethernet oam
```
Attach the specified Ethernet OAM profile (profile-name ), and all of its configuration to the interface.
Example:
```
Router(config-if-eoam)# profile Profile_1
```
Save the configuration changes to the running configuration file. The saved changes remain within the configuration session.
Example:
```
Router(config-if)# commit
```
End the configuration session and exit to the EXEC mode.
Example:
```
Router(config-if)# end
```

Configure Ethernet OAM at an interface and override the profile configuration

Using an EOAM profile is an efficient way of configuring multiple interfaces with a common EOAM configuration. However, if you want to use a profile but also change the behavior of certain functions for a particular interface, then you can override the profile configuration. To override certain profile settings that are applied to an interface, you can configure that command in interface Ethernet OAM configuration mode to change the behavior for that interface.

In some cases, only certain keyword options are available in interface Ethernet OAM configuration due to the default settings for the command. For example, without any configuration of the action commands, several forms of the command have a default behavior of creating a syslog entry when a profile is created and applied to an interface. Therefore, the log keyword is not available in Ethernet OAM configuration for these commands in the profile because it is the default behavior. However, the log keyword is available in Interface Ethernet OAM configuration if the default is changed in the profile configuration so you can retain the action of creating a syslog entry for a particular interface.

To see all of the default Ethernet OAM configuration settings, see the Verify the CFM configuration section.

Use this procedure to configure Ethernet OAM settings at an interface and override the profile configuration.

Procedure

Enter global configuration mode.
Example:
```
Router# configure terminal
```
Enter the interface configuration mode and specify the Ethernet interface name and notation rack/slot/module/port.
Example:
```
Router(config)# interface TenGigE 0/1/0/0
```
The example indicates an 8-port 10-Gigabit Ethernet interface in modular services card slot 1.
Enable Ethernet OAM and enter interface Ethernet OAM configuration mode.
Example:
```
Router(config-if)# ethernet oam
```
Configure a setting for an Ethernet OAM configuration command and override the setting for the profile configuration, where interface-Ethernet-OAM-command is one of the supported commands on the platform in interface Ethernet OAM configuration mode.
Example:
```
Router(config-if-eoam)# action capabilities-conflict error-disable-interface
```
Save the configuration changes to the running configuration file and remains within the configuration session.
Example:
```
Router(config-if)# commit
```
End the configuration session and exit to the EXEC mode.
Example:
```
Router(config-if)# end
```

Verify the Ethernet OAM configuration

Use the show ethernet oam configuration command to display the values for the Ethernet OAM configuration for a particular interface, or for all interfaces. The following example shows the default values for Ethernet OAM settings:

Router# show ethernet oam configuration 
Thu Aug  5 22:07:06.870 DST
GigabitEthernet0/4/0/0:
  Hello interval:                                              1s
  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
  Require remote mode:                                     Ignore
  Require remote MIB retrieval:                                 N

Need help?

Open a support case

(Requires a Cisco Service Contract)

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Configure an Ethernet OAM profile

Procedure

Initialize an Ethernet OAM profile

Procedure

Example:

Example:

Configure link monitoring error events

Before you begin

Procedure

Example:

Example:

Example:

Example:

Example:

Example:

Example:

Example:

Example:

Configure session parameters and remote requirements

Procedure

Example:

Example:

Example:

Example:

Example:

Example:

Configure interface actions for OAM events

Procedure

Example:

Example:

Example:

Example:

Example:

Example:

Example:

Example:

Finalize the OAM configuration

Procedure

Example:

Example:

Example:

Attach an Ethernet OAM profile to an interface

Procedure

Example:

Example:

Example:

Example:

Example:

Example:

Configure Ethernet OAM at an interface and override the profile configuration

Procedure

Example:

Example:

Example:

Example:

Example:

Example:

Verify the Ethernet OAM configuration