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
filepath filepath-name
no exception
filepath filepath-name
Syntax Description
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.
The default file
naming convention used for core dump files is described in
Table 1.
Command History
Release
|
Modification
|
Release 5.0.0
|
This command was introduced.
|
Release 3.9.0
|
No
modification.
|
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,
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.
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:
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 describes the default core dump file naming convention.
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/ slot 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 use
the command:
RP/0/RP1/CPU0:Linkwood(config)#exception filepath f1