Cisco IOS Carrier Ethernet Configuration Guide, Release 12.4T - Using Ethernet Operations, Administration, and Maintenance [Cisco IOS Software Releases 12.4 T]

Table Of Contents

Using Ethernet Operations, Administration,
and Maintenance

Finding Feature Information

Contents

Information About Using Ethernet Operations, Administration, and Maintenance

Ethernet OAM

OAM Client

OAM Sublayer

Benefits of Ethernet OAM

Cisco IOS Implementation of Ethernet OAM

OAM Features

OAM Messages

IEEE 802.3ah Link Fault RFI Support

Ethernet Connectivity Fault Management

How to Set Up and Configure Ethernet Operations, Administration, and Maintenance

Enabling Ethernet OAM on an Interface

Disabling and Enabling a Link Monitoring Session

Disabling a Link Monitoring Session

Enabling a Link Monitoring Session

Stopping and Starting Link Monitoring Operations

Stopping Link Monitoring Operations

Starting Link Monitoring Operations

Configuring Link Monitoring Options

Examples

Configuring Global Ethernet OAM Options Using a Template

Configuring a Port for Link Fault RFI Support

Configuration Examples for Ethernet Operations, Administration, and Maintenance

Additional References

Related Documents

Standards

MIBs

RFCs

Technical Assistance

Command Reference

Feature Information for Using Ethernet Operations, Administration, and Maintenance

Using Ethernet Operations, Administration,
and Maintenance

First Published: November 20, 2006

Last Updated: November 14, 2008

Ethernet Operations, Administration, and Maintenance (OAM) is a protocol for installing, monitoring, and troubleshooting Ethernet metropolitan-area networks (MANs) and Ethernet WANs. It relies on a new, optional sublayer in the data link layer of the Open Systems Interconnection (OSI) model. The OAM features covered by this protocol are Discovery, Link Monitoring, Remote Fault Detection, Remote Loopback, and Cisco Proprietary Extensions.

The advent of Ethernet as a MAN and WAN technology has emphasized the necessity for integrated management for larger deployments. For Ethernet to extend into public MANs and WANs, it must be equipped with a new set of requirements on Ethernet's traditional operations, which had been centered on enterprise networks only. The expansion of Ethernet technology into the domain of service providers, where networks are substantially larger and more complex than enterprise networks and the user-base is wider, makes operational management of link uptime crucial.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for Using Ethernet Operations, Administration, and Maintenance" section.

Use Cisco Feature Navigator to find information about platform support and Cisco IOS, Catalyst OS, and Cisco IOS XE software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

Contents

•Information About Using Ethernet Operations, Administration, and Maintenance

•How to Set Up and Configure Ethernet Operations, Administration, and Maintenance

•Configuration Examples for Ethernet Operations, Administration, and Maintenance

•Additional References

•Command Reference

•Feature Information for Using Ethernet Operations, Administration, and Maintenance

Information About Using Ethernet Operations, Administration, and Maintenance

Before you set up Ethernet OAM, you should understand the following concepts:

•Ethernet OAM

•Cisco IOS Implementation of Ethernet OAM

•OAM Features

•OAM Messages

•IEEE 802.3ah Link Fault RFI Support

•Ethernet Connectivity Fault Management

Ethernet OAM

Ethernet OAM is a protocol for installing, monitoring, and troubleshooting metro Ethernet networks and Ethernet WANs. It relies on a new, optional sublayer in the data link layer of the OSI model. Ethernet OAM can be implemented on any full-duplex point-to-point or emulated point-to-point Ethernet link. A system-wide implementation is not required; OAM can be deployed for part of a system; that is, on particular interfaces.

Normal link operation does not require Ethernet OAM. OAM frames, called OAM protocol data units (PDUs), use the slow protocol destination MAC address 0180.c200.0002. They are intercepted by the MAC sublayer and cannot propagate beyond a single hop within an Ethernet network.

Ethernet OAM is a relatively slow protocol with modest bandwidth requirements. The frame transmission rate is limited to a maximum of 10 frames per second; therefore, the impact of OAM on normal operations is negligible. However, when link monitoring is enabled, the CPU must poll error counters frequently. In this case, the required CPU cycles will be proportional to the number of interfaces that have to be polled.

Two major components, the OAM client and the OAM sublayer, make up Ethernet OAM. The following two sections describe these components.

OAM Client

The OAM client is responsible for establishing and managing Ethernet OAM on a link. The OAM client also enables and configures the OAM sublayer. During the OAM discovery phase, the OAM client monitors OAM PDUs received from the remote peer and enables OAM functionality on the link based on local and remote state as well as configuration settings. Beyond the discovery phase (at steady state), the OAM client is responsible for managing the rules of response to OAM PDUs and managing the OAM remote loopback mode.

OAM Sublayer

The OAM sublayer presents two standard IEEE 802.3 MAC service interfaces: one facing toward the superior sublayers, which include the MAC client (or link aggregation), and the other interface facing toward the subordinate MAC control sublayer. The OAM sublayer provides a dedicated interface for passing OAM control information and OAM PDUs to and from a client.

The OAM sublayer is made up of three components: control block, multiplexer, and packet parser (p-parser). Each component is described in the following sections.

Control Block

The control block provides the interface between the OAM client and other blocks internal to the OAM sublayer. The control block incorporates the discovery process, which detects the existence and capabilities of remote OAM peers. It also includes the transmit process that governs the transmission of OAM PDUs to the multiplexer and a set of rules that govern the receipt of OAM PDUs from the p-parser.

Multiplexer

The multiplexer manages frames generated (or relayed) from the MAC client, control block, and p-parser. The multiplexer passes through frames generated by the MAC client untouched. It passes OAM PDUs generated by the control block to the subordinate sublayer; for example, the MAC sublayer. Similarly, the multiplexer passes loopback frames from the p-parser to the same subordinate sublayer when the interface is in OAM remote loopback mode.

P-Parser

The p-parser classifies frames as OAM PDUs, MAC client frames, or loopback frames and then dispatches each class to the appropriate entity. OAM PDUs are sent to the control block. MAC client frames are passed to the superior sublayer. Loopback frames are dispatched to the multiplexer.

Benefits of Ethernet OAM

Ethernet OAM provides the following benefits:

•Competitive advantage for service providers

•Standardized mechanism to monitor the health of a link and perform diagnostics

Cisco IOS Implementation of Ethernet OAM

The Cisco IOS implementation of Ethernet OAM consists of the Ethernet OAM shim and the Ethernet OAM module.

The Ethernet OAM shim is a thin layer that connects the Ethernet OAM module and the platform code. It is implemented in the platform code (driver). The shim also communicates port state and error conditions to the Ethernet OAM module via control signals.

The Ethernet OAM module, implemented within the control plane, handles the OAM client as well as control block functionality of the OAM sublayer. This module interacts with the command-line interface (CLI) and Simple Network Management Protocol (SNMP)/programmatic interface via control signals. In addition, this module interacts with the Ethernet OAM shim through OAM PDU flows.

OAM Features

The OAM features as defined by IEEE 802.3ah, Ethernet in the First Mile, are discovery, Link Monitoring, Remote Fault Detection, Remote Loopback, and Cisco Proprietary Extensions.

Discovery

Discovery is the first phase of Ethernet OAM and it identifies the devices in the network and their OAM capabilities. Discovery uses information OAM PDUs. During the discovery phase, the following information is advertised within periodic information OAM PDUs:

•OAM mode—Conveyed to the remote OAM entity. The mode can be either active or passive and can be used to determine device functionality.

•OAM configuration (capabilities)—Advertises the capabilities of the local OAM entity. With this information a peer can determine what functions are supported and accessible; for example, loopback capability.

•OAM PDU configuration—Includes the maximum OAM PDU size for receipt and delivery. This information along with the rate limiting of 10 frames per second can be used to limit the bandwidth allocated to OAM traffic.

•Platform identity—A combination of an organization unique identifier (OUI) and 32-bits of vendor-specific information. OUI allocation, controlled by the IEEE, is typically the first three bytes of a MAC address.

Discovery includes an optional phase in which the local station can accept or reject the configuration of the peer OAM entity. For example, a node may require that its partner support loopback capability to be accepted into the management network. These policy decisions may be implemented as vendor-specific extensions.

Link Monitoring

Link monitoring in Ethernet OAM detects and indicates link faults under a variety of conditions. Link monitoring uses the event notification OAM PDU and sends events to the remote OAM entity when there are problems detected on the link. The error events include the following:

•Error Symbol Period (error symbols per second)—The number of symbol errors that occurred during a specified period exceeded a threshold. These errors are coding symbol errors.

•Error Frame (error frames per second)—The number of frame errors detected during a specified period exceeded a threshold.

•Error Frame Period (error frames per n frames)—The number of frame errors within the last n frames has exceeded a threshold.

•Error Frame Seconds Summary (error seconds per m seconds)—The number of error seconds (1-second intervals with at least one frame error) within the last m seconds has exceeded a threshold.

Since IEEE 802.3ah OAM does not provide a guaranteed delivery of any OAM PDU, the event notification OAM PDU may be sent multiple times to reduce the probability of a lost notification. A sequence number is used to recognize duplicate events.

Remote Failure Indication

Faults in Ethernet connectivity that are caused by slowly deteriorating quality are difficult to detect. Ethernet OAM provides a mechanism for an OAM entity to convey these failure conditions to its peer via specific flags in the OAM PDU. The following failure conditions can be communicated:

•Link Fault—Loss of signal is detected by the receiver; for instance, the peer's laser is malfunctioning. A link fault is sent once per second in the information OAM PDU. Link fault applies only when the physical sublayer is capable of independently transmitting and receiving signals.

•Dying Gasp—An unrecoverable condition has occurred; for example, a power failure. This type of condition is vendor specific. A notification about the condition may be sent immediately and continuously.

•Critical Event—An unspecified critical event has occurred. This type of event is vendor specific. A critical event may be sent immediately and continuously.

Remote Loopback

An OAM entity can put its remote peer into loopback mode using the loopback control OAM PDU. Loopback mode helps an administrator ensure the quality of links during installation or when troubleshooting. In loopback mode, every frame received is transmitted back on the same port except for OAM PDUs and pause frames. The periodic exchange of OAM PDUs must continue during the loopback state to maintain the OAM session.

The loopback command is acknowledged by responding with an information OAM PDU with the loopback state indicated in the state field. This acknowledgement allows an administrator, for example, to estimate if a network segment can satisfy a service-level agreement. Acknowledgement makes it possible to test delay, jitter, and throughput.

When an interface is set to the remote loopback mode the interface no longer participates in any other Layer 2 or Layer 3 protocols; for example Spanning Tree Protocol (STP) or Open Shortest Path First (OSPF). The reason is that when two connected ports are in a loopback session, no frames other than the OAM PDUs are sent to the CPU for software processing. The non-OAM PDU frames are either looped back at the MAC level or discarded at the MAC level.

From a user's perspective, an interface in loopback mode is in a link-up state.

Cisco Vendor-Specific Extensions

Ethernet OAM allows vendors to extend the protocol by allowing them to create their own type-length-value (TLV) fields.

OAM Messages

Ethernet OAM messages or OAM PDUs are standard length, untagged Ethernet frames within the normal frame length bounds of 64 to 1518 bytes. The maximum OAM PDU frame size exchanged between two peers is negotiated during the discovery phase.

OAM PDUs always have the destination address of slow protocols (0180.c200.0002) and an Ethertype of 8809. OAM PDUs do not go beyond a single hop and have a hard-set maximum transmission rate of 10 OAM PDUs per second. Some OAM PDU types may be transmitted multiple times to increase the likelihood that they will be successfully received on a deteriorating link.

Four types of OAM messages are supported:

•Information OAM PDU—A variable-length OAM PDU that is used for discovery. This OAM PDU includes local, remote, and organization-specific information.

•Event notification OAM PDU—A variable-length OAM PDU that is used for link monitoring. This type of OAM PDU may be transmitted multiple times to increase the chance of a successful receipt; for example, in the case of high-bit errors. Event notification OAM PDUs also may include a time stamp when generated.

•Loopback control OAM PDU—An OAM PDU fixed at 64 bytes in length that is used to enable or disable the remote loopback command.

•Vendor-specific OAM PDU—A variable-length OAM PDU that allows the addition of vendor-specific extensions to OAM.

IEEE 802.3ah Link Fault RFI Support

The IEEE 802.3ah Link Fault RFI Support feature provides a per-port configurable option that moves a port into a blocking state when an OAM PDU control request packet is received with the Link Fault Status flag set. In the blocking state, the port can continue to receive OAM PDUs, detect remote link status, and automatically recover when the remote link becomes operational. When an OAM PDU is received with the Link Fault Status flag set to zero or FALSE, the port is enabled and all VLANs configured on the port are set to "forwarding."

Note If you configure the Ethernet OAM timeout period to be the minimum allowable value of 2 seconds, the Ethernet OAM session may be dropped briefly when the port transitions from blocked to unblocked. This action will not occur by default; the default timeout value is 5 seconds.

Before the release of the IEEE 802.3ah Link Fault RFI Support feature, when an OAM PDU control request packet was received with the Link Fault Status flag set, one of three actions was taken:

•The port was put in the error-disable state, meaning that the port did not send or receive packets, including Bridge Protocol Data Units (BPDU) packets. In the error-disable state, a link can automatically recover after the error-disable timeout period but cannot recover automatically when the remote link becomes operational.

•A warning message was displayed or logged, and the port remained operational.

•The Link Fault Status flag was ignored.

A new keyword, error-block-interface, for the CLI command ethernet oam remote-failure action is introduced with the IEEE 802.3ah Link Fault RFI Support feature. For detailed information about this command, see the Cisco IOS Carrier Ethernet Command Reference.

Ethernet Connectivity Fault Management

Ethernet connectivity fault management (CFM) is an end-to-end per-service-instance Ethernet layer OAM protocol that includes proactive connectivity monitoring, fault verification, and fault isolation. End to end can be provider edge (PE) to PE or customer edge (CE) to CE. Per service instance means per VLAN.

For more information about Ethernet CFM, see Ethernet Connectivity Fault Management.

How to Set Up and Configure Ethernet Operations, Administration, and Maintenance

Perform the following tasks to configure Ethernet OAM:

•Enabling Ethernet OAM on an Interface

•Disabling and Enabling a Link Monitoring Session

•Stopping and Starting Link Monitoring Operations

•Configuring Link Monitoring Options

•Configuring Global Ethernet OAM Options Using a Template

•Configuring a Port for Link Fault RFI Support

Enabling Ethernet OAM on an Interface

Ethernet OAM is by default disabled on an interface.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]

5. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface gigabitethernet 3/8

Specifies an interface and places the CLI in interface configuration mode.

Step 4

ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]
Example:

Router(config-if)# ethernet oam

Enables Ethernet OAM.

Step 5

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Disabling and Enabling a Link Monitoring Session

Link monitoring is enabled by default when you enable Ethernet OAM. Perform these tasks to disable and enable link monitoring sessions:

•Disabling a Link Monitoring Session

•Enabling a Link Monitoring Session

Disabling a Link Monitoring Session

Perform this task to disable a link monitoring session.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]

5. no ethernet oam link-monitor supported

6. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface gigabitEthernet 3/8

Specifies an interface and places the CLI in interface configuration mode.

Step 4

ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]
Example:

Router(config-if)# ethernet oam

Enables Ethernet OAM.

Step 5

no ethernet oam link-monitor supported
Example:

Router(config-if)# no ethernet oam link-monitor supported

Disables link monitoring on the interface.

Step 6

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Enabling a Link Monitoring Session

Perform this task to reenable a link monitoring session after it was previously disabled.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam link-monitor supported

5. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface gigabitEthernet 3/8

Specifies an interface and places the CLI in interface configuration mode.

Step 4

ethernet oam link-monitor supported
Example:

Router(config-if)# ethernet oam link-monitor supported

Enables link monitoring on the interface.

Step 5

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Stopping and Starting Link Monitoring Operations

Link monitoring operations start automatically when Ethernet OAM is enabled on an interface. When link monitoring operations are stopped, the interface does not actively send or receive event notification OAM PDUs. The tasks in this section describe how to stop and start link monitoring operations.

•Stopping Link Monitoring Operations

•Starting Link Monitoring Operations

Stopping Link Monitoring Operations

Perform this task to stop link monitoring operations.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]

5. no ethernet oam link-monitor on

6. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface gigabitethernet 3/8

Specifies an interface and places the CLI in interface configuration mode.

Step 4

ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]
Example:

Router(config-if)# ethernet oam

Enables Ethernet OAM.

Step 5

no ethernet oam link-monitor on
Example:

Router(config-if)# no ethernet oam link-monitor on

Stops link monitoring operations.

Step 6

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Starting Link Monitoring Operations

Perform this task to start link monitoring operations.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam link-monitor on

5. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface gigabitethernet 3/8

Specifies an interface and places the CLI in interface configuration mode.

Step 4

ethernet oam link-monitor on
Example:

Router(config-if)# ethernet oam link-monitor on

Starts link monitoring operations.

Step 5

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Configuring Link Monitoring Options

Perform this optional task to specify link monitoring options. Steps 4 through 10 can be performed in any sequence.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]

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

6. ethernet oam link-monitor frame {threshold {high {none | high-frames} | low low-frames} | window milliseconds}

7. ethernet oam link-monitor frame-period {threshold {high {none | high-frames} | low low-frames} | window frames}

8. ethernet oam link-monitor frame-seconds {threshold {high {none | high-frames} | low low-frames} | window milliseconds}

9. ethernet oam link-monitor receive-crc {threshold {high {high-frames | none} | low low-frames} | window milliseconds}

10. ethernet oam link-monitor transmit-crc {threshold {high {high-frames | none} | low low-frames} | window milliseconds}

11. ethernet oam link-monitor symbol-period {threshold {high {none | high-symbols} | low low-symbols} | window symbols}

12. exit

DETAILED STEPS
Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface gigabitEthernet 3/8

Identifies the interface and places the CLI in interface configuration mode.

Step 4

ethernet oam [max-rate oampdus | min-rate num-seconds | mode {active | passive} | timeout seconds]
Example:

Router(config-if)# ethernet oam

Enables Ethernet OAM.
Step 5
ethernet oam link-monitor high-threshold action 
error-disable-interface
Example:
Router(config-if)# ethernet oam link-monitor 
high-threshold action error-disable-interface 
Configures an error-disable function on an Ethernet OAM interface when a high threshold for an error is exceeded.
Step 6
ethernet oam link-monitor frame {threshold 
{high {none | high-frames} | low low-frames} | 
window milliseconds}
Example:
Router(config-if)# ethernet oam link-monitor 
frame window 399
Configures a number for error frames that when reached triggers an action.
Step 7
ethernet oam link-monitor frame-period 
{threshold {high {none | high-frames} | low 
low-frames} | window frames}
Example:
Router(config-if)# ethernet oam link-monitor 
frame-period threshold high 599
Configures a number of frames to be polled.

Frame period is a user-defined parameter.
Step 8

ethernet oam link-monitor frame-seconds {threshold {high {none | high-frames} | low low-frames} | window milliseconds}
Example:

Router(config-if)# ethernet oam link-monitor frame-seconds window 699

Configures a period of time in which error frames are counted.
Step 9
ethernet oam link-monitor receive-crc 
{threshold {high {high-frames | none} | low 
low-frames} | window milliseconds}
Example:
Router(config-if)# ethernet oam link-monitor 
receive-crc window 99
Configures an Ethernet OAM interface to monitor ingress frames with cyclic redundancy check (CRC) errors for a period of time.
Step 10
ethernet oam link-monitor transmit-crc 
{threshold {high {high-frames | none} | low 
low-frames} | window milliseconds}
Example:
Router(config-if)# ethernet oam link-monitor 
transmit-crc threshold low 199
Configures an Ethernet OAM interface to monitor egress frames with CRC errors for a period of time.
Step 11
ethernet oam link-monitor symbol-period 
{threshold {high {none | high-symbols} | low 
low-symbols} | window symbols}
Example:
Router(config-if)# ethernet oam link-monitor 
symbol-period threshold high 299
Configures a threshold or window for error symbols, in number of symbols.
Step 12

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.
Examples
Router# configure terminal 
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# interface gigabitEthernet 3/8
Router(config-if)#
Router(config-if)# ethernet oam 
Router(config-if)# ethernet oam link-monitor high-threshold action error-disable-interface
Router(config-if)# ethernet oam link-monitor frame window 399
Router(config-if)# ethernet oam link-monitor frame-period threshold high 599
Router(config-if)# ethernet oam link-monitor frame-seconds window 699
Router(config-if)# ethernet oam link-monitor receive-crc window 99
Router(config-if)# ethernet oam link-monitor transmit-crc threshold low 199
Router(config-if)# ethernet oam link-monitor symbol-period threshold high 299
Router(config-if)# exit
Router# show running-config 
Building configuration...
Current configuration : 5613 bytes
!
!
version 12.2
!
!
.
.
.
!
!
interface GigabitEthernet3/8
 no ip address
 ethernet oam link-monitor high-threshold action error-disable-interface
 ethernet oam link-monitor frame window 399
 ethernet oam link-monitor frame-period threshold high 599
 ethernet oam link-monitor frame-seconds window 699
 ethernet oam link-monitor receive-crc window 99
 ethernet oam link-monitor transmit-crc threshold low 199
 ethernet oam link-monitor symbol-period threshold high 299
 ethernet oam
Configuring Global Ethernet OAM Options Using a Template

Perform this task to create a template to use for configuring a common set of options on multiple Ethernet OAM interfaces. Steps 4 through 10 are optional and can be performed in any sequence. These steps may also be repeated to configure different options.

SUMMARY STEPS

1. enable

2. configure terminal

3. template template-name

4. ethernet oam link-monitor receive-crc {threshold {high {high-frames | none} | low low-frames} | window milliseconds}

5. ethernet oam link-monitor transmit-crc {threshold {high {high-frames | none} | low low-frames} | window milliseconds}

6. ethernet oam link-monitor symbol-period {threshold {high {none | high-symbols} | low low-symbols} | window symbols}

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

8. ethernet oam link-monitor frame {threshold {high {none | high-frames} | low low-frames} | window milliseconds}

9. ethernet oam link-monitor frame-period {threshold {high {none | high-frames} | low low-frames} | window frames}

10. ethernet oam link-monitor frame-seconds {threshold {high {none | high-frames} | low low-frames} | window milliseconds}

11. exit

12. interface type number

13. source template template-name

14. exit

15. exit

16. show running-config

DETAILED STEPS
Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

template template-name
Example:

Router(config)# template oam-temp

Configures a template and places the CLI in template configuration mode.
Step 4
ethernet oam link-monitor receive-crc 
{threshold {high {high-frames | none} | low 
low-frames} | window milliseconds}
Example:
Router(config-template)# ethernet oam 
link-monitor receive-crc window 99
Configures an Ethernet OAM interface to monitor ingress frames with CRC errors for a period of time.
Step 5
ethernet oam link-monitor transmit-crc 
{threshold {high {high-frames | none} | low 
low-frames} | window milliseconds}
Example:
Router(config-template)# ethernet oam 
link-monitor transmit-crc threshold low 199
Configures an Ethernet OAM interface to monitor egress frames with CRC errors for a period of time.
Step 6
ethernet oam link-monitor symbol-period 
{threshold {high {none | high-symbols} | low 
low-symbols} | window symbols}
Example:
Router(config-template)# ethernet oam 
link-monitor symbol-period threshold high 299
Configures a threshold or window for error symbols, in number of symbols.
Step 7
ethernet oam link-monitor high-threshold action 
error-disable-interface
Example:
Router(config-template)# ethernet oam 
link-monitor high-threshold action 
error-disable-interface 
Configures an error-disable function on an Ethernet OAM interface when a high threshold for an error is exceeded.
Step 8
ethernet oam link-monitor frame {threshold 
{high {none | high-frames} | low low-frames} | 
window milliseconds}
Example:
Router(config-template)# ethernet oam 
link-monitor frame window 399
Configures a number for error frames that when reached triggers an action.
Step 9
ethernet oam link-monitor frame-period 
{threshold {high {none | high-frames} | low 
low-frames} | window frames}
Example:
Router(config-template)# ethernet oam 
link-monitor frame-period threshold high 599
Configures a number of frames to be polled.

Frame period is a user-defined parameter.
Step 10

ethernet oam link-monitor frame-seconds {threshold {high {none | high-frames} | low low-frames} | window milliseconds}
Example:

Router(config-template)# ethernet oam link-monitor frame-seconds window 699

Configures a period of time in which error frames are counted.

Step 11

exit
Example:

Router(config-template)# exit

Returns the CLI to global configuration mode.

Step 12

interface type number
Example:

Router(config)# interface gigabitEthernet 3/8

Identifies the interface on which to use the template and places the CLI in interface configuration mode.

Step 13

source template template-name
Example:

Router(config-if)# source template oam-temp

Applies to the interface the options configured in the template.

Step 14

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Step 15

exit
Example:

Router(config)# exit

Returns the CLI to privileged EXEC mode.

Step 16

show running-config
Example:

Router# show running-config

Displays the updated running configuration.
Configuring a Port for Link Fault RFI Support

Perform this task to put a port into a blocking state when an OAM PDU control request packet is received with the Link Fault Status flag set.

SUMMARY STEPS

1. enable

2. configure terminal

3. interface type number

4. ethernet oam remote-failure {critical-event | dying-gasp | link-fault} action {error-block-interface | error-disable-interface}

5. exit

DETAILED STEPS

Command or Action

Purpose

Step 1

enable
Example:

Router> enable

Enables privileged EXEC mode.

•Enter your password if prompted.

Step 2

configure terminal
Example:

Router# configure terminal

Enters global configuration mode.

Step 3

interface type number
Example:

Router(config)# interface fastethernet 1/2

Places the CLI in interface configuration mode.

Step 4

ethernet oam remote-failure {critical-event | dying-gasp | link-fault} action {error-block-interface | error-disable-interface}
Example:

Router(config-if)# ethernet oam remote-failure critical-event action error-block-interface

Sets the interface to the blocking state when a critical event occurs.

Step 5

exit
Example:

Router(config-if)# exit

Returns the CLI to global configuration mode.

Configuration Examples for Ethernet Operations, Administration, and Maintenance

The following example shows how to configure Ethernet OAM options using a template and overriding that configuration by configuring an interface. In this example, the network supports a Gigabit Ethernet interface between the customer edge device and provider edge device.
! Configure a global OAM template for both PE and CE configuration.
!
Router(config)# template oam
Router(config-template)# ethernet oam link-monitor symbol-period threshold low 10
Router(config-template)# ethernet oam link-monitor symbol-period threshold high 100
Router(config-template)# ethernet oam link-monitor frame window 100
Router(config-template)# ethernet oam link-monitor frame threshold low 10
Router(config-template)# ethernet oam link-monitor frame threshold high 100
Router(config-template)# ethernet oam link-monitor frame-period window 100
Router(config-template)# ethernet oam link-monitor frame-period threshold low 10
Router(config-template)# ethernet oam link-monitor frame-period threshold high 100
Router(config-template)# ethernet oam link-monitor frame-seconds window 1000
Router(config-template)# ethernet oam link-monitor frame-seconds threshold low 10
Router(config-template)# ethernet oam link-monitor frame-seconds threshold high 100
Router(config-template)# ethernet oam link-monitor receive-crc window 100
Router(config-template)# ethernet oam link-monitor receive-crc threshold high 100
Router(config-template)# ethernet oam link-monitor transmit-crc window 100
Router(config-template)# ethernet oam link-monitor transmit-crc threshold high 100
Router(config-template)# ethernet oam remote-failure dying-gasp action 
error-disable-interface
Router(config-template)# exit
!
! Enable Ethernet OAM on the CE interface
!
Router(config)# interface gigabitethernet 4/1/1
Router(config-if)# ethernet oam
!
! Apply the global OAM template named "oam" to the interface.
!
Router(config-if)# source template oam
!
! Configure any interface-specific link monitoring commands to override the template 
configuration. The following example disables the high threshold link monitoring for 
receive CRC errors.
!
Router(config-if)# ethernet oam link-monitor receive-crc threshold high none
!
! Enable Ethernet OAM on the PE interface
!
Router(config)# interface gigabitethernet 8/1/1
Router(config-if)# ethernet oam
!
! Apply the global OAM template named "oam" to the interface.
!
Router(config-if)# source template oam
The following examples show how to verify various Ethernet OAM configurations and activities.

Verifying an OAM Session

The following example shows that the local OAM client, Gigabit Ethernet interface Gi6/1/1, is in session with a remote client with MAC address 0012.7fa6.a700 and OUI 00000C, which is the OUI for Cisco. The remote client is in active mode and has established capabilities for link monitoring and remote loopback for the OAM session.
Router# show ethernet oam summary
Symbols:          * - Master Loopback State,  # - Slave Loopback State
Capability codes: L - Link Monitor,  R - Remote Loopback
                  U - Unidirection,  V - Variable Retrieval
  Local                       Remote
Interface       MAC Address    OUI    Mode    Capability
 Gi6/1/1       0012.7fa6.a700 00000C active      L R 
Verifying OAM Discovery Status

The following example shows how to verify OAM discovery status of a local client and a remote peer:
Router# show ethernet oam discovery interface gigabitethernet6/1/1
GigabitEthernet6/1/1
Local client
------------
  Administrative configurations:
    Mode:              active
    Unidirection:      not supported
    Link monitor:      supported (on)
    Remote loopback:   not supported
    MIB retrieval:     not supported
    Mtu size:          1500
  Operational status:
Port status:       operational
    Loopback status:   no loopback
    PDU permission:    any
    PDU revision:      1
Remote client
-------------
  MAC address: 0030.96fd.6bfa
  Vendor(oui): 0x00 0x00 0x0C (cisco)
  Administrative configurations:
    Mode:              active
   Unidirection:      not supported
   Link monitor:      supported
   Remote loopback:   not supported
   MIB retrieval:     not supported
   Mtu size:          1500
Verifying Information OAMPDU and Fault Statistics

The following example shows how to verify statistics for information OAM PDUs and local and remote faults:
Router# show ethernet oam statistics interface gigabitethernet6/1/1
GigabitEthernet6/1/1
Counters:
---------
Information OAMPDU Tx                   : 588806
Information OAMPDU Rx                   : 988
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              : 1
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
Cisco OAMPDU Tx                         : 4
Cisco OAMPDU Rx                         : 0
Unsupported OAMPDU Tx                   : 0
Unsupported OAMPDU Rx                   : 0
Frames Lost due to OAM                  : 0
Local Faults:
-------------
0 Link Fault records
2 Dying Gasp records
Total dying gasps       : 4
Time stamp              : 00:30:39
Total dying gasps       : 3
Time stamp              : 00:32:39
0 Critical Event records
Remote Faults:
--------------
0 Link Fault records
0 Dying Gasp records
0 Critical Event records
Local event logs:
-----------------
0 Errored Symbol Period records
0 Errored Frame records
0 Errored Frame Period records
0 Errored Frame Second records
Remote event logs:
------------------
0 Errored Symbol Period records
0 Errored Frame records
0 Errored Frame Period records
0 Errored Frame Second records
Verifying Link Monitoring Configuration and Status

The following example shows how to verify link monitoring configuration and status on the local client. The highlighted Status field in the example shows that link monitoring status is supported and enabled (on).
Router# show ethernet oam status interface gigabitethernet6/1/1
GigabitEthernet6/1/1
General
-------
  Mode:                  active
  PDU max rate:          10 packets per second
  PDU min rate:          1 packet per 1 second
  Link timeout:          5 seconds
  High threshold action: no action
Link Monitoring
---------------
  Status: supported (on)
  Symbol Period Error
    Window:              1 million symbols
    Low threshold:       1 error symbol(s)
    High threshold:      none
  Frame Error
    Window:              10 x 100 milliseconds
    Low threshold:       1 error frame(s)
    High threshold:      none
Frame Period Error
    Window:              1 x 100,000 frames
    Low threshold:       1 error frame(s)
    High threshold:      none
  Frame Seconds Error
    Window:              600 x 100 milliseconds
    Low threshold:       1 error second(s)
    High threshold:      none
Verifying Status of a Remote OAM Client

The following example shows that the local client interface Gi6/1/1 is connected to a remote client. Note the values in the Mode and Capability fields.
Router# show ethernet oam summary
Symbols:          * - Master Loopback State,  # - Slave Loopback State
Capability codes: L - Link Monitor,  R - Remote Loopback
                  U - Unidirection,  V - Variable Retrieval
  Local                       Remote
Interface       MAC Address    OUI    Mode    Capability
 Gi6/1/1       0012.7fa6.a700 00000C active      L R 
Additional References

The following sections provide references related to using OAM.

Related Documents

Related Topic

Document Title

Ethernet CFM

"Configuring Ethernet Connectivity Fault Management in a Service Provider Network" in the Cisco IOS Carrier Ethernet Configuration Guide

Ethernet LMI

"Configuring Ethernet Local Management Interface" in the Cisco IOS Carrier Ethernet Configuration Guide

Configuring Ethernet LMI on a PE device

"Configuring Ethernet Local Management Interface at a Provider Edge" in the Cisco IOS Carrier Ethernet Configuration Guide

Cisco IOS Carrier Ethernet commands

Cisco IOS Carrier Ethernet Command Reference

Standards

Standard

Title

IEEE Draft P802.3ah/D3.3

Ethernet in the First Mile - Amendment

IETF VPLS OAM

L2VPN OAM Requirements and Framework

ITU-T

ITU-T Y.1731 OAM Mechanisms for Ethernet-Based Networks

MIBs

MIB

MIBs Link

No new or modified MIBs are supported by this feature, and support for existing MIBs has not been modified by this feature.

To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

http://www.cisco.com/go/mibs

RFCs

RFC

Title

No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.

—

Technical Assistance

Description

Link

The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies.

To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds.

Access to most tools on the Cisco Support website requires a Cisco.com user ID and password.

http://www.cisco.com/techsupport

Command Reference

The following commands are introduced or modified in the feature or features documented in this module. For information about these commands, see the Cisco IOS Carrier Ethernet Command Reference at http://www.cisco.com/en/US/docs/ios/cether/command/reference/
ce_book.html. For information about all Cisco IOS commands, use the Command Lookup Tool at http://tools.cisco.com/Support/CLILookup or the Cisco IOS Master Command List, All Releases, at http://www.cisco.com/en/US/docs/ios/mcl/allreleasemcl/all_book.html.

•clear ethernet oam statistics

•debug ethernet oam

•ethernet oam

•ethernet oam link-monitor frame

•ethernet oam link-monitor frame-period

•ethernet oam link-monitor frame-seconds

•ethernet oam link-monitor high-threshold action

•ethernet oam link-monitor on

•ethernet oam link-monitor receive-crc

•ethernet oam link-monitor supported

•ethernet oam link-monitor symbol-period

•ethernet oam link-monitor transmit-crc

•ethernet oam remote-failure action

•ethernet oam remote-loopback

•ethernet oam remote-loopback (interface)

•show ethernet oam discovery

•show ethernet oam statistics

•show ethernet oam status

•show ethernet oam summary

•source template (eoam)

•template (eoam)

Feature Information for Using Ethernet Operations, Administration, and Maintenance

Table 1 lists the features in this module and provides links to specific configuration information. Only features that were introduced or modified in Cisco IOS Release 12.2(33)SRA, Cisco IOS Release 12.2(33)SXH, Cisco IOS Release 12.4(15)T2, and Cisco IOS Release 12.2(33)SXI or a later release appear in the table.

For information on a feature in this technology that is not documented here, see the "Cisco IOS Carrier Ethernet Features Roadmap."

Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.

Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS, Catalyst OS, and Cisco IOS XE software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

Note Table 1 lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS software release train also support that feature.

Table 1 Feature Information for Using Ethernet Operations, Administration, and Maintenance

Feature Name

Releases

Feature Information

Ethernet Operations, Administration, and Maintenance

12.2(33)SRA 12.2(33)SXH 12.4(15)T2

Ethernet OAM is a protocol for installing, monitoring, and troubleshooting metro Ethernet networks and Ethernet WANs. It relies on a new, optional sublayer in the data link layer of the OSI model. The OAM features covered by this protocol are Discovery, Link Monitoring, Remote Fault Detection, Remote Loopback, and Cisco Proprietary Extensions.

The following sections provide information about this feature:

•Ethernet OAM

•Cisco IOS Implementation of Ethernet OAM

•OAM Features

•OAM Messages

•How to Set Up and Configure Ethernet Operations, Administration, and Maintenance

The Ethernet Operations, Administration, and Maintenance feature was integrated into Cisco IOS Release 12.4(15)T.

The Ethernet Operations, Administration, and Maintenance feature was integrated into Cisco IOS Release 12.2(33)SXH.

The following commands were introduced or modified: clear ethernet oam statistics, debug ethernet oam, ethernet oam, ethernet oam link-monitor frame, ethernet oam link-monitor frame-period, ethernet oam link-monitor frame-seconds, ethernet oam link-monitor high-threshold action, ethernet oam link-monitor on, ethernet oam link-monitor receive-crc, ethernet oam link-monitor supported, ethernet oam link-monitor symbol-period, ethernet oam link-monitor transmit-crc, ethernet oam remote-loopback, ethernet oam remote-loopback (interface), show ethernet oam discovery, show ethernet oam statistics, show ethernet oam status, show ethernet oam summary, source template (eoam), template (eoam)

IEEE 802.3ah Link Fault RFI Support

12.2(33)SXI

The IEEE 802.3ah Link Fault RFI Support feature provides a per-port configurable option that moves a port into a blocking state when an OAM PDU control request packet is received with the Link Fault Status flag set. In the blocking state, the port can continue to receive OAM PDUs, detect remote link status, and automatically recover when the remote link becomes operational.

The following commands were introduced or modified: ethernet oam remote-failure action.

CCDE, CCENT, Cisco Eos, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, the Cisco logo, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0809R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

© 2006-2008 Cisco Systems, Inc. All rights reserved.