]> git.ipfire.org Git - thirdparty/mdadm.git/blob - mdadm.8
More consistent honoring of --configfile
[thirdparty/mdadm.git] / mdadm.8
1 .\" -*- nroff -*-
2 .TH MDADM 8 "" v2.5.1
3 .SH NAME
4 mdadm \- manage MD devices
5 .I aka
6 Linux Software Raid.
7
8 .SH SYNOPSIS
9
10 .BI mdadm " [mode] <raiddevice> [options] <component-devices>"
11
12 .SH DESCRIPTION
13 RAID devices are virtual devices created from two or more
14 real block devices. This allows multiple devices (typically disk
15 drives or partitions there-of) to be combined into a single device to
16 hold (for example) a single filesystem.
17 Some RAID levels include redundancy and so can survive some degree of
18 device failure.
19
20 Linux Software RAID devices are implemented through the md (Multiple
21 Devices) device driver.
22
23 Currently, Linux supports
24 .B LINEAR
25 md devices,
26 .B RAID0
27 (striping),
28 .B RAID1
29 (mirroring),
30 .BR RAID4 ,
31 .BR RAID5 ,
32 .BR RAID6 ,
33 .BR RAID10 ,
34 .BR MULTIPATH ,
35 and
36 .BR FAULTY .
37
38 .B MULTIPATH
39 is not a Software RAID mechanism, but does involve
40 multiple devices. For
41 .B MULTIPATH
42 each device is a path to one common physical storage device.
43
44 .B FAULTY
45 is also not true RAID, and it only involves one device. It
46 provides a layer over a true device that can be used to inject faults.
47
48 '''.B mdadm
49 '''is a program that can be used to create, manage, and monitor
50 '''MD devices. As
51 '''such it provides a similar set of functionality to the
52 '''.B raidtools
53 '''packages.
54 '''The key differences between
55 '''.B mdadm
56 '''and
57 '''.B raidtools
58 '''are:
59 '''.IP \(bu 4
60 '''.B mdadm
61 '''is a single program and not a collection of programs.
62 '''.IP \(bu 4
63 '''.B mdadm
64 '''can perform (almost) all of its functions without having a
65 '''configuration file and does not use one by default. Also
66 '''.B mdadm
67 '''helps with management of the configuration
68 '''file.
69 '''.IP \(bu 4
70 '''.B mdadm
71 '''can provide information about your arrays (through Query, Detail, and Examine)
72 '''that
73 '''.B raidtools
74 '''cannot.
75 '''.P
76 '''.I mdadm
77 '''does not use
78 '''.IR /etc/raidtab ,
79 '''the
80 '''.B raidtools
81 '''configuration file, at all. It has a different configuration file
82 '''with a different format and a different purpose.
83
84 .SH MODES
85 mdadm has 7 major modes of operation:
86 .TP
87 .B Assemble
88 Assemble the parts of a previously created
89 array into an active array. Components can be explicitly given
90 or can be searched for.
91 .B mdadm
92 checks that the components
93 do form a bona fide array, and can, on request, fiddle superblock
94 information so as to assemble a faulty array.
95
96 .TP
97 .B Build
98 Build an array that doesn't have per-device superblocks. For these
99 sorts of arrays,
100 .I mdadm
101 cannot differentiate between initial creation and subsequent assembly
102 of an array. It also cannot perform any checks that appropriate
103 devices have been requested. Because of this, the
104 .B Build
105 mode should only be used together with a complete understanding of
106 what you are doing.
107
108 .TP
109 .B Create
110 Create a new array with per-device superblocks.
111 '''It can progress
112 '''in several step create-add-add-run or it can all happen with one command.
113
114 .TP
115 .B "Follow or Monitor"
116 Monitor one or more md devices and act on any state changes. This is
117 only meaningful for raid1, 4, 5, 6, 10 or multipath arrays as
118 only these have interesting state. raid0 or linear never have
119 missing, spare, or failed drives, so there is nothing to monitor.
120
121 .TP
122 .B "Grow"
123 Grow (or shrink) an array, or otherwise reshape it in some way.
124 Currently supported growth options including changing the active size
125 of component devices in RAID level 1/4/5/6 and changing the number of
126 active devices in RAID1.
127
128 .TP
129 .B Manage
130 This is for doing things to specific components of an array such as
131 adding new spares and removing faulty devices.
132
133 .TP
134 .B Misc
135 This is an 'everything else' mode that supports operations on active
136 arrays, operations on component devices such as erasing old superblocks, and
137 information gathering operations.
138 '''This mode allows operations on independent devices such as examine MD
139 '''superblocks, erasing old superblocks and stopping active arrays.
140
141 .SH OPTIONS
142
143 .SH Options for selecting a mode are:
144
145 .TP
146 .BR -A ", " --assemble
147 Assemble a pre-existing array.
148
149 .TP
150 .BR -B ", " --build
151 Build a legacy array without superblocks.
152
153 .TP
154 .BR -C ", " --create
155 Create a new array.
156
157 .TP
158 .BR -F ", " --follow ", " --monitor
159 Select
160 .B Monitor
161 mode.
162
163 .TP
164 .BR -G ", " --grow
165 Change the size or shape of an active array.
166 .P
167 If a device is given before any options, or if the first option is
168 .BR --add ,
169 .BR --fail ,
170 or
171 .BR --remove ,
172 then the MANAGE mode is assume.
173 Anything other than these will cause the
174 .B Misc
175 mode to be assumed.
176
177 .SH Options that are not mode-specific are:
178
179 .TP
180 .BR -h ", " --help
181 Display general help message or, after one of the above options, a
182 mode specific help message.
183
184 .TP
185 .B --help-options
186 Display more detailed help about command line parsing and some commonly
187 used options.
188
189 .TP
190 .BR -V ", " --version
191 Print version information for mdadm.
192
193 .TP
194 .BR -v ", " --verbose
195 Be more verbose about what is happening. This can be used twice to be
196 extra-verbose.
197 The extra verbosity currently only affects
198 .B --detail --scan
199 and
200 .BR "--examine --scan" .
201
202 .TP
203 .BR -q ", " --quiet
204 Avoid printing purely informative messages. With this,
205 .B mdadm
206 will be silent unless there is something really important to report.
207
208 .TP
209 .BR -b ", " --brief
210 Be less verbose. This is used with
211 .B --detail
212 and
213 .BR --examine .
214 Using
215 .B --brief
216 with
217 .B --verbose
218 gives an intermediate level of verbosity.
219
220 .TP
221 .BR -f ", " --force
222 Be more forceful about certain operations. See the various modes of
223 the exact meaning of this option in different contexts.
224
225 .TP
226 .BR -c ", " --config=
227 Specify the config file. Default is to use
228 .BR /etc/mdadm.conf ,
229 or if that is missing, then
230 .BR /etc/mdadm/mdadm.conf .
231 If the config file given is
232 .B partitions
233 then nothing will be read, but
234 .I mdadm
235 will act as though the config file contained exactly
236 .B "DEVICE partitions"
237 and will read
238 .B /proc/partitions
239 to find a list of devices to scan.
240 If the word
241 .B none
242 is given for the config file, then
243 .I mdadm
244 will act as though the config file were empty.
245
246 .TP
247 .BR -s ", " --scan
248 scan config file or
249 .B /proc/mdstat
250 for missing information.
251 In general, this option gives
252 .B mdadm
253 permission to get any missing information, like component devices,
254 array devices, array identities, and alert destination from the
255 configuration file:
256 .BR /etc/mdadm.conf .
257 One exception is MISC mode when using
258 .B --detail
259 or
260 .B --stop
261 in which case
262 .B --scan
263 says to get a list of array devices from
264 .BR /proc/mdstat .
265
266 .TP
267 .B -e ", " --metadata=
268 Declare the style of superblock (raid metadata) to be used. The
269 default is 0.90 for --create, and to guess for other operations.
270
271 Options are:
272 .RS
273 .IP "0, 0.90, default"
274 Use the original 0.90 format superblock. This format limits arrays to
275 28 componenet devices and limits component devices of levels 1 and
276 greater to 2 terabytes.
277 .IP "1, 1.0, 1.1, 1.2"
278 Use the new version-1 format superblock. This has few restrictions.
279 The different subversion store the superblock at different locations
280 on the device, either at the end (for 1.0), at the start (for 1.1) or
281 4K from the start (for 1.2).
282 .RE
283
284 .TP
285 .B --homehost=
286 This will over-ride any
287 .B HOMEHOST
288 setting in the config file and provides the identify of the host which
289 should be considered the home for any arrays.
290
291 When creating an array, the
292 .B homehost
293 will be recorded in the superblock. For version-1 superblocks, it will
294 be prefixed to the array name. For version-0.90 superblocks part of
295 the SHA1 hash of the hostname will be stored in the later half of the
296 UUID.
297
298 When reporting information about an array, any array which is tagged
299 for the given homehost will be reported as such.
300
301 When using Auto-Assemble, only arrays tagged for the given homehost
302 will be assembled.
303
304 .SH For create, build, or grow:
305
306 .TP
307 .BR -n ", " --raid-devices=
308 Specify the number of active devices in the array. This, plus the
309 number of spare devices (see below) must equal the number of
310 .I component-devices
311 (including "\fBmissing\fP" devices)
312 that are listed on the command line for
313 .BR --create .
314 Setting a value of 1 is probably
315 a mistake and so requires that
316 .B --force
317 be specified first. A value of 1 will then be allowed for linear,
318 multipath, raid0 and raid1. It is never allowed for raid4 or raid5.
319 .br
320 This number can only be changed using
321 .B --grow
322 for RAID1 arrays, and only on kernels which provide necessary support.
323
324 .TP
325 .BR -x ", " --spare-devices=
326 Specify the number of spare (eXtra) devices in the initial array.
327 Spares can also be added
328 and removed later. The number of component devices listed
329 on the command line must equal the number of raid devices plus the
330 number of spare devices.
331
332
333 .TP
334 .BR -z ", " --size=
335 Amount (in Kibibytes) of space to use from each drive in RAID1/4/5/6.
336 This must be a multiple of the chunk size, and must leave about 128Kb
337 of space at the end of the drive for the RAID superblock.
338 If this is not specified
339 (as it normally is not) the smallest drive (or partition) sets the
340 size, though if there is a variance among the drives of greater than 1%, a warning is
341 issued.
342
343 This value can be set with
344 .B --grow
345 for RAID level 1/4/5/6. If the array was created with a size smaller
346 than the currently active drives, the extra space can be accessed
347 using
348 .BR --grow .
349 The size can be given as
350 .B max
351 which means to choose the largest size that fits on all current drives.
352
353 .TP
354 .BR -c ", " --chunk=
355 Specify chunk size of kibibytes. The default is 64.
356
357 .TP
358 .BR --rounding=
359 Specify rounding factor for linear array (==chunk size)
360
361 .TP
362 .BR -l ", " --level=
363 Set raid level. When used with
364 .IR --create ,
365 options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4,
366 raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty. Obviously some of these are synonymous.
367
368 When used with
369 .IR --build ,
370 only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid.
371
372 Not yet supported with
373 .IR --grow .
374
375 .TP
376 .BR -p ", " --layout=
377 This option configures the fine details of data layout for raid5,
378 and raid10 arrays, and controls the failure modes for
379 .IR faulty .
380
381 The layout of the raid5 parity block can be one of
382 left-asymmetric,
383 left-symmetric,
384 right-asymmetric,
385 right-symmetric,
386 la, ra, ls, rs. The default is left-symmetric.
387
388 When setting the failure mode for
389 .I faulty
390 the options are:
391 write-transient,
392 wt,
393 read-transient,
394 rt,
395 write-persistent,
396 wp,
397 read-persistent,
398 rp,
399 write-all,
400 read-fixable,
401 rf,
402 clear,
403 flush,
404 none.
405
406 Each mode can be followed by a number which is used as a period
407 between fault generation. Without a number, the fault is generated
408 once on the first relevant request. With a number, the fault will be
409 generated after that many request, and will continue to be generated
410 every time the period elapses.
411
412 Multiple failure modes can be current simultaneously by using the
413 "--grow" option to set subsequent failure modes.
414
415 "clear" or "none" will remove any pending or periodic failure modes,
416 and "flush" will clear any persistent faults.
417
418 To set the parity with "--grow", the level of the array ("faulty")
419 must be specified before the fault mode is specified.
420
421 Finally, the layout options for RAID10 are one of 'n', 'o' or 'p' followed
422 by a small number. The default is 'n2'.
423
424 .I n
425 signals 'near' copies. Multiple copies of one data block are at
426 similar offsets in different devices.
427
428 .I o
429 signals 'offset' copies. Rather than the chunks being duplicated
430 within a stripe, whole stripes are duplicated but are rotated by one
431 device so duplicate blocks are on different devices. Thus subsequent
432 copies of a block are in the next drive, and are one chunk further
433 down.
434
435 .I f
436 signals 'far' copies
437 (multiple copies have very different offsets). See md(4) for more
438 detail about 'near' and 'far'.
439
440 The number is the number of copies of each datablock. 2 is normal, 3
441 can be useful. This number can be at most equal to the number of
442 devices in the array. It does not need to divide evenly into that
443 number (e.g. it is perfectly legal to have an 'n2' layout for an array
444 with an odd number of devices).
445
446 .TP
447 .BR --parity=
448 same as --layout (thus explaining the p of
449 .IR -p ).
450
451 .TP
452 .BR -b ", " --bitmap=
453 Specify a file to store a write-intent bitmap in. The file should not
454 exist unless --force is also given. The same file should be provided
455 when assembling the array. If the word
456 .B internal
457 is given, then the bitmap is stored with the metadata on the array,
458 and so is replicated on all devices. If the word
459 .B none
460 is given with
461 .B --grow
462 mode, then any bitmap that is present is removed.
463
464 To help catch typing errors, the filename must contain at least one
465 slash ('/') if it is a real file (not 'internal' or 'none').
466
467 Note: external bitmaps are only known to work on ext2 and ext3.
468 Storing bitmap files on other filesystems may result in serious problems.
469
470 .TP
471 .BR --bitmap-chunk=
472 Set the chunksize of the bitmap. Each bit corresponds to that many
473 Kilobytes of storage.
474 When using a file based bitmap, the default is to use the smallest
475 size that is atleast 4 and requires no more than 2^21 chunks.
476 When using an
477 .B internal
478 bitmap, the chunksize is automatically determined to make best use of
479 available space.
480
481
482 .TP
483 .BR -W ", " --write-mostly
484 subsequent devices lists in a
485 .BR --build ,
486 .BR --create ,
487 or
488 .B --add
489 command will be flagged as 'write-mostly'. This is valid for RAID1
490 only and means that the 'md' driver will avoid reading from these
491 devices if at all possible. This can be useful if mirroring over a
492 slow link.
493
494 .TP
495 .BR --write-behind=
496 Specify that write-behind mode should be enabled (valid for RAID1
497 only). If an argument is specified, it will set the maximum number
498 of outstanding writes allowed. The default value is 256.
499 A write-intent bitmap is required in order to use write-behind
500 mode, and write-behind is only attempted on drives marked as
501 .IR write-mostly .
502
503 .TP
504 .BR --assume-clean
505 Tell
506 .I mdadm
507 that the array pre-existed and is known to be clean. It can be useful
508 when trying to recover from a major failure as you can be sure that no
509 data will be affected unless you actually write to the array. It can
510 also be used when creating a RAID1 or RAID10 if you want to avoid the
511 initial resync, however this practice - while normally safe - is not
512 recommended. Use this ony if you really know what you are doing.
513
514 .TP
515 .BR --backup-file=
516 This is needed when --grow is used to increase the number of
517 raid-devices in a RAID5 if there are no spare devices available.
518 See the section below on RAID_DEVICE CHANGES. The file should be
519 stored on a separate device, not on the raid array being reshaped.
520
521 .TP
522 .BR -N ", " --name=
523 Set a
524 .B name
525 for the array. This is currently only effective when creating an
526 array with a version-1 superblock. The name is a simple textual
527 string that can be used to identify array components when assembling.
528
529 .TP
530 .BR -R ", " --run
531 Insist that
532 .I mdadm
533 run the array, even if some of the components
534 appear to be active in another array or filesystem. Normally
535 .I mdadm
536 will ask for confirmation before including such components in an
537 array. This option causes that question to be suppressed.
538
539 .TP
540 .BR -f ", " --force
541 Insist that
542 .I mdadm
543 accept the geometry and layout specified without question. Normally
544 .I mdadm
545 will not allow creation of an array with only one device, and will try
546 to create a raid5 array with one missing drive (as this makes the
547 initial resync work faster). With
548 .BR --force ,
549 .I mdadm
550 will not try to be so clever.
551
552 .TP
553 .BR -a ", " "--auto{=no,yes,md,mdp,part,p}{NN}"
554 Instruct mdadm to create the device file if needed, possibly allocating
555 an unused minor number. "md" causes a non-partitionable array
556 to be used. "mdp", "part" or "p" causes a partitionable array (2.6 and
557 later) to be used. "yes" requires the named md device to have
558 a 'standard' format, and the type and minor number will be determined
559 from this. See DEVICE NAMES below.
560
561 The argument can also come immediately after
562 "-a". e.g. "-ap".
563
564 If
565 .I --scan
566 is also given, then any
567 .I auto=
568 entries in the config file will over-ride the
569 .I --auto
570 instruction given on the command line.
571
572 For partitionable arrays,
573 .I mdadm
574 will create the device file for the whole array and for the first 4
575 partitions. A different number of partitions can be specified at the
576 end of this option (e.g.
577 .BR --auto=p7 ).
578 If the device name ends with a digit, the partition names add a 'p',
579 and a number, e.g. "/dev/home1p3". If there is no
580 trailing digit, then the partition names just have a number added,
581 e.g. "/dev/scratch3".
582
583 If the md device name is in a 'standard' format as described in DEVICE
584 NAMES, then it will be created, if necessary, with the appropriate
585 number based on that name. If the device name is not in one of these
586 formats, then a unused minor number will be allocated. The minor
587 number will be considered unused if there is no active array for that
588 number, and there is no entry in /dev for that number and with a
589 non-standard name.
590
591 .SH For assemble:
592
593 .TP
594 .BR -u ", " --uuid=
595 uuid of array to assemble. Devices which don't have this uuid are
596 excluded
597
598 .TP
599 .BR -m ", " --super-minor=
600 Minor number of device that array was created for. Devices which
601 don't have this minor number are excluded. If you create an array as
602 /dev/md1, then all superblocks will contain the minor number 1, even if
603 the array is later assembled as /dev/md2.
604
605 Giving the literal word "dev" for
606 .B --super-minor
607 will cause
608 .I mdadm
609 to use the minor number of the md device that is being assembled.
610 e.g. when assembling
611 .BR /dev/md0 ,
612 .M --super-minor=dev
613 will look for super blocks with a minor number of 0.
614
615 .TP
616 .BR -N ", " --name=
617 Specify the name of the array to assemble. This must be the name
618 that was specified when creating the array. It must either match
619 then name stored in the superblock exactly, or it must match
620 with the current
621 .I homehost
622 is added to the start of the given name.
623
624 .TP
625 .BR -f ", " --force
626 Assemble the array even if some superblocks appear out-of-date
627
628 .TP
629 .BR -R ", " --run
630 Attempt to start the array even if fewer drives were given than were
631 present last time the array was active. Normally if not all the
632 expected drives are found and
633 .B --scan
634 is not used, then the array will be assembled but not started.
635 With
636 .B --run
637 an attempt will be made to start it anyway.
638
639 .TP
640 .B --no-degraded
641 This is the reverse of
642 .B --run
643 in that it inhibits the started if array unless all expected drives
644 are present. This is only needed with
645 .B --scan
646 and can be used if you physical connections to devices are
647 not as reliable as you would like.
648
649 .TP
650 .BR -a ", " "--auto{=no,yes,md,mdp,part}"
651 See this option under Create and Build options.
652
653 .TP
654 .BR -b ", " --bitmap=
655 Specify the bitmap file that was given when the array was created. If
656 an array has an
657 .B internal
658 bitmap, there is no need to specify this when assembling the array.
659
660 .TP
661 .BR --backup-file=
662 If
663 .B --backup-file
664 was used to grow the number of raid-devices in a RAID5, and the system
665 crashed during the critical section, then the same
666 .B --backup-file
667 must be presented to --assemble to allow possibly corrupted data to be
668 restored.
669
670 .TP
671 .BR -U ", " --update=
672 Update the superblock on each device while assembling the array. The
673 argument given to this flag can be one of
674 .BR sparc2.2 ,
675 .BR summaries ,
676 .BR uuid ,
677 .BR name ,
678 .BR homehost ,
679 .BR resync ,
680 .BR byteorder ,
681 or
682 .BR super-minor .
683
684 The
685 .B sparc2.2
686 option will adjust the superblock of an array what was created on a Sparc
687 machine running a patched 2.2 Linux kernel. This kernel got the
688 alignment of part of the superblock wrong. You can use the
689 .B "--examine --sparc2.2"
690 option to
691 .I mdadm
692 to see what effect this would have.
693
694 The
695 .B super-minor
696 option will update the
697 .B "preferred minor"
698 field on each superblock to match the minor number of the array being
699 assembled. This is not needed on 2.6 and later kernels as they make
700 this adjustment automatically.
701
702 The
703 .B uuid
704 option will change the uuid of the array. If a UUID is given with the
705 "--uuid" option that UUID will be used as a new UUID and will
706 .B NOT
707 be used to help identify the devices in the array.
708 If no "--uuid" is given, a random uuid is chosen.
709
710 The
711 .B name
712 option will change the
713 .I name
714 of the array as stored in the superblock. This is only supported for
715 version-1 superblocks.
716
717 The
718 .B homehost
719 option will change the
720 .I homehost
721 as recorded in the superblock. For version-0 superblocks, this is the
722 same as updating the UUID.
723 For version-1 superblocks, this involves updating the name.
724
725 The
726 .B resync
727 option will cause the array to be marked
728 .I dirty
729 meaning that any redundancy in the array (e.g. parity for raid5,
730 copies for raid1) may be incorrect. This will cause the raid system
731 to perform a "resync" pass to make sure that all redundant information
732 is correct.
733
734 The
735 .B byteorder
736 option allows arrays to be moved between machines with different
737 byte-order.
738 When assembling such an array for the first time after a move, giving
739 .B "--update=byteorder"
740 will cause
741 .I mdadm
742 to expect superblocks to have their byteorder reversed, and will
743 correct that order before assembling the array. This is only valid
744 with original (Version 0.90) superblocks.
745
746 The
747 .B summaries
748 option will correct the summaries in the superblock. That is the
749 counts of total, working, active, failed, and spare devices.
750
751 .TP
752 .B --auto-update-homehost
753 This flag is only meaning with auto-assembly (see discussion below).
754 In that situation, if no suitable arrays are found for this homehost,
755 .I mdadm
756 will recan for any arrays at all and will assemble them and update the
757 homehost to match the current host.
758
759 .SH For Manage mode:
760
761 .TP
762 .BR -a ", " --add
763 hot-add listed devices.
764
765 .TP
766 .BR --re-add
767 re-add a device that was recently removed from an array.
768
769 .TP
770 .BR -r ", " --remove
771 remove listed devices. They must not be active. i.e. they should
772 be failed or spare devices.
773
774 .TP
775 .BR -f ", " --fail
776 mark listed devices as faulty.
777
778 .TP
779 .BR --set-faulty
780 same as --fail.
781
782 .P
783 Each of these options require that the first device list is the array
784 to be acted upon and the remainder are component devices to be added,
785 removed, or marked as fault. Several different operations can be
786 specified for different devices, e.g.
787 .in +5
788 mdadm /dev/md0 --add /dev/sda1 --fail /dev/sdb1 --remove /dev/sdb1
789 .in -5
790 Each operation applies to all devices listed until the next
791 operations.
792
793 If an array is using a write-intent bitmap, then devices which have
794 been removed can be re-added in a way that avoids a full
795 reconstruction but instead just updated the blocks that have changed
796 since the device was removed. For arrays with persistent metadata
797 (superblocks) this is done automatically. For arrays created with
798 .B --build
799 mdadm needs to be told that this device we removed recently with
800 .B --re-add.
801
802 Devices can only be removed from an array if they are not in active
803 use. i.e. that must be spares or failed devices. To remove an active
804 device, it must be marked as
805 .B faulty
806 first.
807
808 .SH For Misc mode:
809
810 .TP
811 .BR -Q ", " --query
812 Examine a device to see
813 (1) if it is an md device and (2) if it is a component of an md
814 array.
815 Information about what is discovered is presented.
816
817 .TP
818 .BR -D ", " --detail
819 Print detail of one or more md devices.
820
821 .TP
822 .BR -E ", " --examine
823 Print content of md superblock on device(s).
824 .TP
825 .B --sparc2.2
826 If an array was created on a 2.2 Linux kernel patched with RAID
827 support, the superblock will have been created incorrectly, or at
828 least incompatibly with 2.4 and later kernels. Using the
829 .B --sparc2.2
830 flag with
831 .B --examine
832 will fix the superblock before displaying it. If this appears to do
833 the right thing, then the array can be successfully assembled using
834 .BR "--assemble --update=sparc2.2" .
835
836 .TP
837 .BR -X ", " --examine-bitmap
838 Report information about a bitmap file.
839
840 .TP
841 .BR -R ", " --run
842 start a partially built array.
843
844 .TP
845 .BR -S ", " --stop
846 deactivate array, releasing all resources.
847
848 .TP
849 .BR -o ", " --readonly
850 mark array as readonly.
851
852 .TP
853 .BR -w ", " --readwrite
854 mark array as readwrite.
855
856 .TP
857 .B --zero-superblock
858 If the device contains a valid md superblock, the block is
859 over-written with zeros. With
860 --force
861 the block where the superblock would be is over-written even if it
862 doesn't appear to be valid.
863
864 .TP
865 .BR -t ", " --test
866 When used with
867 .BR --detail ,
868 the exit status of
869 .I mdadm
870 is set to reflect the status of the device.
871
872 .SH For Monitor mode:
873 .TP
874 .BR -m ", " --mail
875 Give a mail address to send alerts to.
876
877 .TP
878 .BR -p ", " --program ", " --alert
879 Give a program to be run whenever an event is detected.
880
881 .TP
882 .BR -y ", " --syslog
883 Cause all events to be reported through 'syslog'. The messages have
884 facility of 'daemon' and varying priorities.
885
886 .TP
887 .BR -d ", " --delay
888 Give a delay in seconds.
889 .B mdadm
890 polls the md arrays and then waits this many seconds before polling
891 again. The default is 60 seconds.
892
893 .TP
894 .BR -f ", " --daemonise
895 Tell
896 .B mdadm
897 to run as a background daemon if it decides to monitor anything. This
898 causes it to fork and run in the child, and to disconnect form the
899 terminal. The process id of the child is written to stdout.
900 This is useful with
901 .B --scan
902 which will only continue monitoring if a mail address or alert program
903 is found in the config file.
904
905 .TP
906 .BR -i ", " --pid-file
907 When
908 .B mdadm
909 is running in daemon mode, write the pid of the daemon process to
910 the specified file, instead of printing it on standard output.
911
912 .TP
913 .BR -1 ", " --oneshot
914 Check arrays only once. This will generate
915 .B NewArray
916 events and more significantly
917 .B DegradedArray
918 and
919 .B SparesMissing
920 events. Running
921 .in +5
922 .B " mdadm --monitor --scan -1"
923 .in -5
924 from a cron script will ensure regular notification of any degraded arrays.
925
926 .TP
927 .BR -t ", " --test
928 Generate a
929 .B TestMessage
930 alert for every array found at startup. This alert gets mailed and
931 passed to the alert program. This can be used for testing that alert
932 message do get through successfully.
933
934 .SH ASSEMBLE MODE
935
936 .HP 12
937 Usage:
938 .B mdadm --assemble
939 .I md-device options-and-component-devices...
940 .HP 12
941 Usage:
942 .B mdadm --assemble --scan
943 .I md-devices-and-options...
944 .HP 12
945 Usage:
946 .B mdadm --assemble --scan
947 .I options...
948
949 .PP
950 This usage assembles one or more raid arrays from pre-existing components.
951 For each array, mdadm needs to know the md device, the identity of the
952 array, and a number of component-devices. These can be found in a number of ways.
953
954 In the first usage example (without the
955 .BR --scan )
956 the first device given is the md device.
957 In the second usage example, all devices listed are treated as md
958 devices and assembly is attempted.
959 In the third (where no devices are listed) all md devices that are
960 listed in the configuration file are assembled.
961
962 If precisely one device is listed, but
963 .B --scan
964 is not given, then
965 .I mdadm
966 acts as though
967 .B --scan
968 was given and identify information is extracted from the configuration file.
969
970 The identity can be given with the
971 .B --uuid
972 option, with the
973 .B --super-minor
974 option, can be found in the config file, or will be taken from the
975 super block on the first component-device listed on the command line.
976
977 Devices can be given on the
978 .B --assemble
979 command line or in the config file. Only devices which have an md
980 superblock which contains the right identity will be considered for
981 any array.
982
983 The config file is only used if explicitly named with
984 .B --config
985 or requested with (a possibly implicit)
986 .B --scan.
987 In the later case,
988 .B /etc/mdadm.conf
989 is used.
990
991 If
992 .B --scan
993 is not given, then the config file will only be used to find the
994 identity of md arrays.
995
996 Normally the array will be started after it is assembled. However if
997 .B --scan
998 is not given and insufficient drives were listed to start a complete
999 (non-degraded) array, then the array is not started (to guard against
1000 usage errors). To insist that the array be started in this case (as
1001 may work for RAID1, 4, 5, 6, or 10), give the
1002 .B --run
1003 flag.
1004
1005 If an
1006 .B auto
1007 option is given, either on the command line (--auto) or in the
1008 configuration file (e.g. auto=part), then
1009 .I mdadm
1010 will create the md device if necessary or will re-create it if it
1011 doesn't look usable as it is.
1012
1013 This can be useful for handling partitioned devices (which don't have
1014 a stable device number - it can change after a reboot) and when using
1015 "udev" to manage your
1016 .B /dev
1017 tree (udev cannot handle md devices because of the unusual device
1018 initialisation conventions).
1019
1020 If the option to "auto" is "mdp" or "part" or (on the command line
1021 only) "p", then mdadm will create a partitionable array, using the
1022 first free one that is not in use, and does not already have an entry
1023 in /dev (apart from numeric /dev/md* entries).
1024
1025 If the option to "auto" is "yes" or "md" or (on the command line)
1026 nothing, then mdadm will create a traditional, non-partitionable md
1027 array.
1028
1029 It is expected that the "auto" functionality will be used to create
1030 device entries with meaningful names such as "/dev/md/home" or
1031 "/dev/md/root", rather than names based on the numerical array number.
1032
1033 When using this option to create a partitionable array, the device
1034 files for the first 4 partitions are also created. If a different
1035 number is required it can be simply appended to the auto option.
1036 e.g. "auto=part8". Partition names are created by appending a digit
1037 string to the device name, with an intervening "p" if the device name
1038 ends with a digit.
1039
1040 The
1041 .B --auto
1042 option is also available in Build and Create modes. As those modes do
1043 not use a config file, the "auto=" config option does not apply to
1044 these modes.
1045
1046 .SS Auto Assembly
1047 When
1048 .B --assemble
1049 is used with
1050 .B --scan
1051 and no devices are listed,
1052 .I mdadm
1053 will first attempt to assemble all the arrays listed in the config
1054 file.
1055
1056 If a
1057 .B homehost
1058 has been specified (either in the config file or on the command line),
1059 .I mdadm
1060 will look further for possible arrays and will try to assemble
1061 anything that it finds which is tagged as belonging to the given
1062 homehost. This is the only situation where
1063 .I mdadm
1064 will assemble arrays without being given specific device name or
1065 identify information for the array.
1066
1067 If
1068 .I mdadm
1069 finds a consistent set of devices that look like they should comprise
1070 an array, and if the superblock is tagged as belonging to the given
1071 home host, it will automatically choose a device name and try to
1072 assemble the array. If the array uses version-0.90 metadata, then the
1073 .B minor
1074 number as recorded in the superblock is used to create a name in
1075 .B /dev/md/
1076 so for example
1077 .BR /dev/md/3 .
1078 If the array uses version-1 metadata, then the
1079 .B name
1080 from the superblock is used to similarly create a name in
1081 .BR /dev/md .
1082 The name will have any 'host' prefix stripped first.
1083
1084 If
1085 .I mdadm
1086 cannot find any array for the given host at all, and if
1087 .B --auto-update-homehost
1088 is given, then
1089 .I mdadm
1090 will search again for any array (not just an array created for this
1091 host) and will assemble each assuming
1092 .IR --update=homehost .
1093 This will change the host tag in the superblock so that on the next run,
1094 these arrays will be found without the second pass. The intention of
1095 this feature is to support transitioning a set of md arrays to using
1096 homehost tagging.
1097
1098 The reason for requiring arrays to be tagged with the homehost for
1099 auto assembly is to guard against problems that can arise when moving
1100 devices from one host to another.
1101
1102 .SH BUILD MODE
1103
1104 .HP 12
1105 Usage:
1106 .B mdadm --build
1107 .I device
1108 .BI --chunk= X
1109 .BI --level= Y
1110 .BI --raid-devices= Z
1111 .I devices
1112
1113 .PP
1114 This usage is similar to
1115 .BR --create .
1116 The difference is that it creates an array without a superblock. With
1117 these arrays there is no difference between initially creating the array and
1118 subsequently assembling the array, except that hopefully there is useful
1119 data there in the second case.
1120
1121 The level may raid0, linear, multipath, or faulty, or one of their
1122 synonyms. All devices must be listed and the array will be started
1123 once complete.
1124
1125 .SH CREATE MODE
1126
1127 .HP 12
1128 Usage:
1129 .B mdadm --create
1130 .I device
1131 .BI --chunk= X
1132 .BI --level= Y
1133 .br
1134 .BI --raid-devices= Z
1135 .I devices
1136
1137 .PP
1138 This usage will initialise a new md array, associate some devices with
1139 it, and activate the array.
1140
1141 If the
1142 .B --auto
1143 option is given (as described in more detail in the section on
1144 Assemble mode), then the md device will be created with a suitable
1145 device number if necessary.
1146
1147 As devices are added, they are checked to see if they contain raid
1148 superblocks or filesystems. They are also checked to see if the variance in
1149 device size exceeds 1%.
1150
1151 If any discrepancy is found, the array will not automatically be run, though
1152 the presence of a
1153 .B --run
1154 can override this caution.
1155
1156 To create a "degraded" array in which some devices are missing, simply
1157 give the word "\fBmissing\fP"
1158 in place of a device name. This will cause
1159 .B mdadm
1160 to leave the corresponding slot in the array empty.
1161 For a RAID4 or RAID5 array at most one slot can be
1162 "\fBmissing\fP"; for a RAID6 array at most two slots.
1163 For a RAID1 array, only one real device needs to be given. All of the
1164 others can be
1165 "\fBmissing\fP".
1166
1167 When creating a RAID5 array,
1168 .B mdadm
1169 will automatically create a degraded array with an extra spare drive.
1170 This is because building the spare into a degraded array is in general faster than resyncing
1171 the parity on a non-degraded, but not clean, array. This feature can
1172 be over-ridden with the
1173 .I --force
1174 option.
1175
1176 When creating an array with version-1 metadata a name for the host is
1177 required.
1178 If this is not given with the
1179 .B --name
1180 option,
1181 .I mdadm
1182 will chose a name based on the last component of the name of the
1183 device being created. So if
1184 .B /dev/md3
1185 is being created, then the name
1186 .B 3
1187 will be chosen.
1188 If
1189 .B /dev/md/home
1190 is being created, then the name
1191 .B home
1192 will be used.
1193
1194 '''If the
1195 '''.B --size
1196 '''option is given, it is not necessary to list any component-devices in this command.
1197 '''They can be added later, before a
1198 '''.B --run.
1199 '''If no
1200 '''.B --size
1201 '''is given, the apparent size of the smallest drive given is used.
1202
1203 The General Management options that are valid with --create are:
1204 .TP
1205 .B --run
1206 insist on running the array even if some devices look like they might
1207 be in use.
1208
1209 .TP
1210 .B --readonly
1211 start the array readonly - not supported yet.
1212
1213
1214 .SH MANAGE MODE
1215 .HP 12
1216 Usage:
1217 .B mdadm
1218 .I device
1219 .I options... devices...
1220 .PP
1221
1222 This usage will allow individual devices in an array to be failed,
1223 removed or added. It is possible to perform multiple operations with
1224 on command. For example:
1225 .br
1226 .B " mdadm /dev/md0 -f /dev/hda1 -r /dev/hda1 -a /dev/hda1"
1227 .br
1228 will firstly mark
1229 .B /dev/hda1
1230 as faulty in
1231 .B /dev/md0
1232 and will then remove it from the array and finally add it back
1233 in as a spare. However only one md array can be affected by a single
1234 command.
1235
1236 .SH MISC MODE
1237 .HP 12
1238 Usage:
1239 .B mdadm
1240 .I options ...
1241 .I devices ...
1242 .PP
1243
1244 MISC mode includes a number of distinct operations that
1245 operate on distinct devices. The operations are:
1246 .TP
1247 --query
1248 The device is examined to see if it is
1249 (1) an active md array, or
1250 (2) a component of an md array.
1251 The information discovered is reported.
1252
1253 .TP
1254 --detail
1255 The device should be an active md device.
1256 .B mdadm
1257 will display a detailed description of the array.
1258 .B --brief
1259 or
1260 .B --scan
1261 will cause the output to be less detailed and the format to be
1262 suitable for inclusion in
1263 .BR /etc/mdadm.conf .
1264 The exit status of
1265 .I mdadm
1266 will normally be 0 unless
1267 .I mdadm
1268 failed to get useful information about the device(s). However if the
1269 .B --test
1270 option is given, then the exit status will be:
1271 .RS
1272 .TP
1273 0
1274 The array is functioning normally.
1275 .TP
1276 1
1277 The array has at least one failed device.
1278 .TP
1279 2
1280 The array has multiple failed devices and hence is unusable (raid4 or
1281 raid5).
1282 .TP
1283 4
1284 There was an error while trying to get information about the device.
1285 .RE
1286
1287 .TP
1288 --examine
1289 The device should be a component of an md array.
1290 .B mdadm
1291 will read the md superblock of the device and display the contents.
1292 If
1293 .B --brief
1294 is given, or
1295 .B --scan
1296 then multiple devices that are components of the one array
1297 are grouped together and reported in a single entry suitable
1298 for inclusion in
1299 .BR /etc/mdadm.conf .
1300
1301 Having
1302 .B --scan
1303 without listing any devices will cause all devices listed in the
1304 config file to be examined.
1305
1306 .TP
1307 --stop
1308 The devices should be active md arrays which will be deactivated, as
1309 long as they are not currently in use.
1310
1311 .TP
1312 --run
1313 This will fully activate a partially assembled md array.
1314
1315 .TP
1316 --readonly
1317 This will mark an active array as read-only, providing that it is
1318 not currently being used.
1319
1320 .TP
1321 --readwrite
1322 This will change a
1323 .B readonly
1324 array back to being read/write.
1325
1326 .TP
1327 --scan
1328 For all operations except
1329 .BR --examine ,
1330 .B --scan
1331 will cause the operation to be applied to all arrays listed in
1332 .BR /proc/mdstat .
1333 For
1334 .BR --examine,
1335 .B --scan
1336 causes all devices listed in the config file to be examined.
1337
1338
1339 .SH MONITOR MODE
1340
1341 .HP 12
1342 Usage:
1343 .B mdadm --monitor
1344 .I options... devices...
1345
1346 .PP
1347 This usage causes
1348 .B mdadm
1349 to periodically poll a number of md arrays and to report on any events
1350 noticed.
1351 .B mdadm
1352 will never exit once it decides that there are arrays to be checked,
1353 so it should normally be run in the background.
1354
1355 As well as reporting events,
1356 .B mdadm
1357 may move a spare drive from one array to another if they are in the
1358 same
1359 .B spare-group
1360 and if the destination array has a failed drive but no spares.
1361
1362 If any devices are listed on the command line,
1363 .B mdadm
1364 will only monitor those devices. Otherwise all arrays listed in the
1365 configuration file will be monitored. Further, if
1366 .B --scan
1367 is given, then any other md devices that appear in
1368 .B /proc/mdstat
1369 will also be monitored.
1370
1371 The result of monitoring the arrays is the generation of events.
1372 These events are passed to a separate program (if specified) and may
1373 be mailed to a given E-mail address.
1374
1375 When passing event to program, the program is run once for each event
1376 and is given 2 or 3 command-line arguments. The first is the
1377 name of the event (see below). The second is the name of the
1378 md device which is affected, and the third is the name of a related
1379 device if relevant, such as a component device that has failed.
1380
1381 If
1382 .B --scan
1383 is given, then a program or an E-mail address must be specified on the
1384 command line or in the config file. If neither are available, then
1385 .B mdadm
1386 will not monitor anything.
1387 Without
1388 .B --scan
1389 .B mdadm
1390 will continue monitoring as long as something was found to monitor. If
1391 no program or email is given, then each event is reported to
1392 .BR stdout .
1393
1394 The different events are:
1395
1396 .RS 4
1397 .TP
1398 .B DeviceDisappeared
1399 An md array which previously was configured appears to no longer be
1400 configured. (syslog priority: Critical)
1401
1402 If
1403 .I mdadm
1404 was told to monitor an array which is RAID0 or Linear, then it will
1405 report
1406 .B DeviceDisappeared
1407 with the extra information
1408 .BR Wrong-Level .
1409 This is because RAID0 and Linear do not support the device-failed,
1410 hot-spare and resync operations which are monitored.
1411
1412 .TP
1413 .B RebuildStarted
1414 An md array started reconstruction. (syslog priority: Warning)
1415
1416 .TP
1417 .BI Rebuild NN
1418 Where
1419 .I NN
1420 is 20, 40, 60, or 80, this indicates that rebuild has passed that many
1421 percentage of the total. (syslog priority: Warning)
1422
1423 .TP
1424 .B RebuildFinished
1425 An md array that was rebuilding, isn't any more, either because it
1426 finished normally or was aborted. (syslog priority: Warning)
1427
1428 .TP
1429 .B Fail
1430 An active component device of an array has been marked as
1431 faulty. (syslog priority: Critical)
1432
1433 .TP
1434 .B FailSpare
1435 A spare component device which was being rebuilt to replace a faulty
1436 device has failed. (syslog priority: Critial)
1437
1438 .TP
1439 .B SpareActive
1440 A spare component device which was being rebuilt to replace a faulty
1441 device has been successfully rebuilt and has been made active.
1442 (syslog priority: Info)
1443
1444 .TP
1445 .B NewArray
1446 A new md array has been detected in the
1447 .B /proc/mdstat
1448 file. (syslog priority: Info)
1449
1450 .TP
1451 .B DegradedArray
1452 A newly noticed array appears to be degraded. This message is not
1453 generated when
1454 .I mdadm
1455 notices a drive failure which causes degradation, but only when
1456 .I mdadm
1457 notices that an array is degraded when it first sees the array.
1458 (syslog priority: Critial)
1459
1460 .TP
1461 .B MoveSpare
1462 A spare drive has been moved from one array in a
1463 .B spare-group
1464 to another to allow a failed drive to be replaced.
1465 (syslog priority: Info)
1466
1467 .TP
1468 .B SparesMissing
1469 If
1470 .I mdadm
1471 has been told, via the config file, that an array should have a certain
1472 number of spare devices, and
1473 .I mdadm
1474 detects that it has fewer that this number when it first sees the
1475 array, it will report a
1476 .B SparesMissing
1477 message.
1478 (syslog priority: Warning)
1479
1480 .TP
1481 .B TestMessage
1482 An array was found at startup, and the
1483 .B --test
1484 flag was given.
1485 (syslog priority: Info)
1486 .RE
1487
1488 Only
1489 .B Fail ,
1490 .B FailSpare ,
1491 .B DegradedArray ,
1492 .B SparesMissing ,
1493 and
1494 .B TestMessage
1495 cause Email to be sent. All events cause the program to be run.
1496 The program is run with two or three arguments, they being the event
1497 name, the array device and possibly a second device.
1498
1499 Each event has an associated array device (e.g.
1500 .BR /dev/md1 )
1501 and possibly a second device. For
1502 .BR Fail ,
1503 .BR FailSpare ,
1504 and
1505 .B SpareActive
1506 the second device is the relevant component device.
1507 For
1508 .B MoveSpare
1509 the second device is the array that the spare was moved from.
1510
1511 For
1512 .B mdadm
1513 to move spares from one array to another, the different arrays need to
1514 be labelled with the same
1515 .B spare-group
1516 in the configuration file. The
1517 .B spare-group
1518 name can be any string. It is only necessary that different spare
1519 groups use different names.
1520
1521 When
1522 .B mdadm
1523 detects that an array which is in a spare group has fewer active
1524 devices than necessary for the complete array, and has no spare
1525 devices, it will look for another array in the same spare group that
1526 has a full complement of working drive and a spare. It will then
1527 attempt to remove the spare from the second drive and add it to the
1528 first.
1529 If the removal succeeds but the adding fails, then it is added back to
1530 the original array.
1531
1532 .SH GROW MODE
1533 The GROW mode is used for changing the size or shape of an active
1534 array.
1535 For this to work, the kernel must support the necessary change.
1536 Various types of growth are being added during 2.6 development,
1537 including restructuring a raid5 array to have more active devices.
1538
1539 Currently the only support available is to
1540 .IP \(bu 4
1541 change the "size" attribute
1542 for RAID1, RAID5 and RAID6.
1543 .IP \(bu 4
1544 increase the "raid-disks" attribute of RAID1 and RAID5.
1545 .IP \(bu 4
1546 add a write-intent bitmap to any array which support these bitmaps, or
1547 remove a write-intent bitmap from such an array.
1548 .PP
1549
1550 .SS SIZE CHANGES
1551 Normally when an array is built the "size" it taken from the smallest
1552 of the drives. If all the small drives in an arrays are, one at a
1553 time, removed and replaced with larger drives, then you could have an
1554 array of large drives with only a small amount used. In this
1555 situation, changing the "size" with "GROW" mode will allow the extra
1556 space to start being used. If the size is increased in this way, a
1557 "resync" process will start to make sure the new parts of the array
1558 are synchronised.
1559
1560 Note that when an array changes size, any filesystem that may be
1561 stored in the array will not automatically grow to use the space. The
1562 filesystem will need to be explicitly told to use the extra space.
1563
1564 .SS RAID-DEVICES CHANGES
1565
1566 A RAID1 array can work with any number of devices from 1 upwards
1567 (though 1 is not very useful). There may be times which you want to
1568 increase or decrease the number of active devices. Note that this is
1569 different to hot-add or hot-remove which changes the number of
1570 inactive devices.
1571
1572 When reducing the number of devices in a RAID1 array, the slots which
1573 are to be removed from the array must already be vacant. That is, the
1574 devices that which were in those slots must be failed and removed.
1575
1576 When the number of devices is increased, any hot spares that are
1577 present will be activated immediately.
1578
1579 Increasing the number of active devices in a RAID5 is much more
1580 effort. Every block in the array will need to be read and written
1581 back to a new location. From 2.6.17, the Linux Kernel is able to do
1582 this safely, including restart and interrupted "reshape".
1583
1584 When relocating the first few stripes on a raid5, it is not possible
1585 to keep the data on disk completely consistent and crash-proof. To
1586 provide the required safety, mdadm disables writes to the array while
1587 this "critical section" is reshaped, and takes a backup of the data
1588 that is in that section. This backup is normally stored in any spare
1589 devices that the array has, however it can also be stored in a
1590 separate file specified with the
1591 .B --backup-file
1592 option. If this option is used, and the system does crash during the
1593 critical period, the same file must be passed to
1594 .B --assemble
1595 to restore the backup and reassemble the array.
1596
1597 .SS BITMAP CHANGES
1598
1599 A write-intent bitmap can be added to, or removed from, an active
1600 array. Either internal bitmaps, or bitmaps stored in a separate file
1601 can be added. Note that if you add a bitmap stored in a file which is
1602 in a filesystem that is on the raid array being affected, the system
1603 will deadlock. The bitmap must be on a separate filesystem.
1604
1605 .SH EXAMPLES
1606
1607 .B " mdadm --query /dev/name-of-device"
1608 .br
1609 This will find out if a given device is a raid array, or is part of
1610 one, and will provide brief information about the device.
1611
1612 .B " mdadm --assemble --scan"
1613 .br
1614 This will assemble and start all arrays listed in the standard config file
1615 file. This command will typically go in a system startup file.
1616
1617 .B " mdadm --stop --scan"
1618 .br
1619 This will shut down all array that can be shut down (i.e. are not
1620 currently in use). This will typically go in a system shutdown script.
1621
1622 .B " mdadm --follow --scan --delay=120"
1623 .br
1624 If (and only if) there is an Email address or program given in the
1625 standard config file, then
1626 monitor the status of all arrays listed in that file by
1627 polling them ever 2 minutes.
1628
1629 .B " mdadm --create /dev/md0 --level=1 --raid-devices=2 /dev/hd[ac]1"
1630 .br
1631 Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.
1632
1633 .br
1634 .B " echo 'DEVICE /dev/hd*[0-9] /dev/sd*[0-9]' > mdadm.conf"
1635 .br
1636 .B " mdadm --detail --scan >> mdadm.conf"
1637 .br
1638 This will create a prototype config file that describes currently
1639 active arrays that are known to be made from partitions of IDE or SCSI drives.
1640 This file should be reviewed before being used as it may
1641 contain unwanted detail.
1642
1643 .B " echo 'DEVICE /dev/hd[a-z] /dev/sd*[a-z]' > mdadm.conf"
1644 .br
1645 .B " mdadm --examine --scan --config=mdadm.conf >> mdadm.conf"
1646 .ber
1647 This will find what arrays could be assembled from existing IDE and
1648 SCSI whole drives (not partitions) and store the information is the
1649 format of a config file.
1650 This file is very likely to contain unwanted detail, particularly
1651 the
1652 .B devices=
1653 entries. It should be reviewed and edited before being used as an
1654 actual config file.
1655
1656 .B " mdadm --examine --brief --scan --config=partitions"
1657 .br
1658 .B " mdadm -Ebsc partitions"
1659 .br
1660 Create a list of devices by reading
1661 .BR /proc/partitions ,
1662 scan these for RAID superblocks, and printout a brief listing of all
1663 that was found.
1664
1665 .B " mdadm -Ac partitions -m 0 /dev/md0"
1666 .br
1667 Scan all partitions and devices listed in
1668 .BR /proc/partitions
1669 and assemble
1670 .B /dev/md0
1671 out of all such devices with a RAID superblock with a minor number of 0.
1672
1673 .B " mdadm --monitor --scan --daemonise > /var/run/mdadm"
1674 .br
1675 If config file contains a mail address or alert program, run mdadm in
1676 the background in monitor mode monitoring all md devices. Also write
1677 pid of mdadm daemon to
1678 .BR /var/run/mdadm .
1679
1680 .B " mdadm --create --help"
1681 .br
1682 Provide help about the Create mode.
1683
1684 .B " mdadm --config --help"
1685 .br
1686 Provide help about the format of the config file.
1687
1688 .B " mdadm --help"
1689 .br
1690 Provide general help.
1691
1692
1693 .SH FILES
1694
1695 .SS /proc/mdstat
1696
1697 If you're using the
1698 .B /proc
1699 filesystem,
1700 .B /proc/mdstat
1701 lists all active md devices with information about them.
1702 .B mdadm
1703 uses this to find arrays when
1704 .B --scan
1705 is given in Misc mode, and to monitor array reconstruction
1706 on Monitor mode.
1707
1708
1709 .SS /etc/mdadm.conf
1710
1711 The config file lists which devices may be scanned to see if
1712 they contain MD super block, and gives identifying information
1713 (e.g. UUID) about known MD arrays. See
1714 .BR mdadm.conf (5)
1715 for more details.
1716
1717 .SH DEVICE NAMES
1718
1719 While entries in the /dev directory can have any format you like,
1720 .I mdadm
1721 has an understanding of 'standard' formats which it uses to guide its
1722 behaviour when creating device files via the
1723 .I --auto
1724 option.
1725
1726 The standard names for non-partitioned arrays (the only sort of md
1727 array available in 2.4 and earlier) either of
1728 .IP
1729 /dev/mdNN
1730 .br
1731 /dev/md/NN
1732 .PP
1733 where NN is a number.
1734 The standard names for partitionable arrays (as available from 2.6
1735 onwards) is one of
1736 .IP
1737 /dev/md/dNN
1738 .br
1739 /dev/md_dNN
1740 .PP
1741 Partition numbers should be indicated by added "pMM" to these, thus "/dev/md/d1p2".
1742
1743 .SH NOTE
1744 .B mdadm
1745 was previously known as
1746 .BR mdctl .
1747 .P
1748 .B mdadm
1749 is completely separate from the
1750 .B raidtools
1751 package, and does not use the
1752 .I /etc/raidtab
1753 configuration file at all.
1754
1755 .SH SEE ALSO
1756 For information on the various levels of
1757 RAID, check out:
1758
1759 .IP
1760 .UR http://ostenfeld.dk/~jakob/Software-RAID.HOWTO/
1761 http://ostenfeld.dk/~jakob/Software-RAID.HOWTO/
1762 .UE
1763 '''.PP
1764 '''for new releases of the RAID driver check out:
1765 '''
1766 '''.IP
1767 '''.UR ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
1768 '''ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
1769 '''.UE
1770 '''.PP
1771 '''or
1772 '''.IP
1773 '''.UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
1774 '''http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
1775 '''.UE
1776 .PP
1777 The latest version of
1778 .I mdadm
1779 should always be available from
1780 .IP
1781 .UR http://www.kernel.org/pub/linux/utils/raid/mdadm/
1782 http://www.kernel.org/pub/linux/utils/raid/mdadm/
1783 .UE
1784 .PP
1785 .IR mdadm.conf (5),
1786 .IR md (4).
1787 .PP
1788 .IR raidtab (5),
1789 .IR raid0run (8),
1790 .IR raidstop (8),
1791 .IR mkraid (8).