To modify core dump settings, use the
exception filepath
command in the appropriate configuration mode. To remove the configuration, use the no form of this command.
exception [choice preference] [compress {on | off}] filename filename lower-limit- higher-limit filepath filepath-name
no exception [choice preference] [compress {on | off}] filename filename lower-limit- higher-limit filepath filepath-name
Syntax Description
choice
preference
|
(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:
|
filename
filename
lower-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.
filename
filename
lower-limit-higher-limit
See exception filepath for a description of the default core dump file naming convention.
Vali
filename
filename
lower-limit-higher-limit
d 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-name
|
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
choice
preference
keyword and argument, the default preference is the primary location or 1.
Core dump files are sent compressed.
Command Modes
Global configuration
XR Config
Command History
Release |
Modification |
Release 7.0.12
|
This command was introduced.
|
Usage Guidelines
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,
choice
1
) 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,
choice
2
) 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,
choice
3
) 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:
process
[.by.
requester
|.abort][.sparse].
date-time
.
node
.
processor-type
[.Z]
For example:
packet.by.dumper_gen.20040921-024800.node0_RP0_CPU0.ppc.Z
Table 1. Default Core Dump File Naming Convention Description
Field
|
Description
|
process
|
Name of the process that generated the core dump.
|
.by.
requester
| .abort
|
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/ 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
filename
filename
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.
RP/0/RP0/CPU0:router(config)# exception choice 1 compress off
filename core 0-5 filepath /harddisk:/corefile