MPLS OAM Commands

This module describes Multiprotocol Label Switching (MPLS) label switched path (LSP) verification commands. These commands provide a means to detect and diagnose data plane failures and are the first set of commands in the MPLS Operations, Administration, and Maintenance (OAM) solution.

Syntax Description

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.

packet

Clears global packet counters.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.3.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

mpls-te

execute

mpls-ldp

execute

mpls-static

execute

Examples

The following example shows how to clear all global MPLS OAM counters:

RP/0/RP0/CPU0:router# clear mpls oam counters global

echo disable-vendor-extension

To disable sending the vendor extension type length and value (TLV) in the echo request, use the echo disable-vendor extension command in MPLS OAM configuration mode. To return to the default behavior, use the no form of this command.

echo disable-vendor-extension

noecho disable-vendor-extension

Syntax Description

This command has no arguments or keywords.

Command Default

The default value is 4.

Command Modes

MPLS OAM configuration mode

Command History

Release

Modification

Release 3.3.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

mpls-te

read, write

mpls-ldp

read, write

mpls-static

read, write

Examples

The following example shows how to disable inclusion of the vendor extensions TLV in the echo requests:

echo revision

To set the echo packet revision, use the echo revision command in MPLS OAM configuration mode. To return to the default behavior, use the no form of this command.

echo revision
{ 1 | 2 | 3 | 4 }

noecho revision

Syntax Description

1 | 2 | 3 | 4

Draft revision number:

1: draft-ietf-mpls-lsp-ping-03 (initial)

2: draft-ietf-mpls-lsp-ping-03 (rev 1)

3: draft-ietf-mpls-lsp-ping-03 (rev 2)

4: draft-ietf-mpls-lsp-ping-09 (initial)

Command Default

The default echo revision is 4 (in draft 9).

Command Modes

MPLS OAM configuration mode

Command History

Release

Modification

Release 3.3.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

mpls-te

read, write

mpls-ldp

read, write

mpls-static

read, write

Examples

The following example shows how to set the echo packet default revision:

mpls oam

To enable MPLS OAM LSP verification, use the mpls oam command in global configuration mode. To return to the default behavior, use the no form of this command.

mpls oam

nompls oam

Syntax Description

This command has no arguments or keywords.

Command Default

By default, MPLS OAM functionality is disabled.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.3.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 mpls oam command and OAM functionality is described in the IETF LSP ping draft.

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Release 3.4.1

Sample output was modified.

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 output interface keyword specifies the output interface on which the MPLS echo request packets are sent. If the specified output interface is not part of the LSP, the packets are not transmitted.

In cases where the sweep keyword is used, values larger than the outgoing interface’s MTU are not transmitted.

The ping command sends an echo request packet to an address, and then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.

Note

The ping mpls command is not supported on optical LSPs. If an optical LSP is encountered along the LSP's path, it is treated as a physical interface.

Command Modes

Command History

This command was introduced. This command was replaced by the ping mpls traffic-eng tunnel-te (P2P) command.

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 output interface keyword specifies the output interface on which the MPLS echo request packets are sent. If the specified output interface is not part of the LSP, the packets are not transmitted.

In cases where the sweep keyword is used, values larger than the outgoing interface’s MTU are not transmitted.

The ping command sends an echo request packet to an address, and then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.

Note

The ping mpls traffic-eng command is not supported on optical LSPs. If an optical LSP is encountered along the LSP's path, it is treated as a physical interface.

Task ID

Task ID

Operations

mpls-te

read, write

mpls-ldp

read, write

Examples

The following example shows how to check connectivity by using the ping mpls traffic-eng command when a TE tunnel 10 is present. Return code, reply address, and packet size are displayed due to the verbose keyword.

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.

In cases in which the sweep keyword is used, values larger than the outgoing interface’s MTU are not transmitted.

The ping command sends an echo request packet to an address, and then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning.

Note

The ping mpls command is not supported on optical LSPs. If an optical LSP is encountered along the LSP's path, it is treated as a physical interface.

AToM VCCV allows the sending of control packets inband of an AToM pseudowire (PW) from the originating provider edge (PE) router. The transmission is intercepted at the destination PE router, instead of being forwarded to the customer edge (CE) router. This lets you use MPLS LSP ping to test the pseudowire section of AToM virtual circuits (VCs).

The no interactive version of the ping pseudowire (AToM) command is supported.

The control word setting is either enabled along the entire path between the Terminating-Provider Edge (T-PE) or it is completely disabled. If the control word configuration is enabled on one segment and disabled on another segment, the multisegment pseudowire does not come up.

Task ID

Task ID

Operations

mpls-te

read, write

mpls-ldp

read, write

Examples

The following example shows how the ping mpls pseudowire command is used to verify PE to PE connectivity in which the remote PE address is 150.150.150.150. Only one echo request packet is sent and the remote PE is to answer using IPv4 instead of the control channel.

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 4.0.0

This command was introduced. This command replaces the ping mpls traffic-eng command.

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 output interface keyword specifies the output interface on which the MPLS echo request packets are sent. If the specified output interface is not part of the LSP, the packets are not transmitted.

In cases where the sweep keyword is used, values larger than the outgoing interface's MTU are not transmitted.

The ping command sends an echo request packet to an address, and then waits for a reply. Ping output helps you evaluate path-to-host reliability, delays over the path. It also helps you determine whether the host is reachable or is functioning.

Task ID

Task ID

Operation

mpls-te

read, write

mpls-ldp

read, write

Related Commands

Command

Description

show mpls traffic-eng tunnels

Displays information about MPLS-TE tunnels.

ping mpls traffic-eng tunnel-mte (P2MP)

Verifies the connectivity of the LSP path for the MPLS-TE P2MP tunnels.

ping mpls traffic-eng tunnel-mte (P2MP)

To specify the destination type as a Point-to-Multipoint (P2MP) for MPLS-TE tunnel and tunnel interface, use the ping mpls traffic-eng tunnel-mte command in EXEC mode.

Syntax Description

tunnel-mte tunnel-ID

Specifies the destination type as an MPLS traffic engineering (TE) P2MP tunnel and the tunnel interface number. The range for the tunnel interface number is 0 to 65535.

ddmap

(Optional) Indicates that a downstream detailed mapping TLV should be included in the LSP echo request.

destinationstart-addressend-addressincrement

Specifies a network 127/8 address to be used as the destination address in the echo request packet.

start-address

Start of the network address.

end-address

End of the network address.

address increment

Incremental value of the network address, which is expressed as a decimal number value or IP address.

responder-idipv4-address

(Optional) Specifies the responder IPv4 address.

expexp-bits

(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.

intervalmin-send-delay

(Optional) Specifies a send interval, in milliseconds, between requests. Range is 0 to 3600000. Default is 0.

jitterjitter-value

(Optional) Specifies a jitter value, in milliseconds. Range is 0 to 2147483647. Default is 200.

lsp {active | reopt}

(Optional) Specifies the Label Switch Path (LSP) to use.

active

Active LSP.

reopt

Reoptimize LSP.

padpattern

(Optional) Specifies the pad pattern for an echo request.

repeatcount

(Optional) Specifies the number of times to resend a packet. Range is 1 to 2147483647. Default is 5.

reply dscpdscp-value

(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.

mode [ipv4 | router-alert | no-reply]

(Optional) Specifies the reply mode for the echo request packet.

no-reply

Do not reply

ipv4

Reply with an IPv4 UDP packet (this is the default)

router-alert

Reply with an IPv4 UDP packet with the IP router alert set

reply pad-tlv

(Optional) Indicates that a pad TLV should be included.

sizepacket-size

(Optional) Specifies the packet size or number of bytes in each MPLS echo request packet. Range is 100 to 17986. Default is 100.

sourcesource-address

(Optional) Specifies the source address used in the echo request packet.

sweepmin-valuemax-valueinterval

(Optional) Specifies a range of sizes for the echo packets sent.

min-value

Minimum or start size for an echo packet (range is 100 to 17986)

max-value

Maximum or end size for an echo packet(range is 100 to 17986)

interval

Number used to increment an echo packet size(range is 1 to 8993)

timeouttimeout

(Optional) Specifies the timeout interval, in seconds. Range is 0 to 3600. Default is 2.

ttlvalue

(Optional) Specifies the TTL value to be used in the MPLS labels (range is 1 to 255). Default is 255.

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 4.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.

To ping for LSP reoptimization, ensure that the reoptimization timer for the tunnel is running by using the show mpls traffic-eng tunnels reoptimized within-last command.

Task ID

Task ID

Operation

basic-services

execute

mpls-te or mpls-ldp

read

Examples

The following example shows how to check connectivity by using the ping mpls traffic-eng tunnel-mte command with the jitter keyword:

The following example shows how to identify the LSP ID tunnel information by using the show mpls traffic-eng tunnels p2mp command, and then using the lsp id keyword with the ping mpls traffic-eng tunnel-mte command.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.1

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

Operation

basic-services

execute

mpls-te

read

mpls-ldp

read

Examples

The following examples show how to check connectivity for P2MP by using the ping mpls mldp p2mp command.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.1

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

Operation

basic-services

execute

mpls-te

read

mpls-ldp

read

Examples

The following example shows how to check connectivity by using the ping mpls mldp command when a root address is present.

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 default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.5.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

mpls-te

read

mpls-ldp

read

mpls-static

read

Examples

The following example shows how to display MPLS OAM client information:

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 3.5.0

This command was introduced.

Release 3.9.0

The handle-value argument was added.

Release 4.0.0

The replies keyword was removed.

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

mpls-te

read

mpls-ldp

read

mpls-static

read

Examples

The following example shows how to display detailed MPLS OAM database information:

RP/0/RP0/CPU0:router# show mpls oam database request detail

traceroute mpls ipv4

To learn the routes that packets follow when traveling to their Label Distribution Protocol (LDP) IPv4 destination, use the traceroute mpls command in EXEC mode.

Command Default

expexp-bits: 0

reply mode: IPv4

timeouttimeout: 2

Command Modes

EXEC

Command History

Release

Modification

Release 3.3.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.

Note

The traceroute mpls command is not supported on optical LSPs. If an optical LSP is encountered along the LSPs path, it is treated as a physical interface.

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 3.3.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 hashkey ipv4 bitmap keyword and bit-size value control how many addresses are encoded in the DSMAP multipath field. Larger values allow more coverage of equal cost multiple paths throughout the network, but with more processing at the head, mid, and tail routers.

Task ID

Task ID

Operations

mpls-te

read, write

mpls-ldp

read, write

Examples

The following example shows how to specify the destination type as an LDP IPv4 prefix:

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 3.9.0

This command was introduced.

Release 4.0.0

This command was replaced by the traceroute mpls traffic-eng tunnel-te (P2P) command.

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

Operation

mpls-te

read

mpls-ldp

read

Examples

The following example shows how to specify the destination as a MPLS-TE tunnel:

Command Default

Command Modes

EXEC

Command History

Release

Modification

Release 4.0.0

This command was introduced. This command replaces the traceroute mpls traffic-eng command.

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

Operation

mpls-te

read

mpls-ldp

read

Examples

The following example shows how to specify the destination as a MPLS-TE tunnel:

Command Default

expexp-bits : 0

reply-mode: IPv4

timeouttimeout : 2

ttl: 30

Command Modes

EXEC

Command History

Release

Modification

Release 4.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

Operation

mpls-te

read

mpls-ldp

read

Examples

The following example shows how to specify the maximum number of hops for the trace route to traverse by using the ttl keyword:

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.1

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

Operation

basic-services

execute

mpls-te or mpls-ldp

read

Examples

The following examples show how to verify path tracing for P2MP by using the traceroute mpls mldp p2mp command.

Command Default

ttl255jitter200

Command Modes

EXEC

Command History

Release

Modification

Release 4.1.1

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

Operation

basic-services

execute

mpls-te or mpls-ldp

read

Examples

The following examples show how to verify path tracing for MP2MP by using the traceroute mpls mldp mp2mp command.