Print this page
NEX-9586 remove nodename from the default savecore directory path
Reviewed by: Dan Fields <dan.fields@nexenta.com>
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Sanjay Nadkarni <sanjay.nadkarni@nexenta.com>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/dumpadm.1m
+++ new/usr/src/man/man1m/dumpadm.1m
1 1 '\" te
2 2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
3 -.\" Copyright 2015 Nexenta Systems, Inc. All Rights Reserved.
3 +.\" Copyright 2017 Nexenta Systems, Inc. All Rights Reserved.
4 4 .\" Copyright (c) 2013 by Delphix. All rights reserved.
5 5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
6 6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
7 7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 -.TH DUMPADM 1M "Apr 09, 2015"
8 +.TH DUMPADM 1M "Feb 13, 2017"
9 9 .SH NAME
10 10 dumpadm \- configure operating system crash dump
11 11 .SH SYNOPSIS
12 12 .LP
13 13 .nf
14 14 \fB/usr/sbin/dumpadm\fR [\fB-enuy\fR] [\fB-c\fR \fIcontent-type\fR] [\fB-d\fR \fIdump-device\fR]
15 15 [\fB-m\fR \fImin\fRk | \fImin\fRm | \fImin\fR%] [\fB-s\fR \fIsavecore-dir\fR]
16 16 [\fB-r\fR \fIroot-dir\fR] [\fB-z\fR on | off]
17 17 .fi
18 18
19 19 .SH DESCRIPTION
20 -.sp
21 20 .LP
22 21 The \fBdumpadm\fR program is an administrative command that manages the
23 22 configuration of the operating system crash dump facility. A crash dump is a
24 23 disk copy of the physical memory of the computer at the time of a fatal system
25 24 error. When a fatal operating system error occurs, a message describing the
26 25 error is printed to the console. The operating system then generates a crash
27 26 dump by writing the contents of physical memory to a predetermined dump device,
28 27 which is typically a local disk partition. The dump device can be configured by
29 28 way of \fBdumpadm\fR. Once the crash dump has been written to the dump device,
30 29 the system will reboot.
31 30 .sp
32 31 .LP
33 32 Fatal operating system errors can be caused by bugs in the operating system,
34 33 its associated device drivers and loadable modules, or by faulty hardware.
35 34 Whatever the cause, the crash dump itself provides invaluable information to
36 35 your support engineer to aid in diagnosing the problem. As such, it is vital
37 36 that the crash dump be retrieved and given to your support provider. Following
38 37 an operating system crash, the \fBsavecore\fR(1M) utility is executed
39 38 automatically during boot to retrieve the crash dump from the dump device, and
40 39 write it to the file system. The directory in which the crash
41 40 dump is saved on reboot can also be configured using \fBdumpadm\fR.
42 41 .sp
43 42 .LP
44 43 When the operating system takes a crash dump the default behavior is to
45 44 compress the crash dump. This behavior is controlled by the \fB-z\fR option.
46 45 When compression is turned on, the \fBsavecore\fR(1M) utility writes one file
47 46 to the file system named \fIvmdump.X\fR. If compression is disabled, it instead
48 47 writes two files named \fIunix.X\fR and \fIvmcore.X\fR. In the uncompressed
49 48 case, both data files form the \fIsaved crash dump\fR. In both cases X is an
50 49 integer identifying the dump.
51 50 .sp
52 51 .LP
53 52 For systems with a UFS root file system, the default dump device is configured
54 53 to be an appropriate swap partition. Swap partitions are disk partitions
55 54 reserved as virtual memory backing store for the operating system. Thus, no
56 55 permanent information resides in swap to be overwritten by the dump. See
57 56 \fBswap\fR(1M). For systems with a ZFS root file system, dedicated ZFS volumes
|
↓ open down ↓ |
27 lines elided |
↑ open up ↑ |
58 57 are used for swap and dump areas. For further information about setting up a
59 58 dump area with ZFS, see the \fIZFS Administration Guide\fR. To view the
60 59 current dump configuration, use the \fBdumpadm\fR command with no arguments:
61 60 .sp
62 61 .in +2
63 62 .nf
64 63 example# \fBdumpadm\fR
65 64
66 65 Dump content: kernel pages
67 66 Dump device: /dev/dsk/c0t0d0s1 (swap)
68 -Savecore directory: /var/crash/saturn
67 +Savecore directory: /var/crash
69 68 Savecore enabled: yes
70 69 Save compressed: on
71 70 .fi
72 71 .in -2
73 72 .sp
74 73
75 74 .sp
76 75 .LP
77 76 When no options are specified, \fBdumpadm\fR prints the current crash dump
78 77 configuration. The example shows the set of default values: the dump content is
79 78 set to kernel memory pages only, the dump device is a swap disk partition, the
80 79 directory for \fBsavecore\fR files is set to
81 -\fB/var/crash/\fR\fIhostname\fR\fB,\fR \fBsavecore\fR is set to run
80 +\fB/var/crash\fR, \fBsavecore\fR is set to run
82 81 automatically on reboot, and compression is turned on.
83 82 .sp
84 83 .LP
85 84 When one or more options are specified, \fBdumpadm\fR verifies that your
86 85 changes are valid, and if so, reconfigures the crash dump parameters and
87 86 displays the resulting configuration. You must be \fBroot\fR to view or change
88 87 dump parameters.
89 88 .SH OPTIONS
90 -.sp
91 89 .LP
92 90 The following options are supported:
93 91 .sp
94 92 .ne 2
95 93 .na
96 94 \fB\fB-c\fR \fIcontent-type\fR\fR
97 95 .ad
98 96 .sp .6
99 97 .RS 4n
100 98 Modify the dump configuration so that the crash dump consists of the specified
101 99 dump content. The content should be one of the following:
102 100 .sp
103 101 .ne 2
104 102 .na
105 103 \fB\fBkernel\fR\fR
106 104 .ad
107 105 .sp .6
108 106 .RS 4n
109 107 Kernel memory pages only.
110 108 .RE
111 109
112 110 .sp
113 111 .ne 2
114 112 .na
115 113 \fB\fBall\fR\fR
116 114 .ad
117 115 .sp .6
118 116 .RS 4n
119 117 All memory pages.
120 118 .RE
121 119
122 120 .sp
123 121 .ne 2
124 122 .na
125 123 \fB\fBcurproc\fR\fR
126 124 .ad
127 125 .sp .6
128 126 .RS 4n
129 127 Kernel memory pages, and the memory pages of the process whose thread was
130 128 currently executing on the CPU on which the crash dump was initiated. If the
131 129 thread executing on that CPU is a kernel thread not associated with any user
132 130 process, only kernel pages will be dumped.
133 131 .RE
134 132
135 133 .RE
136 134
137 135 .sp
138 136 .ne 2
139 137 .na
140 138 \fB\fB-d\fR \fIdump-device\fR\fR
141 139 .ad
142 140 .sp .6
143 141 .RS 4n
144 142 Modify the dump configuration to use the specified dump device. The dump device
145 143 may be one of the following:
146 144 .sp
147 145 .ne 2
148 146 .na
149 147 \fB\fIdump-device\fR\fR
150 148 .ad
151 149 .sp .6
152 150 .RS 4n
153 151 A specific dump device specified as an absolute pathname, such as
154 152 \fB/dev/dsk/\fR\fIcNtNdNsN\fR when the system is running a UFS root file
155 153 system. Or, specify a ZFS volume, such as \fB/dev/zvol/dsk/rpool/dump\fR, when
156 154 the system is running a ZFS root file system.
157 155 .RE
158 156
159 157 .sp
160 158 .ne 2
161 159 .na
162 160 \fB\fBswap\fR\fR
163 161 .ad
164 162 .sp .6
165 163 .RS 4n
166 164 If the special token \fBswap\fR is specified as the dump device, \fBdumpadm\fR
167 165 examines the active swap entries and selects the most appropriate entry to
168 166 configure as the dump device. See \fBswap\fR(1M). Refer to the \fBNOTES\fR
169 167 below for details of the algorithm used to select an appropriate swap entry.
170 168 When the system is first installed with a UFS root file system, \fBdumpadm\fR
171 169 uses the value for \fBswap\fR to determine the initial dump device setting. A
172 170 given ZFS volume cannot be configured for both the swap area and the dump
173 171 device.
174 172 .RE
175 173
176 174 .sp
177 175 .ne 2
178 176 .na
179 177 \fB\fBnone\fR\fR
180 178 .ad
181 179 .sp .6
182 180 .RS 4n
183 181 If the special token \fBnone\fR is specified, the active dump device is removed
184 182 and crash dumps are disabled.
185 183 .RE
186 184
187 185 .RE
188 186
189 187 .sp
190 188 .ne 2
191 189 .na
192 190 \fB\fB-e\fR\fR
193 191 .ad
194 192 .sp .6
195 193 .RS 4n
196 194 Estimates the size of the dump for the current running system.
197 195 .RE
198 196
199 197 .sp
200 198 .ne 2
201 199 .na
202 200 \fB\fB-m\fR \fImin\fR\fBk\fR | \fImin\fR\fBm\fR | \fImin\fR\fB%\fR\fR
203 201 .ad
204 202 .sp .6
205 203 .RS 4n
206 204 Create a \fBminfree\fR file in the current savecore directory indicating that
207 205 \fBsavecore\fR should maintain at least the specified amount of free space in
208 206 the file system where the savecore directory is located. The \fBmin\fR argument
209 207 can be one of the following:
210 208 .sp
211 209 .ne 2
212 210 .na
213 211 \fB\fBk\fR\fR
214 212 .ad
215 213 .sp .6
216 214 .RS 4n
217 215 A positive integer suffixed with the unit \fBk\fR specifying kilobytes.
218 216 .RE
219 217
220 218 .sp
221 219 .ne 2
222 220 .na
223 221 \fB\fBm\fR\fR
224 222 .ad
225 223 .sp .6
226 224 .RS 4n
227 225 A positive integer suffixed with the unit \fBm\fR specifying megabytes.
228 226 .RE
229 227
230 228 .sp
231 229 .ne 2
232 230 .na
233 231 \fB\fB%\fR\fR
234 232 .ad
235 233 .sp .6
236 234 .RS 4n
237 235 A % symbol, indicating that the \fBminfree\fR value should be computed as the
238 236 specified percentage of the total current size of the file system containing
239 237 the savecore directory.
240 238 .RE
241 239
242 240 The \fBsavecore\fR command will consult the \fBminfree\fR file, if present,
243 241 prior to writing the dump files. If the size of these files would decrease the
244 242 amount of free disk space below the \fBminfree\fR threshold, no dump files are
245 243 written and an error message is logged. The administrator should immediately
246 244 clean up the savecore directory to provide adequate free space, and re-execute
247 245 the \fBsavecore\fR command manually. The administrator can also specify an
248 246 alternate directory on the \fBsavecore\fR command-line.
249 247 .RE
250 248
251 249 .sp
252 250 .ne 2
253 251 .na
254 252 \fB\fB-n\fR\fR
255 253 .ad
256 254 .sp .6
257 255 .RS 4n
258 256 Modify the dump configuration to not run \fBsavecore\fR automatically on
259 257 reboot. This is not the recommended system configuration; if the dump device is
260 258 a swap partition, the dump data will be overwritten as the system begins to
261 259 swap. If \fBsavecore\fR is not executed shortly after boot, crash dump
262 260 retrieval may not be possible.
263 261 .RE
264 262
265 263 .sp
266 264 .ne 2
267 265 .na
268 266 \fB\fB-r\fR \fIroot-dir\fR\fR
269 267 .ad
270 268 .sp .6
271 269 .RS 4n
272 270 Specify an alternate root directory relative to which \fBdumpadm\fR should
273 271 create files. If no \fB-r\fR argument is specified, the default root directory
274 272 \fB/\fR is used.
275 273 .RE
276 274
277 275 .sp
278 276 .ne 2
|
↓ open down ↓ |
178 lines elided |
↑ open up ↑ |
279 277 .na
280 278 \fB\fB-s\fR \fIsavecore-dir\fR\fR
281 279 .ad
282 280 .sp .6
283 281 .RS 4n
284 282 Modify the dump configuration to use the specified directory to save files
285 283 written by \fBsavecore\fR. The directory should be an absolute path and exist
286 284 on the system. If upon reboot the directory does not exist, it will be created
287 285 prior to the execution of \fBsavecore\fR. See the \fBNOTES\fR section below for
288 286 a discussion of security issues relating to access to the savecore directory.
289 -The default savecore directory is \fB/var/crash/\fIhostname\fR\fR where
290 -\fIhostname\fR is the output of the \fB-n\fR option to the \fBuname\fR(1)
291 -command.
287 +The default savecore directory is \fB/var/crash\fR.
292 288 .RE
293 289
294 290 .sp
295 291 .ne 2
296 292 .na
297 293 \fB\fB-u\fR\fR
298 294 .ad
299 295 .sp .6
300 296 .RS 4n
301 297 Forcibly update the kernel dump configuration based on the contents of
302 298 \fB/etc/dumpadm.conf\fR. Normally this option is used only on reboot when
303 299 starting \fBsvc:/system/dumpadm:default\fR, when the \fBdumpadm\fR settings
304 300 from the previous boot must be restored. Your dump configuration is saved in
305 301 the configuration file for this purpose. If the configuration file is missing
306 302 or contains invalid values for any dump properties, the default values are
307 303 substituted. Following the update, the configuration file is resynchronized
308 304 with the kernel dump configuration.
309 305 .RE
310 306
311 307 .sp
312 308 .ne 2
313 309 .na
314 310 \fB\fB-y\fR\fR
315 311 .ad
316 312 .sp .6
317 313 .RS 4n
318 314 Modify the dump configuration to automatically run \fBsavecore\fR on reboot.
319 315 This is the default for this dump setting.
320 316 .RE
321 317
322 318 .sp
323 319 .ne 2
324 320 .na
325 321 \fB\fB-z on | off\fR\fR
326 322 .ad
327 323 .sp .6
328 324 .RS 4n
329 325 Turns crash dump compression \fBon\fR or \fBoff\fR.
330 326 .RE
331 327
332 328 .SH EXAMPLES
333 329 .LP
334 330 \fBExample 1 \fRReconfiguring The Dump Device To A Dedicated Dump Device:
335 331 .sp
|
↓ open down ↓ |
34 lines elided |
↑ open up ↑ |
336 332 .LP
337 333 The following command reconfigures the dump device to a dedicated dump device:
338 334
339 335 .sp
340 336 .in +2
341 337 .nf
342 338 example# dumpadm -d /dev/dsk/c0t2d0s2
343 339
344 340 Dump content: kernel pages
345 341 Dump device: /dev/dsk/c0t2d0s2 (dedicated)
346 - Savecore directory: /var/crash/saturn
342 + Savecore directory: /var/crash
347 343 Savecore enabled: yes
348 344 Save compressed: on
349 345 .fi
350 346 .in -2
351 347 .sp
352 348
353 349 .SH EXIT STATUS
354 -.sp
355 350 .LP
356 351 The following exit values are returned:
357 352 .sp
358 353 .ne 2
359 354 .na
360 355 \fB\fB0\fR\fR
361 356 .ad
362 357 .sp .6
363 358 .RS 4n
364 359 Dump configuration is valid and the specified modifications, if any, were made
365 360 successfully.
366 361 .RE
367 362
368 363 .sp
369 364 .ne 2
370 365 .na
371 366 \fB\fB1\fR\fR
372 367 .ad
373 368 .sp .6
374 369 .RS 4n
375 370 A fatal error occurred in either obtaining or modifying the dump configuration.
376 371 .RE
377 372
378 373 .sp
|
↓ open down ↓ |
14 lines elided |
↑ open up ↑ |
379 374 .ne 2
380 375 .na
381 376 \fB\fB2\fR\fR
382 377 .ad
383 378 .sp .6
384 379 .RS 4n
385 380 Invalid command line options were specified.
386 381 .RE
387 382
388 383 .SH FILES
389 -.sp
390 384 .ne 2
391 385 .na
392 386 \fB\fB/dev/dump\fR\fR
393 387 .ad
394 388 .sp .6
395 389 .RS 4n
396 390 Dump device.
397 391 .RE
398 392
399 393 .sp
400 394 .ne 2
401 395 .na
402 396 \fB\fB/etc/dumpadm.conf\fR\fR
403 397 .ad
404 398 .sp .6
405 399 .RS 4n
406 400 Contains configuration parameters for \fBdumpadm\fR. Modifiable only through
407 401 that command.
408 402 .RE
409 403
410 404 .sp
411 405 .ne 2
|
↓ open down ↓ |
12 lines elided |
↑ open up ↑ |
412 406 .na
413 407 \fB\fIsavecore-directory\fR\fB/minfree\fR\fR
414 408 .ad
415 409 .sp .6
416 410 .RS 4n
417 411 Contains minimum amount of free space for \fIsavecore-directory\fR. See
418 412 \fBsavecore\fR(1M).
419 413 .RE
420 414
421 415 .SH SEE ALSO
422 -.sp
423 416 .LP
424 417 \fBsvcs\fR(1), \fBuname\fR(1), \fBsavecore\fR(1M), \fBsvcadm\fR(1M),
425 418 \fBswap\fR(1M), \fBattributes\fR(5), \fBsmf\fR(5)
426 419 .SH NOTES
427 -.sp
428 420 .LP
429 421 The system crash dump service is managed by the service management facility,
430 422 \fBsmf\fR(5), under the service identifier:
431 423 .sp
432 424 .in +2
433 425 .nf
434 426 svc:/system/dumpadm:default
435 427 .fi
436 428 .in -2
437 429 .sp
438 430
439 431 .sp
440 432 .LP
441 433 Administrative actions on this service, such as enabling, disabling, or
442 434 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
443 435 status can be queried using the \fBsvcs\fR(1) command.
444 436 .SS "Dump Device Selection"
445 -.sp
446 437 .LP
447 438 When the special \fBswap\fR token is specified as the argument to \fBdumpadm\fR
448 439 \fB-d\fR the utility will attempt to configure the most appropriate swap device
449 440 as the dump device. \fBdumpadm\fR configures the largest swap block device as
450 441 the dump device; if no block devices are available for swap, the largest swap
451 442 entry is configured as the dump device. If no swap entries are present, or none
452 443 can be configured as the dump device, a warning message will be displayed.
453 444 While local and remote swap files can be configured as the dump device, this is
454 445 not recommended.
455 446 .SS "Dump Device/Swap Device Interaction (UFS File Systems Only)"
456 -.sp
457 447 .LP
458 448 In the event that the dump device is also a swap device, and the swap device is
459 449 deleted by the administrator using the \fBswap\fR \fB-d\fR command, the
460 450 \fBswap\fR command will automatically invoke \fBdumpadm\fR \fB-d\fR \fBswap\fR
461 451 in order to attempt to configure another appropriate swap device as the dump
462 452 device. If no swap devices remain or none can be configured as the dump device,
463 453 the crash dump will be disabled and a warning message will be displayed.
464 454 Similarly, if the crash dump is disabled and the administrator adds a new swap
465 455 device using the \fBswap\fR \fB-a\fR command, \fBdumpadm\fR \fB-d\fR \fBswap\fR
466 456 will be invoked to re-enable the crash dump using the new swap device.
467 457 .sp
468 458 .LP
469 459 Once \fBdumpadm\fR \fB-d\fR \fBswap\fR has been issued, the new dump device is
470 460 stored in the configuration file for subsequent reboots. If a larger or more
471 461 appropriate swap device is added by the administrator, the dump device is not
472 462 changed; the administrator must re-execute \fBdumpadm\fR \fB-d\fR \fBswap\fR to
473 463 reselect the most appropriate device fom the new list of swap devices.
474 464 .SS "Minimum Free Space"
475 -.sp
476 465 .LP
477 466 If the \fBdumpadm\fR \fB-m\fR option is used to create a \fBminfree\fR file
478 467 based on a percentage of the total size of the file system containing the
479 468 savecore directory, this value is not automatically recomputed if the file
480 469 system subsequently changes size. In this case, the administrator must
481 470 re-execute \fBdumpadm\fR \fB-m\fR to recompute the \fBminfree\fR value. If no
482 471 such file exists in the savecore directory, \fBsavecore\fR will default to a
483 472 free space threshold of one megabyte. If no free space threshold is desired, a
484 473 minfree file containing size 0 can be created.
485 474 .SS "Security Issues"
486 -.sp
487 475 .LP
488 476 If, upon reboot, the specified savecore directory is not present, it will be
489 477 created prior to the execution of \fBsavecore\fR with permissions 0700 (read,
490 478 write, execute by owner only) and owner \fBroot\fR. It is recommended that
491 479 alternate savecore directories also be created with similar permissions, as the
492 480 operating system crash dump files themselves may contain secure information.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX