Add .gitignore file
[s390-tools.git] / man / dumpconf.8
blobc795568aa3fbb9ea8f8af37513fd5bef3e20236e
1 .TH DUMPCONF 8 "Nov 2009" "s390-tools"
3 .SH NAME
4 dumpconf \- Configure an ON_PANIC action for Linux on System z.
6 .SH SYNOPSIS
7 .br
8 \fBdumpconf\fR [start|stop|status]
9 .br
10 \fBdumpconf\fR [-h|-v]
12 .SH DESCRIPTION
13 \fBdumpconf\fR reads the /etc/sysconfig/dumpconf file
14 and establishes the action to be taken in case a kernel panic occurs.
16 The following keywords can be used in the dumpconf file:
18 .TP
19 \fB  - ON_PANIC:\fR
20 Shutdown action in case of a kernel panic. Possible values are 'dump', 'reipl', 'dump_reipl', 'stop' and 'vmcmd':
21 .br
23 dump: trigger dump according to the configuration in /etc/sysconfig/dumpconf.
24 .br
26 reipl: trigger re-IPL according to the configuration under /sys/firmware/reipl.
27 .br
29 dump_reipl: first trigger dump according to the configuration in
30 /etc/sysconfig/dumpconf, then trigger re-IPL according to the configuration
31 under /sys/firmware/reipl.
32 .br
34 stop: stop Linux and enter disabled wait (default).
35 .br
37 vmcmd: trigger CP command according to the 'VMCMD_X' configuration in
38 /etc/sysconfig/dumpconf.
40 .TP
41 \fB  - DUMP_TYPE:\fR
42 Type of dump device. Possible values are 'ccw' and 'fcp'.
44 .TP
45 \fB  - DEVICE:\fR
46 Device number of dump device.
48 .TP
49 \fB  - WWPN\fR
50 WWPN for SCSI dump device.
52 .TP
53 \fB  - LUN\fR
54 LUN for SCSI dump device.
56 .TP
57 \fB  - BOOTPROG:\fR
58 Boot program selector.
60 .TP
61 \fB  - BR_LBA:\fR
62 Boot record logical block address.
64 .TP
65 \fB  - VMCMD_1, VMCMD_2 ... VMCMD_5:\fR
66 Up to five CP commands, which are triggered in case of a kernel panic.
68 .TP
69 \fB - DELAY_MINUTES:\fR
70 Number of minutes the activation of dumpconf is to be delayed. If this keyword
71 is omitted, the default is zero, which means that
72 dumpconf activates immediately during system startup.
73 Specify a non-zero delay time only if you specified
74 shutdown action "reipl" or "dump_reipl".
75 These actions might cause a reboot loop
76 if the Linux kernel crashes persistently during (or shortly after) each reboot.
78 A non-zero delay time causes dumpconf to sleep in the background until the
79 delay time has expired. In this case messages are written to /var/log/messages.
80 By default (DELAY_MINUTES is omitted or zero) dumpconf runs in the foreground
81 and informational messages are written to sysout, while
82 error messages are written to syserr.
84 Example: If you specified DELAY_MINUTES=10 and
85 your Linux system crashes within 10 minutes after the reboot,
86 then dumpconf is not yet active and the default action (stop) is triggered.
88 .SH COMMANDS
89 .TP
90 \fBstart\fR
91 Enable configuration defined in /etc/sysconfig/dumpconf.
93 .TP
94 \fBstop\fR
95 Disable dump configuration.
97 .TP
98 \fBstatus\fR
99 Show current configuration.
101 .SH OPTIONS
103 \fB-h\fR or \fB--help\fR
104 Print usage information, then exit.
107 \fB-v\fR or \fB--version\fR
108 Print version information, then exit.
110 .SH EXAMPLES:
111 The following are examples of the /etc/sysconfig/dumpconf file:
116 # Example configuration for a CCW dump device (DASD)
120 ON_PANIC=dump_reipl
122 DUMP_TYPE=ccw
124 DEVICE=0.0.1234
126 DELAY_MINUTES=5
131 # Example configuration for an FCP dump device (SCSI Disk)
135 ON_PANIC=dump
137 DUMP_TYPE=fcp
139 DEVICE=0.0.2345
141 WWPN=0x5005076303004712
143 LUN=0x4713000000000000
145 BOOTPROG=0
147 BR_LBA=0
152 # Example configuration for CP commands on panic
156 ON_PANIC=vmcmd
158 VMCMD_1="MESSAGE * Starting VMDUMP"
160 VMCMD_2="VMDUMP"
162 VMCMD_3="IPL 3456"
166 # Example config for re-IPL on panic
170 ON_PANIC=reipl
172 DELAY_MINUTES=5
174 .SH SEE ALSO
175 Linux on zSeries: Using the Dump Tools