Cisco IOS XR MPLS Debug Command Reference, Release 3.6
MPLS OAM Debug Commands on Cisco IOS XR software

Table Of Contents

MPLS OAM Debug Commands on Cisco IOS XR Software

debug mpls oam api

debug mpls oam config

debug mpls oam database

debug mpls oam edm

debug mpls oam errors

debug mpls oam event

debug mpls oam extra-detail

debug mpls oam fsm

debug mpls oam handle

debug mpls oam hash-agent

debug mpls oam im

debug mpls oam lib

debug mpls oam multipath

debug mpls oam packet

debug mpls oam path-discovery

debug mpls oam process

debug mpls oam rib

debug mpls oam tlv

debug mpls oam workt


MPLS OAM Debug Commands on Cisco IOS XR Software


This chapter describes the commands used to debug MPLS OAM on Cisco IOS XR software.

For more information about MPLS OAM configuration, clear, and show commands, see
MPLS OAM Commands on Cisco IOS XR Software.

debug mpls oam api

To debug client API events, use the debug mpls oam api command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam api

no debug mpls oam api

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for client API events:

RP/0/RP0/CPU0:router# debug mpls oam api

debug mpls oam config

To debug OAM configuration events, use the debug mpls oam config command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam api

no debug mpls oam api

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for OAM configuraiton events:

RP/0/RP0/CPU0:router# debug mpls oam config

debug mpls oam database

To debug OAM database events, use the debug mpls oam database command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam database

no debug mpls oam database

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for OAM database events:

RP/0/RP0/CPU0:router# debug mpls oam database

debug mpls oam edm

To debug external data manager (EDM) events, use the debug mpls oam edm command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam edm

no debug mpls oam edm

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

The debug mpls oam edm commands command is associated with all MPLS OAM show and clear commands.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for EDM events:

RP/0/RP0/CPU0:router# debug mpls oam edm

debug mpls oam errors

To debug a variety of OAM debug errors, use the debug mpls oam errors command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam errors [api | config | database | edm | fsm | handle | hash-agent | im | multipath | packet | path-discovery | process | rib | tlv]

no debug mpls oam errors [api | config | database | edm | fsm | handle | hash-agent | im | multipath | packet | path-discovery | process | rib | tlv]

Syntax Description

api

Displays OAM client API errors.

config

Displays configuring errors.

database

Displays OAM database errors.

edm

Displays OAM EDM errors.

fsm

Displays OAM FSM errors.

handle

Displays OAM handle errors.

hash-agent

Displays OAM hash agent errors.

im

Displays OAM IM errors.

multipath

Displays OAM multipath errors.

packet

Displays OAM packet errors.

path-discovery

Displays OAM traceroute path discovery errors.

process

Displays OAM process and SysDB errors.

rib

Displays OAM RIB errors.

tlv

Displays OAM TLV errors.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for OAM client API errors:

RP/0/RP0/CPU0:router# debug mpls oam errors

debug mpls oam event

To debug general OAM events, use the debug mpls oam event command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam event

no debug mpls oam event

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for general OAM events:

RP/0/RP0/CPU0:router# debug mpls oam event

debug mpls oam extra-detail

To debug extra details in debug messages, use the debug mpls oam extra-detail command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam extra-detail

no debug mpls oam extra-detail

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable extra detail in certain debug messages:

RP/0/RP0/CPU0:router# debug mpls oam a

debug mpls oam fsm

To debug a finite state machine, use the debug mpls oam fsm command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam fsm

no debug mpls oam fsm

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for FSM events:

RP/0/RP0/CPU0:router# debug mpls oam fsm

debug mpls oam handle

To debug handle events, use the debug mpls oam handle command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam handle

no debug mpls oam handle

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Handles are internal indexes allocated to track data structures.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for handle events:

RP/0/RP0/CPU0:router# debug mpls oam handle

debug mpls oam hash-agent

To debug hash agent events, use the debug mpls oam hash-agent command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam hash-agent location node-id

no debug mpls oam hash-agent

Syntax Description

location node-id

Displays hardware resource counters on the designated node. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for hash-agent events on a specified node:

RP/0/RP0/CPU0:router# debug mpls oam hash-agent location 0/1/CPU0

debug mpls oam im

To debug IM events, use the debug mpls oam im command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam api im

no debug mpls oam api im

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for IM events:

RP/0/RP0/CPU0:router# debug mpls oam im

debug mpls oam lib

To debug the OAM client library, use the debug mpls oam lib errors command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam lib [errors]

no debug mpls oam lib [errors]

Syntax Description

errors

(Optional) Displays OAM client library errors.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging an OAM client library:

RP/0/RP0/CPU0:router# debug mpls oam lib

debug mpls oam multipath

To debug multipath events, use the debug mpls oam multipath command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam multipath

no debug mpls oam multipath

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for multipath events:

RP/0/RP0/CPU0:router# debug mpls oam multipath

debug mpls oam packet

To enable OAM packet debugging, use the debug mpls oam packet command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam packet

no debug mpls oam packet

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable OAM packet debugging:

RP/0/RP0/CPU0:router# debug mpls oam packet

debug mpls oam path-discovery

To debug traceroute path-discovery events, use the debug mpls oam path-discovery command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam path-discovery

no debug mpls oam path-discovery

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to debug traceroute path-discovery events:

RP/0/RP0/CPU0:router# debug mpls oam path-discovery

debug mpls oam process

To debug process and SysDB events, use the debug mpls oam process command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam process

no debug mpls oam process

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for process and SysDB events:

RP/0/RP0/CPU0:router# debug mpls oam process

debug mpls oam rib

To debug OAM routing information base (RIB) events, use the debug mpls oam rib command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam rib

no debug mpls oam rib

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for process and SysDB events:

RP/0/RP0/CPU0:router# debug mpls oam rib

debug mpls oam tlv

To debug type length and value events, use the debug mpls oam tlv command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam tlv

no debug mpls oam tlv

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for OAM TLV events:

RP/0/RP0/CPU0:router# debug mpls oam tlv

debug mpls oam workt

To debug OAM work thread events, use the debug mpls oam workt command in EXEC mode. To disable debugging output, use the no form of this command.

debug mpls oam workt

no debug mpls oam workt

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco CRS-1 and
Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.5.0

No modification.

Release 3.6.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, refer to the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

Debugging output is assigned high priority in the CPU process and, therefore, can affect system performance. For more information about the impact on system performance when using debug commands, refer to Using Debug Commands on Cisco IOS XR Software.

Task ID

Task ID
Operations

mpls-te

read

mpls-ldp

read

mpls-static

read


Examples

The following example shows how to enable debugging output for work thread events:

RP/0/RP0/CPU0:router# debug mpls oam workt