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