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