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.
This module describes the configuration of Ethernet Operations, Administration, and Maintenance (OAM) on the Cisco NCS 6000 Series Router.
|
Release |
Modification |
|---|---|
|
Release 5.0.0 |
This feature was introduced. |
You must be in a user group associated with a task group that includes the proper task IDs. The command reference guides include the task IDs required for each command. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Before configuring Ethernet OAM, confirm that at least one of the Gigabit Ethernet line cards supported on the router is installed.
To configure Ethernet OAM, you should understand these concepts:
Ethernet as a Metro Area Network (MAN) or a Wide Area Network (WAN) technology benefits greatly from the implementation of Operations, Administration and Maintenance (OAM) features. Ethernet link OAM features allow Service Providers to monitor the quality of the connections on a MAN or WAN. Service providers can monitor specific events, take actions on events, and if necessary, put specific interfaces into loopback mode for troubleshooting. Ethernet link OAM operates on a single, physical link and it can be configured to monitor either side or both sides of that link.
Ethernet link OAM can be configured in the following ways:
When an interface is also using a link OAM profile, specific parameters that are set in the profile can be overridden by configuring a different value directly on the interface.
An EOAM profile simplifies the process of configuring EOAM features on multiple interfaces. An Ethernet OAM profile, and all of its features, can be referenced by other interfaces, allowing other interfaces to inherit the features of that Ethernet OAM profile.
Individual Ethernet link OAM features can be configured on individual interfaces without being part of a profile. In these cases, the individually configured features always override the features in the profile.
The preferred method of configuring custom EOAM settings is to create an EOAM profile in Ethernet configuration mode and then attach it to an individual interface or to multiple interfaces.
The following standard Ethernet Link OAM features are supported on the router:
Neighbor discovery enables each end of a link to learn the OAM capabilities of the other end and establish an OAM peer relationship. Each end also can require that the peer have certain capabilities before it will establish a session. You can configure certain actions to be taken if there is a capabilities conflict or if a discovery process times out, using the action capabilities-conflict or action discovery-timeout commands.
Link monitoring enables an OAM peer to monitor faults that cause the quality of a link to deteriorate over time. When link monitoring is enabled, an OAM peer can be configured to take action when the configured thresholds are exceeded.
MIB retrieval enables an OAM peer on one side of an interface to get the MIB variables from the remote side of the link. The MIB variables that are retrieved from the remote OAM peer are READ ONLY.
Miswiring Detection is a Cisco-proprietary feature that uses the 32-bit vendor field in every Information OAMPDU to identify potential miswiring cases.
SNMP traps can be enabled or disabled on an Ethernet OAM interface.
This section provides the following configuration procedures:
Custom EOAM settings can be configured and shared on multiple interfaces by creating an EOAM profile in Ethernet configuration mode and then attaching the profile to individual interfaces. The profile configuration does not take effect until the profile is attached to an interface. After an EOAM profile is attached to an interface, individual EOAM features can be configured separately on the interface to override the profile settings when desired.
This section describes how to configure an EOAM profile and attach it to an interface in the following procedures:
Perform these steps to configure an Ethernet OAM profile.
| Command or Action | Purpose | |||
|---|---|---|---|---|
| Step 1 |
configure Example: |
Enters global configuration mode. |
||
| Step 2 |
ethernet oam profile profile-name Example: |
Creates a new Ethernet Operations, Administration and Maintenance (OAM) profile and enters Ethernet OAM configuration mode. |
||
| Step 3 |
link-monitor Example: |
Enters the Ethernet OAM link monitor configuration mode. |
||
| Step 4 |
symbol-period window window Example: |
(Optional) Configures the window size (in milliseconds) for an Ethernet OAM symbol-period error event. The IEEE 802.3 standard defines the window size as a number of symbols rather than a time duration. These two formats can be converted either way by using a knowledge of the interface speed and encoding. The range is 1000 to 60000. The default value is 1000. |
||
| Step 5 |
symbol-period threshold low threshold high threshold Example: |
(Optional) Configures the thresholds (in symbols) that trigger an Ethernet OAM symbol-period error event. The high threshold is optional and is configurable only in conjunction with the low threshold. The range is 0 to 60000000. The default low threshold is 1. |
||
| Step 6 |
frame window window Example: |
(Optional) Configures the frame window size (in milliseconds) of an OAM frame error event. The range is from 1000 to 60000. The default value is 1000. |
||
| Step 7 |
frame threshold low threshold high threshold Example: |
(Optional) Configures the thresholds (in symbols) that triggers an Ethernet OAM frame error event. The high threshold is optional and is configurable only in conjunction with the low threshold. The range is from 0 to 60000000. The default low threshold is 1. |
||
| Step 8 |
frame-period window window Example: |
(Optional) Configures the window size (in milliseconds) for an Ethernet OAM frame-period error event. The IEEE 802.3 standard defines the window size as number of frames rather than a time duration. These two formats can be converted either way by using a knowledge of the interface speed. Note that the conversion assumes that all frames are of the minimum size. The range is from 100 to 60000. The default value is 1000.
|
||
| Step 9 |
frame-period threshold lowthreshold high threshold Example: |
(Optional) Configures the thresholds (in errors per million frames ) that trigger an Ethernet OAM frame-period error event. The frame period window is defined in the IEEE specification as a number of received frames, in our implementation it is x milliseconds. The high threshold is optional and is configurable only in conjunction with the low threshold. The range is from 0 to 1000000. The default low threshold is 1. To obtain the number of frames, the configured time interval is converted to a window size in frames using the interface speed. For example, for a 1Gbps interface, the IEEE defines minimum frame size as 512 bits. So, we get a maximum of approximately 1.5 million frames per second. If the window size is configured to be 8 seconds (8000ms) then this would give us a Window of 12 million frames in the specification's definition of Errored Frame Window. The thresholds for frame-period are measured in errors per million frames. Hence, if you configure a window of 8000ms (that is a window of 12 million frames) and a high threshold of 100, then the threshold would be crossed if there are 1200 errored frames in that period (that is, 100 per million for 12 million). |
||
| Step 10 |
frame-seconds window window Example: |
(Optional) Configures the window size (in milliseconds) for the OAM frame-seconds error event. The range is 10000 to 900000. The default value is 6000.
|
||
| Step 11 |
frame-seconds threshold low threshold high threshold Example: |
(Optional) Configures the thresholds (in seconds) that trigger a frame-seconds error event. The high threshold value can be configured only in conjunction with the low threshold value. The range is 1 to 900 The default value is 1. |
||
| Step 12 |
exit Example: |
Exits back to Ethernet OAM mode. |
||
| Step 13 |
mib-retrieval Example: |
Enables MIB retrieval in an Ethernet OAM profile or on an Ethernet OAM interface. |
||
| Step 14 |
connection timeout <timeout> Example: |
Configures the connection timeout period for an Ethernet OAM session. as a multiple of the hello interval. The range is 2 to 30. The default value is 5. |
||
| Step 15 |
hello-interval {100ms|1s} Example: |
Configures the time interval between hello packets for an Ethernet OAM session. The default is 1 second (1s ). |
||
| Step 16 |
mode {active|passive} Example: |
Configures the Ethernet OAM mode. The default is active. |
||
| Step 17 |
require-remote mode {active|passive} Example: |
Requires that active mode or passive mode is configured on the remote end before the OAM session becomes active. |
||
| Step 18 |
require-remote mib-retrieval Example: |
Requires that MIB-retrieval is configured on the remote end before the OAM session becomes active. |
||
| Step 19 |
action capabilities-conflict {disable | efd | error-disable-interface} Example: |
Specifies the action that is taken on an interface when a capabilities-conflict event occurs. The default action is to create a syslog entry.
|
||
| Step 20 |
action critical-event {disable | error-disable-interface} Example: |
Specifies the action that is taken on an interface when a critical-event notification is received from the remote Ethernet OAM peer. The default action is to create a syslog entry.
|
||
| Step 21 |
action discovery-timeout {disable | efd | error-disable-interface} Example: |
Specifies the action that is taken on an interface when a connection timeout occurs. The default action is to create a syslog entry.
|
||
| Step 22 |
action dying-gasp {disable | error-disable-interface} Example: |
Specifies the action that is taken on an interface when a dying-gasp notification is received from the remote Ethernet OAM peer. The default action is to create a syslog entry.
|
||
| Step 23 |
action high-threshold {error-disable-interface | log} Example: |
Specifies the action that is taken on an interface when a high threshold is exceeded. The default is to take no action when a high threshold is exceeded.
|
||
| Step 24 |
action session-down {disable | efd | error-disable-interface} Example: |
Specifies the action that is taken on an interface when an Ethernet OAM session goes down.
|
||
| Step 25 |
action session-up disable Example: |
Specifies that no action is taken on an interface when an Ethernet OAM session is established. The default action is to create a syslog entry.
|
||
| Step 26 |
action uni-directional link-fault {disable | efd | error-disable-interface} |
Specifies 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.
|
||
| Step 27 |
action wiring-conflict {disable | efd | log} Example: |
Specifies the action that is taken on an interface when a wiring-conflict event occurs. The default is to put the interface into error-disable state.
|
||
| Step 28 |
uni-directional link-fault detection Example: |
Enables detection of a local, unidirectional link fault and sends notification of that fault to an Ethernet OAM peer. |
||
| Step 29 |
commit Example: |
Saves the configuration changes to the running configuration file and remains within the configuration session. |
||
| Step 30 |
end Example: |
Ends the configuration session and exits to the EXEC mode. |
Perform the following steps to attach an Ethernet OAM profile to an interface:
| Command or Action | Purpose | |||
|---|---|---|---|---|
| Step 1 |
configure Example: |
Enters XR configuration mode. |
||
| Step 2 |
interface [GigabitEthernet | TenGigE ] interface-path-id Example: |
Enters interface configuration mode and specifies the Ethernet interface name and notation rack/slot/module/port .
|
||
| Step 3 |
ethernet oam Example: |
Enables Ethernet OAM and enters interface Ethernet OAM configuration mode. |
||
| Step 4 |
profile profile-name Example: |
Attaches the specified Ethernet OAM profile (profile-name ), and all of its configuration, to the interface. |
||
| Step 5 |
commit Example: |
Saves the configuration changes to the running configuration file and remains within the configuration session. |
||
| Step 6 |
end Example: |
Ends the configuration session and exits to the XR EXEC mode. |
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 Verifying the Ethernet OAM Configuration section.
To configure Ethernet OAM settings at an interface and override the profile configuration, perform these steps:
| Command or Action | Purpose | |||
|---|---|---|---|---|
| Step 1 |
configure Example: |
Enters global configuration mode. |
||
| Step 2 |
interface [ GigabitEthernet | TenGigE] interface-path-id Example: |
Enters interface configuration mode and specifies the Ethernet interface name and notation rack/slot/module/port.
|
||
| Step 3 |
ethernet oam Example: |
Enables Ethernet OAM and enters interface Ethernet OAM configuration mode. |
||
| Step 4 |
interface-Ethernet-OAM-command RP/0//CPU0:router(config-if-eoam)# action capabilities-conflict error-disable-interface |
Configures a setting for an Ethernet OAM configuration command and overrides 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. |
||
| Step 5 |
commit Example: |
Saves the configuration changes to the running configuration file and remains within the configuration session. |
||
| Step 6 |
end Example: |
Ends the configuration session and exits to the EXEC mode. |
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:
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: NThis section provides the following configuration examples:
The following example shows how to configure an Ethernet OAM profile globally:
configure terminal
ethernet oam profile Profile_1
link-monitor
symbol-period window 60000
symbol-period threshold low 10000000 high 60000000
frame window 60
frame threshold low 10000000 high 60000000
frame-period window 60000
frame-period threshold low 100 high 12000000
frame-seconds window 900000
frame-seconds threshold 3 threshold 900
exit
mib-retrieval
connection timeout 30
require-remote mode active
require-remote link-monitoring
require-remote mib-retrieval
action dying-gasp error-disable-interface
action critical-event error-disable-interface
action discovery-timeout error-disable-interface
action session-down error-disable-interface
action capabilities-conflict error-disable-interface
action wiring-conflict error-disable-interface
action remote-loopback error-disable-interface
commit
The following example shows how to configure Ethernet OAM features on an individual interface:
configure terminal
interface TenGigE 0/1/0/0
ethernet oam
link-monitor
symbol-period window 60000
symbol-period threshold low 10000000 high 60000000
frame window 60
frame threshold low 10000000 high 60000000
frame-period window 60000
frame-period threshold low 100 high 12000000
frame-seconds window 900000
frame-seconds threshold 3 threshold 900
exit
mib-retrieval
connection timeout 30
require-remote mode active
require-remote link-monitoring
require-remote mib-retrieval
action link-fault error-disable-interface
action dying-gasp error-disable-interface
action critical-event error-disable-interface
action discovery-timeout error-disable-interface
action session-down error-disable-interface
action capabilities-conflict error-disable-interface
action wiring-conflict error-disable-interface
action remote-loopback error-disable-interface
commit
The following example shows the configuration of Ethernet OAM features in a profile followed by an override of that configuration on an interface:
configure terminal
ethernet oam profile Profile_1
mode passive
action dying-gasp disable
action critical-event disable
action discovery-timeout disable
action session-up disable
action session-down disable
action capabilities-conflict disable
action wiring-conflict disable
action remote-loopback disable
action uni-directional link-fault error-disable-interface
commit
configure terminal
interface TenGigE 0/1/0/0
ethernet oam
profile Profile_1
mode active
action dying-gasp log
action critical-event log
action discovery-timeout log
action session-up log
action session-down log
action capabilities-conflict log
action wiring-conflict log
action remote-loopback log
action uni-directional link-fault log
uni-directional link-fault detection
commitThe following example shows how to clear Ethernet OAM statistics on an interface:
RP/0/RP0/CPU0:router# clear ethernet oam statistics interface gigabitethernet 0/1/5/1
The following example shows how to enable SNMP server traps on a router:
configure terminal
ethernet oam profile Profile_1
snmp-server traps ethernet oam events
When you have configured an Ethernet interface, you can configure individual VLAN subinterfaces on that Ethernet interface.
For information about IPv6 see the Implementing Access Lists and Prefix Lists module in the IP Addresses and Services Configuration Guide .
The following sections provide references related to implementing Gigabit,10-Gigabit, and Fast Ethernet interfaces.
|
Related Topic |
Document Title |
|---|---|
|
Cisco IOS XR interface configuration commands |
Cisco IOS XR Interface and Hardware Component Command Reference |
|
Information about user groups and task IDs |
Cisco IOS XR Interface and Hardware Component Command Reference |
|
Standards |
Title |
|---|---|
|
IEEE 802.1ag |
Connectivity Fault Management |
|
ITU-T Y.1731 |
OAM Functions and Mechansims for Ethernet Based Networks |
|
MEF 16 |
Metro Ethernet Forum, Technical Specification MEF 16, Ethernet Local Management Interface (E-LMI), January 2006 |
|
MIBs |
MIBs Link |
|---|---|
|
IEEE8021-CFM-MIB |
To locate and download MIBs for selected platforms using Cisco IOS XR Software, use the Cisco MIB Locator found at the following URL: |
|
RFCs |
Title |
|---|---|
|
No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature. |
— |
|
Description |
Link |
|---|---|
|
The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content. |
Feedback