MPLS Command Reference for Cisco NCS 5500 Series, Cisco NCS 540 Series, and Cisco NCS 560 Series Routers

clear mpls oam counters

To clear MPLS OAM counters, use the clear mpls oam counters command in XR EXEC mode.

clear mpls oam counters {global | interface [type interface-path-id] | packet}

Syntax Description

global

Clears global counters.

interface

Clears counters on a specified interface.

type

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

interface-path-id

Physical interface or virtual interface.

Note

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

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

packet

Clears global packet counters.

Command Default

No default behavior or values

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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

no echo 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 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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:


RP/0/RP0/CPU0:router# configure
RP/0/RP0/CPU0:router(config)# mpls oam
RP/0/RP0/CPU0:router(config-oam)# echo disable-vendor-extension

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 }

no echo revision

Syntax Description


1 \| 2 \| 3 \| 4	Draft revision number: 1: RFC-ietf-mpls-lsp-ping-03 (initial) 2: RFC-ietf-mpls-lsp-ping-03 (rev 1) 3: RFC-ietf-mpls-lsp-ping-03 (rev 2) 4: RFC-ietf-mpls-lsp-ping-09 (initial)

Command Default

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

Command Modes

MPLS OAM configuration mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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:


RP/0/RP0/CPU0:router# configure
RP/0/RP0/CPU0:router(config)# mpls oam
RP/0/RP0/CPU0:router(config-oam)# echo revision 1

mpls oam

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

mpls oam

no mpls oam

Syntax Description

This command has no arguments or keywords.

Command Default

By default, MPLS OAM functionality is disabled.

Command Modes

XR Config mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

The mpls oam command and OAM functionality is described in the RFC 4379.

Task ID


Task ID	Operations
mpls-te	read, write
mpls-ldp	read, write
mpls-static	read, write

Examples

The following example shows how to enable MPLS OAM:


RP/0/RP0/CPU0:router# configure
RP/0/RP0/CPU0:router(config)# mpls oam
RP/0/RP0/CPU0:router(config-oam)#

ping mpls ipv4

To check MPLS host reachability and network connectivity by specifying the destination type as a Label Distribution Protocol (LDP) IPv4 address, use the ping mpls ipv4 command in XR EXEC mode.

ping mpls ipv4 address/mask [destination start-address end-address increment] [dsmap] [exp exp-bits] [force-explicit-null] [interval min-send-delay] [output interface type interface-path-id [nexthop nexthop-address]] [pad pattern] [repeat count] [reply {dscp dscp-value | reply mode {ipv4 | no-reply | router-alert} | reply pad-tlv}] [revision version] [size packet-size] [source source-address] [sweep min value max value increment] [timeout timeout] [ttl value] [verbose] [fec-type {bgp | generic | ldp}]

Syntax Description

address/mask

Address prefix of the target and number of bits in the target address network mask.

destination start address end address address increment

(Optional) 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: Start of the ending network address.
address increment: Incremental value of the network address, which is expressed as a decimal number value or IP address.

dsmap

(Optional) Indicates that a downstream mapping (DSMAP) type length and value should be included in the LSP echo request.

exp exp-bits

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

force-explicit-null

(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.

interval min-send-delay

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

output interface

(Optional) Specifies the output interface where echo request packets are sent.

type

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

interface-path-id

Physical interface or virtual interface.

Note

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

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

nexthop

(Optional) Specifies the nextop as an IP address.

nexthop-iaddress

(Optional) IP address for the next hop.

pad pattern

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

repeat count

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

reply dscp dscp-value

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

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

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

Indicates that a pad TLV should be included.

revision version

(Optional) Specifies the Cisco extension TLV versioning field:

1 RFC-ietf-mpls-lsp-ping-03 (initial)
2 RFC-ietf-mpls-lsp-ping-03 (rev 1)
3 RFC-ietf-mpls-lsp-ping-03 (rev 2)
4 RFC-ietf-mpls-lsp-ping-09 (initial)

size packet size

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

source source-address

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

sweep min value max value interval

(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)

timeout timeout

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

ttl value

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

verbose

(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

fec-type

(Optional) Specifies FEC type to be used.

bgp: Use FEC type as BGP
generic: Use FEC type as generic
ldp: Use FEC type as LDP

Command Default

exp exp bits : 0

interval min-send-delay: 0

repeat count : 5

reply-mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

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.

For detailed configuration information about the MPLS ping command, see Cisco ASR 9000 Series Router Cisco IOS XR System Monitoring Configuration Guide for the CRS-1 Router Cisco XR 12000 Series Router.

Task ID


Task ID	Operations
mpls-te	read, write
mpls-ldp	read, write

Examples

The following example shows the destination type as a label distribution protocol (LDP) prefix and specifies a range of sizes for the echo packets sent:


RP/0/RP0/CPU0:router# ping mpls ipv4 140.140.140/32 verbose sweep 100 200 15 repeat 1
  
  Sending 1, [100..200]-byte MPLS Echos to 140.140.140.140/32,
        timeout is 2 seconds, send interval is 0 msec:
   
  Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
    'L' - labeled output interface, 'B' - unlabeled output interface, 
    'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
    'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
    'P' - no rx intf label prot, 'p' - premature termination of LSP, 
    'R' - transit router, 'I' - unknown upstream index,
    'X' - unknown return code, 'x' - return code 0
   
  Type escape sequence to abort.
  !    size 100, reply addr 196.100.1.26, return code 3
  !    size 115, reply addr 196.100.1.26, return code 3
  !    size 130, reply addr 196.100.1.26, return code 3
  !    size 145, reply addr 196.100.1.26, return code 3
  !    size 160, reply addr 196.100.1.26, return code 3
  !    size 175, reply addr 196.100.1.26, return code 3
  !    size 190, reply addr 196.100.1.26, return code 3
   
  Success rate is 100 percent (7/7), round-trip min/avg/max = 5/6/8 ms

The following example shows the destination type as a label distribution protocol (LDP) prefix and specifies FEC type as generic and verbose option:


RP/0/RP0/CPU0:router# ping mpls ipv4 11.11.11.11/32 fec-type generic output interface gigabitEthernet 0/0/0/3 
nexthop 172.40.103.2 verbose
  
Sending 5, 100-byte MPLS Echos to 11.11.11.11/32,
      timeout is 2 seconds, send interval is 0 msec:

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

!      size 100, reply addr 11.101.11.11, return code 3 
!      size 100, reply addr 11.101.11.11, return code 3 
!      size 100, reply addr 11.101.11.11, return code 3 
!      size 100, reply addr 11.101.11.11, return code 3 
!      size 100, reply addr 11.101.11.11, return code 3 

Success rate is 100 percent (5/5), round-trip min/avg/max = 3/4/6 ms

ping mpls traffic-eng

To specify the destination type as an MPLS-TE tunnel and tunnel interface, use the ping mpls traffic-eng command in XR EXEC mode.

ping mpls traffic-eng tunnel tunnel-ID [dsmap] [exp exp-bits] [force-explicit-null] [interval min-send-delay] [pad pattern] [repeat count] [reply {dscp dscp-value | reply mode {ipv4 | no-reply | router-alert} | reply pad-tlv}] [revision version] [size packet-size] [source source-address] [sweep min-value max-value increment] [timeout timeout] [ttl value] [verbose]

Syntax Description


tunnel `tunnel-ID`	Specifies the destination type as an MPLS traffic engineering (TE) tunnel and the tunnel interface number. The range for the tunnel interface number is from 0 to 65535.
dsmap	(Optional) Indicates that a downstream mapping (DSMAP) type length and value should be included in the LSP echo request.
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
force-explicit-null	(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.
interval `min-send-delay`	(Optional) Specifies a send interval, in milliseconds, between requests. Range is 0 to 3600000. Default is 0.
pad `pattern`	(Optional) Specifies the pad pattern for an echo request.
repeat `count`	(Optional) Specifies the number of times to resend a packet. Range is 1 to 2147483647. Default is 5.
reply dscp `dscp-value`	(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.
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.
revision `version`	(Optional) Specifies the Cisco extension TLV versioning field: 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)
size `packet-size`	(Optional) Specifies the packet size or number of bytes in each MPLS echo request packet. Range is 100 to 17986. Default is 100.
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
sweep `min-value` `max-value` `interval`	(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)
timeout `timeout`	(Optional) Specifies the timeout interval, in seconds. Range is 0 to 3600. Default is 2.
ttl `value`	(Optional) Specifies the TTL value to be used in the MPLS labels (range is 1 to 255).
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

interval min-send-delay : 0

repeat count : 5

reply-mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

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.


RP/0/RP0/CPU0:router# ping mpls traffic-eng tunnel 10 repeat 1 verbose
  
  Sending 1, 100-byte MPLS Echos to tunnel-te10,
        timeout is 2 seconds, send interval is 0 msec:
  
  Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
    'L' - labeled output interface, 'B' - unlabeled output interface, 
    'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
    'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
    'P' - no rx intf label prot, 'p' - premature termination of LSP, 
    'R' - transit router, 'X' - unknown return code, 'x' - return code 0
  
  Type escape sequence to abort.
  !    size 100, reply addr 196.100.1.18, return code 3
  
  Success rate is 100 percent (1/1), round-trip min/avg/max = 15/15/15 ms

ping mpls traffic-eng tunnel-tp

To specify the destination type as an MPLS-TP tunnel and tunnel interface, use the ping mpls traffic-eng tunnel-tp command in XR EXEC mode.

ping mpls traffic-eng tunnel-tp tunnel-id [ddmap] [destination start-address end-address increment] [dsmap] [ encap {cv-ip | cv-non-ip | ip}] [exp exp-bits] [flags {fec | reverse-verification }] [interval min-send-delay] [ lsp {active | protect | working}] [pad pattern] [repeat count] [reply {dscp dscp-value | mode {control-channel | no-reply } | pad-tlv}] [size packet-size] [source source-address] [sweep min value max value increment] [timeout timeout] [ttl value] [verbose]

Syntax Description

tunnel-tp tunnel-ID

Specifies the destination type as an MPLS Transport Profile (MPLS-TP) 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 (DDMAP) TLV should be included in the LSP echo request.

destination start-address end-address increment

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: Start of the ending network address.
address increment: Incremental value of the network address, which is expressed as a decimal number value or IP address.

dsmap

(Optional) Indicates that a downstream mapping (DSMAP) type length and value should be included in the LSP echo request.

encap { cv-ip | cv-non-ip | ip }

(Optional) Specifies the MPLS-TP encapsulation type to use.

cv-ip: Use IP encapsulation with GACH channel 0x0021.

cv-non-ip: Use non-IP encapsulation with GACH channel 0x0025.

ip: Use IP encapsulation.

exp exp-bits

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

flags { fec | reverse-verification }

(Optional) Specifies the flag options to use.

fec: Request forwarding equivalent class (FEC) stack checking is to be performed at transit routers.

reverse-verification: Request reverse path connectivity verification.

interval min-send-delay

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

lsp { active | protect | working }

(Optional) Specifies the LSP to use.

active: Active MPLS-TP tunnel.

protect: Protect MPLS-TP tunnel.

working

Working MPLS-TP tunnel.

Note

Use this option to identify error in the LSP path if the MPLS-TP tunnel is not up.

pad pattern

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

repeat count

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

reply dscp dscp-value

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

mode [control-channel | no-reply ]

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

control-channel: Send reply through a control channel.
no-reply: Do not reply.

pad-tlv

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

size packet-size

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

source source-address

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

sweep min-value max-value interval

(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)

timeout timeout

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

ttl value

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

verbose

(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

interval min-send-delay : 0

repeat count : 5

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

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

Examples

The following sample output is from the ping mpls traffic-eng tunnel-tp command using the non-IP-ACH encapsulation:


RP/0/RP0/CPU0:router# ping mpls traffic-eng tunnel-tp 1 encap cv-non-ip

Sending 5, 100-byte MPLS Echos to tunnel-tp1,
      timeout is 2 seconds, send interval is 0 msec:

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 3/11/45 ms

The following sample output is from the ping mpls traffic-eng tunnel-tp command using the non-IP-ACH encapsulation and verbose option:


RP/0/RP0/CPU0:router# ping mpls traffic-eng tunnel-tp 1 encap cv-non-ip

Sending 5, 100-byte MPLS Echos to tunnel-tp1,
      timeout is 2 seconds, send interval is 0 msec:

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

!      size 100, reply node id 12.12.12.3, global id 0, return code 3 
!      size 100, reply node id 12.12.12.3, global id 0, return code 3 
!      size 100, reply node id 12.12.12.3, global id 0, return code 3 
!      size 100, reply node id 12.12.12.3, global id 0, return code 3 
!      size 100, reply node id 12.12.12.3, global id 0, return code 3 

Success rate is 100 percent (5/5), round-trip min/avg/max = 3/3/4 ms

The following sample output is from the ping mpls traffic-eng tunnel-tp command using the non-IP-ACH encapsulation and DSMAP/DDMAP option:


RP/0/RP0/CPU0:router# ping mpls traffic-eng tunnel-tp 1 encap cv-non-ip

Sending 1, 100-byte MPLS Echos to tunnel-tp1,
      timeout is 2 seconds, send interval is 0 msec:

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface,
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label,
  'P' - no rx intf label prot, 'p' - premature termination of LSP,
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

L      size 100, reply node id 12.12.12.3, global id 0, return code 8 
 Echo Reply received from Node ID 12.12.12.3, Global ID 0
  DSMAP 0, Ingress Link ID 3, Egress Link ID 4
    Depth Limit 0, MRU 1500 [Labels: 1100 Exp: 0]


Success rate is 0 percent (0/1)

ping pseudowire (AToM)

To verify connectivity between provider edge (PE) LSRs in an Any Transport over MPLS (AToM) setup, use the ping pseudowire command in XR EXEC mode.

ping [mpls] pseudowire remote-PE -address pw-id [exp exp-bits] [interval min-send-delay] [pad pattern] [repeat count] [reply {dscp dscp-value | reply mode {ipv4 | no-reply | router-alert | control-channel} | reply pad-tlv}] [size packet-size] [source source-address] [sweep min-value max-value increment] [timeout timeout] [ttl value] [verbose]

Syntax Description


mpls	(Optional) Verifies the Labeled Switch Path (LSP).
`remote-PE address`	IP address of the remote PE LSR.
`pw-id`	Pseudowire ID that identifies the pseudowire in which MPLS connectivity is being verified. The pseudowire is used to send the echo request packets. The range is from 1 to 4294967295.
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
interval `min-send-delay`	(Optional) Specifies a send interval, in milliseconds, between requests. Range is 0 to 3600000. Default is 0.
pad `pattern`	(Optional) Specifies the pad pattern for an echo request.
repeat `count`	(Optional) Specifies the number of times to resend a packet. Range is 1 to 2147483647. Default is 5.
reply dscp `dscp-value`	(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.
reply mode {ipv4 \| router-alert \| no-reply \| control-channel }	(Optional) Specifies the reply mode for the echo request packet. no-reply Do not reply ipv4 Reply with an IPv4 UDP packet (the default) router-alert Reply with an IPv4 UDP packet with the IP router alert set control-channel Force the use of a VCCV control channel. Reply using an application for a defined control channel. This applies only to pseudowires in which VCCV is used in the reply path. This is the default choice for pseudowire ping.
reply pad-tlv	(Optional) Indicates that a reply pad TLV should be included.
size `packet-size`	(Optional) Specifies the packet size or number of bytes in each MPLS echo request packet. Range is 100 to 17986. Default is 100.
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
sweep `min-value` `max-value` `interval`	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)
timeout `timeout`	(Optional) Specifies the timeout interval in seconds. Range is 0 to 3600. Default is 2 seconds.
ttl `value`	(Optional) Specifies the TTL value to be used in the MPLS labels (range is 1 to 255).
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp bits : 0

interval min-send-delay : 0

repeat count : 5

reply-mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History

Release

Modification

Release 6.0

This command was introduced.

Release 6.3.2

Supports segment routing and SR-TE policy preferred path as transport to reach remote PE.

Note

Label distribution protocol (LDP) is required to signal PW up, but is not required as transport.

Usage Guidelines

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.


RP/0/RP0/CPU0:router# ping mpls pseudowire 150.150.150.150 21 repeat 1 reply mode ipv4
  
  Sending 1, 100-byte MPLS Echos to 150.150.150.150 VC: 21,
        timeout is 2 seconds, send interval is 0 msec:
  
  Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
    'L' - labeled output interface, 'B' - unlabeled output interface, 
    'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
    'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
    'P' - no rx intf label prot, 'p' - premature termination of LSP, 
    'R' - transit router, 'I' - unknown upstream index,
    'X' - unknown return code, 'x' - return code 0
  
  Type escape sequence to abort.
  !
  Success rate is 100 percent (1/1), round-trip min/avg/max = 23/23/23 ms

ping mpls traffic-eng tunnel-te (P2P)

To specify the destination type as an MPLS-TE tunnel and tunnel interface, use the ping mpls traffic-eng tunnel-te command in XR EXEC mode.

ping mpls traffic-eng tunnel-te tunnel-ID {destination start-address end-address increment} [dsmap] [exp exp-bits] [force-explicit-null] [interval min-send-delay] [ lsp {active | path-protect}] [pad pattern] [repeat count] [reply {dscp dscp-value | mode {ipv4 | no-reply | router-alert} | pad-tlv}] [revision version] [size packet-size] [source source-address] [sweep min-value max-value increment] [timeout timeout] [ttl value] [verbose]

Syntax Description


tunnel-te `tunnel-ID`	Specifies the destination type as an MPLS traffic engineering (TE) tunnel and the tunnel interface number. The range for the tunnel interface number is 0 to 65535.
destination `start-address` `end-address` `increment`	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` Start of the ending network address. `address increment` Incremental value of the network address, which is expressed as a decimal number value or IP address.
dsmap	Specifies a downstream mapping type length and value which should be included in the LSP echo request.
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
force-explicit-null	(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.
interval `min-send-delay`	(Optional) Specifies a send interval, in milliseconds, between requests. Range is 0 to 3600000. Default is 0.
lsp { active \| \| path-protect }	(Optional) Specifies the LSP to use.
pad `pattern`	(Optional) Specifies the pad pattern for an echo request.
repeat `count`	(Optional) Specifies the number of times to resend a packet. Range is 1 to 2147483647. Default is 5.
reply dscp `dscp-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.
revision `version`	(Optional) Specifies the Cisco extension TLV versioning field: 1 RFC-ietf-mpls-lsp-ping-03 (initial) 2 RFC-ietf-mpls-lsp-ping-03 (rev 1) 3 RFC-ietf-mpls-lsp-ping-03 (rev 2) 4 RFC-ietf-mpls-lsp-ping-09 (initial)
size `packet-size`	(Optional) Specifies the packet size or number of bytes in each MPLS echo request packet. Range is 100 to 17986. Default is 100.
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
sweep `min-value` `max-value` `interval`	(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)
timeout `timeout`	(Optional) Specifies the timeout interval, in seconds. Range is 0 to 3600. Default is 2.
ttl `value`	(Optional) Specifies the TTL value to be used in the MPLS labels (range is 1 to 255).
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

interval min-send-delay : 0

repeat count : 5

reply-mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

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

ping pseudowire multisegment

To verify the ping over the multisegment pseudowire, use the ping pseudowire multisegment command in XR EXEC mode.

ping [mpls] pseudowire multisegment end-address pw-id [destinationfec sender-address remote-address pw-id-address] [exp exp-bits] [interval min-send-delay] [pad pattern] [repeat count] [segment-count segment-number] [reply {dscp dscp-value | mode {ipv4 | no-reply | router-alert | control-channel} | pad-tlv}] [size packet-size] [source source-address] [sweep min value max value increment] [timeout timeout] [verbose]

Syntax Description


mpls	(Optional) Verifies the Label Switched Path (LSP).
`end-address`	Target end address.
`pw-id`	Virtual circuit of the pseudowire ID that identifies the pseudowire in which MPLS connectivity is being verified. The pseudowire sends the echo request packets. Range is from 1 to 4294967295.
destinationfec `sender-address` `remote-address` `pw-id-address`	(Optional) Specifies the destination for the Forwarding Equivalence Class (FEC) . `sender-address` Sender-PE (S-PE) address for the destination FEC. The S-PE address is placed in the S-PE address field of the FEC 128 Pseudowire (RFC 4379). `remote-address` Remote address (S-PE address for the partial ping) for the destination FEC. The address is placed in the remote PE address of the FEC 128 Pseudowire (RFC 4379). pw-id-address Pseudowire ID of the pseudowire segment to the remote T-PE address (S-PE address for the partial ping).
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
interval `min-send-delay`	(Optional) Specifies a send interval between requests (in milliseconds). Range is 0 to 3600000. Default is 0.
pad `pattern`	(Optional) Specifies the pad pattern for an echo request.
repeat `count`	(Optional) Specifies the number of times to resend a packet. Range is 1 to 2147483647. Default is 5.
reply dscp `dscp-value`	(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.
reply mode {ipv4 \| router-alert \| no-reply \| control-channel }	(Optional) Specifies the reply mode for the echo request packet. no-reply Do not reply ipv4 Reply with an IPv4 UDP packet (the default) router-alert Reply with an IPv4 UDP packet with the IP router alert set control-channel Force the use of a VCCV control channel. Reply using an application for a defined control channel. This applies only to pseudowires in which VCCV is used in the reply path. This is the default choice for pseudowire ping.
segment-count	(Optional) Specifies the segment count for the FEC destination of the multisegment pseudowire . The segment count is used for the pseudowire label for the TTL value.
`segment-number`	(Optional) Value of the segment count. Range is 1 to 255.
pad-tlv	(Optional) Indicates that a pad TLV should be included.
size `packet-size`	(Optional) Specifies the packet size or number of bytes in each MPLS echo request packet. Range is 100 to 17986. Default is 100.
sweep `min value` `max value` `interval`	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)
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
timeout `timeout`	(Optional) Specifies the timeout interval in seconds. Range is 0 to 3600. Default is 2 seconds.
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

interval min-send-delay : 0

repeat count : 5

reply-mode : ipv4

size packet-size : 100

timeout timeout : 2 seconds

Command Modes

XR Config mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

The partial ping works only if the destinationfec keyword is used.

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 the local pseudowire segment from T-PE1 is set to S-PE1 80.80.80.80 and the pseudowire ID is set to 100. The last pseudowire segment of the multisegment pseudowire is from S-PE1 80.80.80.80 to T-PE2 90.90.90.90 and the pseudowire ID is set to 300.


RP/0/RP0/CPU0:router#  ping pseudowire multisegment 80.80.80.80 100  destinationfec 80.80.80.80 90.90.90.90 300 segment-count 2

Sending 5, 100-byte MPLS Echos to 80.80.80.80 VC: 100, 90.90.90.90 VC: 300
      timeout is 2 seconds, send interval is 0 msec, PW Label TTL is 2:

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 6/10/18 ms

show mpls oam

To display MPLS OAM information, use the show mpls oam command in XR EXEC mode.

show mpls oam {client | counters {global | packet} | interface type interface-path-id}

Syntax Description

client

Displays clients registered with LSPV server.

counters global

Displays LSP verification global counters.

counters packet

Displays LSP verification packet counters.

interface

Displays LSP verification information for a specific interface.

type

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

interface-path-id

Physical interface or virtual interface.

Note

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

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

Command Default

No default behavior or values

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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:


RP/0/RP0/CPU0:router# show mpls oam client
  
  Client Process: l2vpn_mgr Node: 0/0/SP Pid: 418014
  Client Process: te_control Node: 0/0/SP Pid: 639227

This table describes the significant fields shown in the display.

Table 1. show mpls oam client Command Field Descriptions
Field	Description
Client Process	Process of client.

show mpls oam database

To display MPLS OAM database information, use the show mpls oam database command in XR EXEC mode.

show mpls oam database { requests | tt-requests} [detail] [handle handle-value ]

Syntax Description


requests	Displays request database
tt-requests	Displays tree trace request database
detail	(Optional) Displays displayed information.
handle	(Optional) Displays handle information.
`handle-value`	Generic handle value. Range is from 0 to 4294967295.

Command Default

No default behavior or values

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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 XR EXEC mode.

traceroute mpls ipv4address/mask [destination start-address end-address address-increment] [exp exp-bits] [flags fec] [force-explicit-null] [output {interface type interface-path-id [nexthop nexthop-address] | | [nexthop nexthop-address]}] [reply {dscp dscp-value | reply mode {ipv4 | router-alert}}] [revision version] [source source-address] [timeout timeout] [ttl value] [verbose] [fec-type {bgp | generic | ldp}]

Syntax Description

address/mask

Specifies the destination type as a label distribution protocol (LDP) prefix. Address prefix of the target and number of bits in the target address network mask.

destination start-address end-address address-increment

Specifies a network 127 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.

exp exp-bits

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

flags fec

(Optional) Specifies that forwarding equivalent class (FEC) stack checking is to be performed at transit routers.

force-explicit-null

(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.

output interface

(Optional) Specifies the output interface in which echo request packets are sent.

type

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

interface-path-id

Physical interface or virtual interface.

Note

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

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

nexthop

(Optional) Specifies the IP address for the next hop.

nexthop-address

(Optional) IP address for the next hop.

reply dscp dscp-value

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

reply mode { ipv4 | router-alert }

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

ipv4: Reply with IPv4 UDP packet (this is the default)
router-alert: Reply with IPv4 UDP packet with router alert

revision version

(Optional) Specifies the Cisco extension TLV versioning field:

1 RFC-ietf-mpls-lsp-ping-03 (initial)
2 RFC-ietf-mpls-lsp-ping-03 (rev 1)
3 RFC-ietf-mpls-lsp-ping-03 (rev 2)
4 RFC-ietf-mpls-lsp-ping-09 (initial)

source source-address

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

timeout timeoutt

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

ttl value

(Optional) Specifies the maximum number of hops (range is 1 to 255).

verbose

(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

fec-type

(Optional) Specifies FEC type to be used.

bgp: Use FEC type as BGP
generic: Use FEC type as generic
ldp: Use FEC type as LDP

Command Default

exp exp-bits : 0

reply mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

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.

For detailed configuration information about MPLS LSP trace operations, see System Monitoring Configuration Guide.

Task ID


Task ID	Operations
mpls-te	read, write
mpls-ldp	read, write

Examples

The following example shows how to trace a destination:

RP/0/RP0/CPU0:router# traceroute mpls ipv4 140.140.140.140/32 
destination 127.0.0.10 127.0.0.15 1


Tracing MPLS Label Switched Path to 140.140.140.140/32, timeout is 2
seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

Destination address 127.0.0.10

  0 196.100.1.41 MRU 4470 [Labels: 19 Exp: 0]
L 1 196.100.1.42 MRU 4470 [Labels: 86 Exp: 0] 360 ms
  2 196.100.1.50 MRU 4470 [Labels: implicit-null Exp: 0] 8 ms
! 3 196.100.1.18 9 ms

The following example shows how to trace a destination with FEC type specified as generic and verbose option:

RP/0/RP0/CPU0:router# traceroute mpls ipv4 11.11.11.11/32 fec-type generic output interface gigabitEthernet 0/0/0/3 
nexthop 172.40.103.2 verbose 


Tracing MPLS Label Switched Path to 11.11.11.11/32, timeout is 2 seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

  0 172.40.103.1 172.40.103.2 MRU 1500 [Labels: 16038 Exp: 0]
L 1 172.40.103.2 173.101.103.1 MRU 1500 [Labels: 16037 Exp: 0] 6 ms, ret code 8
L 2 173.101.103.1 11.101.11.11 MRU 1500 [Labels: implicit-null Exp: 0] 4 ms, ret code 8
! 3 11.101.11.11 6 ms, ret code 3

traceroute mpls multipath

To discover all possible paths of an LSP between the ingress and egress routers, use the traceroute mpls multipath command in XR EXEC mode.

traceroute mpls multipath ipv4 address/mask [destination start-address/ end-address address-increment] [exp exp-bits] [flags fec] [force-explicit-null] [hashkey ipv4 bitmap bit-size] [interval min-send-delay] [output {interface type interface-path-id [nexthop nexthop-address] | | [nexthop nexthop-address]}] [reply {dscp dscp-value | reply mode {ipv4 | router-alert}}] [retry-count count] [revision version] [source source-address] [timeout timeout] [ttl value] [verbose] [fec-type {bgp | generic | ldp}]

Syntax Description

ipv4

Specifies the destination type as a Label Distribution Protocol (LDP) IPv4 address.

address/mask

Address prefix of the target and number of bits in the target address network mask.

destination start-address end-address address -increment

(Optional) Specifies a network 127 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.

exp exp-bits

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

flags fec

(Optional) Specifies that forwarding equivalent class (FEC) stack checking is to be performed at transit routers.

force-explicit-null

(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.

hashkey ipv4 bitmap bit-size

(Optional) Allows user control of the hash key/multipath settings. Range is 0 to 256. The default is 32.

interval min-send-delay

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

output interface

(Optional) Specifies the output interface where echo request packets are sent.

type

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

interface-path-id

Physical interface or virtual interface.

Note

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

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

nexthop

(Optional) Specifies the IP address for the next hop.

nexthop-address

(Optional) IP address for the next hop.

reply dscp dscp-value

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

reply mode [ ipv4 | router-alert ]

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

ipv4: Reply with IPv4 UDP packet (this is the default)
router-alert: Reply with IPv4 UDP packet with router alert

retry-count count

(Optional) Specifies the number of retry attempts during multipath LSP traceroute. A retry is attempted if an outstanding echo request

times out waiting for the corresponding echo reply.
fails to find a valid destination address set to exercise a specific outgoing path. Range is 0 to 10. Default is 3.

revision version

(Optional) Specifies the Cisco extension TLV versioning field:

1 RFC-ietf-mpls-lsp-ping-03 (initial)
2 RFC-ietf-mpls-lsp-ping-03 (rev 1)
3 RFC-ietf-mpls-lsp-ping-03 (rev 2)
4 RFC-ietf-mpls-lsp-ping-09 (initial)

source source-address

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

timeout timeout

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

ttl value

(Optional) Specifies the maximum number of hops (range is 1 to 255).

verbose

(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

fec-type

(Optional) Specifies FEC type to be used.

bgp: Use FEC type as BGP
generic: Use FEC type as generic
ldp: Use FEC type as LDP

Command Default

exp exp-bits : 0

hashkey ipv4 bitmap bit-size : 4

interval min-send-delay : 0

reply mode : IPv4

retry-count : 3

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

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:


RP/0/RP0/CPU0:router# traceroute mpls multi ipv4 140.140.140.140/32 verbose 
force-explicit-null
  
  Starting LSP Path Discovery for 140.140.140.140/32
  
  Codes: '!' - success, 'Q' - request not sent, '.' - timeout, 
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch, 
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index, 
  'X' - unknown return code, 'x' - return code 0
  
  Type escape sequence to abort.
  
  LL!
  Path 0 found, 
  output interface POS0/2/0/3 source 196.100.1.61 destination 127.0.0.1 
  0 196.100.1.61 196.100.1.62 MRU 4470 [Labels: 18/explicit-null Exp: 0/0] multipaths 0
  L 1 196.100.1.62 196.100.1.10 MRU 4470 [Labels: 17/explicit-null Exp: 0/0] ret code 8 multipaths 1
  L 2 196.100.1.10 196.100.1.18 MRU 4470 [Labels: implicit-null/explicit-null Exp: 0/0] ret code 8 multipaths 1
  ! 3 196.100.1.1018, ret code 3 multipaths 0
  LL!
  Path 1 found, 
  output interface GigabitEthernet0/3/0/0 source 196.100.1.5 destination 127.0.0.1 
  0 196.100.1.5 196.100.1.37 6 MRU 1500 [Labels: 18/explicit-null Exp: 0/0] multipaths 0
  L 1 196.100.1.6 196.100.1.10 MRU 4470 [Labels: 17/explicit-null Exp: 0/0] ret code 8 multipaths 1
  L 2 10196.0100.21.5 1010 196.0100.21.10 18 MRU 4470 [Labels: implicit-null/explicit-null Exp: 0/0] ret code 8 multipaths 1
  ! 3 10196.0100.21.1018, ret code 3 multipaths 0
  
  Paths (found/broken/unexplored) (2/0/0) 
  Echo Request (sent/fail) (6/0) 
  Echo Reply (received/timeout) (6/0) 
  Total Time Elapsed 80 ms

The following example shows how to specify the FEC type as LDP with verbose option:


RP/0/RP0/CPU0:router#  traceroute mpls multipath ipv4 11.11.11.11/32 fec-type ldp output interface gigabitEthernet 0/0/0/3 
nexthop 172.40.103.2 verbose
  
Starting LSP Path Discovery for 11.11.11.11/32

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

LL!
Path 0 found, 
 output interface GigabitEthernet0/0/0/3 nexthop 172.40.103.2
 source 172.40.103.1 destination 127.0.0.0
  0 172.40.103.1 172.40.103.2 MRU 1500 [Labels: 16038 Exp: 0] multipaths 0
L 1 172.40.103.2 173.101.103.1 MRU 1500 [Labels: 16037 Exp: 0] ret code 8 multipaths 1
L 2 173.101.103.1 11.101.11.11 MRU 1500 [Labels: implicit-null Exp: 0] ret code 8 multipaths 1
! 3 11.101.11.11, ret code 3 multipaths 0

Paths (found/broken/unexplored) (1/0/0)
 Echo Request (sent/fail) (3/0)
 Echo Reply (received/timeout) (3/0)
 Total Time Elapsed 21 ms

traceroute mpls traffic-eng

To specify the destination type as an MPLS traffic engineering (TE) tunnel, use the traceroute mpls traffic-eng command in XR EXEC mode.

traceroute mpls traffic-eng tunnel tunnel-ID [destination start-address end-address address-increment increment-mask] [exp exp-bits] [flags fec] [force-explicit-null] [reply {dscp dscp-value | reply mode {ipv4 | router-alert}}] [revision version] [source source-address] [timeout timeout] [ttl value] [verbose]

Syntax Description


tunnel	Specifies the MPLS-TE tunnel type.
`tunnel-ID`	Tunnel interface.
destination `start-address` `end-address` `address -increment` `increment-mask`	(Optional) Specifies a network 127 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. `increment-mask` Incremental mask of the network address.
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
flags fec	(Optional) Specifies that forwarding equivalent class (FEC) stack checking is to be performed at transit routers.
force-explicit-null	(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.
reply dscp `dscp-value`	(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.
reply mode [ ipv4 \| router-alert ]	(Optional) Specifies the reply mode for the echo request packet. ipv4 Reply with IPv4 UDP packet (this is the default) router-alert Reply with IPv4 UDP packet with router alert
revision `version`	(Optional) Specifies the Cisco extension TLV versioning field: 1 RFC-ietf-mpls-lsp-ping-03 (initial) 2 RFC-ietf-mpls-lsp-ping-03 (rev 1) 3 RFC-ietf-mpls-lsp-ping-03 (rev 2) 4 RFC-ietf-mpls-lsp-ping-09 (initial)
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
timeout `timeout`	(Optional) Specifies the timeout interval, in seconds. Range is from 0 to 3600. Default is 2.
ttl `value`	(Optional) Specifies the maximum number of hops (range is 1 to 255).
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

reply mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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:


RP/0/RP0/CPU0:router#  traceroute mpls traffic-eng tunnel 13

Tracing MPLS TE Label Switched Path on tunnel-te13, timeout is 2 seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface,
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label,
  'P' - no rx intf label prot, 'p' - premature termination of LSP,
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

 0 0.0.0.0 11.0.0.1 MRU 1500 [Labels: 16003 Exp: 0] 
 L 1 192.168.200.2 192.168.170.1 MRU 1500 [Labels: implicit-null Exp: 0] 110 ms 
 ! 2 192.168.170.1 0.0.0.0 MRU 0 [No Label] 169 ms

traceroute pseudowire multisegment

To verify the Labeled Switch Path (LSP) for the multisegment pseudowire, use the traceroute pseudowire multisegment command in XR EXEC mode.

traceroute pseudowire multisegment address pw-id [exp exp-bits] [flags fec] [reply {dscp dscp-value | mode {ipv4 | no-reply | router-alert | control-channel} | pad-tlv}] [source source-address] [timeout timeout] [verbose]

Syntax Description


`address`	Address of the next S-PE.
`pw-id`	Pseudowire ID of the pseudowire segment to the next S-PE.
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
flags fec	(Optional) Specifies that forwarding equivalent class (FEC) stack checking is to be performed at transit routers.
reply dscp `dscp-value`	(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.
mode {ipv4 \| router-alert \| no-reply \| control-channel }	(Optional) Specifies the reply mode for the echo request packet. no-reply Do not reply ipv4 Reply with an IPv4 UDP packet (the default) router-alert Reply with an IPv4 UDP packet with the IP router alert set control-channel Force the use of a VCCV control channel. Reply using an application for a defined control channel. This applies only to pseudowires in which VCCV is used in the reply path. This is the default choice for pseudowire ping.
pad-tlv	(Optional) Indicates that a pad TLV should be included.
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
timeout `timeout`	(Optional) Specifies the timeout interval in seconds. Range is 0 to 3600. Default is 2 seconds.
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

reply-mode : ipv4

timeout timeout : 2 seconds

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID


Task ID	Operation
mpls-te	read
mpls-ldp	read

Examples

The following example shows that the next pseudowire segment and traceroute go through each hop in which each hop is a S-PE or remote T-PE. The local segment from T-PE1 is set to S-PE1 80.80.80.80 and the pseudowire ID is set to 100. The last pseudowire segment of the multisegment pseudowire is from S-PE1 80.80.80.80 to T-PE2 90.90.90.90 and the pseudowire ID is set to 300.


RP/0/RP0/CPU0:router#  traceroute pseudowire multisegment 80.80.80.80 100

Tracing MS-PW to 80.80.80.80 VC: 100, timeout is 2 seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

  0 1.2.1.2 MRU 1500 [Outgoing Labels: 20495 Exp: 0]
L 1 1.2.1.1 MRU 1500 [Outgoing Labels: 24587 Exp: 0] 13 ms
    local 70.70.70.70 remote 80.80.80.80 pw-id 100
! 2 1.4.1.1 9 ms
    local 80.80.80.80 remote 90.90.90.90 pw-id 300

traceroute mpls traffic-eng tunnel-te (P2P)

To specify the destination type as an MPLS traffic engineering (TE) tunnel for a point-to-point connection, use the traceroute mpls traffic-eng tunnel-te (P2P) command in XR EXEC mode.

traceroute mpls traffic-eng tunnel-te tunnel-ID [destination start-address end-address address-increment increment-mask] [exp exp-bits] [flags fec] [force-explicit-null] [reply {dscp dscp-value | mode {ipv4 | router-alert}}] [revision version] [source source-address] [timeout timeout] [ttl value] [verbose]

Syntax Description


tunnel-te	Specifies the MPLS-TE tunnel type.
`tunnel-ID`	Tunnel interface.
destination `start-address` `end-address` `address -increment` `increment-mask`	(Optional) Specifies a network 127 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. `increment-mask` Incremental mask of the network address.
exp `exp-bits`	(Optional) Specifies the MPLS experimental field value in the MPLS header for echo replies. Range is 0 to 7. Default is 0.
flags fec	(Optional) Specifies that forwarding equivalent class (FEC) stack checking is to be performed at transit routers.
force-explicit-null	(Optional) Forces an unsolicited explicit null label to be added to the MPLS label stack and allows LSP ping to be used to detect LSP breakages at the penultimate hop.
reply dscp `dscp-value`	(Optional) Specifies the differentiated service codepoint value for an MPLS echo reply.
reply-mode [ ipv4 \| router-alert ]	(Optional) Specifies the reply mode for the echo request packet. ipv4 Reply with IPv4 UDP packet (this is the default) router-alert Reply with IPv4 UDP packet with router alert
revision `version`	(Optional) Specifies the Cisco extension TLV versioning field: 1 RFC-ietf-mpls-lsp-ping-03 (initial) 2 RFC-ietf-mpls-lsp-ping-03 (rev 1) 3 RFC-ietf-mpls-lsp-ping-03 (rev 2) 4 RFC-ietf-mpls-lsp-ping-09 (initial)
source `source-address`	(Optional) Specifies the source address used in the echo request packet.
timeout `timeout`	(Optional) Specifies the timeout interval, in seconds. Range is from 0 to 3600. Default is 2.
ttl `value`	(Optional) Specifies the maximum number of hops (range is 1 to 255).
verbose	(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

reply-mode : IPv4

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

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:


RP/0/RP0/CPU0:router#  traceroute mpls traffic-eng tunnel-te 13

Tracing MPLS TE Label Switched Path on tunnel-te13, timeout is 2 seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface,
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label,
  'P' - no rx intf label prot, 'p' - premature termination of LSP,
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

 0 0.0.0.0 11.0.0.1 MRU 1500 [Labels: 16003 Exp: 0] 
 L 1 192.168.200.2 192.168.170.1 MRU 1500 [Labels: implicit-null Exp: 0] 110 ms 
 ! 2 192.168.170.1 0.0.0.0 MRU 0 [No Label] 169 ms

traceroute mpls traffic-eng tunnel-tp

To learn the routes that packets follow when traveling to their destination, use the traceroute mpls traffic-eng tunnel-tp command in XR EXEC mode.

traceroute mpls traffic-eng tunnel-tp tunnel-id [ddmap] [destination start-address end-address increment] [ encap {cv-ip | cv-non-ip | ip}] [exp exp-bits] [flags {fec | reverse-verification }] [ lsp {active | protect | working}] [reply {dscp dscp-value | mode {control-channel | no-reply } | pad-tlv}] [source source-address] [timeout timeout] [ttl value] [verbose]

Syntax Description

tunnel-tp tunnel-ID

Specifies the destination type as an MPLS Transport Profile (MPLS-TP) 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 (DDMAP) TLV should be included in the LSP echo request.

destination start-address end-address increment

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: Start of the ending network address.
address increment: Incremental value of the network address, which is expressed as a decimal number value or IP address.

encap { cv-ip | cv-non-ip | ip }

(Optional) Specifies the MPLS-TP encapsulation type to use.

cv-ip: Use IP encapsulation with GACH channel 0x0021.

cv-non-ip: Use non-IP encapsulation with GACH channel 0x0025.

ip: Use IP encapsulation.

exp exp-bits

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

flags { fec | reverse-verification }

(Optional) Specifies the flag options to use.

fec: Request forwarding equivalent class (FEC) stack checking is to be performed at transit routers.

reverse-verification: Request reverse path connectivity verification.

lsp { active | protect | working }

(Optional) Specifies the LSP to use.

active: Active MPLS-TP tunnel.

protect: Protect MPLS-TP tunnel.

working

Working MPLS-TP tunnel.

Note

Use this option to identify error in the LSP path if the MPLS-TP tunnel is not up.

reply dscp dscp-value

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

mode [control-channel ]

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

control-channel: Send reply via a control channel.

source source-address

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

timeout timeout

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

ttl value

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

verbose

(Optional) Enables verbose output information, including MPLS echo reply, sender address of the packet, and return codes.

Command Default

exp exp-bits : 0

timeout timeout : 2

Command Modes

XR EXEC mode

Command History


Release	Modification
Release 6.0	This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID


Task ID	Operation
mpls-te	read, write
mpls-ldp	read, write

Examples

The following sample output is from the traceroute mpls traffic-eng tunnel-tp command using the non-IP-ACH encapsulation:


RP/0/RP0/CPU0:router# traceroute mpls traffic-eng tunnel-tp 1 encap cv-non-ip

Tracing MPLS TP Label Switched Path on tunnel-tp1, timeout is 2 seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

  0 Node ID 10.10.10.1, Global ID 0 MRU 1500 [Labels: 1000 Exp: 0]
L 1 Node ID 10.10.10.2, Global ID 0 MRU 1500 [Labels: 1100 Exp: 0] 3 ms
! 2 Node ID 12.12.12.3, Global ID 0 4 ms

The following sample output is from the traceroute mpls traffic-eng tunnel-tp command using the non-IP-ACH encapsulation and verbose option:


RP/0/RP0/CPU0:router# traceroute mpls traffic-eng tunnel-tp 1 encap cv-non-ip

Tracing MPLS TP Label Switched Path on tunnel-tp1, timeout is 2 seconds

Codes: '!' - success, 'Q' - request not sent, '.' - timeout,
  'L' - labeled output interface, 'B' - unlabeled output interface, 
  'D' - DS Map mismatch, 'F' - no FEC mapping, 'f' - FEC mismatch,
  'M' - malformed request, 'm' - unsupported tlvs, 'N' - no rx label, 
  'P' - no rx intf label prot, 'p' - premature termination of LSP, 
  'R' - transit router, 'I' - unknown upstream index,
  'X' - unknown return code, 'x' - return code 0

Type escape sequence to abort.

  0 Node ID 10.10.10.1, Global ID 0 MRU 1500 [Labels: 1000 Exp: 0]
    Ingress Link ID 0, Egress Link ID 1
L 1 Node ID 10.10.10.2, Global ID 0 MRU 1500 [Labels: 1100 Exp: 0] 3 ms
    Ingress Link ID 2, Egress Link ID 3
! 2 Node ID 12.12.12.3, Global ID 0 4 ms

Bias-Free Language

Results

Chapter: MPLS OAM Commands

MPLS OAM Commands

clear mpls oam counters

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

echo disable-vendor-extension

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

echo revision

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

mpls oam

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

ping mpls ipv4

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

ping mpls traffic-eng

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

ping mpls traffic-eng tunnel-tp

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

ping pseudowire (AToM)

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

Examples

ping mpls traffic-eng tunnel-te (P2P)

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Task ID

ping pseudowire multisegment

Syntax Description

Command Default

Command Modes