Cisco IOS XR System Management Debug Command Reference, Release 3.5
Software Package Management Debug Commands on Cisco IOS XR Software

Table Of Contents

Software Package Management Debug Commands on Cisco IOS XR Software

debug install id

debug install ih

debug install instcmd

debug install inventory

debug install ior

debug install loadpath

debug install notify

debug install platform

debug install replicator

debug install sds

debug install state-file-replication

debug install vs


Software Package Management Debug Commands on Cisco IOS XR Software


This chapter describes the commands used to debug software package management on Cisco IOS XR software.


Caution Because debugging output is assigned high priority in the CPU process, it can render the system unusable. For this reason, use debug commands only to troubleshoot specific problems or during troubleshooting sessions with Cisco technical support staff. Moreover, it is best to use debug commands during periods of lower network traffic and fewer users. Debugging during these periods decreases the likelihood that increased debug command processing overhead will affect system use.

debug install id

To enable the display of the debug messages for the installation director, use the debug install id command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install id [chkpt | compatibility {checks | errors | parser} | config | db | ens | events | install] location node-id

no debug install id [chkpt | compatibility {checks | errors | parser} | config | db | ens | events | install] location node-id

Syntax Description

chkpt

Displays checkpoint operations.

compatibility

Displays installation package compatibility operations.

checks

Displays installation package compatibility checking messages.

errors

Displays installation package compatibility error messages.

parser

Displays installation package compatibility parser operations messages.

config

Displays configuration operations messages.

db

Displays database operations messages.

ens

Displays ENS operations message.

events

Displays received events messages.

install

Displays installation operation messages.

location node-id

Displays debug messages for the installation director for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable installation director debugging:

RP/0/RP0/CPU0:router(admin)# debug install id location 0/RP0/CPU0

debug install ih

To enable the display of the debug messages for the installation helper, use the debug install ih command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install ih [clean | ens | sync | sysdb] [location node-id]

no debug install ih [clean | ens | sync | sysdb] [location node-id]

Syntax Description

clean

(Optional) Displays debug messages for the install helper cleaning code.

ens

(Optional) Displays debug messages for the install helper ens code.

sync

(Optional) Displays debug messages for the install helper sync code.

sysdb

(Optional) Displays debug messages for the install helper system database code.

location node-id

(Optional) Displays debug messages for the install helper for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable installation helper debugging:

RP/0/RP0/CPU0:router(admin)# debug install ih location 0/RP0/CPU0

debug install instcmd

To enable the display of the debug messages for executable installation commands, use the debug install instcmd command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install instcmd [location node-id]

no debug install instcmd [location node-id]

Syntax Description

location node-id

(Optional) Displays debug messages for executable installation commands for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable executable installation commands debugging:

RP/0/RP0/CPU0:router(admin)# debug install instcmd location 0/RP0/CPU0

debug install inventory

To enable the display of the debug messages for the installed inventory commands, use the debug install inventory command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install inventory [process process-name | job jobid] [location node-id]

no debug install inventory [process process-name | job jobid] [location node-id]

Syntax Description

process process-name

(Optional) Displays debug messages for the installed inventory commands for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for the installed inventory commands for a specific job identifier. Job identifier. Range is 0 to 4294967295.

location node-id

(Optional) Displays debug messages for the installed inventory commands for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable installed inventory commands debugging:

RP/0/RP0/CPU0:router(admin)# debug install inventory location 0/RP0/CPU0

debug install ior

To enable the display of the debug messages for the Install Operation Request library commands, use the debug install ior command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install ior [process process-name | job jobid] [location node-id]

no debug install ior [process process-name | job jobid] [location node-id]

Syntax Description

process process-name

(Optional) Displays debug messages for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for a specific job identifier. Job identifier. Range is 0 to 4294967295.

location node-id

(Optional) Displays debug messages for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable installed inventory commands debugging:

RP/0/RP0/CPU0:router(admin)# debug install ior location 0/RP0/CPU0

debug install loadpath

To enable the display of the debug messages for loadpath library, use the debug install loadpath command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install loadpath [process process-name | job jobid] [location node-id]

no debug install loadpath [process process-name | job jobid] [location node-id]

Syntax Description

process process-name

(Optional) Displays debug messages for a loadpath library for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for a loadpath library for a specific job identifier. Job identifier. Range is 0 to 4294967295.

location node-id

(Optional) Displays debug messages for a loadpath library for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable loadpath library debugging:

RP/0/RP0/CPU0:router(admin)# debug install loadpath location 0/RP0/CPU0

debug install notify

To enable the display of the debug notification messages, use the debug install notify command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install notify [blobs | callbacks | dx | lists test | notifications | payload | transid] [process process-name | job jobid] [location node-id]

no debug install notify [callbacks | dx | lists test | notifications | payload | transid] [process process-name | job jobid] [location node-id]

Syntax Description

blobs

(Optional) Installs blobbification and deblobbification routines.

callbacks

(Optional) Installs the callback routines.

dx

(Optional) Installs the data exchange routines.

lists test

(Optional) Displays the messages for the installation list management code.

notifications

(Optional) Installs the notification routines.

payload

(Optional) Installs the payload routines.

transid

(Optional) Installs the transaction ID routines.

process process-name

(Optional) Displays debug notification messages for a specific process. Process name or PID.

job jobid

(Optional) Displays debug notification messages for a specific job identifier. Job identifier. Range is 0 to 4294967295.

location node-id

(Optional) Displays debug notification messages for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable notification messages:

RP/0/RP0/CPU0:router(admin)# debug install notify location 0/RP0/CPU0

debug install platform

To enable the display of the debug messages for the install platform libraries, use the debug install platform command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install platform [process process-name | job jobid] [location node-id]

no debug install platform [process process-name | job jobid] [location node-id]

Syntax Description

process process-name

(Optional) Displays debug messages for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for a specific job identifier. Job identifier. Range is 0 to 4294967295.

location node-id

(Optional) Displays debug messages for a specified location. The node-id argument is entered in the rack/slot/module notation.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable installed inventory commands debugging:

RP/0/RP0/CPU0:router(admin)# debug install platform location 0/RP0/CPU0

debug install replicator

To enable the display of the debug messages for the installation replicator code, use the debug install replicator command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install replicator [process process-name | job jobid] [location node-id]

no debug install replicator [process process-name | job jobid] [location node-id]

Syntax Description

location node-id

(Optional) Displays debug messages for installation replicator code for a specified location. The node-id argument is entered in the rack/slot/module notation.

process process-name

(Optional) Displays debug messages for installation replicator code for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for installation replicator code for a specific job identifier. Job identifier. Range is 0 to 4294967295.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 2.0

This command was introduced on the Cisco CRS-1.

Release 3.0

No modification.

Release 3.2

This command was supported on the Cisco XR 12000 Series Router.

Release 3.3.0

This command was moved from EXEC mode to administration EXEC mode.

Release 3.4.0

This command was supported in EXEC mode.

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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable installation replicator code debugging:

RP/0/RP0/CPU0:router(admin)# debug install replicator location 0/RP0/CPU0

debug install sds

To enable the display of the debug messages for the software download server, use the debug install sds command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install sds [process process-name | job jobid] [location node-id]

no debug install sds [process process-name | job jobid] [location node-id]

Syntax Description

location node-id

(Optional) Displays debug messages for the software download server for a specified location. The node-id argument is entered in the rack/slot/module notation.

process process-name

(Optional) Displays debug messages for the software download server for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for the software download server for a specific job identifier. Job identifier. Range is 0 to 4294967295.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 3.5.0

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


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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable software download server debugging:

RP/0/RP0/CPU0:router(admin)# debug install sds location 0/RP0/CPU0

debug install state-file-replication

To enable the display of the debug messages for the replication of install-specific state files, use the debug install state-file-replication command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install state-file-replication [process process-name | job jobid] [location node-id]

no debug install state-file-replication [process process-name | job jobid] [location node-id]

Syntax Description

location node-id

(Optional) Displays debug messages for a specified location. The node-id argument is entered in the rack/slot/module notation.

process process-name

(Optional) Displays debug messages for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for a specific job identifier. Job identifier. Range is 0 to 4294967295.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 3.5.0

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


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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable state file debugging:

RP/0/RP0/CPU0:router(admin)# debug install state-file-replication location 0/RP0/CPU0

debug install vs

To enable the display of the debug messages for the version server, use the debug install vs command in EXEC or administration EXEC mode. To disable the display of debug messages, use the no form of this command.

debug install vs [process process-name | job jobid] [location node-id]

no debug install vs [process process-name | job jobid] [location node-id]

Syntax Description

location node-id

(Optional) Displays debug messages for a specified location. The node-id argument is entered in the rack/slot/module notation.

process process-name

(Optional) Displays debug messages for a specific process. Process name or PID.

job jobid

(Optional) Displays debug messages for a specific job identifier. Job identifier. Range is 0 to 4294967295.


Defaults

No default behavior or values

Command Modes

EXEC
Administration EXEC

Command History

Release
Modification

Release 3.5.0

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


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, see 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

pkg-mgmt

read


Examples

The following example shows how to enable version server debugging:

RP/0/RP0/CPU0:router(admin)# debug install vs location 0/RP0/CPU0