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
222 then the MANAGE mode is assumed.
223 Anything other than these will cause the
227 .SH Options that are not mode-specific are:
230 .BR \-h ", " \-\-help
231 Display general help message or, after one of the above options, a
232 mode-specific help message.
236 Display more detailed help about command line parsing and some commonly
240 .BR \-V ", " \-\-version
241 Print version information for mdadm.
244 .BR \-v ", " \-\-verbose
245 Be more verbose about what is happening. This can be used twice to be
247 The extra verbosity currently only affects
248 .B \-\-detail \-\-scan
250 .BR "\-\-examine \-\-scan" .
253 .BR \-q ", " \-\-quiet
254 Avoid printing purely informative messages. With this,
256 will be silent unless there is something really important to report.
260 .BR \-f ", " \-\-force
261 Be more forceful about certain operations. See the various modes for
262 the exact meaning of this option in different contexts.
265 .BR \-c ", " \-\-config=
266 Specify the config file. Default is to use
267 .BR /etc/mdadm.conf ,
268 or if that is missing then
269 .BR /etc/mdadm/mdadm.conf .
270 If the config file given is
272 then nothing will be read, but
274 will act as though the config file contained exactly
275 .B "DEVICE partitions containers"
278 to find a list of devices to scan, and
280 to find a list of containers to examine.
283 is given for the config file, then
285 will act as though the config file were empty.
288 .BR \-s ", " \-\-scan
291 for missing information.
292 In general, this option gives
294 permission to get any missing information (like component devices,
295 array devices, array identities, and alert destination) from the
296 configuration file (see previous option);
297 one exception is MISC mode when using
303 says to get a list of array devices from
307 .BR \-e ", " \-\-metadata=
308 Declare the style of RAID metadata (superblock) to be used. The
309 default is {DEFAULT_METADATA} for
311 and to guess for other operations.
312 The default can be overridden by setting the
321 .ie '{DEFAULT_METADATA}'0.90'
322 .IP "0, 0.90, default"
325 Use the original 0.90 format superblock. This format limits arrays to
326 28 component devices and limits component devices of levels 1 and
327 greater to 2 terabytes. It is also possible for there to be confusion
328 about whether the superblock applies to a whole device or just the
329 last partition, if that partition starts on a 64K boundary.
330 .ie '{DEFAULT_METADATA}'0.90'
331 .IP "1, 1.0, 1.1, 1.2"
333 .IP "1, 1.0, 1.1, 1.2 default"
334 Use the new version-1 format superblock. This has fewer restrictions.
335 It can easily be moved between hosts with different endian-ness, and a
336 recovery operation can be checkpointed and restarted. The different
337 sub-versions store the superblock at different locations on the
338 device, either at the end (for 1.0), at the start (for 1.1) or 4K from
339 the start (for 1.2). "1" is equivalent to "1.2" (the commonly
340 preferred 1.x format).
341 'if '{DEFAULT_METADATA}'1.2' "default" is equivalent to "1.2".
343 Use the "Industry Standard" DDF (Disk Data Format) format defined by
345 When creating a DDF array a
347 will be created, and normal arrays can be created in that container.
349 Use the Intel(R) Matrix Storage Manager metadata format. This creates a
351 which is managed in a similar manner to DDF, and is supported by an
352 option-rom on some platforms:
354 .B http://www.intel.com/design/chipsets/matrixstorage_sb.htm
360 This will override any
362 setting in the config file and provides the identity of the host which
363 should be considered the home for any arrays.
365 When creating an array, the
367 will be recorded in the metadata. For version-1 superblocks, it will
368 be prefixed to the array name. For version-0.90 superblocks, part of
369 the SHA1 hash of the hostname will be stored in the later half of the
372 When reporting information about an array, any array which is tagged
373 for the given homehost will be reported as such.
375 When using Auto-Assemble, only arrays tagged for the given homehost
376 will be allowed to use 'local' names (i.e. not ending in '_' followed
377 by a digit string). See below under
378 .BR "Auto Assembly" .
384 needs to print the name for a device it normally finds the name in
386 which refers to the device and is shortest. When a path component is
390 will prefer a longer name if it contains that component. For example
391 .B \-\-prefer=by-uuid
392 will prefer a name in a subdirectory of
397 This functionality is currently only provided by
402 .SH For create, build, or grow:
405 .BR \-n ", " \-\-raid\-devices=
406 Specify the number of active devices in the array. This, plus the
407 number of spare devices (see below) must equal the number of
409 (including "\fBmissing\fP" devices)
410 that are listed on the command line for
412 Setting a value of 1 is probably
413 a mistake and so requires that
415 be specified first. A value of 1 will then be allowed for linear,
416 multipath, RAID0 and RAID1. It is never allowed for RAID4, RAID5 or RAID6.
418 This number can only be changed using
420 for RAID1, RAID4, RAID5 and RAID6 arrays, and only on kernels which provide
421 the necessary support.
424 .BR \-x ", " \-\-spare\-devices=
425 Specify the number of spare (eXtra) devices in the initial array.
426 Spares can also be added
427 and removed later. The number of component devices listed
428 on the command line must equal the number of RAID devices plus the
429 number of spare devices.
432 .BR \-z ", " \-\-size=
433 Amount (in Kibibytes) of space to use from each drive in RAID levels 1/4/5/6.
434 This must be a multiple of the chunk size, and must leave about 128Kb
435 of space at the end of the drive for the RAID superblock.
436 If this is not specified
437 (as it normally is not) the smallest drive (or partition) sets the
438 size, though if there is a variance among the drives of greater than 1%, a warning is
441 A suffix of 'M' or 'G' can be given to indicate Megabytes or
442 Gigabytes respectively.
444 Sometimes a replacement drive can be a little smaller than the
445 original drives though this should be minimised by IDEMA standards.
446 Such a replacement drive will be rejected by
448 To guard against this it can be useful to set the initial size
449 slightly smaller than the smaller device with the aim that it will
450 still be larger than any replacement.
452 This value can be set with
454 for RAID level 1/4/5/6 though
456 based arrays such as those with IMSM metadata may not be able to
458 If the array was created with a size smaller than the currently
459 active drives, the extra space can be accessed using
461 The size can be given as
463 which means to choose the largest size that fits on all current drives.
465 Before reducing the size of the array (with
466 .BR "\-\-grow \-\-size=" )
467 you should make sure that space isn't needed. If the device holds a
468 filesystem, you would need to resize the filesystem to use less space.
470 After reducing the array size you should check that the data stored in
471 the device is still available. If the device holds a filesystem, then
472 an 'fsck' of the filesystem is a minimum requirement. If there are
473 problems the array can be made bigger again with no loss with another
474 .B "\-\-grow \-\-size="
477 This value cannot be used when creating a
479 such as with DDF and IMSM metadata, though it perfectly valid when
480 creating an array inside a container.
483 .BR \-Z ", " \-\-array\-size=
484 This is only meaningful with
486 and its effect is not persistent: when the array is stopped and
487 restarted the default array size will be restored.
489 Setting the array-size causes the array to appear smaller to programs
490 that access the data. This is particularly needed before reshaping an
491 array so that it will be smaller. As the reshape is not reversible,
492 but setting the size with
494 is, it is required that the array size is reduced as appropriate
495 before the number of devices in the array is reduced.
497 Before reducing the size of the array you should make sure that space
498 isn't needed. If the device holds a filesystem, you would need to
499 resize the filesystem to use less space.
501 After reducing the array size you should check that the data stored in
502 the device is still available. If the device holds a filesystem, then
503 an 'fsck' of the filesystem is a minimum requirement. If there are
504 problems the array can be made bigger again with no loss with another
505 .B "\-\-grow \-\-array\-size="
508 A suffix of 'M' or 'G' can be given to indicate Megabytes or
509 Gigabytes respectively.
512 restores the apparent size of the array to be whatever the real
513 amount of available space is.
516 .BR \-c ", " \-\-chunk=
517 Specify chunk size of kibibytes. The default when creating an
518 array is 512KB. To ensure compatibility with earlier versions, the
519 default when Building and array with no persistent metadata is 64KB.
520 This is only meaningful for RAID0, RAID4, RAID5, RAID6, and RAID10.
522 RAID4, RAID5, RAID6, and RAID10 require the chunk size to be a power
523 of 2. In any case it must be a multiple of 4KB.
525 A suffix of 'M' or 'G' can be given to indicate Megabytes or
526 Gigabytes respectively.
530 Specify rounding factor for a Linear array. The size of each
531 component will be rounded down to a multiple of this size.
532 This is a synonym for
534 but highlights the different meaning for Linear as compared to other
535 RAID levels. The default is 64K if a kernel earlier than 2.6.16 is in
536 use, and is 0K (i.e. no rounding) in later kernels.
539 .BR \-l ", " \-\-level=
540 Set RAID level. When used with
542 options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4,
543 raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty, container.
544 Obviously some of these are synonymous.
548 metadata type is requested, only the
550 level is permitted, and it does not need to be explicitly given.
554 only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid.
558 to change the RAID level in some cases. See LEVEL CHANGES below.
561 .BR \-p ", " \-\-layout=
562 This option configures the fine details of data layout for RAID5, RAID6,
563 and RAID10 arrays, and controls the failure modes for
566 The layout of the RAID5 parity block can be one of
567 .BR left\-asymmetric ,
568 .BR left\-symmetric ,
569 .BR right\-asymmetric ,
570 .BR right\-symmetric ,
571 .BR la ", " ra ", " ls ", " rs .
573 .BR left\-symmetric .
575 It is also possible to cause RAID5 to use a RAID4-like layout by
581 Finally for RAID5 there are DDF\-compatible layouts,
582 .BR ddf\-zero\-restart ,
583 .BR ddf\-N\-restart ,
585 .BR ddf\-N\-continue .
587 These same layouts are available for RAID6. There are also 4 layouts
588 that will provide an intermediate stage for converting between RAID5
589 and RAID6. These provide a layout which is identical to the
590 corresponding RAID5 layout on the first N\-1 devices, and has the 'Q'
591 syndrome (the second 'parity' block used by RAID6) on the last device.
593 .BR left\-symmetric\-6 ,
594 .BR right\-symmetric\-6 ,
595 .BR left\-asymmetric\-6 ,
596 .BR right\-asymmetric\-6 ,
598 .BR parity\-first\-6 .
600 When setting the failure mode for level
603 .BR write\-transient ", " wt ,
604 .BR read\-transient ", " rt ,
605 .BR write\-persistent ", " wp ,
606 .BR read\-persistent ", " rp ,
608 .BR read\-fixable ", " rf ,
609 .BR clear ", " flush ", " none .
611 Each failure mode can be followed by a number, which is used as a period
612 between fault generation. Without a number, the fault is generated
613 once on the first relevant request. With a number, the fault will be
614 generated after that many requests, and will continue to be generated
615 every time the period elapses.
617 Multiple failure modes can be current simultaneously by using the
619 option to set subsequent failure modes.
621 "clear" or "none" will remove any pending or periodic failure modes,
622 and "flush" will clear any persistent faults.
624 Finally, the layout options for RAID10 are one of 'n', 'o' or 'f' followed
625 by a small number. The default is 'n2'. The supported options are:
628 signals 'near' copies. Multiple copies of one data block are at
629 similar offsets in different devices.
632 signals 'offset' copies. Rather than the chunks being duplicated
633 within a stripe, whole stripes are duplicated but are rotated by one
634 device so duplicate blocks are on different devices. Thus subsequent
635 copies of a block are in the next drive, and are one chunk further
640 (multiple copies have very different offsets).
641 See md(4) for more detail about 'near', 'offset', and 'far'.
643 The number is the number of copies of each datablock. 2 is normal, 3
644 can be useful. This number can be at most equal to the number of
645 devices in the array. It does not need to divide evenly into that
646 number (e.g. it is perfectly legal to have an 'n2' layout for an array
647 with an odd number of devices).
649 When an array is converted between RAID5 and RAID6 an intermediate
650 RAID6 layout is used in which the second parity block (Q) is always on
651 the last device. To convert a RAID5 to RAID6 and leave it in this new
652 layout (which does not require re-striping) use
653 .BR \-\-layout=preserve .
654 This will try to avoid any restriping.
656 The converse of this is
657 .B \-\-layout=normalise
658 which will change a non-standard RAID6 layout into a more standard
665 (thus explaining the p of
669 .BR \-b ", " \-\-bitmap=
670 Specify a file to store a write-intent bitmap in. The file should not
673 is also given. The same file should be provided
674 when assembling the array. If the word
676 is given, then the bitmap is stored with the metadata on the array,
677 and so is replicated on all devices. If the word
681 mode, then any bitmap that is present is removed.
683 To help catch typing errors, the filename must contain at least one
684 slash ('/') if it is a real file (not 'internal' or 'none').
686 Note: external bitmaps are only known to work on ext2 and ext3.
687 Storing bitmap files on other filesystems may result in serious problems.
690 .BR \-\-bitmap\-chunk=
691 Set the chunksize of the bitmap. Each bit corresponds to that many
692 Kilobytes of storage.
693 When using a file based bitmap, the default is to use the smallest
694 size that is at-least 4 and requires no more than 2^21 chunks.
697 bitmap, the chunksize defaults to 64Meg, or larger if necessary to
698 fit the bitmap into the available space.
700 A suffix of 'M' or 'G' can be given to indicate Megabytes or
701 Gigabytes respectively.
704 .BR \-W ", " \-\-write\-mostly
705 subsequent devices listed in a
710 command will be flagged as 'write-mostly'. This is valid for RAID1
711 only and means that the 'md' driver will avoid reading from these
712 devices if at all possible. This can be useful if mirroring over a
716 .BR \-\-write\-behind=
717 Specify that write-behind mode should be enabled (valid for RAID1
718 only). If an argument is specified, it will set the maximum number
719 of outstanding writes allowed. The default value is 256.
720 A write-intent bitmap is required in order to use write-behind
721 mode, and write-behind is only attempted on drives marked as
725 .BR \-\-assume\-clean
728 that the array pre-existed and is known to be clean. It can be useful
729 when trying to recover from a major failure as you can be sure that no
730 data will be affected unless you actually write to the array. It can
731 also be used when creating a RAID1 or RAID10 if you want to avoid the
732 initial resync, however this practice \(em while normally safe \(em is not
733 recommended. Use this only if you really know what you are doing.
735 When the devices that will be part of a new array were filled
736 with zeros before creation the operator knows the array is
737 actually clean. If that is the case, such as after running
738 badblocks, this argument can be used to tell mdadm the
739 facts the operator knows.
741 When an array is resized to a larger size with
742 .B "\-\-grow \-\-size="
743 the new space is normally resynced in that same way that the whole
744 array is resynced at creation. From Linux version 3.0,
746 can be used with that command to avoid the automatic resync.
749 .BR \-\-backup\-file=
752 is used to increase the number of raid-devices in a RAID5 or RAID6 if
753 there are no spare devices available, or to shrink, change RAID level
754 or layout. See the GROW MODE section below on RAID\-DEVICES CHANGES.
755 The file must be stored on a separate device, not on the RAID array
760 Arrays with 1.x metadata can leave a gap between the start of the
761 device and the start of array data. This gap can be used for various
762 metadata. The start of data is known as the
764 Normally an appropriate data offset is computed automatically.
765 However it can be useful to set it explicitly such as when re-creating
766 an array which was originally created using a different version of
768 which computed a different offset.
770 Setting the offset explicitly over-rides the default. The value given
771 is in Kilobytes unless an 'M' or 'G' suffix is given.
775 can also be used with
777 for some RAID levels (initially on RAID10). This allows the
778 data\-offset to be changed as part of the reshape process. When the
779 data offset is changed, no backup file is required as the difference
780 in offsets is used to provide the same functionality.
782 When the new offset is earlier than the old offset, the number of
783 devices in the array cannot shrink. When it is after the old offset,
784 the number of devices in the array cannot increase.
786 When creating an array,
790 In the case each member device is expected to have a offset appended
791 to the name, separated by a colon. This makes it possible to recreate
792 exactly an array which has varying data offsets (as can happen when
793 different versions of
795 are used to add different devices).
799 This option is complementary to the
800 .B \-\-freeze-reshape
801 option for assembly. It is needed when
803 operation is interrupted and it is not restarted automatically due to
804 .B \-\-freeze-reshape
805 usage during array assembly. This option is used together with
809 ) command and device for a pending reshape to be continued.
810 All parameters required for reshape continuation will be read from array metadata.
814 .BR \-\-backup\-file=
815 option to be set, continuation option will require to have exactly the same
816 backup file given as well.
818 Any other parameter passed together with
820 option will be ignored.
823 .BR \-N ", " \-\-name=
826 for the array. This is currently only effective when creating an
827 array with a version-1 superblock, or an array in a DDF container.
828 The name is a simple textual string that can be used to identify array
829 components when assembling. If name is needed but not specified, it
830 is taken from the basename of the device that is being created.
842 run the array, even if some of the components
843 appear to be active in another array or filesystem. Normally
845 will ask for confirmation before including such components in an
846 array. This option causes that question to be suppressed.
849 .BR \-f ", " \-\-force
852 accept the geometry and layout specified without question. Normally
854 will not allow creation of an array with only one device, and will try
855 to create a RAID5 array with one missing drive (as this makes the
856 initial resync work faster). With
859 will not try to be so clever.
862 .BR \-o ", " \-\-readonly
865 rather than read-write as normal. No writes will be allowed to the
866 array, and no resync, recovery, or reshape will be started.
869 .BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}"
870 Instruct mdadm how to create the device file if needed, possibly allocating
871 an unused minor number. "md" causes a non-partitionable array
872 to be used (though since Linux 2.6.28, these array devices are in fact
873 partitionable). "mdp", "part" or "p" causes a partitionable array (2.6 and
874 later) to be used. "yes" requires the named md device to have
875 a 'standard' format, and the type and minor number will be determined
876 from this. With mdadm 3.0, device creation is normally left up to
878 so this option is unlikely to be needed.
879 See DEVICE NAMES below.
881 The argument can also come immediately after
886 is not given on the command line or in the config file, then
892 is also given, then any
894 entries in the config file will override the
896 instruction given on the command line.
898 For partitionable arrays,
900 will create the device file for the whole array and for the first 4
901 partitions. A different number of partitions can be specified at the
902 end of this option (e.g.
904 If the device name ends with a digit, the partition names add a 'p',
906 .IR /dev/md/home1p3 .
907 If there is no trailing digit, then the partition names just have a
909 .IR /dev/md/scratch3 .
911 If the md device name is in a 'standard' format as described in DEVICE
912 NAMES, then it will be created, if necessary, with the appropriate
913 device number based on that name. If the device name is not in one of these
914 formats, then a unused device number will be allocated. The device
915 number will be considered unused if there is no active array for that
916 number, and there is no entry in /dev for that number and with a
917 non-standard name. Names that are not in 'standard' format are only
918 allowed in "/dev/md/".
920 This is meaningful with
926 .BR \-a ", " "\-\-add"
927 This option can be used in Grow mode in two cases.
929 If the target array is a Linear array, then
931 can be used to add one or more devices to the array. They
932 are simply catenated on to the end of the array. Once added, the
933 devices cannot be removed.
937 option is being used to increase the number of devices in an array,
940 can be used to add some extra devices to be included in the array.
941 In most cases this is not needed as the extra devices can be added as
942 spares first, and then the number of raid-disks can be changed.
943 However for RAID0, it is not possible to add spares. So to increase
944 the number of devices in a RAID0, it is necessary to set the new
945 number of devices, and to add the new devices, in the same command.
950 .BR \-u ", " \-\-uuid=
951 uuid of array to assemble. Devices which don't have this uuid are
955 .BR \-m ", " \-\-super\-minor=
956 Minor number of device that array was created for. Devices which
957 don't have this minor number are excluded. If you create an array as
958 /dev/md1, then all superblocks will contain the minor number 1, even if
959 the array is later assembled as /dev/md2.
961 Giving the literal word "dev" for
965 to use the minor number of the md device that is being assembled.
968 .B \-\-super\-minor=dev
969 will look for super blocks with a minor number of 0.
972 is only relevant for v0.90 metadata, and should not normally be used.
978 .BR \-N ", " \-\-name=
979 Specify the name of the array to assemble. This must be the name
980 that was specified when creating the array. It must either match
981 the name stored in the superblock exactly, or it must match
984 prefixed to the start of the given name.
987 .BR \-f ", " \-\-force
988 Assemble the array even if the metadata on some devices appears to be
991 cannot find enough working devices to start the array, but can find
992 some devices that are recorded as having failed, then it will mark
993 those devices as working so that the array can be started.
994 An array which requires
996 to be started may contain data corruption. Use it carefully.
1000 Attempt to start the array even if fewer drives were given than were
1001 present last time the array was active. Normally if not all the
1002 expected drives are found and
1004 is not used, then the array will be assembled but not started.
1007 an attempt will be made to start it anyway.
1011 This is the reverse of
1013 in that it inhibits the startup of array unless all expected drives
1014 are present. This is only needed with
1016 and can be used if the physical connections to devices are
1017 not as reliable as you would like.
1020 .BR \-a ", " "\-\-auto{=no,yes,md,mdp,part}"
1021 See this option under Create and Build options.
1024 .BR \-b ", " \-\-bitmap=
1025 Specify the bitmap file that was given when the array was created. If
1028 bitmap, there is no need to specify this when assembling the array.
1031 .BR \-\-backup\-file=
1034 was used while reshaping an array (e.g. changing number of devices or
1035 chunk size) and the system crashed during the critical section, then the same
1037 must be presented to
1039 to allow possibly corrupted data to be restored, and the reshape
1043 .BR \-\-invalid\-backup
1044 If the file needed for the above option is not available for any
1045 reason an empty file can be given together with this option to
1046 indicate that the backup file is invalid. In this case the data that
1047 was being rearranged at the time of the crash could be irrecoverably
1048 lost, but the rest of the array may still be recoverable. This option
1049 should only be used as a last resort if there is no way to recover the
1054 .BR \-U ", " \-\-update=
1055 Update the superblock on each device while assembling the array. The
1056 argument given to this flag can be one of
1073 option will adjust the superblock of an array what was created on a Sparc
1074 machine running a patched 2.2 Linux kernel. This kernel got the
1075 alignment of part of the superblock wrong. You can use the
1076 .B "\-\-examine \-\-sparc2.2"
1079 to see what effect this would have.
1083 option will update the
1084 .B "preferred minor"
1085 field on each superblock to match the minor number of the array being
1087 This can be useful if
1089 reports a different "Preferred Minor" to
1091 In some cases this update will be performed automatically
1092 by the kernel driver. In particular the update happens automatically
1093 at the first write to an array with redundancy (RAID level 1 or
1094 greater) on a 2.6 (or later) kernel.
1098 option will change the uuid of the array. If a UUID is given with the
1100 option that UUID will be used as a new UUID and will
1102 be used to help identify the devices in the array.
1105 is given, a random UUID is chosen.
1109 option will change the
1111 of the array as stored in the superblock. This is only supported for
1112 version-1 superblocks.
1116 option will change the
1118 as recorded in the superblock. For version-0 superblocks, this is the
1119 same as updating the UUID.
1120 For version-1 superblocks, this involves updating the name.
1124 option will cause the array to be marked
1126 meaning that any redundancy in the array (e.g. parity for RAID5,
1127 copies for RAID1) may be incorrect. This will cause the RAID system
1128 to perform a "resync" pass to make sure that all redundant information
1133 option allows arrays to be moved between machines with different
1135 When assembling such an array for the first time after a move, giving
1136 .B "\-\-update=byteorder"
1139 to expect superblocks to have their byteorder reversed, and will
1140 correct that order before assembling the array. This is only valid
1141 with original (Version 0.90) superblocks.
1145 option will correct the summaries in the superblock. That is the
1146 counts of total, working, active, failed, and spare devices.
1150 option will rarely be of use. It applies to version 1.1 and 1.2 metadata
1151 only (where the metadata is at the start of the device) and is only
1152 useful when the component device has changed size (typically become
1153 larger). The version 1 metadata records the amount of the device that
1154 can be used to store data, so if a device in a version 1.1 or 1.2
1155 array becomes larger, the metadata will still be visible, but the
1156 extra space will not. In this case it might be useful to assemble the
1158 .BR \-\-update=devicesize .
1161 to determine the maximum usable amount of space on each device and
1162 update the relevant field in the metadata.
1166 option can be used when an array has an internal bitmap which is
1167 corrupt in some way so that assembling the array normally fails. It
1168 will cause any internal bitmap to be ignored.
1172 option will reserve space in each device for a bad block list. This
1173 will be 4K in size and positioned near the end of any free space
1174 between the superblock and the data.
1178 option will cause any reservation of space for a bad block list to be
1179 removed. If the bad block list contains entries, this will fail, as
1180 removing the list could cause data corruption.
1183 .BR \-\-freeze\-reshape
1184 Option is intended to be used in start-up scripts during initrd boot phase.
1185 When array under reshape is assembled during initrd phase, this option
1186 stops reshape after reshape critical section is being restored. This happens
1187 before file system pivot operation and avoids loss of file system context.
1188 Losing file system context would cause reshape to be broken.
1190 Reshape can be continued later using the
1192 option for the grow command.
1194 .SH For Manage mode:
1197 .BR \-t ", " \-\-test
1198 Unless a more serious error occurred,
1200 will exit with a status of 2 if no changes were made to the array and
1201 0 if at least one change was made.
1202 This can be useful when an indirect specifier such as
1207 is used in requesting an operation on the array.
1209 will report failure if these specifiers didn't find any match.
1212 .BR \-a ", " \-\-add
1213 hot-add listed devices.
1214 If a device appears to have recently been part of the array
1215 (possibly it failed or was removed) the device is re\-added as described
1217 If that fails or the device was never part of the array, the device is
1218 added as a hot-spare.
1219 If the array is degraded, it will immediately start to rebuild data
1222 Note that this and the following options are only meaningful on array
1223 with redundancy. They don't apply to RAID0 or Linear.
1227 re\-add a device that was previous removed from an array.
1228 If the metadata on the device reports that it is a member of the
1229 array, and the slot that it used is still vacant, then the device will
1230 be added back to the array in the same position. This will normally
1231 cause the data for that device to be recovered. However based on the
1232 event count on the device, the recovery may only require sections that
1233 are flagged a write-intent bitmap to be recovered or may not require
1234 any recovery at all.
1236 When used on an array that has no metadata (i.e. it was built with
1238 it will be assumed that bitmap-based recovery is enough to make the
1239 device fully consistent with the array.
1241 When used with v1.x metadata,
1243 can be accompanied by
1244 .BR \-\-update=devicesize ,
1245 .BR \-\-update=bbl ", or"
1246 .BR \-\-update=no\-bbl .
1247 See the description of these option when used in Assemble mode for an
1248 explanation of their use.
1250 If the device name given is
1254 will try to find any device that looks like it should be
1255 part of the array but isn't and will try to re\-add all such devices.
1257 If the device name given is
1261 will find all devices in the array that are marked
1263 remove them and attempt to immediately re\-add them. This can be
1264 useful if you are certain that the reason for failure has been
1268 .BR \-r ", " \-\-remove
1269 remove listed devices. They must not be active. i.e. they should
1270 be failed or spare devices. As well as the name of a device file
1279 The first causes all failed device to be removed. The second causes
1280 any device which is no longer connected to the system (i.e an 'open'
1283 to be removed. This will only succeed for devices that are spares or
1284 have already been marked as failed.
1287 .BR \-f ", " \-\-fail
1288 Mark listed devices as faulty.
1289 As well as the name of a device file, the word
1291 can be given. This will cause any device that has been detached from
1292 the system to be marked as failed. It can then be removed.
1301 Mark listed devices as requiring replacement. As soon as a spare is
1302 available, it will be rebuilt and will replace the marked device.
1303 This is similar to marking a device as faulty, but the device remains
1304 in service during the recovery process to increase resilience against
1305 multiple failures. When the replacement process finishes, the
1306 replaced device will be marked as faulty.
1310 This can follow a list of
1312 devices. The devices listed after
1314 will be preferentially used to replace the devices listed after
1316 These device must already be spare devices in the array.
1319 .BR \-\-write\-mostly
1320 Subsequent devices that are added or re\-added will have the 'write-mostly'
1321 flag set. This is only valid for RAID1 and means that the 'md' driver
1322 will avoid reading from these devices if possible.
1325 Subsequent devices that are added or re\-added will have the 'write-mostly'
1329 Each of these options requires that the first device listed is the array
1330 to be acted upon, and the remainder are component devices to be added,
1331 removed, marked as faulty, etc. Several different operations can be
1332 specified for different devices, e.g.
1334 mdadm /dev/md0 \-\-add /dev/sda1 \-\-fail /dev/sdb1 \-\-remove /dev/sdb1
1336 Each operation applies to all devices listed until the next
1339 If an array is using a write-intent bitmap, then devices which have
1340 been removed can be re\-added in a way that avoids a full
1341 reconstruction but instead just updates the blocks that have changed
1342 since the device was removed. For arrays with persistent metadata
1343 (superblocks) this is done automatically. For arrays created with
1345 mdadm needs to be told that this device we removed recently with
1348 Devices can only be removed from an array if they are not in active
1349 use, i.e. that must be spares or failed devices. To remove an active
1350 device, it must first be marked as
1356 .BR \-Q ", " \-\-query
1357 Examine a device to see
1358 (1) if it is an md device and (2) if it is a component of an md
1360 Information about what is discovered is presented.
1363 .BR \-D ", " \-\-detail
1364 Print details of one or more md devices.
1367 .BR \-\-detail\-platform
1368 Print details of the platform's RAID capabilities (firmware / hardware
1369 topology) for a given metadata format. If used without argument, mdadm
1370 will scan all controllers looking for their capabilities. Otherwise, mdadm
1371 will only look at the controller specified by the argument in form of an
1372 absolute filepath or a link, e.g.
1373 .IR /sys/devices/pci0000:00/0000:00:1f.2 .
1376 .BR \-Y ", " \-\-export
1378 .B \-\-detail , \-\-detail-platform
1381 output will be formatted as
1383 pairs for easy import into the environment.
1386 .BR \-E ", " \-\-examine
1387 Print contents of the metadata stored on the named device(s).
1388 Note the contrast between
1393 applies to devices which are components of an array, while
1395 applies to a whole array which is currently active.
1398 If an array was created on a SPARC machine with a 2.2 Linux kernel
1399 patched with RAID support, the superblock will have been created
1400 incorrectly, or at least incompatibly with 2.4 and later kernels.
1405 will fix the superblock before displaying it. If this appears to do
1406 the right thing, then the array can be successfully assembled using
1407 .BR "\-\-assemble \-\-update=sparc2.2" .
1410 .BR \-X ", " \-\-examine\-bitmap
1411 Report information about a bitmap file.
1412 The argument is either an external bitmap file or an array component
1413 in case of an internal bitmap. Note that running this on an array
1416 does not report the bitmap for that array.
1419 .B \-\-examine\-badblocks
1420 List the bad-blocks recorded for the device, if a bad-blocks list has
1421 been configured. Currently only
1423 metadata supports bad-blocks lists.
1426 .BR \-R ", " \-\-run
1427 start a partially assembled array. If
1429 did not find enough devices to fully start the array, it might leaving
1430 it partially assembled. If you wish, you can then use
1432 to start the array in degraded mode.
1435 .BR \-S ", " \-\-stop
1436 deactivate array, releasing all resources.
1439 .BR \-o ", " \-\-readonly
1440 mark array as readonly.
1443 .BR \-w ", " \-\-readwrite
1444 mark array as readwrite.
1447 .B \-\-zero\-superblock
1448 If the device contains a valid md superblock, the block is
1449 overwritten with zeros. With
1451 the block where the superblock would be is overwritten even if it
1452 doesn't appear to be valid.
1455 .B \-\-kill\-subarray=
1456 If the device is a container and the argument to \-\-kill\-subarray
1457 specifies an inactive subarray in the container, then the subarray is
1458 deleted. Deleting all subarrays will leave an 'empty-container' or
1459 spare superblock on the drives. See \-\-zero\-superblock for completely
1460 removing a superblock. Note that some formats depend on the subarray
1461 index for generating a UUID, this command will fail if it would change
1462 the UUID of an active subarray.
1465 .B \-\-update\-subarray=
1466 If the device is a container and the argument to \-\-update\-subarray
1467 specifies a subarray in the container, then attempt to update the given
1468 superblock field in the subarray. See below in
1473 .BR \-t ", " \-\-test
1478 is set to reflect the status of the device. See below in
1483 .BR \-W ", " \-\-wait
1484 For each md device given, wait for any resync, recovery, or reshape
1485 activity to finish before returning.
1487 will return with success if it actually waited for every device
1488 listed, otherwise it will return failure.
1492 For each md device given, or each device in /proc/mdstat if
1494 is given, arrange for the array to be marked clean as soon as possible.
1496 will return with success if the array uses external metadata and we
1497 successfully waited. For native arrays this returns immediately as the
1498 kernel handles dirty-clean transitions at shutdown. No action is taken
1499 if safe-mode handling is disabled.
1501 .SH For Incremental Assembly mode:
1503 .BR \-\-rebuild\-map ", " \-r
1504 Rebuild the map file
1508 uses to help track which arrays are currently being assembled.
1511 .BR \-\-run ", " \-R
1512 Run any array assembled as soon as a minimal number of devices are
1513 available, rather than waiting until all expected devices are present.
1516 .BR \-\-scan ", " \-s
1517 Only meaningful with
1521 file for arrays that are being incrementally assembled and will try to
1522 start any that are not already started. If any such array is listed
1525 as requiring an external bitmap, that bitmap will be attached first.
1528 .BR \-\-fail ", " \-f
1529 This allows the hot-plug system to remove devices that have fully disappeared
1530 from the kernel. It will first fail and then remove the device from any
1531 array it belongs to.
1532 The device name given should be a kernel device name such as "sda",
1538 Only used with \-\-fail. The 'path' given will be recorded so that if
1539 a new device appears at the same location it can be automatically
1540 added to the same array. This allows the failed device to be
1541 automatically replaced by a new device without metadata if it appears
1542 at specified path. This option is normally only set by a
1546 .SH For Monitor mode:
1548 .BR \-m ", " \-\-mail
1549 Give a mail address to send alerts to.
1552 .BR \-p ", " \-\-program ", " \-\-alert
1553 Give a program to be run whenever an event is detected.
1556 .BR \-y ", " \-\-syslog
1557 Cause all events to be reported through 'syslog'. The messages have
1558 facility of 'daemon' and varying priorities.
1561 .BR \-d ", " \-\-delay
1562 Give a delay in seconds.
1564 polls the md arrays and then waits this many seconds before polling
1565 again. The default is 60 seconds. Since 2.6.16, there is no need to
1566 reduce this as the kernel alerts
1568 immediately when there is any change.
1571 .BR \-r ", " \-\-increment
1572 Give a percentage increment.
1574 will generate RebuildNN events with the given percentage increment.
1577 .BR \-f ", " \-\-daemonise
1580 to run as a background daemon if it decides to monitor anything. This
1581 causes it to fork and run in the child, and to disconnect from the
1582 terminal. The process id of the child is written to stdout.
1585 which will only continue monitoring if a mail address or alert program
1586 is found in the config file.
1589 .BR \-i ", " \-\-pid\-file
1592 is running in daemon mode, write the pid of the daemon process to
1593 the specified file, instead of printing it on standard output.
1596 .BR \-1 ", " \-\-oneshot
1597 Check arrays only once. This will generate
1599 events and more significantly
1605 .B " mdadm \-\-monitor \-\-scan \-1"
1607 from a cron script will ensure regular notification of any degraded arrays.
1610 .BR \-t ", " \-\-test
1613 alert for every array found at startup. This alert gets mailed and
1614 passed to the alert program. This can be used for testing that alert
1615 message do get through successfully.
1619 This inhibits the functionality for moving spares between arrays.
1620 Only one monitoring process started with
1622 but without this flag is allowed, otherwise the two could interfere
1629 .B mdadm \-\-assemble
1630 .I md-device options-and-component-devices...
1633 .B mdadm \-\-assemble \-\-scan
1634 .I md-devices-and-options...
1637 .B mdadm \-\-assemble \-\-scan
1641 This usage assembles one or more RAID arrays from pre-existing components.
1642 For each array, mdadm needs to know the md device, the identity of the
1643 array, and a number of component-devices. These can be found in a number of ways.
1645 In the first usage example (without the
1647 the first device given is the md device.
1648 In the second usage example, all devices listed are treated as md
1649 devices and assembly is attempted.
1650 In the third (where no devices are listed) all md devices that are
1651 listed in the configuration file are assembled. If no arrays are
1652 described by the configuration file, then any arrays that
1653 can be found on unused devices will be assembled.
1655 If precisely one device is listed, but
1661 was given and identity information is extracted from the configuration file.
1663 The identity can be given with the
1669 option, will be taken from the md-device record in the config file, or
1670 will be taken from the super block of the first component-device
1671 listed on the command line.
1673 Devices can be given on the
1675 command line or in the config file. Only devices which have an md
1676 superblock which contains the right identity will be considered for
1679 The config file is only used if explicitly named with
1681 or requested with (a possibly implicit)
1686 .B /etc/mdadm/mdadm.conf
1691 is not given, then the config file will only be used to find the
1692 identity of md arrays.
1694 Normally the array will be started after it is assembled. However if
1696 is not given and not all expected drives were listed, then the array
1697 is not started (to guard against usage errors). To insist that the
1698 array be started in this case (as may work for RAID1, 4, 5, 6, or 10),
1707 does not create any entries in
1711 It does record information in
1715 to choose the correct name.
1719 detects that udev is not configured, it will create the devices in
1723 In Linux kernels prior to version 2.6.28 there were two distinctly
1724 different types of md devices that could be created: one that could be
1725 partitioned using standard partitioning tools and one that could not.
1726 Since 2.6.28 that distinction is no longer relevant as both type of
1727 devices can be partitioned.
1729 will normally create the type that originally could not be partitioned
1730 as it has a well defined major number (9).
1732 Prior to 2.6.28, it is important that mdadm chooses the correct type
1733 of array device to use. This can be controlled with the
1735 option. In particular, a value of "mdp" or "part" or "p" tells mdadm
1736 to use a partitionable device rather than the default.
1738 In the no-udev case, the value given to
1740 can be suffixed by a number. This tells
1742 to create that number of partition devices rather than the default of 4.
1746 can also be given in the configuration file as a word starting
1748 on the ARRAY line for the relevant array.
1755 and no devices are listed,
1757 will first attempt to assemble all the arrays listed in the config
1760 If no arrays are listed in the config (other than those marked
1762 it will look through the available devices for possible arrays and
1763 will try to assemble anything that it finds. Arrays which are tagged
1764 as belonging to the given homehost will be assembled and started
1765 normally. Arrays which do not obviously belong to this host are given
1766 names that are expected not to conflict with anything local, and are
1767 started "read-auto" so that nothing is written to any device until the
1768 array is written to. i.e. automatic resync etc is delayed.
1772 finds a consistent set of devices that look like they should comprise
1773 an array, and if the superblock is tagged as belonging to the given
1774 home host, it will automatically choose a device name and try to
1775 assemble the array. If the array uses version-0.90 metadata, then the
1777 number as recorded in the superblock is used to create a name in
1781 If the array uses version-1 metadata, then the
1783 from the superblock is used to similarly create a name in
1785 (the name will have any 'host' prefix stripped first).
1787 This behaviour can be modified by the
1791 configuration file. This line can indicate that specific metadata
1792 type should, or should not, be automatically assembled. If an array
1793 is found which is not listed in
1795 and has a metadata format that is denied by the
1797 line, then it will not be assembled.
1800 line can also request that all arrays identified as being for this
1801 homehost should be assembled regardless of their metadata type.
1804 for further details.
1806 Note: Auto assembly cannot be used for assembling and activating some
1807 arrays which are undergoing reshape. In particular as the
1809 cannot be given, any reshape which requires a backup-file to continue
1810 cannot be started by auto assembly. An array which is growing to more
1811 devices and has passed the critical section can be assembled using
1822 .BI \-\-raid\-devices= Z
1826 This usage is similar to
1828 The difference is that it creates an array without a superblock. With
1829 these arrays there is no difference between initially creating the array and
1830 subsequently assembling the array, except that hopefully there is useful
1831 data there in the second case.
1833 The level may raid0, linear, raid1, raid10, multipath, or faulty, or
1834 one of their synonyms. All devices must be listed and the array will
1835 be started once complete. It will often be appropriate to use
1836 .B \-\-assume\-clean
1837 with levels raid1 or raid10.
1848 .BI \-\-raid\-devices= Z
1852 This usage will initialise a new md array, associate some devices with
1853 it, and activate the array.
1855 The named device will normally not exist when
1856 .I "mdadm \-\-create"
1857 is run, but will be created by
1859 once the array becomes active.
1861 As devices are added, they are checked to see if they contain RAID
1862 superblocks or filesystems. They are also checked to see if the variance in
1863 device size exceeds 1%.
1865 If any discrepancy is found, the array will not automatically be run, though
1868 can override this caution.
1870 To create a "degraded" array in which some devices are missing, simply
1871 give the word "\fBmissing\fP"
1872 in place of a device name. This will cause
1874 to leave the corresponding slot in the array empty.
1875 For a RAID4 or RAID5 array at most one slot can be
1876 "\fBmissing\fP"; for a RAID6 array at most two slots.
1877 For a RAID1 array, only one real device needs to be given. All of the
1881 When creating a RAID5 array,
1883 will automatically create a degraded array with an extra spare drive.
1884 This is because building the spare into a degraded array is in general
1885 faster than resyncing the parity on a non-degraded, but not clean,
1886 array. This feature can be overridden with the
1890 When creating an array with version-1 metadata a name for the array is
1892 If this is not given with the
1896 will choose a name based on the last component of the name of the
1897 device being created. So if
1899 is being created, then the name
1904 is being created, then the name
1908 When creating a partition based array, using
1910 with version-1.x metadata, the partition type should be set to
1912 (non fs-data). This type selection allows for greater precision since
1913 using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)],
1914 might create problems in the event of array recovery through a live cdrom.
1916 A new array will normally get a randomly assigned 128bit UUID which is
1917 very likely to be unique. If you have a specific need, you can choose
1918 a UUID for the array by giving the
1920 option. Be warned that creating two arrays with the same UUID is a
1921 recipe for disaster. Also, using
1923 when creating a v0.90 array will silently override any
1928 .\"option is given, it is not necessary to list any component-devices in this command.
1929 .\"They can be added later, before a
1933 .\"is given, the apparent size of the smallest drive given is used.
1935 If the metadata type supports it (currently only 1.x metadata), space
1936 will be allocated to store a bad block list. This allows a modest
1937 number of bad blocks to be recorded, allowing the drive to remain in
1938 service while only partially functional.
1940 When creating an array within a
1943 can be given either the list of devices to use, or simply the name of
1944 the container. The former case gives control over which devices in
1945 the container will be used for the array. The latter case allows
1947 to automatically choose which devices to use based on how much spare
1950 The General Management options that are valid with
1955 insist on running the array even if some devices look like they might
1960 start the array readonly \(em not supported yet.
1967 .I options... devices...
1970 This usage will allow individual devices in an array to be failed,
1971 removed or added. It is possible to perform multiple operations with
1972 on command. For example:
1974 .B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1"
1980 and will then remove it from the array and finally add it back
1981 in as a spare. However only one md array can be affected by a single
1984 When a device is added to an active array, mdadm checks to see if it
1985 has metadata on it which suggests that it was recently a member of the
1986 array. If it does, it tries to "re\-add" the device. If there have
1987 been no changes since the device was removed, or if the array has a
1988 write-intent bitmap which has recorded whatever changes there were,
1989 then the device will immediately become a full member of the array and
1990 those differences recorded in the bitmap will be resolved.
2000 MISC mode includes a number of distinct operations that
2001 operate on distinct devices. The operations are:
2004 The device is examined to see if it is
2005 (1) an active md array, or
2006 (2) a component of an md array.
2007 The information discovered is reported.
2011 The device should be an active md device.
2013 will display a detailed description of the array.
2017 will cause the output to be less detailed and the format to be
2018 suitable for inclusion in
2022 will normally be 0 unless
2024 failed to get useful information about the device(s); however, if the
2026 option is given, then the exit status will be:
2030 The array is functioning normally.
2033 The array has at least one failed device.
2036 The array has multiple failed devices such that it is unusable.
2039 There was an error while trying to get information about the device.
2043 .B \-\-detail\-platform
2044 Print detail of the platform's RAID capabilities (firmware / hardware
2045 topology). If the metadata is specified with
2049 then the return status will be:
2053 metadata successfully enumerated its platform components on this system
2056 metadata is platform independent
2059 metadata failed to find its platform components on this system
2063 .B \-\-update\-subarray=
2064 If the device is a container and the argument to \-\-update\-subarray
2065 specifies a subarray in the container, then attempt to update the given
2066 superblock field in the subarray. Similar to updating an array in
2067 "assemble" mode, the field to update is selected by
2071 option. Currently only
2077 option updates the subarray name in the metadata, it may not affect the
2078 device node name or the device node symlink until the subarray is
2079 re\-assembled. If updating
2081 would change the UUID of an active subarray this operation is blocked,
2082 and the command will end in an error.
2086 The device should be a component of an md array.
2088 will read the md superblock of the device and display the contents.
2093 is given, then multiple devices that are components of the one array
2094 are grouped together and reported in a single entry suitable
2100 without listing any devices will cause all devices listed in the
2101 config file to be examined.
2105 The devices should be active md arrays which will be deactivated, as
2106 long as they are not currently in use.
2110 This will fully activate a partially assembled md array.
2114 This will mark an active array as read-only, providing that it is
2115 not currently being used.
2121 array back to being read/write.
2125 For all operations except
2128 will cause the operation to be applied to all arrays listed in
2133 causes all devices listed in the config file to be examined.
2136 .BR \-b ", " \-\-brief
2137 Be less verbose. This is used with
2145 gives an intermediate level of verbosity.
2151 .B mdadm \-\-monitor
2152 .I options... devices...
2157 to periodically poll a number of md arrays and to report on any events
2160 will never exit once it decides that there are arrays to be checked,
2161 so it should normally be run in the background.
2163 As well as reporting events,
2165 may move a spare drive from one array to another if they are in the
2170 and if the destination array has a failed drive but no spares.
2172 If any devices are listed on the command line,
2174 will only monitor those devices. Otherwise all arrays listed in the
2175 configuration file will be monitored. Further, if
2177 is given, then any other md devices that appear in
2179 will also be monitored.
2181 The result of monitoring the arrays is the generation of events.
2182 These events are passed to a separate program (if specified) and may
2183 be mailed to a given E-mail address.
2185 When passing events to a program, the program is run once for each event,
2186 and is given 2 or 3 command-line arguments: the first is the
2187 name of the event (see below), the second is the name of the
2188 md device which is affected, and the third is the name of a related
2189 device if relevant (such as a component device that has failed).
2193 is given, then a program or an E-mail address must be specified on the
2194 command line or in the config file. If neither are available, then
2196 will not monitor anything.
2200 will continue monitoring as long as something was found to monitor. If
2201 no program or email is given, then each event is reported to
2204 The different events are:
2208 .B DeviceDisappeared
2209 An md array which previously was configured appears to no longer be
2210 configured. (syslog priority: Critical)
2214 was told to monitor an array which is RAID0 or Linear, then it will
2216 .B DeviceDisappeared
2217 with the extra information
2219 This is because RAID0 and Linear do not support the device-failed,
2220 hot-spare and resync operations which are monitored.
2224 An md array started reconstruction. (syslog priority: Warning)
2230 is a two-digit number (ie. 05, 48). This indicates that rebuild
2231 has passed that many percent of the total. The events are generated
2232 with fixed increment since 0. Increment size may be specified with
2233 a commandline option (default is 20). (syslog priority: Warning)
2237 An md array that was rebuilding, isn't any more, either because it
2238 finished normally or was aborted. (syslog priority: Warning)
2242 An active component device of an array has been marked as
2243 faulty. (syslog priority: Critical)
2247 A spare component device which was being rebuilt to replace a faulty
2248 device has failed. (syslog priority: Critical)
2252 A spare component device which was being rebuilt to replace a faulty
2253 device has been successfully rebuilt and has been made active.
2254 (syslog priority: Info)
2258 A new md array has been detected in the
2260 file. (syslog priority: Info)
2264 A newly noticed array appears to be degraded. This message is not
2267 notices a drive failure which causes degradation, but only when
2269 notices that an array is degraded when it first sees the array.
2270 (syslog priority: Critical)
2274 A spare drive has been moved from one array in a
2278 to another to allow a failed drive to be replaced.
2279 (syslog priority: Info)
2285 has been told, via the config file, that an array should have a certain
2286 number of spare devices, and
2288 detects that it has fewer than this number when it first sees the
2289 array, it will report a
2292 (syslog priority: Warning)
2296 An array was found at startup, and the
2299 (syslog priority: Info)
2309 cause Email to be sent. All events cause the program to be run.
2310 The program is run with two or three arguments: the event
2311 name, the array device and possibly a second device.
2313 Each event has an associated array device (e.g.
2315 and possibly a second device. For
2320 the second device is the relevant component device.
2323 the second device is the array that the spare was moved from.
2327 to move spares from one array to another, the different arrays need to
2328 be labeled with the same
2330 or the spares must be allowed to migrate through matching POLICY domains
2331 in the configuration file. The
2333 name can be any string; it is only necessary that different spare
2334 groups use different names.
2338 detects that an array in a spare group has fewer active
2339 devices than necessary for the complete array, and has no spare
2340 devices, it will look for another array in the same spare group that
2341 has a full complement of working drive and a spare. It will then
2342 attempt to remove the spare from the second drive and add it to the
2344 If the removal succeeds but the adding fails, then it is added back to
2347 If the spare group for a degraded array is not defined,
2349 will look at the rules of spare migration specified by POLICY lines in
2351 and then follow similar steps as above if a matching spare is found.
2354 The GROW mode is used for changing the size or shape of an active
2356 For this to work, the kernel must support the necessary change.
2357 Various types of growth are being added during 2.6 development.
2359 Currently the supported changes include
2361 change the "size" attribute for RAID1, RAID4, RAID5 and RAID6.
2363 increase or decrease the "raid\-devices" attribute of RAID0, RAID1, RAID4,
2366 change the chunk-size and layout of RAID0, RAID4, RAID5 and RAID6.
2368 convert between RAID1 and RAID5, between RAID5 and RAID6, between
2369 RAID0, RAID4, and RAID5, and between RAID0 and RAID10 (in the near-2 mode).
2371 add a write-intent bitmap to any array which supports these bitmaps, or
2372 remove a write-intent bitmap from such an array.
2375 Using GROW on containers is currently supported only for Intel's IMSM
2376 container format. The number of devices in a container can be
2377 increased - which affects all arrays in the container - or an array
2378 in a container can be converted between levels where those levels are
2379 supported by the container, and the conversion is on of those listed
2380 above. Resizing arrays in an IMSM container with
2382 is not yet supported.
2384 Grow functionality (e.g. expand a number of raid devices) for Intel's
2385 IMSM container format has an experimental status. It is guarded by the
2386 .B MDADM_EXPERIMENTAL
2387 environment variable which must be set to '1' for a GROW command to
2389 This is for the following reasons:
2392 Intel's native IMSM check-pointing is not fully tested yet.
2393 This can causes IMSM incompatibility during the grow process: an array
2394 which is growing cannot roam between Microsoft Windows(R) and Linux
2398 Interrupting a grow operation is not recommended, because it
2399 has not been fully tested for Intel's IMSM container format yet.
2402 Note: Intel's native checkpointing doesn't use
2404 option and it is transparent for assembly feature.
2407 Normally when an array is built the "size" is taken from the smallest
2408 of the drives. If all the small drives in an arrays are, one at a
2409 time, removed and replaced with larger drives, then you could have an
2410 array of large drives with only a small amount used. In this
2411 situation, changing the "size" with "GROW" mode will allow the extra
2412 space to start being used. If the size is increased in this way, a
2413 "resync" process will start to make sure the new parts of the array
2416 Note that when an array changes size, any filesystem that may be
2417 stored in the array will not automatically grow or shrink to use or
2418 vacate the space. The
2419 filesystem will need to be explicitly told to use the extra space
2420 after growing, or to reduce its size
2422 to shrinking the array.
2424 Also the size of an array cannot be changed while it has an active
2425 bitmap. If an array has a bitmap, it must be removed before the size
2426 can be changed. Once the change is complete a new bitmap can be created.
2428 .SS RAID\-DEVICES CHANGES
2430 A RAID1 array can work with any number of devices from 1 upwards
2431 (though 1 is not very useful). There may be times which you want to
2432 increase or decrease the number of active devices. Note that this is
2433 different to hot-add or hot-remove which changes the number of
2436 When reducing the number of devices in a RAID1 array, the slots which
2437 are to be removed from the array must already be vacant. That is, the
2438 devices which were in those slots must be failed and removed.
2440 When the number of devices is increased, any hot spares that are
2441 present will be activated immediately.
2443 Changing the number of active devices in a RAID5 or RAID6 is much more
2444 effort. Every block in the array will need to be read and written
2445 back to a new location. From 2.6.17, the Linux Kernel is able to
2446 increase the number of devices in a RAID5 safely, including restarting
2447 an interrupted "reshape". From 2.6.31, the Linux Kernel is able to
2448 increase or decrease the number of devices in a RAID5 or RAID6.
2450 From 2.6.35, the Linux Kernel is able to convert a RAID0 in to a RAID4
2453 uses this functionality and the ability to add
2454 devices to a RAID4 to allow devices to be added to a RAID0. When
2455 requested to do this,
2457 will convert the RAID0 to a RAID4, add the necessary disks and make
2458 the reshape happen, and then convert the RAID4 back to RAID0.
2460 When decreasing the number of devices, the size of the array will also
2461 decrease. If there was data in the array, it could get destroyed and
2462 this is not reversible, so you should firstly shrink the filesystem on
2463 the array to fit within the new size. To help prevent accidents,
2465 requires that the size of the array be decreased first with
2466 .BR "mdadm --grow --array-size" .
2467 This is a reversible change which simply makes the end of the array
2468 inaccessible. The integrity of any data can then be checked before
2469 the non-reversible reduction in the number of devices is request.
2471 When relocating the first few stripes on a RAID5 or RAID6, it is not
2472 possible to keep the data on disk completely consistent and
2473 crash-proof. To provide the required safety, mdadm disables writes to
2474 the array while this "critical section" is reshaped, and takes a
2475 backup of the data that is in that section. For grows, this backup may be
2476 stored in any spare devices that the array has, however it can also be
2477 stored in a separate file specified with the
2479 option, and is required to be specified for shrinks, RAID level
2480 changes and layout changes. If this option is used, and the system
2481 does crash during the critical period, the same file must be passed to
2483 to restore the backup and reassemble the array. When shrinking rather
2484 than growing the array, the reshape is done from the end towards the
2485 beginning, so the "critical section" is at the end of the reshape.
2489 Changing the RAID level of any array happens instantaneously. However
2490 in the RAID5 to RAID6 case this requires a non-standard layout of the
2491 RAID6 data, and in the RAID6 to RAID5 case that non-standard layout is
2492 required before the change can be accomplished. So while the level
2493 change is instant, the accompanying layout change can take quite a
2496 is required. If the array is not simultaneously being grown or
2497 shrunk, so that the array size will remain the same - for example,
2498 reshaping a 3-drive RAID5 into a 4-drive RAID6 - the backup file will
2499 be used not just for a "cricital section" but throughout the reshape
2500 operation, as described below under LAYOUT CHANGES.
2502 .SS CHUNK-SIZE AND LAYOUT CHANGES
2504 Changing the chunk-size of layout without also changing the number of
2505 devices as the same time will involve re-writing all blocks in-place.
2506 To ensure against data loss in the case of a crash, a
2508 must be provided for these changes. Small sections of the array will
2509 be copied to the backup file while they are being rearranged. This
2510 means that all the data is copied twice, once to the backup and once
2511 to the new layout on the array, so this type of reshape will go very
2514 If the reshape is interrupted for any reason, this backup file must be
2516 .B "mdadm --assemble"
2517 so the array can be reassembled. Consequently the file cannot be
2518 stored on the device being reshaped.
2523 A write-intent bitmap can be added to, or removed from, an active
2524 array. Either internal bitmaps, or bitmaps stored in a separate file,
2525 can be added. Note that if you add a bitmap stored in a file which is
2526 in a filesystem that is on the RAID array being affected, the system
2527 will deadlock. The bitmap must be on a separate filesystem.
2529 .SH INCREMENTAL MODE
2533 .B mdadm \-\-incremental
2539 .B mdadm \-\-incremental \-\-fail
2543 .B mdadm \-\-incremental \-\-rebuild\-map
2546 .B mdadm \-\-incremental \-\-run \-\-scan
2549 This mode is designed to be used in conjunction with a device
2550 discovery system. As devices are found in a system, they can be
2552 .B "mdadm \-\-incremental"
2553 to be conditionally added to an appropriate array.
2555 Conversely, it can also be used with the
2557 flag to do just the opposite and find whatever array a particular device
2558 is part of and remove the device from that array.
2560 If the device passed is a
2562 device created by a previous call to
2564 then rather than trying to add that device to an array, all the arrays
2565 described by the metadata of the container will be started.
2568 performs a number of tests to determine if the device is part of an
2569 array, and which array it should be part of. If an appropriate array
2570 is found, or can be created,
2572 adds the device to the array and conditionally starts the array.
2576 will normally only add devices to an array which were previously working
2577 (active or spare) parts of that array. The support for automatic
2578 inclusion of a new drive as a spare in some array requires
2579 a configuration through POLICY in config file.
2583 makes are as follow:
2585 Is the device permitted by
2587 That is, is it listed in a
2589 line in that file. If
2591 is absent then the default it to allow any device. Similar if
2593 contains the special word
2595 then any device is allowed. Otherwise the device name given to
2597 must match one of the names or patterns in a
2602 Does the device have a valid md superblock? If a specific metadata
2603 version is requested with
2607 then only that style of metadata is accepted, otherwise
2609 finds any known version of metadata. If no
2611 metadata is found, the device may be still added to an array
2612 as a spare if POLICY allows.
2616 Does the metadata match an expected array?
2617 The metadata can match in two ways. Either there is an array listed
2620 which identifies the array (either by UUID, by name, by device list,
2621 or by minor-number), or the array was created with a
2627 or on the command line.
2630 is not able to positively identify the array as belonging to the
2631 current host, the device will be rejected.
2636 keeps a list of arrays that it has partially assembled in
2638 If no array exists which matches
2639 the metadata on the new device,
2641 must choose a device name and unit number. It does this based on any
2644 or any name information stored in the metadata. If this name
2645 suggests a unit number, that number will be used, otherwise a free
2646 unit number will be chosen. Normally
2648 will prefer to create a partitionable array, however if the
2652 suggests that a non-partitionable array is preferred, that will be
2655 If the array is not found in the config file and its metadata does not
2656 identify it as belonging to the "homehost", then
2658 will choose a name for the array which is certain not to conflict with
2659 any array which does belong to this host. It does this be adding an
2660 underscore and a small number to the name preferred by the metadata.
2662 Once an appropriate array is found or created and the device is added,
2664 must decide if the array is ready to be started. It will
2665 normally compare the number of available (non-spare) devices to the
2666 number of devices that the metadata suggests need to be active. If
2667 there are at least that many, the array will be started. This means
2668 that if any devices are missing the array will not be restarted.
2674 in which case the array will be run as soon as there are enough
2675 devices present for the data to be accessible. For a RAID1, that
2676 means one device will start the array. For a clean RAID5, the array
2677 will be started as soon as all but one drive is present.
2679 Note that neither of these approaches is really ideal. If it can
2680 be known that all device discovery has completed, then
2684 can be run which will try to start all arrays that are being
2685 incrementally assembled. They are started in "read-auto" mode in
2686 which they are read-only until the first write request. This means
2687 that no metadata updates are made and no attempt at resync or recovery
2688 happens. Further devices that are found before the first write can
2689 still be added safely.
2692 This section describes environment variables that affect how mdadm
2697 Setting this value to 1 will prevent mdadm from automatically launching
2698 mdmon. This variable is intended primarily for debugging mdadm/mdmon.
2704 does not create any device nodes in /dev, but leaves that task to
2708 appears not to be configured, or if this environment variable is set
2711 will create and devices that are needed.
2715 A key value of IMSM metadata is that it allows interoperability with
2716 boot ROMs on Intel platforms, and with other major operating systems.
2719 will only allow an IMSM array to be created or modified if detects
2720 that it is running on an Intel platform which supports IMSM, and
2721 supports the particular configuration of IMSM that is being requested
2722 (some functionality requires newer OROM support).
2724 These checks can be suppressed by setting IMSM_NO_PLATFORM=1 in the
2725 environment. This can be useful for testing or for disaster
2726 recovery. You should be aware that interoperability may be
2727 compromised by setting this value.
2730 .B " mdadm \-\-query /dev/name-of-device"
2732 This will find out if a given device is a RAID array, or is part of
2733 one, and will provide brief information about the device.
2735 .B " mdadm \-\-assemble \-\-scan"
2737 This will assemble and start all arrays listed in the standard config
2738 file. This command will typically go in a system startup file.
2740 .B " mdadm \-\-stop \-\-scan"
2742 This will shut down all arrays that can be shut down (i.e. are not
2743 currently in use). This will typically go in a system shutdown script.
2745 .B " mdadm \-\-follow \-\-scan \-\-delay=120"
2747 If (and only if) there is an Email address or program given in the
2748 standard config file, then
2749 monitor the status of all arrays listed in that file by
2750 polling them ever 2 minutes.
2752 .B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1"
2754 Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.
2757 .B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf"
2759 .B " mdadm \-\-detail \-\-scan >> mdadm.conf"
2761 This will create a prototype config file that describes currently
2762 active arrays that are known to be made from partitions of IDE or SCSI drives.
2763 This file should be reviewed before being used as it may
2764 contain unwanted detail.
2766 .B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf"
2768 .B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf"
2770 This will find arrays which could be assembled from existing IDE and
2771 SCSI whole drives (not partitions), and store the information in the
2772 format of a config file.
2773 This file is very likely to contain unwanted detail, particularly
2776 entries. It should be reviewed and edited before being used as an
2779 .B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions"
2781 .B " mdadm \-Ebsc partitions"
2783 Create a list of devices by reading
2784 .BR /proc/partitions ,
2785 scan these for RAID superblocks, and printout a brief listing of all
2788 .B " mdadm \-Ac partitions \-m 0 /dev/md0"
2790 Scan all partitions and devices listed in
2791 .BR /proc/partitions
2794 out of all such devices with a RAID superblock with a minor number of 0.
2796 .B " mdadm \-\-monitor \-\-scan \-\-daemonise > /run/mdadm/mon.pid"
2798 If config file contains a mail address or alert program, run mdadm in
2799 the background in monitor mode monitoring all md devices. Also write
2800 pid of mdadm daemon to
2801 .BR /run/mdadm/mon.pid .
2803 .B " mdadm \-Iq /dev/somedevice"
2805 Try to incorporate newly discovered device into some array as
2808 .B " mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan"
2810 Rebuild the array map from any current arrays, and then start any that
2813 .B " mdadm /dev/md4 --fail detached --remove detached"
2815 Any devices which are components of /dev/md4 will be marked as faulty
2816 and then remove from the array.
2818 .B " mdadm --grow /dev/md4 --level=6 --backup-file=/root/backup-md4"
2822 which is currently a RAID5 array will be converted to RAID6. There
2823 should normally already be a spare drive attached to the array as a
2824 RAID6 needs one more drive than a matching RAID5.
2826 .B " mdadm --create /dev/md/ddf --metadata=ddf --raid-disks 6 /dev/sd[a-f]"
2828 Create a DDF array over 6 devices.
2830 .B " mdadm --create /dev/md/home -n3 -l5 -z 30000000 /dev/md/ddf"
2832 Create a RAID5 array over any 3 devices in the given DDF set. Use
2833 only 30 gigabytes of each device.
2835 .B " mdadm -A /dev/md/ddf1 /dev/sd[a-f]"
2837 Assemble a pre-exist ddf array.
2839 .B " mdadm -I /dev/md/ddf1"
2841 Assemble all arrays contained in the ddf array, assigning names as
2844 .B " mdadm \-\-create \-\-help"
2846 Provide help about the Create mode.
2848 .B " mdadm \-\-config \-\-help"
2850 Provide help about the format of the config file.
2852 .B " mdadm \-\-help"
2854 Provide general help.
2864 lists all active md devices with information about them.
2866 uses this to find arrays when
2868 is given in Misc mode, and to monitor array reconstruction
2873 The config file lists which devices may be scanned to see if
2874 they contain MD super block, and gives identifying information
2875 (e.g. UUID) about known MD arrays. See
2882 mode is used, this file gets a list of arrays currently being created.
2887 understand two sorts of names for array devices.
2889 The first is the so-called 'standard' format name, which matches the
2890 names used by the kernel and which appear in
2893 The second sort can be freely chosen, but must reside in
2895 When giving a device name to
2897 to create or assemble an array, either full path name such as
2901 can be given, or just the suffix of the second sort of name, such as
2907 chooses device names during auto-assembly or incremental assembly, it
2908 will sometimes add a small sequence number to the end of the name to
2909 avoid conflicted between multiple arrays that have the same name. If
2911 can reasonably determine that the array really is meant for this host,
2912 either by a hostname in the metadata, or by the presence of the array
2915 then it will leave off the suffix if possible.
2916 Also if the homehost is specified as
2919 will only use a suffix if a different array of the same name already
2920 exists or is listed in the config file.
2922 The standard names for non-partitioned arrays (the only sort of md
2923 array available in 2.4 and earlier) are of the form
2927 where NN is a number.
2928 The standard names for partitionable arrays (as available from 2.6
2929 onwards) are of the form
2933 Partition numbers should be indicated by added "pMM" to these, thus "/dev/md/d1p2".
2935 From kernel version, 2.6.28 the "non-partitioned array" can actually
2936 be partitioned. So the "md_dNN" names are no longer needed, and
2937 partitions such as "/dev/mdNNpXX" are possible.
2941 was previously known as
2945 is completely separate from the
2947 package, and does not use the
2949 configuration file at all.
2952 For further information on mdadm usage, MD and the various levels of
2955 .B http://raid.wiki.kernel.org/
2957 (based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO)
2959 .\"for new releases of the RAID driver check out:
2962 .\".UR ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
2963 .\"ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
2968 .\".UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
2969 .\"http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
2972 The latest version of
2974 should always be available from
2976 .B http://www.kernel.org/pub/linux/utils/raid/mdadm/
projects / thirdparty / mdadm.git / blob