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