1KDUMP.CONF(5)                 File Formats Manual                KDUMP.CONF(5)
2
3
4

NAME

6       kdump.conf - configuration file for kdump kernel.
7
8

DESCRIPTION

10       kdump.conf  is  a configuration file for the kdump kernel crash collec‐
11       tion service.
12
13       kdump.conf provides post-kexec instructions to the kdump kernel. It  is
14       stored  in  the initrd file managed by the kdump service. If you change
15       this file and do not want to restart before it  takes  effect,  restart
16       the kdump service to rebuild to initrd.
17
18       For most configurations, you can simply review the examples provided in
19       the stock /etc/kdump.conf.
20
21       NOTE: kdump.conf only affects the behavior of  the  initramfs.   Please
22       read the kdump operational flow section of kexec-kdump-howto.txt in the
23       docs to better understand  how  this  configuration  file  affects  the
24       behavior of kdump.
25
26

OPTIONS

28       raw <partition>
29              Will dd /proc/vmcore into <partition>.
30
31       net <nfs mount>
32              Will      mount      fs     and     copy     /proc/vmcore     to
33              <mnt>/var/crash/%HOST-%DATE/, supports DNS.  Note  that  a  fqdn
34              should be used as the server name in the mount point
35
36       net <user@server>
37              Will  scp /proc/vmcore to <user@server>:/var/crash/%HOST-%DATE/,
38              supports DNS. NOTE: make sure user has necessary  write  permis‐
39              sions on server and that a fqdn is used as the server name
40
41       <fs type> <partition>
42              Will  mount  -t <fs type> <partition> /mnt and copy /proc/vmcore
43              to /mnt/var/crash/%DATE/.  NOTE: <partition>  can  be  a  device
44              node, label or uuid.
45
46       path <path>
47              Append  path  to the filesystem device which you are dumping to.
48              Ignored for  raw  device  dumps.   If  unset,  will  default  to
49              /var/crash.
50
51       disk_timeout <seconds>
52              Number  of seconds to wait for disks to appear in sysfs prior to
53              continuing Normally, the kdump initramfs waits for disks that it
54              has  determined  it needs to use during the course of saving the
55              vmcore.  By default, it  pauses  indefinately,  but  in  certain
56              cases,  it  may wait indefinately on disks that either wont ever
57              appear (if a usb drive is removed for instance),  or  for  disks
58              that  it  actually  doesn't  need  (depending on configuration).
59              This allows the pause to be terminated in those events.
60
61       core_collector makedumpfile <options>
62              This directive allows you to  use  the  dump  filtering  program
63              makedumpfile  to  retrieve  your  core, which on some arches can
64              drastically  reduce  core  file  size.   See  /sbin/makedumpfile
65              --help  for  a list of options.  Note that the -i and -g options
66              are not needed here, as the initrd will automatically  be  popu‐
67              lated with a config file appropriate for the running kernel.
68
69       link_delay <seconds>
70              Some  network  cards  take  a  long time to initialize, and some
71              spanning tree enabled networks do not transmit user traffic  for
72              long  periods after a link state changes.  This optional parame‐
73              ter defines a wait period after a link is activated in which the
74              initramfs will wait before attempting to transmit user data.
75
76       kdump_post <binary | script>
77              This  directive  allows  you  to run a specified executable just
78              after the memory dump process terminates. The exit  status  from
79              the  dump process is fed to the kdump_post executable, which can
80              be used to trigger different actions for success or failure.
81
82              Note that scripts written for use with this directive  must  use
83              the /bin/msh interpreter
84
85       kdump_pre <binary | script>
86              Works just like the kdump_post directive, but instead of running
87              after the dump process, runs immediately before.  Exit status of
88              this binary is interpreted as follows:
89
90              0 - continue with dump process as usual
91
92              non 0 - reboot/halt the system
93
94              Note  that  scripts  written  for  this  directive  must use the
95              /bin/msh interpreter
96
97       extra_bins <binaries | shell scripts>
98              This directive allows you  to  specify  additional  binaries  or
99              shell scripts you'd like to include in your kdump initrd. Gener‐
100              ally only useful in conjunction  with  a  kdump_post  binary  or
101              script that relies on other binaries or scripts.
102
103       extra_modules <module(s)>
104              This  directive  allows you to specify extra kernel modules that
105              you want to be loaded in the kdump initrd, typically used to set
106              up access to non-boot-path dump targets that might otherwise not
107              be accessible in the kdump environment. Multiple modules can  be
108              listed,  separated  by  a  space, and any dependent modules will
109              automatically be included.
110
111       options <module> <option list>
112              This directive allows you to specify options to apply to modules
113              in the initramfs.  This directive overrides options specified in
114              /etc/modprobe.conf
115
116       default <reboot | halt | shell>
117              Action to preform instead of mounting root fs and  running  init
118              process  reboot:  If  the default action is reboot simply reboot
119              the system (this is what most people will want,  as  it  returns
120              the system to a nominal state).  shell: If the default action is
121              shell, then drop to an msh session  inside  the  initramfs  from
122              where  you  can  manually  preform  additional recovery actions.
123              Exiting this shell reboots the system.  halt: bring  the  system
124              to a halt, requiring manual reset NOTE: Since kdump.conf is only
125              used to configure  the  kdump  initramfs  specifying  a  default
126              action  without  also  specifying  a  dump target will cause the
127              default directive to be ignored.  A warning  will be  issued  on
128              service  start if this invalid configuration is specified.  Also
129              note that if no default action is specified, reboot is implied.
130
131

EXAMPLES

133       see /etc/kdump.conf
134
135

SEE ALSO

137       kexec(8) mkdumprd(8)
138
139
140
141kexec-tools                       07/23/2008                     KDUMP.CONF(5)
Impressum