2 .\" Copyright Neil Brown and others.
3 .\" This program is free software; you can redistribute it and/or modify
4 .\" it under the terms of the GNU General Public License as published by
5 .\" the Free Software Foundation; either version 2 of the License, or
6 .\" (at your option) any later version.
7 .\" See file COPYING in distribution for details.
10 mdadm \- manage MD devices
16 .BI mdadm " [mode] <raiddevice> [options] <component-devices>"
19 RAID devices are virtual devices created from two or more
20 real block devices. This allows multiple devices (typically disk
21 drives or partitions thereof) to be combined into a single device to
22 hold (for example) a single filesystem.
23 Some RAID levels include redundancy and so can survive some degree of
26 Linux Software RAID devices are implemented through the md (Multiple
27 Devices) device driver.
29 Currently, Linux supports
46 is not a Software RAID mechanism, but does involve
48 each device is a path to one common physical storage device.
49 New installations should not use md/multipath as it is not well
50 supported and has no ongoing development. Use the Device Mapper based
51 multipath-tools instead.
54 is also not true RAID, and it only involves one device. It
55 provides a layer over a true device that can be used to inject faults.
60 is a collection of devices that are
61 managed as a set. This is similar to the set of devices connected to
62 a hardware RAID controller. The set of devices may contain a number
63 of different RAID arrays each utilising some (or all) of the blocks from a
64 number of the devices in the set. For example, two devices in a 5-device set
65 might form a RAID1 using the whole devices. The remaining three might
66 have a RAID5 over the first half of each device, and a RAID0 over the
71 there is one set of metadata that describes all of
72 the arrays in the container. So when
76 device, the device just represents the metadata. Other normal arrays (RAID1
77 etc) can be created inside the container.
80 mdadm has several major modes of operation:
83 Assemble the components of a previously created
84 array into an active array. Components can be explicitly given
85 or can be searched for.
87 checks that the components
88 do form a bona fide array, and can, on request, fiddle superblock
89 information so as to assemble a faulty array.
93 Build an array that doesn't have per-device metadata (superblocks). For these
96 cannot differentiate between initial creation and subsequent assembly
97 of an array. It also cannot perform any checks that appropriate
98 components have been requested. Because of this, the
100 mode should only be used together with a complete understanding of
105 Create a new array with per-device metadata (superblocks).
106 Appropriate metadata is written to each device, and then the array
107 comprising those devices is activated. A 'resync' process is started
108 to make sure that the array is consistent (e.g. both sides of a mirror
109 contain the same data) but the content of the device is left otherwise
111 The array can be used as soon as it has been created. There is no
112 need to wait for the initial resync to finish.
115 .B "Follow or Monitor"
116 Monitor one or more md devices and act on any state changes. This is
117 only meaningful for RAID1, 4, 5, 6, 10 or multipath arrays, as
118 only these have interesting state. RAID0 or Linear never have
119 missing, spare, or failed drives, so there is nothing to monitor.
123 Grow (or shrink) an array, or otherwise reshape it in some way.
124 Currently supported growth options including changing the active size
125 of component devices and changing the number of active devices in
126 Linear and RAID levels 0/1/4/5/6,
127 changing the RAID level between 0, 1, 5, and 6, and between 0 and 10,
128 changing the chunk size and layout for RAID 0,4,5,6, as well as adding or
129 removing a write-intent bitmap.
132 .B "Incremental Assembly"
133 Add a single device to an appropriate array. If the addition of the
134 device makes the array runnable, the array will be started.
135 This provides a convenient interface to a
137 system. As each device is detected,
139 has a chance to include it in some array as appropriate.
142 flag is passed in we will remove the device from any active array
143 instead of adding it.
149 in this mode, then any arrays within that container will be assembled
154 This is for doing things to specific components of an array such as
155 adding new spares and removing faulty devices.
159 This is an 'everything else' mode that supports operations on active
160 arrays, operations on component devices such as erasing old superblocks, and
161 information gathering operations.
162 .\"This mode allows operations on independent devices such as examine MD
163 .\"superblocks, erasing old superblocks and stopping active arrays.
167 This mode does not act on a specific device or array, but rather it
168 requests the Linux Kernel to activate any auto-detected arrays.
171 .SH Options for selecting a mode are:
174 .BR \-A ", " \-\-assemble
175 Assemble a pre-existing array.
178 .BR \-B ", " \-\-build
179 Build a legacy array without superblocks.
182 .BR \-C ", " \-\-create
186 .BR \-F ", " \-\-follow ", " \-\-monitor
192 .BR \-G ", " \-\-grow
193 Change the size or shape of an active array.
196 .BR \-I ", " \-\-incremental
197 Add/remove a single device to/from an appropriate array, and possibly start the array.
201 Request that the kernel starts any auto-detected arrays. This can only
204 is compiled into the kernel \(em not if it is a module.
205 Arrays can be auto-detected by the kernel if all the components are in
206 primary MS-DOS partitions with partition type
208 and all use v0.90 metadata.
209 In-kernel autodetect is not recommended for new installations. Using
211 to detect and assemble arrays \(em possibly in an
213 \(em is substantially more flexible and should be preferred.
216 If a device is given before any options, or if the first option is
221 then the MANAGE mode is assumed.
222 Anything other than these will cause the
226 .SH Options that are not mode-specific are:
229 .BR \-h ", " \-\-help
230 Display general help message or, after one of the above options, a
231 mode-specific help message.
235 Display more detailed help about command line parsing and some commonly
239 .BR \-V ", " \-\-version
240 Print version information for mdadm.
243 .BR \-v ", " \-\-verbose
244 Be more verbose about what is happening. This can be used twice to be
246 The extra verbosity currently only affects
247 .B \-\-detail \-\-scan
249 .BR "\-\-examine \-\-scan" .
252 .BR \-q ", " \-\-quiet
253 Avoid printing purely informative messages. With this,
255 will be silent unless there is something really important to report.
259 Set first character of argv[0] to @ to indicate mdadm was launched
260 from initrd/initramfs and should not be shutdown by systemd as part of
261 the regular shutdown process. This option is normally only used by
262 the system's initscripts. Please see here for more details on how
263 systemd handled argv[0]:
265 .B http://www.freedesktop.org/wiki/Software/systemd/RootStorageDaemons
270 .BR \-f ", " \-\-force
271 Be more forceful about certain operations. See the various modes for
272 the exact meaning of this option in different contexts.
275 .BR \-c ", " \-\-config=
276 Specify the config file. Default is to use
277 .BR /etc/mdadm.conf ,
278 or if that is missing then
279 .BR /etc/mdadm/mdadm.conf .
280 If the config file given is
282 then nothing will be read, but
284 will act as though the config file contained exactly
285 .B "DEVICE partitions containers"
288 to find a list of devices to scan, and
290 to find a list of containers to examine.
293 is given for the config file, then
295 will act as though the config file were empty.
298 .BR \-s ", " \-\-scan
301 for missing information.
302 In general, this option gives
304 permission to get any missing information (like component devices,
305 array devices, array identities, and alert destination) from the
306 configuration file (see previous option);
307 one exception is MISC mode when using
313 says to get a list of array devices from
317 .BR \-e ", " \-\-metadata=
318 Declare the style of RAID metadata (superblock) to be used. The
319 default is {DEFAULT_METADATA} for
321 and to guess for other operations.
322 The default can be overridden by setting the
331 .ie '{DEFAULT_METADATA}'0.90'
332 .IP "0, 0.90, default"
336 Use the original 0.90 format superblock. This format limits arrays to
337 28 component devices and limits component devices of levels 1 and
338 greater to 2 terabytes. It is also possible for there to be confusion
339 about whether the superblock applies to a whole device or just the
340 last partition, if that partition starts on a 64K boundary.
341 .ie '{DEFAULT_METADATA}'0.90'
342 .IP "1, 1.0, 1.1, 1.2"
344 .IP "1, 1.0, 1.1, 1.2 default"
346 Use the new version-1 format superblock. This has fewer restrictions.
347 It can easily be moved between hosts with different endian-ness, and a
348 recovery operation can be checkpointed and restarted. The different
349 sub-versions store the superblock at different locations on the
350 device, either at the end (for 1.0), at the start (for 1.1) or 4K from
351 the start (for 1.2). "1" is equivalent to "1.2" (the commonly
352 preferred 1.x format).
353 'if '{DEFAULT_METADATA}'1.2' "default" is equivalent to "1.2".
355 Use the "Industry Standard" DDF (Disk Data Format) format defined by
357 When creating a DDF array a
359 will be created, and normal arrays can be created in that container.
361 Use the Intel(R) Matrix Storage Manager metadata format. This creates a
363 which is managed in a similar manner to DDF, and is supported by an
364 option-rom on some platforms:
366 .B http://www.intel.com/design/chipsets/matrixstorage_sb.htm
372 This will override any
374 setting in the config file and provides the identity of the host which
375 should be considered the home for any arrays.
377 When creating an array, the
379 will be recorded in the metadata. For version-1 superblocks, it will
380 be prefixed to the array name. For version-0.90 superblocks, part of
381 the SHA1 hash of the hostname will be stored in the later half of the
384 When reporting information about an array, any array which is tagged
385 for the given homehost will be reported as such.
387 When using Auto-Assemble, only arrays tagged for the given homehost
388 will be allowed to use 'local' names (i.e. not ending in '_' followed
389 by a digit string). See below under
390 .BR "Auto Assembly" .
396 needs to print the name for a device it normally finds the name in
398 which refers to the device and is shortest. When a path component is
402 will prefer a longer name if it contains that component. For example
403 .B \-\-prefer=by-uuid
404 will prefer a name in a subdirectory of
409 This functionality is currently only provided by
414 .SH For create, build, or grow:
417 .BR \-n ", " \-\-raid\-devices=
418 Specify the number of active devices in the array. This, plus the
419 number of spare devices (see below) must equal the number of
421 (including "\fBmissing\fP" devices)
422 that are listed on the command line for
424 Setting a value of 1 is probably
425 a mistake and so requires that
427 be specified first. A value of 1 will then be allowed for linear,
428 multipath, RAID0 and RAID1. It is never allowed for RAID4, RAID5 or RAID6.
430 This number can only be changed using
432 for RAID1, RAID4, RAID5 and RAID6 arrays, and only on kernels which provide
433 the necessary support.
436 .BR \-x ", " \-\-spare\-devices=
437 Specify the number of spare (eXtra) devices in the initial array.
438 Spares can also be added
439 and removed later. The number of component devices listed
440 on the command line must equal the number of RAID devices plus the
441 number of spare devices.
444 .BR \-z ", " \-\-size=
445 Amount (in Kibibytes) of space to use from each drive in RAID levels 1/4/5/6.
446 This must be a multiple of the chunk size, and must leave about 128Kb
447 of space at the end of the drive for the RAID superblock.
448 If this is not specified
449 (as it normally is not) the smallest drive (or partition) sets the
450 size, though if there is a variance among the drives of greater than 1%, a warning is
453 A suffix of 'M' or 'G' can be given to indicate Megabytes or
454 Gigabytes respectively.
456 Sometimes a replacement drive can be a little smaller than the
457 original drives though this should be minimised by IDEMA standards.
458 Such a replacement drive will be rejected by
460 To guard against this it can be useful to set the initial size
461 slightly smaller than the smaller device with the aim that it will
462 still be larger than any replacement.
464 This value can be set with
466 for RAID level 1/4/5/6 though
468 based arrays such as those with IMSM metadata may not be able to
470 If the array was created with a size smaller than the currently
471 active drives, the extra space can be accessed using
473 The size can be given as
475 which means to choose the largest size that fits on all current drives.
477 Before reducing the size of the array (with
478 .BR "\-\-grow \-\-size=" )
479 you should make sure that space isn't needed. If the device holds a
480 filesystem, you would need to resize the filesystem to use less space.
482 After reducing the array size you should check that the data stored in
483 the device is still available. If the device holds a filesystem, then
484 an 'fsck' of the filesystem is a minimum requirement. If there are
485 problems the array can be made bigger again with no loss with another
486 .B "\-\-grow \-\-size="
489 This value cannot be used when creating a
491 such as with DDF and IMSM metadata, though it perfectly valid when
492 creating an array inside a container.
495 .BR \-Z ", " \-\-array\-size=
496 This is only meaningful with
498 and its effect is not persistent: when the array is stopped and
499 restarted the default array size will be restored.
501 Setting the array-size causes the array to appear smaller to programs
502 that access the data. This is particularly needed before reshaping an
503 array so that it will be smaller. As the reshape is not reversible,
504 but setting the size with
506 is, it is required that the array size is reduced as appropriate
507 before the number of devices in the array is reduced.
509 Before reducing the size of the array you should make sure that space
510 isn't needed. If the device holds a filesystem, you would need to
511 resize the filesystem to use less space.
513 After reducing the array size you should check that the data stored in
514 the device is still available. If the device holds a filesystem, then
515 an 'fsck' of the filesystem is a minimum requirement. If there are
516 problems the array can be made bigger again with no loss with another
517 .B "\-\-grow \-\-array\-size="
520 A suffix of 'M' or 'G' can be given to indicate Megabytes or
521 Gigabytes respectively.
524 restores the apparent size of the array to be whatever the real
525 amount of available space is.
528 .BR \-c ", " \-\-chunk=
529 Specify chunk size of kibibytes. The default when creating an
530 array is 512KB. To ensure compatibility with earlier versions, the
531 default when Building and array with no persistent metadata is 64KB.
532 This is only meaningful for RAID0, RAID4, RAID5, RAID6, and RAID10.
534 RAID4, RAID5, RAID6, and RAID10 require the chunk size to be a power
535 of 2. In any case it must be a multiple of 4KB.
537 A suffix of 'M' or 'G' can be given to indicate Megabytes or
538 Gigabytes respectively.
542 Specify rounding factor for a Linear array. The size of each
543 component will be rounded down to a multiple of this size.
544 This is a synonym for
546 but highlights the different meaning for Linear as compared to other
547 RAID levels. The default is 64K if a kernel earlier than 2.6.16 is in
548 use, and is 0K (i.e. no rounding) in later kernels.
551 .BR \-l ", " \-\-level=
552 Set RAID level. When used with
554 options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4,
555 raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty, container.
556 Obviously some of these are synonymous.
560 metadata type is requested, only the
562 level is permitted, and it does not need to be explicitly given.
566 only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid.
570 to change the RAID level in some cases. See LEVEL CHANGES below.
573 .BR \-p ", " \-\-layout=
574 This option configures the fine details of data layout for RAID5, RAID6,
575 and RAID10 arrays, and controls the failure modes for
578 The layout of the RAID5 parity block can be one of
579 .BR left\-asymmetric ,
580 .BR left\-symmetric ,
581 .BR right\-asymmetric ,
582 .BR right\-symmetric ,
583 .BR la ", " ra ", " ls ", " rs .
585 .BR left\-symmetric .
587 It is also possible to cause RAID5 to use a RAID4-like layout by
593 Finally for RAID5 there are DDF\-compatible layouts,
594 .BR ddf\-zero\-restart ,
595 .BR ddf\-N\-restart ,
597 .BR ddf\-N\-continue .
599 These same layouts are available for RAID6. There are also 4 layouts
600 that will provide an intermediate stage for converting between RAID5
601 and RAID6. These provide a layout which is identical to the
602 corresponding RAID5 layout on the first N\-1 devices, and has the 'Q'
603 syndrome (the second 'parity' block used by RAID6) on the last device.
605 .BR left\-symmetric\-6 ,
606 .BR right\-symmetric\-6 ,
607 .BR left\-asymmetric\-6 ,
608 .BR right\-asymmetric\-6 ,
610 .BR parity\-first\-6 .
612 When setting the failure mode for level
615 .BR write\-transient ", " wt ,
616 .BR read\-transient ", " rt ,
617 .BR write\-persistent ", " wp ,
618 .BR read\-persistent ", " rp ,
620 .BR read\-fixable ", " rf ,
621 .BR clear ", " flush ", " none .
623 Each failure mode can be followed by a number, which is used as a period
624 between fault generation. Without a number, the fault is generated
625 once on the first relevant request. With a number, the fault will be
626 generated after that many requests, and will continue to be generated
627 every time the period elapses.
629 Multiple failure modes can be current simultaneously by using the
631 option to set subsequent failure modes.
633 "clear" or "none" will remove any pending or periodic failure modes,
634 and "flush" will clear any persistent faults.
636 Finally, the layout options for RAID10 are one of 'n', 'o' or 'f' followed
637 by a small number. The default is 'n2'. The supported options are:
640 signals 'near' copies. Multiple copies of one data block are at
641 similar offsets in different devices.
644 signals 'offset' copies. Rather than the chunks being duplicated
645 within a stripe, whole stripes are duplicated but are rotated by one
646 device so duplicate blocks are on different devices. Thus subsequent
647 copies of a block are in the next drive, and are one chunk further
652 (multiple copies have very different offsets).
653 See md(4) for more detail about 'near', 'offset', and 'far'.
655 The number is the number of copies of each datablock. 2 is normal, 3
656 can be useful. This number can be at most equal to the number of
657 devices in the array. It does not need to divide evenly into that
658 number (e.g. it is perfectly legal to have an 'n2' layout for an array
659 with an odd number of devices).
661 When an array is converted between RAID5 and RAID6 an intermediate
662 RAID6 layout is used in which the second parity block (Q) is always on
663 the last device. To convert a RAID5 to RAID6 and leave it in this new
664 layout (which does not require re-striping) use
665 .BR \-\-layout=preserve .
666 This will try to avoid any restriping.
668 The converse of this is
669 .B \-\-layout=normalise
670 which will change a non-standard RAID6 layout into a more standard
677 (thus explaining the p of
681 .BR \-b ", " \-\-bitmap=
682 Specify a file to store a write-intent bitmap in. The file should not
685 is also given. The same file should be provided
686 when assembling the array. If the word
688 is given, then the bitmap is stored with the metadata on the array,
689 and so is replicated on all devices. If the word
693 mode, then any bitmap that is present is removed.
695 To help catch typing errors, the filename must contain at least one
696 slash ('/') if it is a real file (not 'internal' or 'none').
698 Note: external bitmaps are only known to work on ext2 and ext3.
699 Storing bitmap files on other filesystems may result in serious problems.
702 .BR \-\-bitmap\-chunk=
703 Set the chunksize of the bitmap. Each bit corresponds to that many
704 Kilobytes of storage.
705 When using a file based bitmap, the default is to use the smallest
706 size that is at-least 4 and requires no more than 2^21 chunks.
709 bitmap, the chunksize defaults to 64Meg, or larger if necessary to
710 fit the bitmap into the available space.
712 A suffix of 'M' or 'G' can be given to indicate Megabytes or
713 Gigabytes respectively.
716 .BR \-W ", " \-\-write\-mostly
717 subsequent devices listed in a
722 command will be flagged as 'write-mostly'. This is valid for RAID1
723 only and means that the 'md' driver will avoid reading from these
724 devices if at all possible. This can be useful if mirroring over a
728 .BR \-\-write\-behind=
729 Specify that write-behind mode should be enabled (valid for RAID1
730 only). If an argument is specified, it will set the maximum number
731 of outstanding writes allowed. The default value is 256.
732 A write-intent bitmap is required in order to use write-behind
733 mode, and write-behind is only attempted on drives marked as
737 .BR \-\-assume\-clean
740 that the array pre-existed and is known to be clean. It can be useful
741 when trying to recover from a major failure as you can be sure that no
742 data will be affected unless you actually write to the array. It can
743 also be used when creating a RAID1 or RAID10 if you want to avoid the
744 initial resync, however this practice \(em while normally safe \(em is not
745 recommended. Use this only if you really know what you are doing.
747 When the devices that will be part of a new array were filled
748 with zeros before creation the operator knows the array is
749 actually clean. If that is the case, such as after running
750 badblocks, this argument can be used to tell mdadm the
751 facts the operator knows.
753 When an array is resized to a larger size with
754 .B "\-\-grow \-\-size="
755 the new space is normally resynced in that same way that the whole
756 array is resynced at creation. From Linux version 3.0,
758 can be used with that command to avoid the automatic resync.
761 .BR \-\-backup\-file=
764 is used to increase the number of raid-devices in a RAID5 or RAID6 if
765 there are no spare devices available, or to shrink, change RAID level
766 or layout. See the GROW MODE section below on RAID\-DEVICES CHANGES.
767 The file must be stored on a separate device, not on the RAID array
772 Arrays with 1.x metadata can leave a gap between the start of the
773 device and the start of array data. This gap can be used for various
774 metadata. The start of data is known as the
776 Normally an appropriate data offset is computed automatically.
777 However it can be useful to set it explicitly such as when re-creating
778 an array which was originally created using a different version of
780 which computed a different offset.
782 Setting the offset explicitly over-rides the default. The value given
783 is in Kilobytes unless an 'M' or 'G' suffix is given.
787 can also be used with
789 for some RAID levels (initially on RAID10). This allows the
790 data\-offset to be changed as part of the reshape process. When the
791 data offset is changed, no backup file is required as the difference
792 in offsets is used to provide the same functionality.
794 When the new offset is earlier than the old offset, the number of
795 devices in the array cannot shrink. When it is after the old offset,
796 the number of devices in the array cannot increase.
798 When creating an array,
802 In the case each member device is expected to have a offset appended
803 to the name, separated by a colon. This makes it possible to recreate
804 exactly an array which has varying data offsets (as can happen when
805 different versions of
807 are used to add different devices).
811 This option is complementary to the
812 .B \-\-freeze-reshape
813 option for assembly. It is needed when
815 operation is interrupted and it is not restarted automatically due to
816 .B \-\-freeze-reshape
817 usage during array assembly. This option is used together with
821 ) command and device for a pending reshape to be continued.
822 All parameters required for reshape continuation will be read from array metadata.
826 .BR \-\-backup\-file=
827 option to be set, continuation option will require to have exactly the same
828 backup file given as well.
830 Any other parameter passed together with
832 option will be ignored.
835 .BR \-N ", " \-\-name=
838 for the array. This is currently only effective when creating an
839 array with a version-1 superblock, or an array in a DDF container.
840 The name is a simple textual string that can be used to identify array
841 components when assembling. If name is needed but not specified, it
842 is taken from the basename of the device that is being created.
854 run the array, even if some of the components
855 appear to be active in another array or filesystem. Normally
857 will ask for confirmation before including such components in an
858 array. This option causes that question to be suppressed.
861 .BR \-f ", " \-\-force
864 accept the geometry and layout specified without question. Normally
866 will not allow creation of an array with only one device, and will try
867 to create a RAID5 array with one missing drive (as this makes the
868 initial resync work faster). With
871 will not try to be so clever.
874 .BR \-o ", " \-\-readonly
877 rather than read-write as normal. No writes will be allowed to the
878 array, and no resync, recovery, or reshape will be started.
881 .BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}"
882 Instruct mdadm how to create the device file if needed, possibly allocating
883 an unused minor number. "md" causes a non-partitionable array
884 to be used (though since Linux 2.6.28, these array devices are in fact
885 partitionable). "mdp", "part" or "p" causes a partitionable array (2.6 and
886 later) to be used. "yes" requires the named md device to have
887 a 'standard' format, and the type and minor number will be determined
888 from this. With mdadm 3.0, device creation is normally left up to
890 so this option is unlikely to be needed.
891 See DEVICE NAMES below.
893 The argument can also come immediately after
898 is not given on the command line or in the config file, then
904 is also given, then any
906 entries in the config file will override the
908 instruction given on the command line.
910 For partitionable arrays,
912 will create the device file for the whole array and for the first 4
913 partitions. A different number of partitions can be specified at the
914 end of this option (e.g.
916 If the device name ends with a digit, the partition names add a 'p',
918 .IR /dev/md/home1p3 .
919 If there is no trailing digit, then the partition names just have a
921 .IR /dev/md/scratch3 .
923 If the md device name is in a 'standard' format as described in DEVICE
924 NAMES, then it will be created, if necessary, with the appropriate
925 device number based on that name. If the device name is not in one of these
926 formats, then a unused device number will be allocated. The device
927 number will be considered unused if there is no active array for that
928 number, and there is no entry in /dev for that number and with a
929 non-standard name. Names that are not in 'standard' format are only
930 allowed in "/dev/md/".
932 This is meaningful with
939 .\".BR \-\-symlink = no
944 .\"to create devices in
946 .\"it will also create symlinks from
948 .\"with names starting with
954 .\"to suppress this, or
955 .\".B \-\-symlink=yes
956 .\"to enforce this even if it is suppressing
962 .BR \-a ", " "\-\-add"
963 This option can be used in Grow mode in two cases.
965 If the target array is a Linear array, then
967 can be used to add one or more devices to the array. They
968 are simply catenated on to the end of the array. Once added, the
969 devices cannot be removed.
973 option is being used to increase the number of devices in an array,
976 can be used to add some extra devices to be included in the array.
977 In most cases this is not needed as the extra devices can be added as
978 spares first, and then the number of raid-disks can be changed.
979 However for RAID0, it is not possible to add spares. So to increase
980 the number of devices in a RAID0, it is necessary to set the new
981 number of devices, and to add the new devices, in the same command.
986 .BR \-u ", " \-\-uuid=
987 uuid of array to assemble. Devices which don't have this uuid are
991 .BR \-m ", " \-\-super\-minor=
992 Minor number of device that array was created for. Devices which
993 don't have this minor number are excluded. If you create an array as
994 /dev/md1, then all superblocks will contain the minor number 1, even if
995 the array is later assembled as /dev/md2.
997 Giving the literal word "dev" for
1001 to use the minor number of the md device that is being assembled.
1002 e.g. when assembling
1004 .B \-\-super\-minor=dev
1005 will look for super blocks with a minor number of 0.
1008 is only relevant for v0.90 metadata, and should not normally be used.
1014 .BR \-N ", " \-\-name=
1015 Specify the name of the array to assemble. This must be the name
1016 that was specified when creating the array. It must either match
1017 the name stored in the superblock exactly, or it must match
1020 prefixed to the start of the given name.
1023 .BR \-f ", " \-\-force
1024 Assemble the array even if the metadata on some devices appears to be
1027 cannot find enough working devices to start the array, but can find
1028 some devices that are recorded as having failed, then it will mark
1029 those devices as working so that the array can be started.
1030 An array which requires
1032 to be started may contain data corruption. Use it carefully.
1035 .BR \-R ", " \-\-run
1036 Attempt to start the array even if fewer drives were given than were
1037 present last time the array was active. Normally if not all the
1038 expected drives are found and
1040 is not used, then the array will be assembled but not started.
1043 an attempt will be made to start it anyway.
1047 This is the reverse of
1049 in that it inhibits the startup of array unless all expected drives
1050 are present. This is only needed with
1052 and can be used if the physical connections to devices are
1053 not as reliable as you would like.
1056 .BR \-a ", " "\-\-auto{=no,yes,md,mdp,part}"
1057 See this option under Create and Build options.
1060 .BR \-b ", " \-\-bitmap=
1061 Specify the bitmap file that was given when the array was created. If
1064 bitmap, there is no need to specify this when assembling the array.
1067 .BR \-\-backup\-file=
1070 was used while reshaping an array (e.g. changing number of devices or
1071 chunk size) and the system crashed during the critical section, then the same
1073 must be presented to
1075 to allow possibly corrupted data to be restored, and the reshape
1079 .BR \-\-invalid\-backup
1080 If the file needed for the above option is not available for any
1081 reason an empty file can be given together with this option to
1082 indicate that the backup file is invalid. In this case the data that
1083 was being rearranged at the time of the crash could be irrecoverably
1084 lost, but the rest of the array may still be recoverable. This option
1085 should only be used as a last resort if there is no way to recover the
1090 .BR \-U ", " \-\-update=
1091 Update the superblock on each device while assembling the array. The
1092 argument given to this flag can be one of
1109 option will adjust the superblock of an array what was created on a Sparc
1110 machine running a patched 2.2 Linux kernel. This kernel got the
1111 alignment of part of the superblock wrong. You can use the
1112 .B "\-\-examine \-\-sparc2.2"
1115 to see what effect this would have.
1119 option will update the
1120 .B "preferred minor"
1121 field on each superblock to match the minor number of the array being
1123 This can be useful if
1125 reports a different "Preferred Minor" to
1127 In some cases this update will be performed automatically
1128 by the kernel driver. In particular the update happens automatically
1129 at the first write to an array with redundancy (RAID level 1 or
1130 greater) on a 2.6 (or later) kernel.
1134 option will change the uuid of the array. If a UUID is given with the
1136 option that UUID will be used as a new UUID and will
1138 be used to help identify the devices in the array.
1141 is given, a random UUID is chosen.
1145 option will change the
1147 of the array as stored in the superblock. This is only supported for
1148 version-1 superblocks.
1152 option will change the
1154 as recorded in the superblock. For version-0 superblocks, this is the
1155 same as updating the UUID.
1156 For version-1 superblocks, this involves updating the name.
1160 option will cause the array to be marked
1162 meaning that any redundancy in the array (e.g. parity for RAID5,
1163 copies for RAID1) may be incorrect. This will cause the RAID system
1164 to perform a "resync" pass to make sure that all redundant information
1169 option allows arrays to be moved between machines with different
1171 When assembling such an array for the first time after a move, giving
1172 .B "\-\-update=byteorder"
1175 to expect superblocks to have their byteorder reversed, and will
1176 correct that order before assembling the array. This is only valid
1177 with original (Version 0.90) superblocks.
1181 option will correct the summaries in the superblock. That is the
1182 counts of total, working, active, failed, and spare devices.
1186 option will rarely be of use. It applies to version 1.1 and 1.2 metadata
1187 only (where the metadata is at the start of the device) and is only
1188 useful when the component device has changed size (typically become
1189 larger). The version 1 metadata records the amount of the device that
1190 can be used to store data, so if a device in a version 1.1 or 1.2
1191 array becomes larger, the metadata will still be visible, but the
1192 extra space will not. In this case it might be useful to assemble the
1194 .BR \-\-update=devicesize .
1197 to determine the maximum usable amount of space on each device and
1198 update the relevant field in the metadata.
1202 option can be used when an array has an internal bitmap which is
1203 corrupt in some way so that assembling the array normally fails. It
1204 will cause any internal bitmap to be ignored.
1208 option will reserve space in each device for a bad block list. This
1209 will be 4K in size and positioned near the end of any free space
1210 between the superblock and the data.
1214 option will cause any reservation of space for a bad block list to be
1215 removed. If the bad block list contains entries, this will fail, as
1216 removing the list could cause data corruption.
1219 .BR \-\-freeze\-reshape
1220 Option is intended to be used in start-up scripts during initrd boot phase.
1221 When array under reshape is assembled during initrd phase, this option
1222 stops reshape after reshape critical section is being restored. This happens
1223 before file system pivot operation and avoids loss of file system context.
1224 Losing file system context would cause reshape to be broken.
1226 Reshape can be continued later using the
1228 option for the grow command.
1230 .SH For Manage mode:
1233 .BR \-t ", " \-\-test
1234 Unless a more serious error occurred,
1236 will exit with a status of 2 if no changes were made to the array and
1237 0 if at least one change was made.
1238 This can be useful when an indirect specifier such as
1243 is used in requesting an operation on the array.
1245 will report failure if these specifiers didn't find any match.
1248 .BR \-a ", " \-\-add
1249 hot-add listed devices.
1250 If a device appears to have recently been part of the array
1251 (possibly it failed or was removed) the device is re\-added as described
1253 If that fails or the device was never part of the array, the device is
1254 added as a hot-spare.
1255 If the array is degraded, it will immediately start to rebuild data
1258 Note that this and the following options are only meaningful on array
1259 with redundancy. They don't apply to RAID0 or Linear.
1263 re\-add a device that was previous removed from an array.
1264 If the metadata on the device reports that it is a member of the
1265 array, and the slot that it used is still vacant, then the device will
1266 be added back to the array in the same position. This will normally
1267 cause the data for that device to be recovered. However based on the
1268 event count on the device, the recovery may only require sections that
1269 are flagged a write-intent bitmap to be recovered or may not require
1270 any recovery at all.
1272 When used on an array that has no metadata (i.e. it was built with
1274 it will be assumed that bitmap-based recovery is enough to make the
1275 device fully consistent with the array.
1277 When used with v1.x metadata,
1279 can be accompanied by
1280 .BR \-\-update=devicesize ,
1281 .BR \-\-update=bbl ", or"
1282 .BR \-\-update=no\-bbl .
1283 See the description of these option when used in Assemble mode for an
1284 explanation of their use.
1286 If the device name given is
1288 then mdadm will try to find any device that looks like it should be
1289 part of the array but isn't and will try to re\-add all such devices.
1292 .BR \-r ", " \-\-remove
1293 remove listed devices. They must not be active. i.e. they should
1294 be failed or spare devices. As well as the name of a device file
1303 The first causes all failed device to be removed. The second causes
1304 any device which is no longer connected to the system (i.e an 'open'
1307 to be removed. This will only succeed for devices that are spares or
1308 have already been marked as failed.
1311 .BR \-f ", " \-\-fail
1312 mark listed devices as faulty.
1313 As well as the name of a device file, the word
1315 can be given. This will cause any device that has been detached from
1316 the system to be marked as failed. It can then be removed.
1324 .BR \-\-write\-mostly
1325 Subsequent devices that are added or re\-added will have the 'write-mostly'
1326 flag set. This is only valid for RAID1 and means that the 'md' driver
1327 will avoid reading from these devices if possible.
1330 Subsequent devices that are added or re\-added will have the 'write-mostly'
1334 Each of these options requires that the first device listed is the array
1335 to be acted upon, and the remainder are component devices to be added,
1336 removed, marked as faulty, etc. Several different operations can be
1337 specified for different devices, e.g.
1339 mdadm /dev/md0 \-\-add /dev/sda1 \-\-fail /dev/sdb1 \-\-remove /dev/sdb1
1341 Each operation applies to all devices listed until the next
1344 If an array is using a write-intent bitmap, then devices which have
1345 been removed can be re\-added in a way that avoids a full
1346 reconstruction but instead just updates the blocks that have changed
1347 since the device was removed. For arrays with persistent metadata
1348 (superblocks) this is done automatically. For arrays created with
1350 mdadm needs to be told that this device we removed recently with
1353 Devices can only be removed from an array if they are not in active
1354 use, i.e. that must be spares or failed devices. To remove an active
1355 device, it must first be marked as
1361 .BR \-Q ", " \-\-query
1362 Examine a device to see
1363 (1) if it is an md device and (2) if it is a component of an md
1365 Information about what is discovered is presented.
1368 .BR \-D ", " \-\-detail
1369 Print details of one or more md devices.
1372 .BR \-\-detail\-platform
1373 Print details of the platform's RAID capabilities (firmware / hardware
1374 topology) for a given metadata format. If used without argument, mdadm
1375 will scan all controllers looking for their capabilities. Otherwise, mdadm
1376 will only look at the controller specified by the argument in form of an
1377 absolute filepath or a link, e.g.
1378 .IR /sys/devices/pci0000:00/0000:00:1f.2 .
1381 .BR \-Y ", " \-\-export
1383 .B \-\-detail , \-\-detail-platform
1386 output will be formatted as
1388 pairs for easy import into the environment.
1391 .BR \-E ", " \-\-examine
1392 Print contents of the metadata stored on the named device(s).
1393 Note the contrast between
1398 applies to devices which are components of an array, while
1400 applies to a whole array which is currently active.
1403 If an array was created on a SPARC machine with a 2.2 Linux kernel
1404 patched with RAID support, the superblock will have been created
1405 incorrectly, or at least incompatibly with 2.4 and later kernels.
1410 will fix the superblock before displaying it. If this appears to do
1411 the right thing, then the array can be successfully assembled using
1412 .BR "\-\-assemble \-\-update=sparc2.2" .
1415 .BR \-X ", " \-\-examine\-bitmap
1416 Report information about a bitmap file.
1417 The argument is either an external bitmap file or an array component
1418 in case of an internal bitmap. Note that running this on an array
1421 does not report the bitmap for that array.
1424 .BR \-R ", " \-\-run
1425 start a partially assembled array. If
1427 did not find enough devices to fully start the array, it might leaving
1428 it partially assembled. If you wish, you can then use
1430 to start the array in degraded mode.
1433 .BR \-S ", " \-\-stop
1434 deactivate array, releasing all resources.
1437 .BR \-o ", " \-\-readonly
1438 mark array as readonly.
1441 .BR \-w ", " \-\-readwrite
1442 mark array as readwrite.
1445 .B \-\-zero\-superblock
1446 If the device contains a valid md superblock, the block is
1447 overwritten with zeros. With
1449 the block where the superblock would be is overwritten even if it
1450 doesn't appear to be valid.
1453 .B \-\-kill\-subarray=
1454 If the device is a container and the argument to \-\-kill\-subarray
1455 specifies an inactive subarray in the container, then the subarray is
1456 deleted. Deleting all subarrays will leave an 'empty-container' or
1457 spare superblock on the drives. See \-\-zero\-superblock for completely
1458 removing a superblock. Note that some formats depend on the subarray
1459 index for generating a UUID, this command will fail if it would change
1460 the UUID of an active subarray.
1463 .B \-\-update\-subarray=
1464 If the device is a container and the argument to \-\-update\-subarray
1465 specifies a subarray in the container, then attempt to update the given
1466 superblock field in the subarray. See below in
1471 .BR \-t ", " \-\-test
1476 is set to reflect the status of the device. See below in
1481 .BR \-W ", " \-\-wait
1482 For each md device given, wait for any resync, recovery, or reshape
1483 activity to finish before returning.
1485 will return with success if it actually waited for every device
1486 listed, otherwise it will return failure.
1490 For each md device given, or each device in /proc/mdstat if
1492 is given, arrange for the array to be marked clean as soon as possible.
1494 will return with success if the array uses external metadata and we
1495 successfully waited. For native arrays this returns immediately as the
1496 kernel handles dirty-clean transitions at shutdown. No action is taken
1497 if safe-mode handling is disabled.
1499 .SH For Incremental Assembly mode:
1501 .BR \-\-rebuild\-map ", " \-r
1502 Rebuild the map file
1506 uses to help track which arrays are currently being assembled.
1509 .BR \-\-run ", " \-R
1510 Run any array assembled as soon as a minimal number of devices are
1511 available, rather than waiting until all expected devices are present.
1514 .BR \-\-scan ", " \-s
1515 Only meaningful with
1519 file for arrays that are being incrementally assembled and will try to
1520 start any that are not already started. If any such array is listed
1523 as requiring an external bitmap, that bitmap will be attached first.
1526 .BR \-\-fail ", " \-f
1527 This allows the hot-plug system to remove devices that have fully disappeared
1528 from the kernel. It will first fail and then remove the device from any
1529 array it belongs to.
1530 The device name given should be a kernel device name such as "sda",
1536 Only used with \-\-fail. The 'path' given will be recorded so that if
1537 a new device appears at the same location it can be automatically
1538 added to the same array. This allows the failed device to be
1539 automatically replaced by a new device without metadata if it appears
1540 at specified path. This option is normally only set by a
1544 .SH For Monitor mode:
1546 .BR \-m ", " \-\-mail
1547 Give a mail address to send alerts to.
1550 .BR \-p ", " \-\-program ", " \-\-alert
1551 Give a program to be run whenever an event is detected.
1554 .BR \-y ", " \-\-syslog
1555 Cause all events to be reported through 'syslog'. The messages have
1556 facility of 'daemon' and varying priorities.
1559 .BR \-d ", " \-\-delay
1560 Give a delay in seconds.
1562 polls the md arrays and then waits this many seconds before polling
1563 again. The default is 60 seconds. Since 2.6.16, there is no need to
1564 reduce this as the kernel alerts
1566 immediately when there is any change.
1569 .BR \-r ", " \-\-increment
1570 Give a percentage increment.
1572 will generate RebuildNN events with the given percentage increment.
1575 .BR \-f ", " \-\-daemonise
1578 to run as a background daemon if it decides to monitor anything. This
1579 causes it to fork and run in the child, and to disconnect from the
1580 terminal. The process id of the child is written to stdout.
1583 which will only continue monitoring if a mail address or alert program
1584 is found in the config file.
1587 .BR \-i ", " \-\-pid\-file
1590 is running in daemon mode, write the pid of the daemon process to
1591 the specified file, instead of printing it on standard output.
1594 .BR \-1 ", " \-\-oneshot
1595 Check arrays only once. This will generate
1597 events and more significantly
1603 .B " mdadm \-\-monitor \-\-scan \-1"
1605 from a cron script will ensure regular notification of any degraded arrays.
1608 .BR \-t ", " \-\-test
1611 alert for every array found at startup. This alert gets mailed and
1612 passed to the alert program. This can be used for testing that alert
1613 message do get through successfully.
1617 This inhibits the functionality for moving spares between arrays.
1618 Only one monitoring process started with
1620 but without this flag is allowed, otherwise the two could interfere
1627 .B mdadm \-\-assemble
1628 .I md-device options-and-component-devices...
1631 .B mdadm \-\-assemble \-\-scan
1632 .I md-devices-and-options...
1635 .B mdadm \-\-assemble \-\-scan
1639 This usage assembles one or more RAID arrays from pre-existing components.
1640 For each array, mdadm needs to know the md device, the identity of the
1641 array, and a number of component-devices. These can be found in a number of ways.
1643 In the first usage example (without the
1645 the first device given is the md device.
1646 In the second usage example, all devices listed are treated as md
1647 devices and assembly is attempted.
1648 In the third (where no devices are listed) all md devices that are
1649 listed in the configuration file are assembled. If no arrays are
1650 described by the configuration file, then any arrays that
1651 can be found on unused devices will be assembled.
1653 If precisely one device is listed, but
1659 was given and identity information is extracted from the configuration file.
1661 The identity can be given with the
1667 option, will be taken from the md-device record in the config file, or
1668 will be taken from the super block of the first component-device
1669 listed on the command line.
1671 Devices can be given on the
1673 command line or in the config file. Only devices which have an md
1674 superblock which contains the right identity will be considered for
1677 The config file is only used if explicitly named with
1679 or requested with (a possibly implicit)
1684 .B /etc/mdadm/mdadm.conf
1689 is not given, then the config file will only be used to find the
1690 identity of md arrays.
1692 Normally the array will be started after it is assembled. However if
1694 is not given and not all expected drives were listed, then the array
1695 is not started (to guard against usage errors). To insist that the
1696 array be started in this case (as may work for RAID1, 4, 5, 6, or 10),
1705 does not create any entries in
1709 It does record information in
1713 to choose the correct name.
1717 detects that udev is not configured, it will create the devices in
1721 In Linux kernels prior to version 2.6.28 there were two distinctly
1722 different types of md devices that could be created: one that could be
1723 partitioned using standard partitioning tools and one that could not.
1724 Since 2.6.28 that distinction is no longer relevant as both type of
1725 devices can be partitioned.
1727 will normally create the type that originally could not be partitioned
1728 as it has a well defined major number (9).
1730 Prior to 2.6.28, it is important that mdadm chooses the correct type
1731 of array device to use. This can be controlled with the
1733 option. In particular, a value of "mdp" or "part" or "p" tells mdadm
1734 to use a partitionable device rather than the default.
1736 In the no-udev case, the value given to
1738 can be suffixed by a number. This tells
1740 to create that number of partition devices rather than the default of 4.
1744 can also be given in the configuration file as a word starting
1746 on the ARRAY line for the relevant array.
1753 and no devices are listed,
1755 will first attempt to assemble all the arrays listed in the config
1758 If no arrays are listed in the config (other than those marked
1760 it will look through the available devices for possible arrays and
1761 will try to assemble anything that it finds. Arrays which are tagged
1762 as belonging to the given homehost will be assembled and started
1763 normally. Arrays which do not obviously belong to this host are given
1764 names that are expected not to conflict with anything local, and are
1765 started "read-auto" so that nothing is written to any device until the
1766 array is written to. i.e. automatic resync etc is delayed.
1770 finds a consistent set of devices that look like they should comprise
1771 an array, and if the superblock is tagged as belonging to the given
1772 home host, it will automatically choose a device name and try to
1773 assemble the array. If the array uses version-0.90 metadata, then the
1775 number as recorded in the superblock is used to create a name in
1779 If the array uses version-1 metadata, then the
1781 from the superblock is used to similarly create a name in
1783 (the name will have any 'host' prefix stripped first).
1785 This behaviour can be modified by the
1789 configuration file. This line can indicate that specific metadata
1790 type should, or should not, be automatically assembled. If an array
1791 is found which is not listed in
1793 and has a metadata format that is denied by the
1795 line, then it will not be assembled.
1798 line can also request that all arrays identified as being for this
1799 homehost should be assembled regardless of their metadata type.
1802 for further details.
1804 Note: Auto assembly cannot be used for assembling and activating some
1805 arrays which are undergoing reshape. In particular as the
1807 cannot be given, any reshape which requires a backup-file to continue
1808 cannot be started by auto assembly. An array which is growing to more
1809 devices and has passed the critical section can be assembled using
1820 .BI \-\-raid\-devices= Z
1824 This usage is similar to
1826 The difference is that it creates an array without a superblock. With
1827 these arrays there is no difference between initially creating the array and
1828 subsequently assembling the array, except that hopefully there is useful
1829 data there in the second case.
1831 The level may raid0, linear, raid1, raid10, multipath, or faulty, or
1832 one of their synonyms. All devices must be listed and the array will
1833 be started once complete. It will often be appropriate to use
1834 .B \-\-assume\-clean
1835 with levels raid1 or raid10.
1846 .BI \-\-raid\-devices= Z
1850 This usage will initialise a new md array, associate some devices with
1851 it, and activate the array.
1853 The named device will normally not exist when
1854 .I "mdadm \-\-create"
1855 is run, but will be created by
1857 once the array becomes active.
1859 As devices are added, they are checked to see if they contain RAID
1860 superblocks or filesystems. They are also checked to see if the variance in
1861 device size exceeds 1%.
1863 If any discrepancy is found, the array will not automatically be run, though
1866 can override this caution.
1868 To create a "degraded" array in which some devices are missing, simply
1869 give the word "\fBmissing\fP"
1870 in place of a device name. This will cause
1872 to leave the corresponding slot in the array empty.
1873 For a RAID4 or RAID5 array at most one slot can be
1874 "\fBmissing\fP"; for a RAID6 array at most two slots.
1875 For a RAID1 array, only one real device needs to be given. All of the
1879 When creating a RAID5 array,
1881 will automatically create a degraded array with an extra spare drive.
1882 This is because building the spare into a degraded array is in general
1883 faster than resyncing the parity on a non-degraded, but not clean,
1884 array. This feature can be overridden with the
1888 When creating an array with version-1 metadata a name for the array is
1890 If this is not given with the
1894 will choose a name based on the last component of the name of the
1895 device being created. So if
1897 is being created, then the name
1902 is being created, then the name
1906 When creating a partition based array, using
1908 with version-1.x metadata, the partition type should be set to
1910 (non fs-data). This type selection allows for greater precision since
1911 using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)],
1912 might create problems in the event of array recovery through a live cdrom.
1914 A new array will normally get a randomly assigned 128bit UUID which is
1915 very likely to be unique. If you have a specific need, you can choose
1916 a UUID for the array by giving the
1918 option. Be warned that creating two arrays with the same UUID is a
1919 recipe for disaster. Also, using
1921 when creating a v0.90 array will silently override any
1926 .\"option is given, it is not necessary to list any component-devices in this command.
1927 .\"They can be added later, before a
1931 .\"is given, the apparent size of the smallest drive given is used.
1933 If the metadata type supports it (currently only 1.x metadata), space
1934 will be allocated to store a bad block list. This allows a modest
1935 number of bad blocks to be recorded, allowing the drive to remain in
1936 service while only partially functional.
1938 When creating an array within a
1941 can be given either the list of devices to use, or simply the name of
1942 the container. The former case gives control over which devices in
1943 the container will be used for the array. The latter case allows
1945 to automatically choose which devices to use based on how much spare
1948 The General Management options that are valid with
1953 insist on running the array even if some devices look like they might
1958 start the array readonly \(em not supported yet.
1965 .I options... devices...
1968 This usage will allow individual devices in an array to be failed,
1969 removed or added. It is possible to perform multiple operations with
1970 on command. For example:
1972 .B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1"
1978 and will then remove it from the array and finally add it back
1979 in as a spare. However only one md array can be affected by a single
1982 When a device is added to an active array, mdadm checks to see if it
1983 has metadata on it which suggests that it was recently a member of the
1984 array. If it does, it tries to "re\-add" the device. If there have
1985 been no changes since the device was removed, or if the array has a
1986 write-intent bitmap which has recorded whatever changes there were,
1987 then the device will immediately become a full member of the array and
1988 those differences recorded in the bitmap will be resolved.
1998 MISC mode includes a number of distinct operations that
1999 operate on distinct devices. The operations are:
2002 The device is examined to see if it is
2003 (1) an active md array, or
2004 (2) a component of an md array.
2005 The information discovered is reported.
2009 The device should be an active md device.
2011 will display a detailed description of the array.
2015 will cause the output to be less detailed and the format to be
2016 suitable for inclusion in
2020 will normally be 0 unless
2022 failed to get useful information about the device(s); however, if the
2024 option is given, then the exit status will be:
2028 The array is functioning normally.
2031 The array has at least one failed device.
2034 The array has multiple failed devices such that it is unusable.
2037 There was an error while trying to get information about the device.
2041 .B \-\-detail\-platform
2042 Print detail of the platform's RAID capabilities (firmware / hardware
2043 topology). If the metadata is specified with
2047 then the return status will be:
2051 metadata successfully enumerated its platform components on this system
2054 metadata is platform independent
2057 metadata failed to find its platform components on this system
2061 .B \-\-update\-subarray=
2062 If the device is a container and the argument to \-\-update\-subarray
2063 specifies a subarray in the container, then attempt to update the given
2064 superblock field in the subarray. Similar to updating an array in
2065 "assemble" mode, the field to update is selected by
2069 option. Currently only
2075 option updates the subarray name in the metadata, it may not affect the
2076 device node name or the device node symlink until the subarray is
2077 re\-assembled. If updating
2079 would change the UUID of an active subarray this operation is blocked,
2080 and the command will end in an error.
2084 The device should be a component of an md array.
2086 will read the md superblock of the device and display the contents.
2091 is given, then multiple devices that are components of the one array
2092 are grouped together and reported in a single entry suitable
2098 without listing any devices will cause all devices listed in the
2099 config file to be examined.
2103 The devices should be active md arrays which will be deactivated, as
2104 long as they are not currently in use.
2108 This will fully activate a partially assembled md array.
2112 This will mark an active array as read-only, providing that it is
2113 not currently being used.
2119 array back to being read/write.
2123 For all operations except
2126 will cause the operation to be applied to all arrays listed in
2131 causes all devices listed in the config file to be examined.
2134 .BR \-b ", " \-\-brief
2135 Be less verbose. This is used with
2143 gives an intermediate level of verbosity.
2149 .B mdadm \-\-monitor
2150 .I options... devices...
2155 to periodically poll a number of md arrays and to report on any events
2158 will never exit once it decides that there are arrays to be checked,
2159 so it should normally be run in the background.
2161 As well as reporting events,
2163 may move a spare drive from one array to another if they are in the
2168 and if the destination array has a failed drive but no spares.
2170 If any devices are listed on the command line,
2172 will only monitor those devices. Otherwise all arrays listed in the
2173 configuration file will be monitored. Further, if
2175 is given, then any other md devices that appear in
2177 will also be monitored.
2179 The result of monitoring the arrays is the generation of events.
2180 These events are passed to a separate program (if specified) and may
2181 be mailed to a given E-mail address.
2183 When passing events to a program, the program is run once for each event,
2184 and is given 2 or 3 command-line arguments: the first is the
2185 name of the event (see below), the second is the name of the
2186 md device which is affected, and the third is the name of a related
2187 device if relevant (such as a component device that has failed).
2191 is given, then a program or an E-mail address must be specified on the
2192 command line or in the config file. If neither are available, then
2194 will not monitor anything.
2198 will continue monitoring as long as something was found to monitor. If
2199 no program or email is given, then each event is reported to
2202 The different events are:
2206 .B DeviceDisappeared
2207 An md array which previously was configured appears to no longer be
2208 configured. (syslog priority: Critical)
2212 was told to monitor an array which is RAID0 or Linear, then it will
2214 .B DeviceDisappeared
2215 with the extra information
2217 This is because RAID0 and Linear do not support the device-failed,
2218 hot-spare and resync operations which are monitored.
2222 An md array started reconstruction. (syslog priority: Warning)
2228 is a two-digit number (ie. 05, 48). This indicates that rebuild
2229 has passed that many percent of the total. The events are generated
2230 with fixed increment since 0. Increment size may be specified with
2231 a commandline option (default is 20). (syslog priority: Warning)
2235 An md array that was rebuilding, isn't any more, either because it
2236 finished normally or was aborted. (syslog priority: Warning)
2240 An active component device of an array has been marked as
2241 faulty. (syslog priority: Critical)
2245 A spare component device which was being rebuilt to replace a faulty
2246 device has failed. (syslog priority: Critical)
2250 A spare component device which was being rebuilt to replace a faulty
2251 device has been successfully rebuilt and has been made active.
2252 (syslog priority: Info)
2256 A new md array has been detected in the
2258 file. (syslog priority: Info)
2262 A newly noticed array appears to be degraded. This message is not
2265 notices a drive failure which causes degradation, but only when
2267 notices that an array is degraded when it first sees the array.
2268 (syslog priority: Critical)
2272 A spare drive has been moved from one array in a
2276 to another to allow a failed drive to be replaced.
2277 (syslog priority: Info)
2283 has been told, via the config file, that an array should have a certain
2284 number of spare devices, and
2286 detects that it has fewer than this number when it first sees the
2287 array, it will report a
2290 (syslog priority: Warning)
2294 An array was found at startup, and the
2297 (syslog priority: Info)
2307 cause Email to be sent. All events cause the program to be run.
2308 The program is run with two or three arguments: the event
2309 name, the array device and possibly a second device.
2311 Each event has an associated array device (e.g.
2313 and possibly a second device. For
2318 the second device is the relevant component device.
2321 the second device is the array that the spare was moved from.
2325 to move spares from one array to another, the different arrays need to
2326 be labeled with the same
2328 or the spares must be allowed to migrate through matching POLICY domains
2329 in the configuration file. The
2331 name can be any string; it is only necessary that different spare
2332 groups use different names.
2336 detects that an array in a spare group has fewer active
2337 devices than necessary for the complete array, and has no spare
2338 devices, it will look for another array in the same spare group that
2339 has a full complement of working drive and a spare. It will then
2340 attempt to remove the spare from the second drive and add it to the
2342 If the removal succeeds but the adding fails, then it is added back to
2345 If the spare group for a degraded array is not defined,
2347 will look at the rules of spare migration specified by POLICY lines in
2349 and then follow similar steps as above if a matching spare is found.
2352 The GROW mode is used for changing the size or shape of an active
2354 For this to work, the kernel must support the necessary change.
2355 Various types of growth are being added during 2.6 development.
2357 Currently the supported changes include
2359 change the "size" attribute for RAID1, RAID4, RAID5 and RAID6.
2361 increase or decrease the "raid\-devices" attribute of RAID0, RAID1, RAID4,
2364 change the chunk-size and layout of RAID0, RAID4, RAID5 and RAID6.
2366 convert between RAID1 and RAID5, between RAID5 and RAID6, between
2367 RAID0, RAID4, and RAID5, and between RAID0 and RAID10 (in the near-2 mode).
2369 add a write-intent bitmap to any array which supports these bitmaps, or
2370 remove a write-intent bitmap from such an array.
2373 Using GROW on containers is currently supported only for Intel's IMSM
2374 container format. The number of devices in a container can be
2375 increased - which affects all arrays in the container - or an array
2376 in a container can be converted between levels where those levels are
2377 supported by the container, and the conversion is on of those listed
2378 above. Resizing arrays in an IMSM container with
2380 is not yet supported.
2382 Grow functionality (e.g. expand a number of raid devices) for Intel's
2383 IMSM container format has an experimental status. It is guarded by the
2384 .B MDADM_EXPERIMENTAL
2385 environment variable which must be set to '1' for a GROW command to
2387 This is for the following reasons:
2390 Intel's native IMSM check-pointing is not fully tested yet.
2391 This can causes IMSM incompatibility during the grow process: an array
2392 which is growing cannot roam between Microsoft Windows(R) and Linux
2396 Interrupting a grow operation is not recommended, because it
2397 has not been fully tested for Intel's IMSM container format yet.
2400 Note: Intel's native checkpointing doesn't use
2402 option and it is transparent for assembly feature.
2405 Normally when an array is built the "size" is taken from the smallest
2406 of the drives. If all the small drives in an arrays are, one at a
2407 time, removed and replaced with larger drives, then you could have an
2408 array of large drives with only a small amount used. In this
2409 situation, changing the "size" with "GROW" mode will allow the extra
2410 space to start being used. If the size is increased in this way, a
2411 "resync" process will start to make sure the new parts of the array
2414 Note that when an array changes size, any filesystem that may be
2415 stored in the array will not automatically grow or shrink to use or
2416 vacate the space. The
2417 filesystem will need to be explicitly told to use the extra space
2418 after growing, or to reduce its size
2420 to shrinking the array.
2422 Also the size of an array cannot be changed while it has an active
2423 bitmap. If an array has a bitmap, it must be removed before the size
2424 can be changed. Once the change is complete a new bitmap can be created.
2426 .SS RAID\-DEVICES CHANGES
2428 A RAID1 array can work with any number of devices from 1 upwards
2429 (though 1 is not very useful). There may be times which you want to
2430 increase or decrease the number of active devices. Note that this is
2431 different to hot-add or hot-remove which changes the number of
2434 When reducing the number of devices in a RAID1 array, the slots which
2435 are to be removed from the array must already be vacant. That is, the
2436 devices which were in those slots must be failed and removed.
2438 When the number of devices is increased, any hot spares that are
2439 present will be activated immediately.
2441 Changing the number of active devices in a RAID5 or RAID6 is much more
2442 effort. Every block in the array will need to be read and written
2443 back to a new location. From 2.6.17, the Linux Kernel is able to
2444 increase the number of devices in a RAID5 safely, including restarting
2445 an interrupted "reshape". From 2.6.31, the Linux Kernel is able to
2446 increase or decrease the number of devices in a RAID5 or RAID6.
2448 From 2.6.35, the Linux Kernel is able to convert a RAID0 in to a RAID4
2451 uses this functionality and the ability to add
2452 devices to a RAID4 to allow devices to be added to a RAID0. When
2453 requested to do this,
2455 will convert the RAID0 to a RAID4, add the necessary disks and make
2456 the reshape happen, and then convert the RAID4 back to RAID0.
2458 When decreasing the number of devices, the size of the array will also
2459 decrease. If there was data in the array, it could get destroyed and
2460 this is not reversible, so you should firstly shrink the filesystem on
2461 the array to fit within the new size. To help prevent accidents,
2463 requires that the size of the array be decreased first with
2464 .BR "mdadm --grow --array-size" .
2465 This is a reversible change which simply makes the end of the array
2466 inaccessible. The integrity of any data can then be checked before
2467 the non-reversible reduction in the number of devices is request.
2469 When relocating the first few stripes on a RAID5 or RAID6, it is not
2470 possible to keep the data on disk completely consistent and
2471 crash-proof. To provide the required safety, mdadm disables writes to
2472 the array while this "critical section" is reshaped, and takes a
2473 backup of the data that is in that section. For grows, this backup may be
2474 stored in any spare devices that the array has, however it can also be
2475 stored in a separate file specified with the
2477 option, and is required to be specified for shrinks, RAID level
2478 changes and layout changes. If this option is used, and the system
2479 does crash during the critical period, the same file must be passed to
2481 to restore the backup and reassemble the array. When shrinking rather
2482 than growing the array, the reshape is done from the end towards the
2483 beginning, so the "critical section" is at the end of the reshape.
2487 Changing the RAID level of any array happens instantaneously. However
2488 in the RAID5 to RAID6 case this requires a non-standard layout of the
2489 RAID6 data, and in the RAID6 to RAID5 case that non-standard layout is
2490 required before the change can be accomplished. So while the level
2491 change is instant, the accompanying layout change can take quite a
2494 is required. If the array is not simultaneously being grown or
2495 shrunk, so that the array size will remain the same - for example,
2496 reshaping a 3-drive RAID5 into a 4-drive RAID6 - the backup file will
2497 be used not just for a "cricital section" but throughout the reshape
2498 operation, as described below under LAYOUT CHANGES.
2500 .SS CHUNK-SIZE AND LAYOUT CHANGES
2502 Changing the chunk-size of layout without also changing the number of
2503 devices as the same time will involve re-writing all blocks in-place.
2504 To ensure against data loss in the case of a crash, a
2506 must be provided for these changes. Small sections of the array will
2507 be copied to the backup file while they are being rearranged. This
2508 means that all the data is copied twice, once to the backup and once
2509 to the new layout on the array, so this type of reshape will go very
2512 If the reshape is interrupted for any reason, this backup file must be
2514 .B "mdadm --assemble"
2515 so the array can be reassembled. Consequently the file cannot be
2516 stored on the device being reshaped.
2521 A write-intent bitmap can be added to, or removed from, an active
2522 array. Either internal bitmaps, or bitmaps stored in a separate file,
2523 can be added. Note that if you add a bitmap stored in a file which is
2524 in a filesystem that is on the RAID array being affected, the system
2525 will deadlock. The bitmap must be on a separate filesystem.
2527 .SH INCREMENTAL MODE
2531 .B mdadm \-\-incremental
2537 .B mdadm \-\-incremental \-\-fail
2541 .B mdadm \-\-incremental \-\-rebuild\-map
2544 .B mdadm \-\-incremental \-\-run \-\-scan
2547 This mode is designed to be used in conjunction with a device
2548 discovery system. As devices are found in a system, they can be
2550 .B "mdadm \-\-incremental"
2551 to be conditionally added to an appropriate array.
2553 Conversely, it can also be used with the
2555 flag to do just the opposite and find whatever array a particular device
2556 is part of and remove the device from that array.
2558 If the device passed is a
2560 device created by a previous call to
2562 then rather than trying to add that device to an array, all the arrays
2563 described by the metadata of the container will be started.
2566 performs a number of tests to determine if the device is part of an
2567 array, and which array it should be part of. If an appropriate array
2568 is found, or can be created,
2570 adds the device to the array and conditionally starts the array.
2574 will normally only add devices to an array which were previously working
2575 (active or spare) parts of that array. The support for automatic
2576 inclusion of a new drive as a spare in some array requires
2577 a configuration through POLICY in config file.
2581 makes are as follow:
2583 Is the device permitted by
2585 That is, is it listed in a
2587 line in that file. If
2589 is absent then the default it to allow any device. Similar if
2591 contains the special word
2593 then any device is allowed. Otherwise the device name given to
2595 must match one of the names or patterns in a
2600 Does the device have a valid md superblock? If a specific metadata
2601 version is requested with
2605 then only that style of metadata is accepted, otherwise
2607 finds any known version of metadata. If no
2609 metadata is found, the device may be still added to an array
2610 as a spare if POLICY allows.
2614 Does the metadata match an expected array?
2615 The metadata can match in two ways. Either there is an array listed
2618 which identifies the array (either by UUID, by name, by device list,
2619 or by minor-number), or the array was created with a
2625 or on the command line.
2628 is not able to positively identify the array as belonging to the
2629 current host, the device will be rejected.
2634 keeps a list of arrays that it has partially assembled in
2636 If no array exists which matches
2637 the metadata on the new device,
2639 must choose a device name and unit number. It does this based on any
2642 or any name information stored in the metadata. If this name
2643 suggests a unit number, that number will be used, otherwise a free
2644 unit number will be chosen. Normally
2646 will prefer to create a partitionable array, however if the
2650 suggests that a non-partitionable array is preferred, that will be
2653 If the array is not found in the config file and its metadata does not
2654 identify it as belonging to the "homehost", then
2656 will choose a name for the array which is certain not to conflict with
2657 any array which does belong to this host. It does this be adding an
2658 underscore and a small number to the name preferred by the metadata.
2660 Once an appropriate array is found or created and the device is added,
2662 must decide if the array is ready to be started. It will
2663 normally compare the number of available (non-spare) devices to the
2664 number of devices that the metadata suggests need to be active. If
2665 there are at least that many, the array will be started. This means
2666 that if any devices are missing the array will not be restarted.
2672 in which case the array will be run as soon as there are enough
2673 devices present for the data to be accessible. For a RAID1, that
2674 means one device will start the array. For a clean RAID5, the array
2675 will be started as soon as all but one drive is present.
2677 Note that neither of these approaches is really ideal. If it can
2678 be known that all device discovery has completed, then
2682 can be run which will try to start all arrays that are being
2683 incrementally assembled. They are started in "read-auto" mode in
2684 which they are read-only until the first write request. This means
2685 that no metadata updates are made and no attempt at resync or recovery
2686 happens. Further devices that are found before the first write can
2687 still be added safely.
2690 This section describes environment variables that affect how mdadm
2695 Setting this value to 1 will prevent mdadm from automatically launching
2696 mdmon. This variable is intended primarily for debugging mdadm/mdmon.
2702 does not create any device nodes in /dev, but leaves that task to
2706 appears not to be configured, or if this environment variable is set
2709 will create and devices that are needed.
2713 .B " mdadm \-\-query /dev/name-of-device"
2715 This will find out if a given device is a RAID array, or is part of
2716 one, and will provide brief information about the device.
2718 .B " mdadm \-\-assemble \-\-scan"
2720 This will assemble and start all arrays listed in the standard config
2721 file. This command will typically go in a system startup file.
2723 .B " mdadm \-\-stop \-\-scan"
2725 This will shut down all arrays that can be shut down (i.e. are not
2726 currently in use). This will typically go in a system shutdown script.
2728 .B " mdadm \-\-follow \-\-scan \-\-delay=120"
2730 If (and only if) there is an Email address or program given in the
2731 standard config file, then
2732 monitor the status of all arrays listed in that file by
2733 polling them ever 2 minutes.
2735 .B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1"
2737 Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.
2740 .B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf"
2742 .B " mdadm \-\-detail \-\-scan >> mdadm.conf"
2744 This will create a prototype config file that describes currently
2745 active arrays that are known to be made from partitions of IDE or SCSI drives.
2746 This file should be reviewed before being used as it may
2747 contain unwanted detail.
2749 .B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf"
2751 .B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf"
2753 This will find arrays which could be assembled from existing IDE and
2754 SCSI whole drives (not partitions), and store the information in the
2755 format of a config file.
2756 This file is very likely to contain unwanted detail, particularly
2759 entries. It should be reviewed and edited before being used as an
2762 .B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions"
2764 .B " mdadm \-Ebsc partitions"
2766 Create a list of devices by reading
2767 .BR /proc/partitions ,
2768 scan these for RAID superblocks, and printout a brief listing of all
2771 .B " mdadm \-Ac partitions \-m 0 /dev/md0"
2773 Scan all partitions and devices listed in
2774 .BR /proc/partitions
2777 out of all such devices with a RAID superblock with a minor number of 0.
2779 .B " mdadm \-\-monitor \-\-scan \-\-daemonise > /run/mdadm/mon.pid"
2781 If config file contains a mail address or alert program, run mdadm in
2782 the background in monitor mode monitoring all md devices. Also write
2783 pid of mdadm daemon to
2784 .BR /run/mdadm/mon.pid .
2786 .B " mdadm \-Iq /dev/somedevice"
2788 Try to incorporate newly discovered device into some array as
2791 .B " mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan"
2793 Rebuild the array map from any current arrays, and then start any that
2796 .B " mdadm /dev/md4 --fail detached --remove detached"
2798 Any devices which are components of /dev/md4 will be marked as faulty
2799 and then remove from the array.
2801 .B " mdadm --grow /dev/md4 --level=6 --backup-file=/root/backup-md4"
2805 which is currently a RAID5 array will be converted to RAID6. There
2806 should normally already be a spare drive attached to the array as a
2807 RAID6 needs one more drive than a matching RAID5.
2809 .B " mdadm --create /dev/md/ddf --metadata=ddf --raid-disks 6 /dev/sd[a-f]"
2811 Create a DDF array over 6 devices.
2813 .B " mdadm --create /dev/md/home -n3 -l5 -z 30000000 /dev/md/ddf"
2815 Create a RAID5 array over any 3 devices in the given DDF set. Use
2816 only 30 gigabytes of each device.
2818 .B " mdadm -A /dev/md/ddf1 /dev/sd[a-f]"
2820 Assemble a pre-exist ddf array.
2822 .B " mdadm -I /dev/md/ddf1"
2824 Assemble all arrays contained in the ddf array, assigning names as
2827 .B " mdadm \-\-create \-\-help"
2829 Provide help about the Create mode.
2831 .B " mdadm \-\-config \-\-help"
2833 Provide help about the format of the config file.
2835 .B " mdadm \-\-help"
2837 Provide general help.
2847 lists all active md devices with information about them.
2849 uses this to find arrays when
2851 is given in Misc mode, and to monitor array reconstruction
2856 The config file lists which devices may be scanned to see if
2857 they contain MD super block, and gives identifying information
2858 (e.g. UUID) about known MD arrays. See
2865 mode is used, this file gets a list of arrays currently being created.
2870 understand two sorts of names for array devices.
2872 The first is the so-called 'standard' format name, which matches the
2873 names used by the kernel and which appear in
2876 The second sort can be freely chosen, but must reside in
2878 When giving a device name to
2880 to create or assemble an array, either full path name such as
2884 can be given, or just the suffix of the second sort of name, such as
2890 chooses device names during auto-assembly or incremental assembly, it
2891 will sometimes add a small sequence number to the end of the name to
2892 avoid conflicted between multiple arrays that have the same name. If
2894 can reasonably determine that the array really is meant for this host,
2895 either by a hostname in the metadata, or by the presence of the array
2898 then it will leave off the suffix if possible.
2899 Also if the homehost is specified as
2902 will only use a suffix if a different array of the same name already
2903 exists or is listed in the config file.
2905 The standard names for non-partitioned arrays (the only sort of md
2906 array available in 2.4 and earlier) are of the form
2910 where NN is a number.
2911 The standard names for partitionable arrays (as available from 2.6
2912 onwards) are of the form
2916 Partition numbers should be indicated by added "pMM" to these, thus "/dev/md/d1p2".
2918 From kernel version, 2.6.28 the "non-partitioned array" can actually
2919 be partitioned. So the "md_dNN" names are no longer needed, and
2920 partitions such as "/dev/mdNNpXX" are possible.
2924 was previously known as
2928 is completely separate from the
2930 package, and does not use the
2932 configuration file at all.
2935 For further information on mdadm usage, MD and the various levels of
2938 .B http://raid.wiki.kernel.org/
2940 (based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO)
2942 .\"for new releases of the RAID driver check out:
2945 .\".UR ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
2946 .\"ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
2951 .\".UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
2952 .\"http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
2955 The latest version of
2957 should always be available from
2959 .B http://www.kernel.org/pub/linux/utils/raid/mdadm/
projects / thirdparty / mdadm.git / blob