clear context

To clear core dump context information, use the clearcontext command in administration EXEC mode or in EXEC mode.

clearcontextlocation
{ node-id | all }

Syntax Description

location{node-id | all}

(Optional) Clears core dump context information for a specified node. The node-id argument is expressed in the rack/slot/module notation. Use the all keyword to indicate all nodes.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the clearcontext command to clear core dump context information. If you do not specify a node with the locationnode-id keyword and argument, this command clears core dump context information for all nodes.

Use the showcontext command to display core dump context information.

Task ID

Task ID

Operations

diag

execute

Examples

The following example shows how to clear core dump context information:

dumpcore

To manually generate a core dump, use the dumpcore command in administration EXEC mode or in EXEC mode.

dumpcore
{ running | suspended }
job-idlocationnode-id

Syntax Description

running

Generates a core dump for a running process.

suspended

Suspends a process, generates a core dump for the process, and resumes the process.

job-id

Process instance identifier.

locationnode-id

Generates a core dump for a process running on the specified node. The node-id argument is expressed in the rack/slot/module notation.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When a process crashes on the Cisco IOS XR software, a core dump file of the event is written to a designated destination without bringing down the router. Upon receiving notification that a process has terminated abnormally, the Cisco IOS XR software then respawns the crashed process. Core dump files are used by Cisco Technical Support Center engineers and development engineers to debug the Cisco IOS XR software.

Core dumps can be generated manually for a process, even when a process has not crashed. Two modes exist to generate a core dump manually:

running—Generates a core dump for a running process. This mode can be used to generate a core dump on a critical process (a process whose suspension could have a negative impact on the performance of the router) because the core dump file is generated independently, that is, the process continues to run as the core dump file is being generated.

suspended—Suspends a process, generates a core dump for the process, and resumes the process. Whenever the process is suspended, this mode ensures data consistency in the core dump file.

Core dump files contain the following information about a crashed process:

Register information

Thread status information

Process status information

Selected memory segments

Task ID

Task ID

Operations

diag

read, write

Examples

The following example shows how to generate a core dump in suspended mode for the process instance 52:

Syntax Description

choicepreference

(Optional) Configures the order of preference for the destination of core dump files. Up to the three destinations can be defined. Valid values are 1 to 3.

compress {on | off}

(Optional) Specifies whether or not the core dump file should be sent compressed. By default, core dump files are sent compressed. If you specify the compress keyword, you must specify one of the following required keywords:

on—Compresses the core dump file before sending it.

off—Does not compress the core dump file before sending it.

filenamefilenamelower-limit-higher-limit

(Optional) Specifies the filename to be appended to core dump files and the lower and higher limit range of core dump files to be sent to a specified destination before being recycled by the circular buffer.

See Table 1 for a description of the default core dump file naming convention.

Valid values for the lower-limit argument are 0 to 4. Valid values for the higher-limit argument are 5 to 64. A hyphen (-) must immediately follow the lower-limit argument.

Note

To uniquely identify each core dump file, a value is appended to each core dump file, beginning with the lower limit value configured for the lower-limit argument and continuing until the higher limit value configured for the higher-limit argument has been reached. After the higher limit value has been reached, the Cisco IOS XR software begins to recycle the values appended to core dump files, beginning with the lower limit value.

filepath

Local file system or network protocol, followed by the directory path. All local file systems are supported. The following network protocols are supported: TFTP and FTP.

Command Default

If you do not specify the order of preference for the destination of core dump files using the choicepreference keyword and argument, the default preference is the primary location or 1.

Core dump files are sent compressed.

The default file naming convention used for core dump files is described in Table 1.

Command Modes

Administration configuration

Global configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the exception filepath command to modify core dump settings, such as the destination file path to store core dump files, file compression, and the filename appended to core dumps.

Up to three user-defined locations may be configured as the preferred destinations for core dump files:

Primary location—The primary destination for core dump files. Enter the choice keyword and a value of 1 (that is, choice1) for the preference argument to specify a destination as the primary location for core dump files.

Secondary location—The secondary fallback choice for the destination for core dump files, if the primary location is unavailable (for example, if the hard disk is set as the primary location and the hard disk fails). Enter the choice keyword and a value of 2 (that is, choice2) for the preference argument to specify a destination as the secondary location for core dump files.

Tertiary location—The tertiary fallback choice as the destination for core dump files, if the primary and secondary locations fail. Enter the choice keyword and a value of 3 (that is, choice3) for the preference argument to specify a destination as the tertiary location for core dump files.

When specifying a destination for a core dump file, you can specify an absolute file path on a local file system or on a network server. The following network protocols are supported: TFTP and FTP.

Note

We recommend that you specify a location on the hard disk as the primary location.

In addition to the three preferred destinations that can be configured, Cisco IOS XR software provides three default fallback destinations for core dump files in the event that user-defined locations are unavailable.

The default fallback destinations are:

harddisk:/dumper

disk1:/dumper

disk0:/dumper

Note

If a default destination is a boot device, the core dump file is not sent to that destination.

We recommend that you configure at least one preferred destination for core dump files as a preventive measure if the default fallback paths are unavailable. Configuring at least one preferred destination also ensures that core dump files are archived because the default fallback destinations store only the first and last core dump files for a crashed process.

Note

Cisco IOS XR software does not save a core file on a local storage device if the size of the core dump file creates a low-memory condition.

By default, Cisco IOS XR software assigns filenames to core dump files according to the following format:

If the core dump was generated because of a request by a process (requester), the core filename contains the string “.by.requester” where the requester variable is the name or process ID (PID) of the process that requested the core dump. If the core dump was due to a self-generated abort call request, the core filename contains the string “.abort” instead of the name of the requester.

.sparse

If a sparse core dump was generated instead of a full core dump, “sparse” appears in the core dump filename.

.date-time

Date and time the dumper process was called by the process manager to generate the core dump. The .date-time time-stamp variable is expressed in the yyyy.mm.dd-hh.mm.ss format. Including the time stamp in the filename uniquely identifies the core dump filename.

.node

Node ID, expressed in the rack/slot/module notation, where the process that generated the core dump was running.

.processor-type

Type of processor (mips or ppc).

.Z

If the core dump was sent compressed, the filename contains the .Z suffix.

You can modify the default naming convention by specifying a filename to be appended to core dump files with the optional filenamefilename keyword and argument and by specifying a lower and higher limit ranges of values to be appended to core dump filenames with the lower-limit and higher-limit arguments, respectively. The filename that you specify for the filename argument is appended to the core dump file and the lower and higher limit ranges of core dump files to be sent to a specified destination before the filenames are recycled. Valid values for the lower-limit argument are 0 to 4. Valid values for the higher-limit argument are 5 to 64. A hyphen (-) must immediately follow the lower-limit argument. In addition, to uniquely identify each core dump file, a value is appended to each core dump file, beginning with the lower-limit value specified with the lower-limit argument and continuing until the higher-limit value specified with the higher-limit argument has been reached. When the configured higher-limit value has been reached, Cisco IOS XR software begins to recycle the values appended to core dump files, beginning with the lower-limit value.

Task ID

Task ID

Operations

diag

read, write

Examples

The following example shows how to configure the core dump setting for the primary user-defined preferred location. In this example, core files are configured to be sent uncompressed; the filename of core dump files is set to “core” (that is, all core filenames will be named core); the range value is set from 0 to 5 (that is, the values 0 to 5 are appended to the filename for the first five generated core dump files, respectively, before being recycled); and the destination is set to a directory on the hard disk.

exception pakmem

To configure the collection of packet memory information in core dump files, use the exceptionpakmem command in administration configuration mode or in global configuration mode. To remove the configuration, use the no form of this command.

Command Default

Command Modes

Administration configuration

Global configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the exceptionpakmem command with the on keyword to configure the collection of packet memory information in core dump files. Cisco Technical Support Center engineers and development engineers use packet memory information to debug packet memory issues related to a process.

Caution

Including packet memory information in core dump files significantly increases the amount of data generated in the core dump file, which may delay the restart time for the process.

Task ID

Task ID

Operations

diag

read, write

Examples

The following example shows how to configure core dumps to include packet memory information:

exception sparse

To enable or disable sparse core dumps, use the exceptionsparse command in administration configuration mode or in global configuration mode. To remove the configuration, use the no form of this command.

exceptionsparse
{ on | off }

noexceptionsparse

Syntax Description

on

Enables sparse core dumps.

off

Disables sparse core dumps

Command Default

Sparse core dumps are disabled.

Command Modes

Administration configuration

Global configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the exceptionsparse command to reduce the amount of data generated in the core dump file. Sparse core dumps reduce the amount of time required to generate the core dump file because only referenced data is generated in the core file (at the cost of lost information in the core file). Reducing the time required to generate core dump files corresponds to faster process restart times.

Sparse core dumps contain the following information about crashed processes:

Register information for all threads, and any memory pages referenced in these register values

Stack information for all threads, and any memory pages referenced in these threads

All memory pages referenced by a loaded dynamic loadable library (DLL) data section, if the final program counter falls in a DLL data section

Any user-specified marker pages from the lib_dumper_marker DLL

The exceptionsparse command dumps memory pages based on trigger addresses found in the previously listed dump information, according to the following criteria:

If the trigger address in the memory page is in the beginning 128 bytes of the memory page, the previous memory page in the continuous address region is dumped also.

If the trigger address in the memory page is in the final 128 bytes of the memory page, the next memory page in the continuous address region is dumped also.

In all other instances, only the memory page that includes the trigger address is dumped.

Note

Use the exception sparse off command in administration configuration mode to get a complete coredump of the transient processes on the RP.

exception sprsize

To specify the maximum file size for core dumps, use the exceptionsprsize command in administration configuration mode or in global configuration mode. To remove the configuration, use the no form of this command.

exceptionsprsizemegabytes

noexceptionsprsize

Syntax Description

megabytes

Size in megabytes (MB).

Command Default

megabytes: 192

Command Modes

Administration configuration

Global configuration

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the exceptionsprsize command to specify the maximum file size for core dumps. The maximum file size configured for the megabytes argument is used with the configuration set for the exception sparse command to determine whether or not to generate a sparse core dump file. If sparse core dumps are disabled and a core dump file is predicted to exceed the default value (192 MB) uncompressed or the value specified for the megabytes argument uncompressed, a sparse core dump file is generated. If sparse core dumps are enabled, a sparse core dump file is generated, regardless of the size of the core dump file.

Task ID

Task ID

Operations

diag

read, write

Examples

The following example shows how to set the file size of sparse core dumps to 300 MB:

Command Default

Entering the follow command without any optional keywords or arguments performs the operation for five iterations from the local node with a delay of 5 seconds between each iteration. The output includes information about all live threads. This command uses the default scheduling priority from where the command is being run.

Command Modes

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use this command to unintrusively debug a live process or a live thread in a process. This command is particularly useful for debugging deadlock and livelock conditions, for examining the contents of a memory location or a variable in a process to determine the cause of a corruption issue, or in investigating issues where a thread is stuck spinning in a loop. A livelock condition is one that occurs when two or more processes continually change their state in response to changes in the other processes.

The following actions can be specified with this command:

Follow all live threads of a given process or a given thread of a process and print stack trace in a format similar to core dump output.

Follow a process in a loop for a given number of iterations.

Set a delay between two iterations while invoking the command.

Set the priority at which this process should run while this command is being run.

Dump memory from a given virtual memory location for a given size.

Display register values and status information of the target process.

Take a snapshot of the execution path of a thread asynchronously to investigate performance-related issues by specifying a high number of iterations with a zero delay.

Task ID

Task ID

Operations

basic-services

read

Examples

The following example shows how to use the follow command to debug the process associated with job ID 257 for one iteration:

monitor processes

To display auto-updating statistics on processes in a full-screen mode, use the monitor processes command in administration EXEC mode or in EXEC mode.

monitorprocesses [dumbtty]
[ locationnode-id ]

Syntax Description

dumbtty

(Optional) Displays the output of the command as if on a dumb terminal (the screen is not refreshed).

locationnode-id

(Optional) Displays the output of the command from the designated node. The node-id argument is entered in the rack/slot/module notation.

Command Default

If you omit all keywords, the monitor processes command displays the top 10 processes of CPU usage for the local node, sorted in descending order by the time used. The display is cleared and updated every 5 seconds until you quit the command by pressing the q key.

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the monitor processes command to display the top ten processes based on CPU usage. The display refreshes every 10 seconds.

To change the parameters displayed by the monitor processes command, enter one of the interactive commands described in Table 1.

To terminate the display and return to the system prompt, enter the q key.

To list the interactive commands, type ? during the display.

Table 2 Interactive Commands Available for the monitor processes Command

Command

Description

?

Displays the available interactive commands.

c

Sorts display by number of open channels.

d

Changes the delay interval between updates.

f

Sorts display by number of open files.

k

Kills a process.

l

Refreshes the screen.

m

Sorts display by memory used.

n

Changes the number of processes to be displayed.

q

Quits the interactive display and returns the prompt to EXEC mode.

t

Sorts display by time (default).

Task ID

Task ID

Operations

basic-services

execute

Examples

The following example shows sample output from the monitor processes command:

Examples

When the n or d interactive command is used, the monitor processes command prompts you to enter a number. For example, when the interactive command n is entered, the prompt responds as shown in the following example:

monitor threads

To display auto-updating statistics on threads in a full-screen mode, use the monitor threads command in administration EXEC mode or in EXEC mode.

monitorthreads [dumbtty]
[ iterationnumber ]
[ locationnode-id ]

Syntax Description

dumbtty

(Optional) Displays the output of the command as if on a dumb terminal (the screen is not refreshed).

iterationnumber

(Optional) Number of times the statistics display is to be updated, in the range from 0 to 4294967295.

locationnode-id

(Optional) Displays the output from the command from the designated node. The node-id argument is entered in the rack/slot/module notation.

Command Default

When all keywords are omitted, the monitor threads command displays the first ten threads for the local node, sorted in descending order by the time used. The display is cleared and updated every 5 seconds until you quit the command.

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the monitor threads command to show the top ten threads based on CPU usage. The display refreshes every 10 seconds.

To change the parameters displayed by the monitor threads command, enter one of the key commands described in Table 1.

To terminate the display and return to the system prompt, enter the q key.

Examples

When the n or d interactive command is used, the monitor threads command prompts for a number appropriate to the specific interactive command. The following example shows sample output from the monitor threads command using the interactive n command after the first display cycle to change the number of threads:

process

Syntax Description

crash

Crashes a process.

restart

Restarts a process.

shutdown

Stops a process. The process is not restarted (even if considered “mandatory�?).

start

Starts a process.

executable-name

Executable name of the process to be started, terminated, or restarted. Supplying an executable name for the executable-name argument performs the action for all the simultaneously running instances of the process, if applicable.

job-id

Job ID of the process instance to be started, terminated, or restarted. Supplying a job ID for the job-id argument performs the action for only the process instance associated with the job ID.

location { node-id | all}

Starts, terminates, or restarts a process on the designated node. The node-id argument is entered in the rack/slot/module notation. The all keyword specifies all nodes.

Command Default

No default behavior or values

Command Modes

Administration EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Under normal circumstances, processes are started and restarted automatically by the operating system as required. If a process crashes, it is automatically restarted.

Use this command to manually stop, start, or restart individual processes.

Caution

Manually stopping or restarting a process can seriously impact the operation of a router. Use these commands only under the direction of a Cisco Technical Support representative.

process shutdown

The process shutdown command shuts down (terminates) the specified process and copies associated with the specified process. The process is not restarted, even if considered “mandatory.�? Use the show processes command to display a list of executable processes running on the system.

Caution

Stopping a process can result in an RP switchover, system failure or both. This command is intended for use only under the direct supervision of a Cisco Technical Support representative.

process restart

The process restart command restarts a process, such as a process that is not functioning optimally.

process start

The process start command starts a process that is not currently running, such as a process that was terminated using the process kill command. If multiple copies are on the system, all instances of the process are started simultaneously.

Task ID

Task ID

Operations

root-lr

execute

Examples

The following example shows how to restart a process. In this example, the IS-IS process is restarted:

Syntax Description

executable-name

Executable name of the process for which you want to change core dump options. Specifying a value for the executable-name argument changes the core dump option for multiple instances of a running process.

job-id

Job ID associated with the process instance. Specifying a job-id value changes the core dump option for only a single instance of a running process.

context

Dumps only context information for a process.

copy

Copies a core dump locally before performing the core dump.

fallback

Sets the core dump options to use the fallback options (if needed).

iomem

Dumps the I/O memory of a process.

mainmem

Dumps the main memory of a process.

off

Indicates that a core dump is not taken on the termination of the specified process.

sharedmem

Dumps the shared memory of a process.

sparse

Enables sparse core dumps of a process.

sync

Enables only synchronous core dumping.

text

Dumps the text of a process.

maxcore value

(Optional) Specifies the maximum number of core dumps allowed for the specified process on its creation.

locationnode-id

Sets the core dump options for a process on a designated node. The node-id argument is entered in the rack/slot/module notation.

Command Default

Command Modes

Administration EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Specifying an executable name for the executable-namejob-id argument changes the core dump option for all instances of the process. Specifying a job ID for the value changes the core dump option for a single instance of a running process.

Task ID

Task ID

Operations

root-lr

execute

Examples

The following example shows how to enable the collection of shared memory of a process:

RP/0/RSP0/CPU0:router# process ospf core sharedmem

The following example shows how to turn off core dumping for a process:

process mandatory reboot

process mandatory toggle

Syntax Description

Turns off the mandatory process attribute. The process is not considered mandatory.

reboot { enable | disable}

Enables or disables the reboot action when a mandatory process fails.

toggle

Toggles a mandatory process attribute.

executable-name

Executable name of the process to be terminated. Specifying an executable name for the executable-name argument terminates the process and all the simultaneously running copies, if applicable.

job-id

Job ID associated with the process to be terminated. Terminates only the process associated with the job ID.

locationnode-id

Sets the mandatory settings for a process on a designated node. The node-id argument is expressed in the rack/slot/module notation.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

If a process unexpectedly goes down, the following action occurs based on whether the process is considered mandatory.

If the process is mandatory and the process cannot be restarted, the node automatically reboots.

If the process is not mandatory and cannot be restarted, it stays down and the node does not reboot.

Task ID

Task ID

Operations

root-lr

execute

Examples

The following example shows how to turn on a mandatory attribute. In this example, the mandatory attribute is turned on for the media_ether_config_di process.

RP/0/RSP0/CPU0:router# process mandatory on media_ether_config_di

The following example shows how to turn the reboot option on. In this example, the router is set to reboot the node if a mandatory process goes down and cannot be restarted.

The following example shows how to turn off the reboot option. In this example, the router is set not to reboot the node if a mandatory process goes down and cannot be restarted. In this case, the mandatory process is restarted, but the node is not rebooted.

Syntax Description

(Optional) Core dump context information to be displayed based on the occurrence of the core dump. Valid values are 1 to 10.

clear

(Optional) Clears the current context information.

location { node-id | all}

Displays core dump information that occurred on the designated node. The node-id argument is expressed in the rack/slot/module notation. The all keyword specifies to display information for all nodes.

Command Default

If no coredump-occurrence value is specified, core dump context information for all core dumps is displayed.

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show context command to display core dump context information. This command displays context information for the last ten core dumps. Cisco Technical Support Center engineers and development engineers use this command for post-analysis in the debugging of processes.

Syntax Description

(Optional) Displays the virtual path of DLLs. The virtual path is expressed in the /pkg/lib/library-name.dll format where the library name is the name of the DLL followed by the .dll suffix.

symbol

(Optional) Displays the symbol at the virtual address specified for the virtual-address argument.

addressvirtual-address

(Optional) Displays the DLL that is mapped at the virtual address specified for the virtual-address argument.

dllnamedll-virtual-path

(Optional) Displays the process IDs (PIDs) of the process that have downloaded the DLL specified for the dll-virtual-path argument.

memory

(Optional) Displays a summary of DLL memory usage.

locationnode-id

(Optional) Displays DLLs for the specified node. The node-id argument is expressed in the rack/slot/module notation.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

basic-services

read

Examples

The following example shows sample output from the show dll command. In this example, the output displays all the DLLs loaded on the router.

Syntax Description

(Optional) Specifies the process for which to display the information.

locationnode-id

(Optional) Displays configured settings for a specified node. The node-id argument is expressed in the rack/slot/module notation.

Command Default

None

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Release 3.9.0

Support for the core-options keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the showexception command to display the configured core dump settings. The output from this command displays the core dump settings configured with the following commands:

show memory

To display the available physical memory and memory usage information of processes on the router, use the show memory command in administration EXEC mode or in EXEC mode.

showmemory
[ jobid | summary
[ bytes | detail ] ]
locationnode-id

Syntax Description

jobid

(Optional) Job ID associated with a process instance. Specifying a job ID for the job-id argument displays the memory available and memory usage information for only the process associated with the specified job ID. If the job-id argument is not specified, this command displays information for all running processes.

summary

(Optional) Displays a summary of the physical memory and memory usage information.

bytes

(Optional) Displays numbers in bytes for an exact count.

detail

(Optional) Displays numbers in the format “nnn.dddM” for more detail.

locationnode-id

Displays the available physical memory from the designated node. The node-id argument is entered in the rack/slot/module notation.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

To display detailed memory information for the entire router, enter the show memory command without any parameters.

Task ID

Task ID

Operations

basic-services

read

Examples

This example shows partial sample output from the show memory command entered without keywords or arguments. This command displays details for the entire router.

show memory compare

To display details about heap memory usage for all processes on the router at different moments in time and compare the results, use the showmemorycompare command in administration EXEC mode or in EXEC mode.

showmemorycompare
{ start | end | report }

Syntax Description

start

Takes the initial snapshot of heap memory usage for all processes on the router and sends the report to a temporary file named /tmp/memcmp_start.out.

end

Takes the second snapshot of heap memory usage for all processes on the router and sends the report to a temporary file named /tmp/memcmp_end.out. This snapshot is compared with the initial snapshot when displaying the heap memory usage comparison report.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the showmemorycompare command to display details about the heap memory usage of all processes on the router at different moments in time and compare the results. This command is useful for detecting patterns of memory usage during events such as restarting processes or configuring interfaces.

Use the following steps to create and compare memory snapshots:

Enter the showmemorycompare command with the start keyword to take the initial snapshot of heap memory usage for all processes on the router.

Note

The snapshot is similar to that resulting from entry of the show memory heap command with the optional summary keyword.

Perform the test you want to analyze.

Enter the showmemorycompare command with the end keyword to take the snapshot of heap memory usage to be compared with the initial snapshot.

Enter the showmemorycompare command with the report keyword to display the heap memory usage comparison report.

Task ID

Task ID

Operations

basic-services

read

Examples

This example shows sample output from the showmemorycompare command with the report keyword:

show memory heap

To display information about the heap space for a process, use the show memory heap command in administration EXEC mode or in EXEC mode.

showmemoryheap [allocated] [dllname] [failure] [free]
{ jobid | all }

Syntax Description

allocated

(Optional) Displays a list of all allocated heap blocks.

dllname

(Optional) Displays heaps with dynamic link library (DLL) names.

failure

(Optional) Displays a summary of heap failures.

free

(Optional) Displays a list of all free heap blocks.

summary

(Optional) Displays a summary of the information about the heap space.

job-id

Job ID associated with the process instance.

all

(Optional) Displays information about the heap space for all processes. The all keyword is only available when the failure or summary keywords are used.

Command Default

No default behavior or values

Command Modes

Administration EXEC

EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

basic-services

read

Examples

This example shows sample output from the show memory heap command, specifying a job ID for the job-id argument:

(Optional) Displays more detail. This option is available only with the process-name argument.

run

(Optional) Displays information for only running processes. This option is available only with the process-name argument.

Command Default

No default behavior or values

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.7.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show processes command to display general information about the active processes. To display more detailed information for a process, specify a job ID or process for the job-id argument or process-name argument, respectively.

You can also use the monitor processes command to determine the top processes and threads based on CPU usage.

Task ID

Task ID

Operations

basic-services

read

Examples

The show processes command with the process-name argument displays detailed information about a process:

Number of times the process has restarted since the node was booted. If a node is reloaded, the restart count for all processes is reset. Normally, this value is 1, because usually processes do not restart. However, if you restart a process using the process restart command, the restart count for the process increases by one.

Placement

Indicates whether the process is a placeable process or not. Most processes are not placeable, so the value is blank. ISIS, OSPF, and BGP are examples of placeable processes.

Mandatory

M indicates that the process is mandatory. A mandatory process must be running. If a mandatory process cannot be started (for example, sysmgr starts it but it keeps crashing), after five attempts the sysmgr causes the node to reload in an attempt to correct the problem. A node cannot function properly if a mandatory process is not running.

Maint Mode

Indicates processes that should be running when a node is in maintenance mode. Maintenance mode is intended to run as few processes as possible to perform diagnostics on a card when a problem is suspected. However, even the diagnostics require some services running.

Name (IID)

Name of the process followed by the instance ID. A process can have multiple instances running, so the IID is the instance ID.