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