]> git.ipfire.org Git - thirdparty/mdadm.git/blame_incremental - mdadm.8.in
Fix regression with removing 'failed' and 'detached' devices.
[thirdparty/mdadm.git] / mdadm.8.in
... / ...
CommitLineData
1.\" -*- nroff -*-
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.
8.TH MDADM 8 "" v3.2
9.SH NAME
10mdadm \- manage MD devices
11.I aka
12Linux Software RAID
13
14.SH SYNOPSIS
15
16.BI mdadm " [mode] <raiddevice> [options] <component-devices>"
17
18.SH DESCRIPTION
19RAID devices are virtual devices created from two or more
20real block devices. This allows multiple devices (typically disk
21drives or partitions thereof) to be combined into a single device to
22hold (for example) a single filesystem.
23Some RAID levels include redundancy and so can survive some degree of
24device failure.
25
26Linux Software RAID devices are implemented through the md (Multiple
27Devices) device driver.
28
29Currently, Linux supports
30.B LINEAR
31md devices,
32.B RAID0
33(striping),
34.B RAID1
35(mirroring),
36.BR RAID4 ,
37.BR RAID5 ,
38.BR RAID6 ,
39.BR RAID10 ,
40.BR MULTIPATH ,
41.BR FAULTY ,
42and
43.BR CONTAINER .
44
45.B MULTIPATH
46is not a Software RAID mechanism, but does involve
47multiple devices:
48each device is a path to one common physical storage device.
49New installations should not use md/multipath as it is not well
50supported and has no ongoing development. Use the Device Mapper based
51multipath-tools instead.
52
53.B FAULTY
54is also not true RAID, and it only involves one device. It
55provides a layer over a true device that can be used to inject faults.
56
57.B CONTAINER
58is different again. A
59.B CONTAINER
60is a collection of devices that are
61managed as a set. This is similar to the set of devices connected to
62a hardware RAID controller. The set of devices may contain a number
63of different RAID arrays each utilising some (or all) of the blocks from a
64number of the devices in the set. For example, two devices in a 5-device set
65might form a RAID1 using the whole devices. The remaining three might
66have a RAID5 over the first half of each device, and a RAID0 over the
67second half.
68
69With a
70.BR CONTAINER ,
71there is one set of metadata that describes all of
72the arrays in the container. So when
73.I mdadm
74creates a
75.B CONTAINER
76device, the device just represents the metadata. Other normal arrays (RAID1
77etc) can be created inside the container.
78
79.SH MODES
80mdadm has several major modes of operation:
81.TP
82.B Assemble
83Assemble the components of a previously created
84array into an active array. Components can be explicitly given
85or can be searched for.
86.I mdadm
87checks that the components
88do form a bona fide array, and can, on request, fiddle superblock
89information so as to assemble a faulty array.
90
91.TP
92.B Build
93Build an array that doesn't have per-device metadata (superblocks). For these
94sorts of arrays,
95.I mdadm
96cannot differentiate between initial creation and subsequent assembly
97of an array. It also cannot perform any checks that appropriate
98components have been requested. Because of this, the
99.B Build
100mode should only be used together with a complete understanding of
101what you are doing.
102
103.TP
104.B Create
105Create a new array with per-device metadata (superblocks).
106Appropriate metadata is written to each device, and then the array
107comprising those devices is activated. A 'resync' process is started
108to make sure that the array is consistent (e.g. both sides of a mirror
109contain the same data) but the content of the device is left otherwise
110untouched.
111The array can be used as soon as it has been created. There is no
112need to wait for the initial resync to finish.
113
114.TP
115.B "Follow or Monitor"
116Monitor one or more md devices and act on any state changes. This is
117only meaningful for RAID1, 4, 5, 6, 10 or multipath arrays, as
118only these have interesting state. RAID0 or Linear never have
119missing, spare, or failed drives, so there is nothing to monitor.
120
121.TP
122.B "Grow"
123Grow (or shrink) an array, or otherwise reshape it in some way.
124Currently supported growth options including changing the active size
125of component devices and changing the number of active devices in RAID
126levels 1/4/5/6, changing the RAID level between 1, 5, and 6, changing
127the chunk size and layout for RAID5 and RAID5, as well as adding or
128removing a write-intent bitmap.
129
130.TP
131.B "Incremental Assembly"
132Add a single device to an appropriate array. If the addition of the
133device makes the array runnable, the array will be started.
134This provides a convenient interface to a
135.I hot-plug
136system. As each device is detected,
137.I mdadm
138has a chance to include it in some array as appropriate.
139Optionally, when the
140.I \-\-fail
141flag is passed in we will remove the device from any active array
142instead of adding it.
143
144If a
145.B CONTAINER
146is passed to
147.I mdadm
148in this mode, then any arrays within that container will be assembled
149and started.
150
151.TP
152.B Manage
153This is for doing things to specific components of an array such as
154adding new spares and removing faulty devices.
155
156.TP
157.B Misc
158This is an 'everything else' mode that supports operations on active
159arrays, operations on component devices such as erasing old superblocks, and
160information gathering operations.
161.\"This mode allows operations on independent devices such as examine MD
162.\"superblocks, erasing old superblocks and stopping active arrays.
163
164.TP
165.B Auto-detect
166This mode does not act on a specific device or array, but rather it
167requests the Linux Kernel to activate any auto-detected arrays.
168.SH OPTIONS
169
170.SH Options for selecting a mode are:
171
172.TP
173.BR \-A ", " \-\-assemble
174Assemble a pre-existing array.
175
176.TP
177.BR \-B ", " \-\-build
178Build a legacy array without superblocks.
179
180.TP
181.BR \-C ", " \-\-create
182Create a new array.
183
184.TP
185.BR \-F ", " \-\-follow ", " \-\-monitor
186Select
187.B Monitor
188mode.
189
190.TP
191.BR \-G ", " \-\-grow
192Change the size or shape of an active array.
193
194.TP
195.BR \-I ", " \-\-incremental
196Add/remove a single device to/from an appropriate array, and possibly start the array.
197
198.TP
199.B \-\-auto-detect
200Request that the kernel starts any auto-detected arrays. This can only
201work if
202.I md
203is compiled into the kernel \(em not if it is a module.
204Arrays can be auto-detected by the kernel if all the components are in
205primary MS-DOS partitions with partition type
206.BR FD ,
207and all use v0.90 metadata.
208In-kernel autodetect is not recommended for new installations. Using
209.I mdadm
210to detect and assemble arrays \(em possibly in an
211.I initrd
212\(em is substantially more flexible and should be preferred.
213
214.P
215If a device is given before any options, or if the first option is
216.BR \-\-add ,
217.BR \-\-fail ,
218or
219.BR \-\-remove ,
220then the MANAGE mode is assumed.
221Anything other than these will cause the
222.B Misc
223mode to be assumed.
224
225.SH Options that are not mode-specific are:
226
227.TP
228.BR \-h ", " \-\-help
229Display general help message or, after one of the above options, a
230mode-specific help message.
231
232.TP
233.B \-\-help\-options
234Display more detailed help about command line parsing and some commonly
235used options.
236
237.TP
238.BR \-V ", " \-\-version
239Print version information for mdadm.
240
241.TP
242.BR \-v ", " \-\-verbose
243Be more verbose about what is happening. This can be used twice to be
244extra-verbose.
245The extra verbosity currently only affects
246.B \-\-detail \-\-scan
247and
248.BR "\-\-examine \-\-scan" .
249
250.TP
251.BR \-q ", " \-\-quiet
252Avoid printing purely informative messages. With this,
253.I mdadm
254will be silent unless there is something really important to report.
255
256.TP
257.BR \-f ", " \-\-force
258Be more forceful about certain operations. See the various modes for
259the exact meaning of this option in different contexts.
260
261.TP
262.BR \-c ", " \-\-config=
263Specify the config file. Default is to use
264.BR /etc/mdadm.conf ,
265or if that is missing then
266.BR /etc/mdadm/mdadm.conf .
267If the config file given is
268.B "partitions"
269then nothing will be read, but
270.I mdadm
271will act as though the config file contained exactly
272.B "DEVICE partitions containers"
273and will read
274.B /proc/partitions
275to find a list of devices to scan, and
276.B /proc/mdstat
277to find a list of containers to examine.
278If the word
279.B "none"
280is given for the config file, then
281.I mdadm
282will act as though the config file were empty.
283
284.TP
285.BR \-s ", " \-\-scan
286Scan config file or
287.B /proc/mdstat
288for missing information.
289In general, this option gives
290.I mdadm
291permission to get any missing information (like component devices,
292array devices, array identities, and alert destination) from the
293configuration file (see previous option);
294one exception is MISC mode when using
295.B \-\-detail
296or
297.B \-\-stop,
298in which case
299.B \-\-scan
300says to get a list of array devices from
301.BR /proc/mdstat .
302
303.TP
304.BR \-e ", " \-\-metadata=
305Declare the style of RAID metadata (superblock) to be used. The
306default is {DEFAULT_METADATA} for
307.BR \-\-create ,
308and to guess for other operations.
309The default can be overridden by setting the
310.B metadata
311value for the
312.B CREATE
313keyword in
314.BR mdadm.conf .
315
316Options are:
317.RS
318.ie '{DEFAULT_METADATA}'0.90'
319.IP "0, 0.90, default"
320.el
321.IP "0, 0.90"
322..
323Use the original 0.90 format superblock. This format limits arrays to
32428 component devices and limits component devices of levels 1 and
325greater to 2 terabytes. It is also possible for there to be confusion
326about whether the superblock applies to a whole device or just the
327last partition, if that partition starts on a 64K boundary.
328.ie '{DEFAULT_METADATA}'0.90'
329.IP "1, 1.0, 1.1, 1.2"
330.el
331.IP "1, 1.0, 1.1, 1.2 default"
332..
333Use the new version-1 format superblock. This has fewer restrictions.
334It can easily be moved between hosts with different endian-ness, and a
335recovery operation can be checkpointed and restarted. The different
336sub-versions store the superblock at different locations on the
337device, either at the end (for 1.0), at the start (for 1.1) or 4K from
338the start (for 1.2). "1" is equivalent to "1.0".
339'if '{DEFAULT_METADATA}'1.2' "default" is equivalent to "1.2".
340.IP ddf
341Use the "Industry Standard" DDF (Disk Data Format) format defined by
342SNIA.
343When creating a DDF array a
344.B CONTAINER
345will be created, and normal arrays can be created in that container.
346.IP imsm
347Use the Intel(R) Matrix Storage Manager metadata format. This creates a
348.B CONTAINER
349which is managed in a similar manner to DDF, and is supported by an
350option-rom on some platforms:
351.IP
352.B http://www.intel.com/design/chipsets/matrixstorage_sb.htm
353.PP
354.RE
355
356.TP
357.B \-\-homehost=
358This will override any
359.B HOMEHOST
360setting in the config file and provides the identity of the host which
361should be considered the home for any arrays.
362
363When creating an array, the
364.B homehost
365will be recorded in the metadata. For version-1 superblocks, it will
366be prefixed to the array name. For version-0.90 superblocks, part of
367the SHA1 hash of the hostname will be stored in the later half of the
368UUID.
369
370When reporting information about an array, any array which is tagged
371for the given homehost will be reported as such.
372
373When using Auto-Assemble, only arrays tagged for the given homehost
374will be allowed to use 'local' names (i.e. not ending in '_' followed
375by a digit string). See below under
376.BR "Auto Assembly" .
377
378.SH For create, build, or grow:
379
380.TP
381.BR \-n ", " \-\-raid\-devices=
382Specify the number of active devices in the array. This, plus the
383number of spare devices (see below) must equal the number of
384.I component-devices
385(including "\fBmissing\fP" devices)
386that are listed on the command line for
387.BR \-\-create .
388Setting a value of 1 is probably
389a mistake and so requires that
390.B \-\-force
391be specified first. A value of 1 will then be allowed for linear,
392multipath, RAID0 and RAID1. It is never allowed for RAID4, RAID5 or RAID6.
393.br
394This number can only be changed using
395.B \-\-grow
396for RAID1, RAID4, RAID5 and RAID6 arrays, and only on kernels which provide
397the necessary support.
398
399.TP
400.BR \-x ", " \-\-spare\-devices=
401Specify the number of spare (eXtra) devices in the initial array.
402Spares can also be added
403and removed later. The number of component devices listed
404on the command line must equal the number of RAID devices plus the
405number of spare devices.
406
407.TP
408.BR \-z ", " \-\-size=
409Amount (in Kibibytes) of space to use from each drive in RAID levels 1/4/5/6.
410This must be a multiple of the chunk size, and must leave about 128Kb
411of space at the end of the drive for the RAID superblock.
412If this is not specified
413(as it normally is not) the smallest drive (or partition) sets the
414size, though if there is a variance among the drives of greater than 1%, a warning is
415issued.
416
417A suffix of 'M' or 'G' can be given to indicate Megabytes or
418Gigabytes respectively.
419
420This value can be set with
421.B \-\-grow
422for RAID level 1/4/5/6. If the array was created with a size smaller
423than the currently active drives, the extra space can be accessed
424using
425.BR \-\-grow .
426The size can be given as
427.B max
428which means to choose the largest size that fits on all current drives.
429
430This value can not be used with
431.B CONTAINER
432metadata such as DDF and IMSM.
433
434.TP
435.BR \-Z ", " \-\-array-size=
436This is only meaningful with
437.B \-\-grow
438and its effect is not persistent: when the array is stopped and
439restarted the default array size will be restored.
440
441Setting the array-size causes the array to appear smaller to programs
442that access the data. This is particularly needed before reshaping an
443array so that it will be smaller. As the reshape is not reversible,
444but setting the size with
445.B \-\-array-size
446is, it is required that the array size is reduced as appropriate
447before the number of devices in the array is reduced.
448
449A suffix of 'M' or 'G' can be given to indicate Megabytes or
450Gigabytes respectively.
451A value of
452.B max
453restores the apparent size of the array to be whatever the real
454amount of available space is.
455
456.TP
457.BR \-c ", " \-\-chunk=
458Specify chunk size of kibibytes. The default when creating an
459array is 512KB. To ensure compatibility with earlier versions, the
460default when Building and array with no persistent metadata is 64KB.
461This is only meaningful for RAID0, RAID4, RAID5, RAID6, and RAID10.
462
463A suffix of 'M' or 'G' can be given to indicate Megabytes or
464Gigabytes respectively.
465
466.TP
467.BR \-\-rounding=
468Specify rounding factor for a Linear array. The size of each
469component will be rounded down to a multiple of this size.
470This is a synonym for
471.B \-\-chunk
472but highlights the different meaning for Linear as compared to other
473RAID levels. The default is 64K if a kernel earlier than 2.6.16 is in
474use, and is 0K (i.e. no rounding) in later kernels.
475
476.TP
477.BR \-l ", " \-\-level=
478Set RAID level. When used with
479.BR \-\-create ,
480options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4,
481raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty, container.
482Obviously some of these are synonymous.
483
484When a
485.B CONTAINER
486metadata type is requested, only the
487.B container
488level is permitted, and it does not need to be explicitly given.
489
490When used with
491.BR \-\-build ,
492only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid.
493
494Can be used with
495.B \-\-grow
496to change the RAID level in some cases. See LEVEL CHANGES below.
497
498.TP
499.BR \-p ", " \-\-layout=
500This option configures the fine details of data layout for RAID5, RAID6,
501and RAID10 arrays, and controls the failure modes for
502.IR faulty .
503
504The layout of the RAID5 parity block can be one of
505.BR left\-asymmetric ,
506.BR left\-symmetric ,
507.BR right\-asymmetric ,
508.BR right\-symmetric ,
509.BR la ", " ra ", " ls ", " rs .
510The default is
511.BR left\-symmetric .
512
513It is also possible to cause RAID5 to use a RAID4-like layout by
514choosing
515.BR parity\-first ,
516or
517.BR parity\-last .
518
519Finally for RAID5 there are DDF\-compatible layouts,
520.BR ddf\-zero\-restart ,
521.BR ddf\-N\-restart ,
522and
523.BR ddf\-N\-continue .
524
525These same layouts are available for RAID6. There are also 4 layouts
526that will provide an intermediate stage for converting between RAID5
527and RAID6. These provide a layout which is identical to the
528corresponding RAID5 layout on the first N\-1 devices, and has the 'Q'
529syndrome (the second 'parity' block used by RAID6) on the last device.
530These layouts are:
531.BR left\-symmetric\-6 ,
532.BR right\-symmetric\-6 ,
533.BR left\-asymmetric\-6 ,
534.BR right\-asymmetric\-6 ,
535and
536.BR parity\-first\-6 .
537
538When setting the failure mode for level
539.I faulty,
540the options are:
541.BR write\-transient ", " wt ,
542.BR read\-transient ", " rt ,
543.BR write\-persistent ", " wp ,
544.BR read\-persistent ", " rp ,
545.BR write\-all ,
546.BR read\-fixable ", " rf ,
547.BR clear ", " flush ", " none .
548
549Each failure mode can be followed by a number, which is used as a period
550between fault generation. Without a number, the fault is generated
551once on the first relevant request. With a number, the fault will be
552generated after that many requests, and will continue to be generated
553every time the period elapses.
554
555Multiple failure modes can be current simultaneously by using the
556.B \-\-grow
557option to set subsequent failure modes.
558
559"clear" or "none" will remove any pending or periodic failure modes,
560and "flush" will clear any persistent faults.
561
562Finally, the layout options for RAID10 are one of 'n', 'o' or 'f' followed
563by a small number. The default is 'n2'. The supported options are:
564
565.I 'n'
566signals 'near' copies. Multiple copies of one data block are at
567similar offsets in different devices.
568
569.I 'o'
570signals 'offset' copies. Rather than the chunks being duplicated
571within a stripe, whole stripes are duplicated but are rotated by one
572device so duplicate blocks are on different devices. Thus subsequent
573copies of a block are in the next drive, and are one chunk further
574down.
575
576.I 'f'
577signals 'far' copies
578(multiple copies have very different offsets).
579See md(4) for more detail about 'near', 'offset', and 'far'.
580
581The number is the number of copies of each datablock. 2 is normal, 3
582can be useful. This number can be at most equal to the number of
583devices in the array. It does not need to divide evenly into that
584number (e.g. it is perfectly legal to have an 'n2' layout for an array
585with an odd number of devices).
586
587When an array is converted between RAID5 and RAID6 an intermediate
588RAID6 layout is used in which the second parity block (Q) is always on
589the last device. To convert a RAID5 to RAID6 and leave it in this new
590layout (which does not require re-striping) use
591.BR \-\-layout=preserve .
592This will try to avoid any restriping.
593
594The converse of this is
595.B \-\-layout=normalise
596which will change a non-standard RAID6 layout into a more standard
597arrangement.
598
599.TP
600.BR \-\-parity=
601same as
602.B \-\-layout
603(thus explaining the p of
604.BR \-p ).
605
606.TP
607.BR \-b ", " \-\-bitmap=
608Specify a file to store a write-intent bitmap in. The file should not
609exist unless
610.B \-\-force
611is also given. The same file should be provided
612when assembling the array. If the word
613.B "internal"
614is given, then the bitmap is stored with the metadata on the array,
615and so is replicated on all devices. If the word
616.B "none"
617is given with
618.B \-\-grow
619mode, then any bitmap that is present is removed.
620
621To help catch typing errors, the filename must contain at least one
622slash ('/') if it is a real file (not 'internal' or 'none').
623
624Note: external bitmaps are only known to work on ext2 and ext3.
625Storing bitmap files on other filesystems may result in serious problems.
626
627.TP
628.BR \-\-bitmap\-chunk=
629Set the chunksize of the bitmap. Each bit corresponds to that many
630Kilobytes of storage.
631When using a file based bitmap, the default is to use the smallest
632size that is at-least 4 and requires no more than 2^21 chunks.
633When using an
634.B internal
635bitmap, the chunksize defaults to 64Meg, or larger if necessary to
636fit the bitmap into the available space.
637
638A suffix of 'M' or 'G' can be given to indicate Megabytes or
639Gigabytes respectively.
640
641.TP
642.BR \-W ", " \-\-write\-mostly
643subsequent devices listed in a
644.BR \-\-build ,
645.BR \-\-create ,
646or
647.B \-\-add
648command will be flagged as 'write-mostly'. This is valid for RAID1
649only and means that the 'md' driver will avoid reading from these
650devices if at all possible. This can be useful if mirroring over a
651slow link.
652
653.TP
654.BR \-\-write\-behind=
655Specify that write-behind mode should be enabled (valid for RAID1
656only). If an argument is specified, it will set the maximum number
657of outstanding writes allowed. The default value is 256.
658A write-intent bitmap is required in order to use write-behind
659mode, and write-behind is only attempted on drives marked as
660.IR write-mostly .
661
662.TP
663.BR \-\-assume\-clean
664Tell
665.I mdadm
666that the array pre-existed and is known to be clean. It can be useful
667when trying to recover from a major failure as you can be sure that no
668data will be affected unless you actually write to the array. It can
669also be used when creating a RAID1 or RAID10 if you want to avoid the
670initial resync, however this practice \(em while normally safe \(em is not
671recommended. Use this only if you really know what you are doing.
672.IP
673When the devices that will be part of a new array were filled
674with zeros before creation the operator knows the array is
675actually clean. If that is the case, such as after running
676badblocks, this argument can be used to tell mdadm the
677facts the operator knows.
678
679.TP
680.BR \-\-backup\-file=
681This is needed when
682.B \-\-grow
683is used to increase the number of raid-devices in a RAID5 or RAID6 if
684there are no spare devices available, or to shrink, change RAID level
685or layout. See the GROW MODE section below on RAID\-DEVICES CHANGES.
686The file must be stored on a separate device, not on the RAID array
687being reshaped.
688
689.TP
690.BR \-N ", " \-\-name=
691Set a
692.B name
693for the array. This is currently only effective when creating an
694array with a version-1 superblock, or an array in a DDF container.
695The name is a simple textual string that can be used to identify array
696components when assembling. If name is needed but not specified, it
697is taken from the basename of the device that is being created.
698e.g. when creating
699.I /dev/md/home
700the
701.B name
702will default to
703.IR home .
704
705.TP
706.BR \-R ", " \-\-run
707Insist that
708.I mdadm
709run the array, even if some of the components
710appear to be active in another array or filesystem. Normally
711.I mdadm
712will ask for confirmation before including such components in an
713array. This option causes that question to be suppressed.
714
715.TP
716.BR \-f ", " \-\-force
717Insist that
718.I mdadm
719accept the geometry and layout specified without question. Normally
720.I mdadm
721will not allow creation of an array with only one device, and will try
722to create a RAID5 array with one missing drive (as this makes the
723initial resync work faster). With
724.BR \-\-force ,
725.I mdadm
726will not try to be so clever.
727
728.TP
729.BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}"
730Instruct mdadm how to create the device file if needed, possibly allocating
731an unused minor number. "md" causes a non-partitionable array
732to be used (though since Linux 2.6.28, these array devices are in fact
733partitionable). "mdp", "part" or "p" causes a partitionable array (2.6 and
734later) to be used. "yes" requires the named md device to have
735a 'standard' format, and the type and minor number will be determined
736from this. With mdadm 3.0, device creation is normally left up to
737.I udev
738so this option is unlikely to be needed.
739See DEVICE NAMES below.
740
741The argument can also come immediately after
742"\-a". e.g. "\-ap".
743
744If
745.B \-\-auto
746is not given on the command line or in the config file, then
747the default will be
748.BR \-\-auto=yes .
749
750If
751.B \-\-scan
752is also given, then any
753.I auto=
754entries in the config file will override the
755.B \-\-auto
756instruction given on the command line.
757
758For partitionable arrays,
759.I mdadm
760will create the device file for the whole array and for the first 4
761partitions. A different number of partitions can be specified at the
762end of this option (e.g.
763.BR \-\-auto=p7 ).
764If the device name ends with a digit, the partition names add a 'p',
765and a number, e.g.
766.IR /dev/md/home1p3 .
767If there is no trailing digit, then the partition names just have a
768number added, e.g.
769.IR /dev/md/scratch3 .
770
771If the md device name is in a 'standard' format as described in DEVICE
772NAMES, then it will be created, if necessary, with the appropriate
773device number based on that name. If the device name is not in one of these
774formats, then a unused device number will be allocated. The device
775number will be considered unused if there is no active array for that
776number, and there is no entry in /dev for that number and with a
777non-standard name. Names that are not in 'standard' format are only
778allowed in "/dev/md/".
779
780.ig XX
781.\".TP
782.\".BR \-\-symlink = no
783.\"Normally when
784.\".B \-\-auto
785.\"causes
786.\".I mdadm
787.\"to create devices in
788.\".B /dev/md/
789.\"it will also create symlinks from
790.\".B /dev/
791.\"with names starting with
792.\".B md
793.\"or
794.\".BR md_ .
795.\"Use
796.\".B \-\-symlink=no
797.\"to suppress this, or
798.\".B \-\-symlink=yes
799.\"to enforce this even if it is suppressing
800.\".IR mdadm.conf .
801.\"
802.XX
803
804.SH For assemble:
805
806.TP
807.BR \-u ", " \-\-uuid=
808uuid of array to assemble. Devices which don't have this uuid are
809excluded
810
811.TP
812.BR \-m ", " \-\-super\-minor=
813Minor number of device that array was created for. Devices which
814don't have this minor number are excluded. If you create an array as
815/dev/md1, then all superblocks will contain the minor number 1, even if
816the array is later assembled as /dev/md2.
817
818Giving the literal word "dev" for
819.B \-\-super\-minor
820will cause
821.I mdadm
822to use the minor number of the md device that is being assembled.
823e.g. when assembling
824.BR /dev/md0 ,
825.B \-\-super\-minor=dev
826will look for super blocks with a minor number of 0.
827
828.B \-\-super\-minor
829is only relevant for v0.90 metadata, and should not normally be used.
830Using
831.B \-\-uuid
832is much safer.
833
834.TP
835.BR \-N ", " \-\-name=
836Specify the name of the array to assemble. This must be the name
837that was specified when creating the array. It must either match
838the name stored in the superblock exactly, or it must match
839with the current
840.I homehost
841prefixed to the start of the given name.
842
843.TP
844.BR \-f ", " \-\-force
845Assemble the array even if the metadata on some devices appears to be
846out-of-date. If
847.I mdadm
848cannot find enough working devices to start the array, but can find
849some devices that are recorded as having failed, then it will mark
850those devices as working so that the array can be started.
851An array which requires
852.B \-\-force
853to be started may contain data corruption. Use it carefully.
854
855.TP
856.BR \-R ", " \-\-run
857Attempt to start the array even if fewer drives were given than were
858present last time the array was active. Normally if not all the
859expected drives are found and
860.B \-\-scan
861is not used, then the array will be assembled but not started.
862With
863.B \-\-run
864an attempt will be made to start it anyway.
865
866.TP
867.B \-\-no\-degraded
868This is the reverse of
869.B \-\-run
870in that it inhibits the startup of array unless all expected drives
871are present. This is only needed with
872.B \-\-scan,
873and can be used if the physical connections to devices are
874not as reliable as you would like.
875
876.TP
877.BR \-a ", " "\-\-auto{=no,yes,md,mdp,part}"
878See this option under Create and Build options.
879
880.TP
881.BR \-b ", " \-\-bitmap=
882Specify the bitmap file that was given when the array was created. If
883an array has an
884.B internal
885bitmap, there is no need to specify this when assembling the array.
886
887.TP
888.BR \-\-backup\-file=
889If
890.B \-\-backup\-file
891was used while reshaping an array (e.g. changing number of devices or
892chunk size) and the system crashed during the critical section, then the same
893.B \-\-backup\-file
894must be presented to
895.B \-\-assemble
896to allow possibly corrupted data to be restored, and the reshape
897to be completed.
898
899.TP
900.BR \-\-invalid\-backup
901If the file needed for the above option is not available for any
902reason an empty file can be given together with this option to
903indicate that the backup file is invalid. In this case the data that
904was being rearranged at the time of the crash could be irrecoverably
905lost, but the rest of the array may still be recoverable. This option
906should only be used as a last resort if there is no way to recover the
907backup file.
908
909
910.TP
911.BR \-U ", " \-\-update=
912Update the superblock on each device while assembling the array. The
913argument given to this flag can be one of
914.BR sparc2.2 ,
915.BR summaries ,
916.BR uuid ,
917.BR name ,
918.BR homehost ,
919.BR resync ,
920.BR byteorder ,
921.BR devicesize ,
922.BR no\-bitmap ,
923or
924.BR super\-minor .
925
926The
927.B sparc2.2
928option will adjust the superblock of an array what was created on a Sparc
929machine running a patched 2.2 Linux kernel. This kernel got the
930alignment of part of the superblock wrong. You can use the
931.B "\-\-examine \-\-sparc2.2"
932option to
933.I mdadm
934to see what effect this would have.
935
936The
937.B super\-minor
938option will update the
939.B "preferred minor"
940field on each superblock to match the minor number of the array being
941assembled.
942This can be useful if
943.B \-\-examine
944reports a different "Preferred Minor" to
945.BR \-\-detail .
946In some cases this update will be performed automatically
947by the kernel driver. In particular the update happens automatically
948at the first write to an array with redundancy (RAID level 1 or
949greater) on a 2.6 (or later) kernel.
950
951The
952.B uuid
953option will change the uuid of the array. If a UUID is given with the
954.B \-\-uuid
955option that UUID will be used as a new UUID and will
956.B NOT
957be used to help identify the devices in the array.
958If no
959.B \-\-uuid
960is given, a random UUID is chosen.
961
962The
963.B name
964option will change the
965.I name
966of the array as stored in the superblock. This is only supported for
967version-1 superblocks.
968
969The
970.B homehost
971option will change the
972.I homehost
973as recorded in the superblock. For version-0 superblocks, this is the
974same as updating the UUID.
975For version-1 superblocks, this involves updating the name.
976
977The
978.B resync
979option will cause the array to be marked
980.I dirty
981meaning that any redundancy in the array (e.g. parity for RAID5,
982copies for RAID1) may be incorrect. This will cause the RAID system
983to perform a "resync" pass to make sure that all redundant information
984is correct.
985
986The
987.B byteorder
988option allows arrays to be moved between machines with different
989byte-order.
990When assembling such an array for the first time after a move, giving
991.B "\-\-update=byteorder"
992will cause
993.I mdadm
994to expect superblocks to have their byteorder reversed, and will
995correct that order before assembling the array. This is only valid
996with original (Version 0.90) superblocks.
997
998The
999.B summaries
1000option will correct the summaries in the superblock. That is the
1001counts of total, working, active, failed, and spare devices.
1002
1003The
1004.B devicesize
1005option will rarely be of use. It applies to version 1.1 and 1.2 metadata
1006only (where the metadata is at the start of the device) and is only
1007useful when the component device has changed size (typically become
1008larger). The version 1 metadata records the amount of the device that
1009can be used to store data, so if a device in a version 1.1 or 1.2
1010array becomes larger, the metadata will still be visible, but the
1011extra space will not. In this case it might be useful to assemble the
1012array with
1013.BR \-\-update=devicesize .
1014This will cause
1015.I mdadm
1016to determine the maximum usable amount of space on each device and
1017update the relevant field in the metadata.
1018
1019The
1020.B no\-bitmap
1021option can be used when an array has an internal bitmap which is
1022corrupt in some way so that assembling the array normally fails. It
1023will cause any internal bitmap to be ignored.
1024
1025.ig
1026.TP
1027.B \-\-auto\-update\-homehost
1028This flag is only meaningful with auto-assembly (see discussion below).
1029In that situation, if no suitable arrays are found for this homehost,
1030.I mdadm
1031will rescan for any arrays at all and will assemble them and update the
1032homehost to match the current host.
1033..
1034
1035.SH For Manage mode:
1036
1037.TP
1038.BR \-t ", " \-\-test
1039Unless a more serious error occurred,
1040.I mdadm
1041will exit with a status of 2 if no changes were made to the array and
10420 if at least one change was made.
1043This can be useful when an indirect specifier such as
1044.BR missing ,
1045.B detached
1046or
1047.B faulty
1048is used in requesting an operation on the array.
1049.B \-\-test
1050will report failure if these specifiers didn't find any match.
1051
1052.TP
1053.BR \-a ", " \-\-add
1054hot-add listed devices.
1055If a device appears to have recently been part of the array
1056(possibly it failed or was removed) the device is re\-added as describe
1057in the next point.
1058If that fails or the device was never part of the array, the device is
1059added as a hot-spare.
1060If the array is degraded, it will immediately start to rebuild data
1061onto that spare.
1062
1063Note that this and the following options are only meaningful on array
1064with redundancy. They don't apply to RAID0 or Linear.
1065
1066.TP
1067.BR \-\-re\-add
1068re\-add a device that was previous removed from an array.
1069If the metadata on the device reports that it is a member of the
1070array, and the slot that it used is still vacant, then the device will
1071be added back to the array in the same position. This will normally
1072cause the data for that device to be recovered. However based on the
1073event count on the device, the recovery may only require sections that
1074are flagged a write-intent bitmap to be recovered or may not require
1075any recovery at all.
1076
1077When used on an array that has no metadata (i.e. it was built with
1078.BR \-\-build)
1079it will be assumed that bitmap-based recovery is enough to make the
1080device fully consistent with the array.
1081
1082When
1083.B \-\-re\-add
1084can be accompanied by
1085.BR \-\-update=devicesize .
1086See the description of this option when used in Assemble mode for an
1087explanation of its use.
1088
1089If the device name given is
1090.B missing
1091then mdadm will try to find any device that looks like it should be
1092part of the array but isn't and will try to re\-add all such devices.
1093
1094.TP
1095.BR \-r ", " \-\-remove
1096remove listed devices. They must not be active. i.e. they should
1097be failed or spare devices. As well as the name of a device file
1098(e.g.
1099.BR /dev/sda1 )
1100the words
1101.B failed
1102and
1103.B detached
1104can be given to
1105.BR \-\-remove .
1106The first causes all failed device to be removed. The second causes
1107any device which is no longer connected to the system (i.e an 'open'
1108returns
1109.BR ENXIO )
1110to be removed. This will only succeed for devices that are spares or
1111have already been marked as failed.
1112
1113.TP
1114.BR \-f ", " \-\-fail
1115mark listed devices as faulty.
1116As well as the name of a device file, the word
1117.B detached
1118can be given. This will cause any device that has been detached from
1119the system to be marked as failed. It can then be removed.
1120
1121.TP
1122.BR \-\-set\-faulty
1123same as
1124.BR \-\-fail .
1125
1126.TP
1127.BR \-\-write\-mostly
1128Subsequent devices that are added or re\-added will have the 'write-mostly'
1129flag set. This is only valid for RAID1 and means that the 'md' driver
1130will avoid reading from these devices if possible.
1131.TP
1132.BR \-\-readwrite
1133Subsequent devices that are added or re\-added will have the 'write-mostly'
1134flag cleared.
1135
1136.P
1137Each of these options requires that the first device listed is the array
1138to be acted upon, and the remainder are component devices to be added,
1139removed, marked as faulty, etc. Several different operations can be
1140specified for different devices, e.g.
1141.in +5
1142mdadm /dev/md0 \-\-add /dev/sda1 \-\-fail /dev/sdb1 \-\-remove /dev/sdb1
1143.in -5
1144Each operation applies to all devices listed until the next
1145operation.
1146
1147If an array is using a write-intent bitmap, then devices which have
1148been removed can be re\-added in a way that avoids a full
1149reconstruction but instead just updates the blocks that have changed
1150since the device was removed. For arrays with persistent metadata
1151(superblocks) this is done automatically. For arrays created with
1152.B \-\-build
1153mdadm needs to be told that this device we removed recently with
1154.BR \-\-re\-add .
1155
1156Devices can only be removed from an array if they are not in active
1157use, i.e. that must be spares or failed devices. To remove an active
1158device, it must first be marked as
1159.B faulty.
1160
1161.SH For Misc mode:
1162
1163.TP
1164.BR \-Q ", " \-\-query
1165Examine a device to see
1166(1) if it is an md device and (2) if it is a component of an md
1167array.
1168Information about what is discovered is presented.
1169
1170.TP
1171.BR \-D ", " \-\-detail
1172Print details of one or more md devices.
1173
1174.TP
1175.BR \-\-detail\-platform
1176Print details of the platform's RAID capabilities (firmware / hardware
1177topology) for a given metadata format.
1178
1179.TP
1180.BR \-Y ", " \-\-export
1181When used with
1182.B \-\-detail
1183or
1184.BR \-\-examine ,
1185output will be formatted as
1186.B key=value
1187pairs for easy import into the environment.
1188
1189.TP
1190.BR \-E ", " \-\-examine
1191Print contents of the metadata stored on the named device(s).
1192Note the contrast between
1193.B \-\-examine
1194and
1195.BR \-\-detail .
1196.B \-\-examine
1197applies to devices which are components of an array, while
1198.B \-\-detail
1199applies to a whole array which is currently active.
1200.TP
1201.B \-\-sparc2.2
1202If an array was created on a SPARC machine with a 2.2 Linux kernel
1203patched with RAID support, the superblock will have been created
1204incorrectly, or at least incompatibly with 2.4 and later kernels.
1205Using the
1206.B \-\-sparc2.2
1207flag with
1208.B \-\-examine
1209will fix the superblock before displaying it. If this appears to do
1210the right thing, then the array can be successfully assembled using
1211.BR "\-\-assemble \-\-update=sparc2.2" .
1212
1213.TP
1214.BR \-X ", " \-\-examine\-bitmap
1215Report information about a bitmap file.
1216The argument is either an external bitmap file or an array component
1217in case of an internal bitmap. Note that running this on an array
1218device (e.g.
1219.BR /dev/md0 )
1220does not report the bitmap for that array.
1221
1222.TP
1223.BR \-R ", " \-\-run
1224start a partially assembled array. If
1225.B \-\-assemble
1226did not find enough devices to fully start the array, it might leaving
1227it partially assembled. If you wish, you can then use
1228.B \-\-run
1229to start the array in degraded mode.
1230
1231.TP
1232.BR \-S ", " \-\-stop
1233deactivate array, releasing all resources.
1234
1235.TP
1236.BR \-o ", " \-\-readonly
1237mark array as readonly.
1238
1239.TP
1240.BR \-w ", " \-\-readwrite
1241mark array as readwrite.
1242
1243.TP
1244.B \-\-zero\-superblock
1245If the device contains a valid md superblock, the block is
1246overwritten with zeros. With
1247.B \-\-force
1248the block where the superblock would be is overwritten even if it
1249doesn't appear to be valid.
1250
1251.TP
1252.B \-\-kill\-subarray=
1253If the device is a container and the argument to \-\-kill\-subarray
1254specifies an inactive subarray in the container, then the subarray is
1255deleted. Deleting all subarrays will leave an 'empty-container' or
1256spare superblock on the drives. See \-\-zero\-superblock for completely
1257removing a superblock. Note that some formats depend on the subarray
1258index for generating a UUID, this command will fail if it would change
1259the UUID of an active subarray.
1260
1261.TP
1262.B \-\-update\-subarray=
1263If the device is a container and the argument to \-\-update\-subarray
1264specifies a subarray in the container, then attempt to update the given
1265superblock field in the subarray. See below in
1266.B MISC MODE
1267for details.
1268
1269.TP
1270.BR \-t ", " \-\-test
1271When used with
1272.BR \-\-detail ,
1273the exit status of
1274.I mdadm
1275is set to reflect the status of the device. See below in
1276.B MISC MODE
1277for details.
1278
1279.TP
1280.BR \-W ", " \-\-wait
1281For each md device given, wait for any resync, recovery, or reshape
1282activity to finish before returning.
1283.I mdadm
1284will return with success if it actually waited for every device
1285listed, otherwise it will return failure.
1286
1287.TP
1288.BR \-\-wait\-clean
1289For each md device given, or each device in /proc/mdstat if
1290.B \-\-scan
1291is given, arrange for the array to be marked clean as soon as possible.
1292.I mdadm
1293will return with success if the array uses external metadata and we
1294successfully waited. For native arrays this returns immediately as the
1295kernel handles dirty-clean transitions at shutdown. No action is taken
1296if safe-mode handling is disabled.
1297
1298.SH For Incremental Assembly mode:
1299.TP
1300.BR \-\-rebuild\-map ", " \-r
1301Rebuild the map file
1302.RB ( /var/run/mdadm/map )
1303that
1304.I mdadm
1305uses to help track which arrays are currently being assembled.
1306
1307.TP
1308.BR \-\-run ", " \-R
1309Run any array assembled as soon as a minimal number of devices are
1310available, rather than waiting until all expected devices are present.
1311
1312.TP
1313.BR \-\-scan ", " \-s
1314Only meaningful with
1315.B \-R
1316this will scan the
1317.B map
1318file for arrays that are being incrementally assembled and will try to
1319start any that are not already started. If any such array is listed
1320in
1321.B mdadm.conf
1322as requiring an external bitmap, that bitmap will be attached first.
1323
1324.TP
1325.BR \-\-fail ", " \-f
1326This allows the hot-plug system to remove devices that have fully disappeared
1327from the kernel. It will first fail and then remove the device from any
1328array it belongs to.
1329The device name given should be a kernel device name such as "sda",
1330not a name in
1331.IR /dev .
1332
1333.TP
1334.BR \-\-path=
1335Only used with \-\-fail. The 'path' given will be recorded so that if
1336a new device appears at the same location it can be automatically
1337added to the same array. This allows the failed device to be
1338automatically replaced by a new device without metadata if it appears
1339at specified path. This option is normally only set by a
1340.I udev
1341script.
1342
1343.SH For Monitor mode:
1344.TP
1345.BR \-m ", " \-\-mail
1346Give a mail address to send alerts to.
1347
1348.TP
1349.BR \-p ", " \-\-program ", " \-\-alert
1350Give a program to be run whenever an event is detected.
1351
1352.TP
1353.BR \-y ", " \-\-syslog
1354Cause all events to be reported through 'syslog'. The messages have
1355facility of 'daemon' and varying priorities.
1356
1357.TP
1358.BR \-d ", " \-\-delay
1359Give a delay in seconds.
1360.I mdadm
1361polls the md arrays and then waits this many seconds before polling
1362again. The default is 60 seconds. Since 2.6.16, there is no need to
1363reduce this as the kernel alerts
1364.I mdadm
1365immediately when there is any change.
1366
1367.TP
1368.BR \-r ", " \-\-increment
1369Give a percentage increment.
1370.I mdadm
1371will generate RebuildNN events with the given percentage increment.
1372
1373.TP
1374.BR \-f ", " \-\-daemonise
1375Tell
1376.I mdadm
1377to run as a background daemon if it decides to monitor anything. This
1378causes it to fork and run in the child, and to disconnect from the
1379terminal. The process id of the child is written to stdout.
1380This is useful with
1381.B \-\-scan
1382which will only continue monitoring if a mail address or alert program
1383is found in the config file.
1384
1385.TP
1386.BR \-i ", " \-\-pid\-file
1387When
1388.I mdadm
1389is running in daemon mode, write the pid of the daemon process to
1390the specified file, instead of printing it on standard output.
1391
1392.TP
1393.BR \-1 ", " \-\-oneshot
1394Check arrays only once. This will generate
1395.B NewArray
1396events and more significantly
1397.B DegradedArray
1398and
1399.B SparesMissing
1400events. Running
1401.in +5
1402.B " mdadm \-\-monitor \-\-scan \-1"
1403.in -5
1404from a cron script will ensure regular notification of any degraded arrays.
1405
1406.TP
1407.BR \-t ", " \-\-test
1408Generate a
1409.B TestMessage
1410alert for every array found at startup. This alert gets mailed and
1411passed to the alert program. This can be used for testing that alert
1412message do get through successfully.
1413
1414.TP
1415.BR \-\-no\-sharing
1416This inhibits the functionality for moving spares between arrays.
1417Only one monitoring process started with
1418.B \-\-scan
1419but without this flag is allowed, otherwise the two could interfere
1420with each other.
1421
1422.SH ASSEMBLE MODE
1423
1424.HP 12
1425Usage:
1426.B mdadm \-\-assemble
1427.I md-device options-and-component-devices...
1428.HP 12
1429Usage:
1430.B mdadm \-\-assemble \-\-scan
1431.I md-devices-and-options...
1432.HP 12
1433Usage:
1434.B mdadm \-\-assemble \-\-scan
1435.I options...
1436
1437.PP
1438This usage assembles one or more RAID arrays from pre-existing components.
1439For each array, mdadm needs to know the md device, the identity of the
1440array, and a number of component-devices. These can be found in a number of ways.
1441
1442In the first usage example (without the
1443.BR \-\-scan )
1444the first device given is the md device.
1445In the second usage example, all devices listed are treated as md
1446devices and assembly is attempted.
1447In the third (where no devices are listed) all md devices that are
1448listed in the configuration file are assembled. If not arrays are
1449described by the configuration file, then any arrays that
1450can be found on unused devices will be assembled.
1451
1452If precisely one device is listed, but
1453.B \-\-scan
1454is not given, then
1455.I mdadm
1456acts as though
1457.B \-\-scan
1458was given and identity information is extracted from the configuration file.
1459
1460The identity can be given with the
1461.B \-\-uuid
1462option, the
1463.B \-\-name
1464option, or the
1465.B \-\-super\-minor
1466option, will be taken from the md-device record in the config file, or
1467will be taken from the super block of the first component-device
1468listed on the command line.
1469
1470Devices can be given on the
1471.B \-\-assemble
1472command line or in the config file. Only devices which have an md
1473superblock which contains the right identity will be considered for
1474any array.
1475
1476The config file is only used if explicitly named with
1477.B \-\-config
1478or requested with (a possibly implicit)
1479.BR \-\-scan .
1480In the later case,
1481.B /etc/mdadm.conf
1482or
1483.B /etc/mdadm/mdadm.conf
1484is used.
1485
1486If
1487.B \-\-scan
1488is not given, then the config file will only be used to find the
1489identity of md arrays.
1490
1491Normally the array will be started after it is assembled. However if
1492.B \-\-scan
1493is not given and not all expected drives were listed, then the array
1494is not started (to guard against usage errors). To insist that the
1495array be started in this case (as may work for RAID1, 4, 5, 6, or 10),
1496give the
1497.B \-\-run
1498flag.
1499
1500If
1501.I udev
1502is active,
1503.I mdadm
1504does not create any entries in
1505.B /dev
1506but leaves that to
1507.IR udev .
1508It does record information in
1509.B /var/run/mdadm/map
1510which will allow
1511.I udev
1512to choose the correct name.
1513
1514If
1515.I mdadm
1516detects that udev is not configured, it will create the devices in
1517.B /dev
1518itself.
1519
1520In Linux kernels prior to version 2.6.28 there were two distinctly
1521different types of md devices that could be created: one that could be
1522partitioned using standard partitioning tools and one that could not.
1523Since 2.6.28 that distinction is no longer relevant as both type of
1524devices can be partitioned.
1525.I mdadm
1526will normally create the type that originally could not be partitioned
1527as it has a well defined major number (9).
1528
1529Prior to 2.6.28, it is important that mdadm chooses the correct type
1530of array device to use. This can be controlled with the
1531.B \-\-auto
1532option. In particular, a value of "mdp" or "part" or "p" tells mdadm
1533to use a partitionable device rather than the default.
1534
1535In the no-udev case, the value given to
1536.B \-\-auto
1537can be suffixed by a number. This tells
1538.I mdadm
1539to create that number of partition devices rather than the default of 4.
1540
1541The value given to
1542.B \-\-auto
1543can also be given in the configuration file as a word starting
1544.B auto=
1545on the ARRAY line for the relevant array.
1546
1547.SS Auto Assembly
1548When
1549.B \-\-assemble
1550is used with
1551.B \-\-scan
1552and no devices are listed,
1553.I mdadm
1554will first attempt to assemble all the arrays listed in the config
1555file.
1556
1557In no array at listed in the config (other than those marked
1558.BR <ignore> )
1559it will look through the available devices for possible arrays and
1560will try to assemble anything that it finds. Arrays which are tagged
1561as belonging to the given homehost will be assembled and started
1562normally. Arrays which do not obviously belong to this host are given
1563names that are expected not to conflict with anything local, and are
1564started "read-auto" so that nothing is written to any device until the
1565array is written to. i.e. automatic resync etc is delayed.
1566
1567If
1568.I mdadm
1569finds a consistent set of devices that look like they should comprise
1570an array, and if the superblock is tagged as belonging to the given
1571home host, it will automatically choose a device name and try to
1572assemble the array. If the array uses version-0.90 metadata, then the
1573.B minor
1574number as recorded in the superblock is used to create a name in
1575.B /dev/md/
1576so for example
1577.BR /dev/md/3 .
1578If the array uses version-1 metadata, then the
1579.B name
1580from the superblock is used to similarly create a name in
1581.B /dev/md/
1582(the name will have any 'host' prefix stripped first).
1583
1584This behaviour can be modified by the
1585.I AUTO
1586line in the
1587.I mdadm.conf
1588configuration file. This line can indicate that specific metadata
1589type should, or should not, be automatically assembled. If an array
1590is found which is not listed in
1591.I mdadm.conf
1592and has a metadata format that is denied by the
1593.I AUTO
1594line, then it will not be assembled.
1595The
1596.I AUTO
1597line can also request that all arrays identified as being for this
1598homehost should be assembled regardless of their metadata type.
1599See
1600.IR mdadm.conf (5)
1601for further details.
1602
1603.ig
1604If
1605.I mdadm
1606cannot find any array for the given host at all, and if
1607.B \-\-auto\-update\-homehost
1608is given, then
1609.I mdadm
1610will search again for any array (not just an array created for this
1611host) and will assemble each assuming
1612.BR \-\-update=homehost .
1613This will change the host tag in the superblock so that on the next run,
1614these arrays will be found without the second pass. The intention of
1615this feature is to support transitioning a set of md arrays to using
1616homehost tagging.
1617
1618The reason for requiring arrays to be tagged with the homehost for
1619auto assembly is to guard against problems that can arise when moving
1620devices from one host to another.
1621..
1622
1623.SH BUILD MODE
1624
1625.HP 12
1626Usage:
1627.B mdadm \-\-build
1628.I md-device
1629.BI \-\-chunk= X
1630.BI \-\-level= Y
1631.BI \-\-raid\-devices= Z
1632.I devices
1633
1634.PP
1635This usage is similar to
1636.BR \-\-create .
1637The difference is that it creates an array without a superblock. With
1638these arrays there is no difference between initially creating the array and
1639subsequently assembling the array, except that hopefully there is useful
1640data there in the second case.
1641
1642The level may raid0, linear, raid1, raid10, multipath, or faulty, or
1643one of their synonyms. All devices must be listed and the array will
1644be started once complete. It will often be appropriate to use
1645.B \-\-assume\-clean
1646with levels raid1 or raid10.
1647
1648.SH CREATE MODE
1649
1650.HP 12
1651Usage:
1652.B mdadm \-\-create
1653.I md-device
1654.BI \-\-chunk= X
1655.BI \-\-level= Y
1656.br
1657.BI \-\-raid\-devices= Z
1658.I devices
1659
1660.PP
1661This usage will initialise a new md array, associate some devices with
1662it, and activate the array.
1663
1664The named device will normally not exist when
1665.I "mdadm \-\-create"
1666is run, but will be created by
1667.I udev
1668once the array becomes active.
1669
1670As devices are added, they are checked to see if they contain RAID
1671superblocks or filesystems. They are also checked to see if the variance in
1672device size exceeds 1%.
1673
1674If any discrepancy is found, the array will not automatically be run, though
1675the presence of a
1676.B \-\-run
1677can override this caution.
1678
1679To create a "degraded" array in which some devices are missing, simply
1680give the word "\fBmissing\fP"
1681in place of a device name. This will cause
1682.I mdadm
1683to leave the corresponding slot in the array empty.
1684For a RAID4 or RAID5 array at most one slot can be
1685"\fBmissing\fP"; for a RAID6 array at most two slots.
1686For a RAID1 array, only one real device needs to be given. All of the
1687others can be
1688"\fBmissing\fP".
1689
1690When creating a RAID5 array,
1691.I mdadm
1692will automatically create a degraded array with an extra spare drive.
1693This is because building the spare into a degraded array is in general
1694faster than resyncing the parity on a non-degraded, but not clean,
1695array. This feature can be overridden with the
1696.B \-\-force
1697option.
1698
1699When creating an array with version-1 metadata a name for the array is
1700required.
1701If this is not given with the
1702.B \-\-name
1703option,
1704.I mdadm
1705will choose a name based on the last component of the name of the
1706device being created. So if
1707.B /dev/md3
1708is being created, then the name
1709.B 3
1710will be chosen.
1711If
1712.B /dev/md/home
1713is being created, then the name
1714.B home
1715will be used.
1716
1717When creating a partition based array, using
1718.I mdadm
1719with version-1.x metadata, the partition type should be set to
1720.B 0xDA
1721(non fs-data). This type selection allows for greater precision since
1722using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)],
1723might create problems in the event of array recovery through a live cdrom.
1724
1725A new array will normally get a randomly assigned 128bit UUID which is
1726very likely to be unique. If you have a specific need, you can choose
1727a UUID for the array by giving the
1728.B \-\-uuid=
1729option. Be warned that creating two arrays with the same UUID is a
1730recipe for disaster. Also, using
1731.B \-\-uuid=
1732when creating a v0.90 array will silently override any
1733.B \-\-homehost=
1734setting.
1735.\"If the
1736.\".B \-\-size
1737.\"option is given, it is not necessary to list any component-devices in this command.
1738.\"They can be added later, before a
1739.\".B \-\-run.
1740.\"If no
1741.\".B \-\-size
1742.\"is given, the apparent size of the smallest drive given is used.
1743
1744When creating an array within a
1745.B CONTAINER
1746.I mdadm
1747can be given either the list of devices to use, or simply the name of
1748the container. The former case gives control over which devices in
1749the container will be used for the array. The latter case allows
1750.I mdadm
1751to automatically choose which devices to use based on how much spare
1752space is available.
1753
1754The General Management options that are valid with
1755.B \-\-create
1756are:
1757.TP
1758.B \-\-run
1759insist on running the array even if some devices look like they might
1760be in use.
1761
1762.TP
1763.B \-\-readonly
1764start the array readonly \(em not supported yet.
1765
1766.SH MANAGE MODE
1767.HP 12
1768Usage:
1769.B mdadm
1770.I device
1771.I options... devices...
1772.PP
1773
1774This usage will allow individual devices in an array to be failed,
1775removed or added. It is possible to perform multiple operations with
1776on command. For example:
1777.br
1778.B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1"
1779.br
1780will firstly mark
1781.B /dev/hda1
1782as faulty in
1783.B /dev/md0
1784and will then remove it from the array and finally add it back
1785in as a spare. However only one md array can be affected by a single
1786command.
1787
1788When a device is added to an active array, mdadm checks to see if it
1789has metadata on it which suggests that it was recently a member of the
1790array. If it does, it tries to "re\-add" the device. If there have
1791been no changes since the device was removed, or if the array has a
1792write-intent bitmap which has recorded whatever changes there were,
1793then the device will immediately become a full member of the array and
1794those differences recorded in the bitmap will be resolved.
1795
1796.SH MISC MODE
1797.HP 12
1798Usage:
1799.B mdadm
1800.I options ...
1801.I devices ...
1802.PP
1803
1804MISC mode includes a number of distinct operations that
1805operate on distinct devices. The operations are:
1806.TP
1807.B \-\-query
1808The device is examined to see if it is
1809(1) an active md array, or
1810(2) a component of an md array.
1811The information discovered is reported.
1812
1813.TP
1814.B \-\-detail
1815The device should be an active md device.
1816.B mdadm
1817will display a detailed description of the array.
1818.B \-\-brief
1819or
1820.B \-\-scan
1821will cause the output to be less detailed and the format to be
1822suitable for inclusion in
1823.BR mdadm.conf .
1824The exit status of
1825.I mdadm
1826will normally be 0 unless
1827.I mdadm
1828failed to get useful information about the device(s); however, if the
1829.B \-\-test
1830option is given, then the exit status will be:
1831.RS
1832.TP
18330
1834The array is functioning normally.
1835.TP
18361
1837The array has at least one failed device.
1838.TP
18392
1840The array has multiple failed devices such that it is unusable.
1841.TP
18424
1843There was an error while trying to get information about the device.
1844.RE
1845
1846.TP
1847.B \-\-detail\-platform
1848Print detail of the platform's RAID capabilities (firmware / hardware
1849topology). If the metadata is specified with
1850.B \-e
1851or
1852.B \-\-metadata=
1853then the return status will be:
1854.RS
1855.TP
18560
1857metadata successfully enumerated its platform components on this system
1858.TP
18591
1860metadata is platform independent
1861.TP
18622
1863metadata failed to find its platform components on this system
1864.RE
1865
1866.TP
1867.B \-\-update\-subarray=
1868If the device is a container and the argument to \-\-update\-subarray
1869specifies a subarray in the container, then attempt to update the given
1870superblock field in the subarray. Similar to updating an array in
1871"assemble" mode, the field to update is selected by
1872.B \-U
1873or
1874.B \-\-update=
1875option. Currently only
1876.B name
1877is supported.
1878
1879The
1880.B name
1881option updates the subarray name in the metadata, it may not affect the
1882device node name or the device node symlink until the subarray is
1883re\-assembled. If updating
1884.B name
1885would change the UUID of an active subarray this operation is blocked,
1886and the command will end in an error.
1887
1888.TP
1889.B \-\-examine
1890The device should be a component of an md array.
1891.I mdadm
1892will read the md superblock of the device and display the contents.
1893If
1894.B \-\-brief
1895or
1896.B \-\-scan
1897is given, then multiple devices that are components of the one array
1898are grouped together and reported in a single entry suitable
1899for inclusion in
1900.BR mdadm.conf .
1901
1902Having
1903.B \-\-scan
1904without listing any devices will cause all devices listed in the
1905config file to be examined.
1906
1907.TP
1908.B \-\-stop
1909The devices should be active md arrays which will be deactivated, as
1910long as they are not currently in use.
1911
1912.TP
1913.B \-\-run
1914This will fully activate a partially assembled md array.
1915
1916.TP
1917.B \-\-readonly
1918This will mark an active array as read-only, providing that it is
1919not currently being used.
1920
1921.TP
1922.B \-\-readwrite
1923This will change a
1924.B readonly
1925array back to being read/write.
1926
1927.TP
1928.B \-\-scan
1929For all operations except
1930.BR \-\-examine ,
1931.B \-\-scan
1932will cause the operation to be applied to all arrays listed in
1933.BR /proc/mdstat .
1934For
1935.BR \-\-examine,
1936.B \-\-scan
1937causes all devices listed in the config file to be examined.
1938
1939.TP
1940.BR \-b ", " \-\-brief
1941Be less verbose. This is used with
1942.B \-\-detail
1943and
1944.BR \-\-examine .
1945Using
1946.B \-\-brief
1947with
1948.B \-\-verbose
1949gives an intermediate level of verbosity.
1950
1951.SH MONITOR MODE
1952
1953.HP 12
1954Usage:
1955.B mdadm \-\-monitor
1956.I options... devices...
1957
1958.PP
1959This usage causes
1960.I mdadm
1961to periodically poll a number of md arrays and to report on any events
1962noticed.
1963.I mdadm
1964will never exit once it decides that there are arrays to be checked,
1965so it should normally be run in the background.
1966
1967As well as reporting events,
1968.I mdadm
1969may move a spare drive from one array to another if they are in the
1970same
1971.B spare-group
1972or
1973.B domain
1974and if the destination array has a failed drive but no spares.
1975
1976If any devices are listed on the command line,
1977.I mdadm
1978will only monitor those devices. Otherwise all arrays listed in the
1979configuration file will be monitored. Further, if
1980.B \-\-scan
1981is given, then any other md devices that appear in
1982.B /proc/mdstat
1983will also be monitored.
1984
1985The result of monitoring the arrays is the generation of events.
1986These events are passed to a separate program (if specified) and may
1987be mailed to a given E-mail address.
1988
1989When passing events to a program, the program is run once for each event,
1990and is given 2 or 3 command-line arguments: the first is the
1991name of the event (see below), the second is the name of the
1992md device which is affected, and the third is the name of a related
1993device if relevant (such as a component device that has failed).
1994
1995If
1996.B \-\-scan
1997is given, then a program or an E-mail address must be specified on the
1998command line or in the config file. If neither are available, then
1999.I mdadm
2000will not monitor anything.
2001Without
2002.B \-\-scan,
2003.I mdadm
2004will continue monitoring as long as something was found to monitor. If
2005no program or email is given, then each event is reported to
2006.BR stdout .
2007
2008The different events are:
2009
2010.RS 4
2011.TP
2012.B DeviceDisappeared
2013An md array which previously was configured appears to no longer be
2014configured. (syslog priority: Critical)
2015
2016If
2017.I mdadm
2018was told to monitor an array which is RAID0 or Linear, then it will
2019report
2020.B DeviceDisappeared
2021with the extra information
2022.BR Wrong-Level .
2023This is because RAID0 and Linear do not support the device-failed,
2024hot-spare and resync operations which are monitored.
2025
2026.TP
2027.B RebuildStarted
2028An md array started reconstruction. (syslog priority: Warning)
2029
2030.TP
2031.BI Rebuild NN
2032Where
2033.I NN
2034is a two-digit number (ie. 05, 48). This indicates that rebuild
2035has passed that many percent of the total. The events are generated
2036with fixed increment since 0. Increment size may be specified with
2037a commandline option (default is 20). (syslog priority: Warning)
2038
2039.TP
2040.B RebuildFinished
2041An md array that was rebuilding, isn't any more, either because it
2042finished normally or was aborted. (syslog priority: Warning)
2043
2044.TP
2045.B Fail
2046An active component device of an array has been marked as
2047faulty. (syslog priority: Critical)
2048
2049.TP
2050.B FailSpare
2051A spare component device which was being rebuilt to replace a faulty
2052device has failed. (syslog priority: Critical)
2053
2054.TP
2055.B SpareActive
2056A spare component device which was being rebuilt to replace a faulty
2057device has been successfully rebuilt and has been made active.
2058(syslog priority: Info)
2059
2060.TP
2061.B NewArray
2062A new md array has been detected in the
2063.B /proc/mdstat
2064file. (syslog priority: Info)
2065
2066.TP
2067.B DegradedArray
2068A newly noticed array appears to be degraded. This message is not
2069generated when
2070.I mdadm
2071notices a drive failure which causes degradation, but only when
2072.I mdadm
2073notices that an array is degraded when it first sees the array.
2074(syslog priority: Critical)
2075
2076.TP
2077.B MoveSpare
2078A spare drive has been moved from one array in a
2079.B spare-group
2080or
2081.B domain
2082to another to allow a failed drive to be replaced.
2083(syslog priority: Info)
2084
2085.TP
2086.B SparesMissing
2087If
2088.I mdadm
2089has been told, via the config file, that an array should have a certain
2090number of spare devices, and
2091.I mdadm
2092detects that it has fewer than this number when it first sees the
2093array, it will report a
2094.B SparesMissing
2095message.
2096(syslog priority: Warning)
2097
2098.TP
2099.B TestMessage
2100An array was found at startup, and the
2101.B \-\-test
2102flag was given.
2103(syslog priority: Info)
2104.RE
2105
2106Only
2107.B Fail,
2108.B FailSpare,
2109.B DegradedArray,
2110.B SparesMissing
2111and
2112.B TestMessage
2113cause Email to be sent. All events cause the program to be run.
2114The program is run with two or three arguments: the event
2115name, the array device and possibly a second device.
2116
2117Each event has an associated array device (e.g.
2118.BR /dev/md1 )
2119and possibly a second device. For
2120.BR Fail ,
2121.BR FailSpare ,
2122and
2123.B SpareActive
2124the second device is the relevant component device.
2125For
2126.B MoveSpare
2127the second device is the array that the spare was moved from.
2128
2129For
2130.I mdadm
2131to move spares from one array to another, the different arrays need to
2132be labeled with the same
2133.B spare-group
2134or the spares must be allowed to migrate through matching POLICY domains
2135in the configuration file. The
2136.B spare-group
2137name can be any string; it is only necessary that different spare
2138groups use different names.
2139
2140When
2141.I mdadm
2142detects that an array in a spare group has fewer active
2143devices than necessary for the complete array, and has no spare
2144devices, it will look for another array in the same spare group that
2145has a full complement of working drive and a spare. It will then
2146attempt to remove the spare from the second drive and add it to the
2147first.
2148If the removal succeeds but the adding fails, then it is added back to
2149the original array.
2150
2151If the spare group for a degraded array is not defined,
2152.I mdadm
2153will look at the rules of spare migration specified by POLICY lines in
2154.B mdadm.conf
2155and then follow similar steps as above if a matching spare is found.
2156
2157.SH GROW MODE
2158The GROW mode is used for changing the size or shape of an active
2159array.
2160For this to work, the kernel must support the necessary change.
2161Various types of growth are being added during 2.6 development,
2162including restructuring a RAID5 array to have more active devices.
2163
2164Currently the only support available is to
2165.IP \(bu 4
2166change the "size" attribute
2167for RAID1, RAID5 and RAID6.
2168.IP \(bu 4
2169increase or decrease the "raid\-devices" attribute of RAID1, RAID5,
2170and RAID6.
2171.IP \bu 4
2172change the chunk-size and layout of RAID5 and RAID6.
2173.IP \bu 4
2174convert between RAID1 and RAID5, and between RAID5 and RAID6.
2175.IP \(bu 4
2176add a write-intent bitmap to any array which supports these bitmaps, or
2177remove a write-intent bitmap from such an array.
2178.PP
2179
2180GROW mode is not currently supported for
2181.B CONTAINERS
2182or arrays inside containers.
2183
2184.SS SIZE CHANGES
2185Normally when an array is built the "size" it taken from the smallest
2186of the drives. If all the small drives in an arrays are, one at a
2187time, removed and replaced with larger drives, then you could have an
2188array of large drives with only a small amount used. In this
2189situation, changing the "size" with "GROW" mode will allow the extra
2190space to start being used. If the size is increased in this way, a
2191"resync" process will start to make sure the new parts of the array
2192are synchronised.
2193
2194Note that when an array changes size, any filesystem that may be
2195stored in the array will not automatically grow to use the space. The
2196filesystem will need to be explicitly told to use the extra space.
2197
2198Also the size of an array cannot be changed while it has an active
2199bitmap. If an array has a bitmap, it must be removed before the size
2200can be changed. Once the change it complete a new bitmap can be created.
2201
2202.SS RAID\-DEVICES CHANGES
2203
2204A RAID1 array can work with any number of devices from 1 upwards
2205(though 1 is not very useful). There may be times which you want to
2206increase or decrease the number of active devices. Note that this is
2207different to hot-add or hot-remove which changes the number of
2208inactive devices.
2209
2210When reducing the number of devices in a RAID1 array, the slots which
2211are to be removed from the array must already be vacant. That is, the
2212devices which were in those slots must be failed and removed.
2213
2214When the number of devices is increased, any hot spares that are
2215present will be activated immediately.
2216
2217Changing the number of active devices in a RAID5 or RAID6 is much more
2218effort. Every block in the array will need to be read and written
2219back to a new location. From 2.6.17, the Linux Kernel is able to
2220increase the number of devices in a RAID5 safely, including restarting
2221an interrupted "reshape". From 2.6.31, the Linux Kernel is able to
2222increase or decrease the number of devices in a RAID5 or RAID6.
2223
2224When decreasing the number of devices, the size of the array will also
2225decrease. If there was data in the array, it could get destroyed and
2226this is not reversible. To help prevent accidents,
2227.I mdadm
2228requires that the size of the array be decreased first with
2229.BR "mdadm --grow --array-size" .
2230This is a reversible change which simply makes the end of the array
2231inaccessible. The integrity of any data can then be checked before
2232the non-reversible reduction in the number of devices is request.
2233
2234When relocating the first few stripes on a RAID5 or RAID6, it is not
2235possible to keep the data on disk completely consistent and
2236crash-proof. To provide the required safety, mdadm disables writes to
2237the array while this "critical section" is reshaped, and takes a
2238backup of the data that is in that section. For grows, this backup may be
2239stored in any spare devices that the array has, however it can also be
2240stored in a separate file specified with the
2241.B \-\-backup\-file
2242option, and is required to be specified for shrinks, RAID level
2243changes and layout changes. If this option is used, and the system
2244does crash during the critical period, the same file must be passed to
2245.B \-\-assemble
2246to restore the backup and reassemble the array. When shrinking rather
2247than growing the array, the reshape is done from the end towards the
2248beginning, so the "critical section" is at the end of the reshape.
2249
2250.SS LEVEL CHANGES
2251
2252Changing the RAID level of any array happens instantaneously. However
2253in the RAID5 to RAID6 case this requires a non-standard layout of the
2254RAID6 data, and in the RAID6 to RAID5 case that non-standard layout is
2255required before the change can be accomplished. So while the level
2256change is instant, the accompanying layout change can take quite a
2257long time. A
2258.B \-\-backup\-file
2259is required. If the array is not simultaneously being grown or
2260shrunk, so that the array size will remain the same - for example,
2261reshaping a 3-drive RAID5 into a 4-drive RAID6 - the backup file will
2262be used not just for a "cricital section" but throughout the reshape
2263operation, as described below under LAYOUT CHANGES.
2264
2265.SS CHUNK-SIZE AND LAYOUT CHANGES
2266
2267Changing the chunk-size of layout without also changing the number of
2268devices as the same time will involve re-writing all blocks in-place.
2269To ensure against data loss in the case of a crash, a
2270.B --backup-file
2271must be provided for these changes. Small sections of the array will
2272be copied to the backup file while they are being rearranged. This
2273means that all the data is copied twice, once to the backup and once
2274to the new layout on the array, so this type of reshape will go very
2275slowly.
2276
2277If the reshape is interrupted for any reason, this backup file must be
2278made available to
2279.B "mdadm --assemble"
2280so the array can be reassembled. Consequently the file cannot be
2281stored on the device being reshaped.
2282
2283
2284.SS BITMAP CHANGES
2285
2286A write-intent bitmap can be added to, or removed from, an active
2287array. Either internal bitmaps, or bitmaps stored in a separate file,
2288can be added. Note that if you add a bitmap stored in a file which is
2289in a filesystem that is on the RAID array being affected, the system
2290will deadlock. The bitmap must be on a separate filesystem.
2291
2292.SH INCREMENTAL MODE
2293
2294.HP 12
2295Usage:
2296.B mdadm \-\-incremental
2297.RB [ \-\-run ]
2298.RB [ \-\-quiet ]
2299.I component-device
2300.HP 12
2301Usage:
2302.B mdadm \-\-incremental \-\-fail
2303.I component-device
2304.HP 12
2305Usage:
2306.B mdadm \-\-incremental \-\-rebuild\-map
2307.HP 12
2308Usage:
2309.B mdadm \-\-incremental \-\-run \-\-scan
2310
2311.PP
2312This mode is designed to be used in conjunction with a device
2313discovery system. As devices are found in a system, they can be
2314passed to
2315.B "mdadm \-\-incremental"
2316to be conditionally added to an appropriate array.
2317
2318Conversely, it can also be used with the
2319.B \-\-fail
2320flag to do just the opposite and find whatever array a particular device
2321is part of and remove the device from that array.
2322
2323If the device passed is a
2324.B CONTAINER
2325device created by a previous call to
2326.IR mdadm ,
2327then rather than trying to add that device to an array, all the arrays
2328described by the metadata of the container will be started.
2329
2330.I mdadm
2331performs a number of tests to determine if the device is part of an
2332array, and which array it should be part of. If an appropriate array
2333is found, or can be created,
2334.I mdadm
2335adds the device to the array and conditionally starts the array.
2336
2337Note that
2338.I mdadm
2339will normally only add devices to an array which were previously working
2340(active or spare) parts of that array. The support for automatic
2341inclusion of a new drive as a spare in some array requires
2342a configuration through POLICY in config file.
2343
2344The tests that
2345.I mdadm
2346makes are as follow:
2347.IP +
2348Is the device permitted by
2349.BR mdadm.conf ?
2350That is, is it listed in a
2351.B DEVICES
2352line in that file. If
2353.B DEVICES
2354is absent then the default it to allow any device. Similar if
2355.B DEVICES
2356contains the special word
2357.B partitions
2358then any device is allowed. Otherwise the device name given to
2359.I mdadm
2360must match one of the names or patterns in a
2361.B DEVICES
2362line.
2363
2364.IP +
2365Does the device have a valid md superblock. If a specific metadata
2366version is request with
2367.B \-\-metadata
2368or
2369.B \-e
2370then only that style of metadata is accepted, otherwise
2371.I mdadm
2372finds any known version of metadata. If no
2373.I md
2374metadata is found, the device may be still added to an array
2375as a spare if POLICY allows.
2376
2377.ig
2378.IP +
2379Does the metadata match an expected array?
2380The metadata can match in two ways. Either there is an array listed
2381in
2382.B mdadm.conf
2383which identifies the array (either by UUID, by name, by device list,
2384or by minor-number), or the array was created with a
2385.B homehost
2386specified and that
2387.B homehost
2388matches the one in
2389.B mdadm.conf
2390or on the command line.
2391If
2392.I mdadm
2393is not able to positively identify the array as belonging to the
2394current host, the device will be rejected.
2395..
2396
2397.I mdadm
2398keeps a list of arrays that it has partially assembled in
2399.B /var/run/mdadm/map
2400(or
2401.B /var/run/mdadm.map
2402if the directory doesn't exist. Or maybe even
2403.BR /dev/.mdadm.map ).
2404If no array exists which matches
2405the metadata on the new device,
2406.I mdadm
2407must choose a device name and unit number. It does this based on any
2408name given in
2409.B mdadm.conf
2410or any name information stored in the metadata. If this name
2411suggests a unit number, that number will be used, otherwise a free
2412unit number will be chosen. Normally
2413.I mdadm
2414will prefer to create a partitionable array, however if the
2415.B CREATE
2416line in
2417.B mdadm.conf
2418suggests that a non-partitionable array is preferred, that will be
2419honoured.
2420
2421If the array is not found in the config file and its metadata does not
2422identify it as belonging to the "homehost", then
2423.I mdadm
2424will choose a name for the array which is certain not to conflict with
2425any array which does belong to this host. It does this be adding an
2426underscore and a small number to the name preferred by the metadata.
2427
2428Once an appropriate array is found or created and the device is added,
2429.I mdadm
2430must decide if the array is ready to be started. It will
2431normally compare the number of available (non-spare) devices to the
2432number of devices that the metadata suggests need to be active. If
2433there are at least that many, the array will be started. This means
2434that if any devices are missing the array will not be restarted.
2435
2436As an alternative,
2437.B \-\-run
2438may be passed to
2439.I mdadm
2440in which case the array will be run as soon as there are enough
2441devices present for the data to be accessible. For a RAID1, that
2442means one device will start the array. For a clean RAID5, the array
2443will be started as soon as all but one drive is present.
2444
2445Note that neither of these approaches is really ideal. If it can
2446be known that all device discovery has completed, then
2447.br
2448.B " mdadm \-IRs"
2449.br
2450can be run which will try to start all arrays that are being
2451incrementally assembled. They are started in "read-auto" mode in
2452which they are read-only until the first write request. This means
2453that no metadata updates are made and no attempt at resync or recovery
2454happens. Further devices that are found before the first write can
2455still be added safely.
2456
2457.SH ENVIRONMENT
2458This section describes environment variables that affect how mdadm
2459operates.
2460
2461.TP
2462.B MDADM_NO_MDMON
2463Setting this value to 1 will prevent mdadm from automatically launching
2464mdmon. This variable is intended primarily for debugging mdadm/mdmon.
2465
2466.TP
2467.B MDADM_NO_UDEV
2468Normally,
2469.I mdadm
2470does not create any device nodes in /dev, but leaves that task to
2471.IR udev .
2472If
2473.I udev
2474appears not to be configured, or if this environment variable is set
2475to '1', the
2476.I mdadm
2477will create and devices that are needed.
2478
2479.SH EXAMPLES
2480
2481.B " mdadm \-\-query /dev/name-of-device"
2482.br
2483This will find out if a given device is a RAID array, or is part of
2484one, and will provide brief information about the device.
2485
2486.B " mdadm \-\-assemble \-\-scan"
2487.br
2488This will assemble and start all arrays listed in the standard config
2489file. This command will typically go in a system startup file.
2490
2491.B " mdadm \-\-stop \-\-scan"
2492.br
2493This will shut down all arrays that can be shut down (i.e. are not
2494currently in use). This will typically go in a system shutdown script.
2495
2496.B " mdadm \-\-follow \-\-scan \-\-delay=120"
2497.br
2498If (and only if) there is an Email address or program given in the
2499standard config file, then
2500monitor the status of all arrays listed in that file by
2501polling them ever 2 minutes.
2502
2503.B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1"
2504.br
2505Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.
2506
2507.br
2508.B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf"
2509.br
2510.B " mdadm \-\-detail \-\-scan >> mdadm.conf"
2511.br
2512This will create a prototype config file that describes currently
2513active arrays that are known to be made from partitions of IDE or SCSI drives.
2514This file should be reviewed before being used as it may
2515contain unwanted detail.
2516
2517.B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf"
2518.br
2519.B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf"
2520.br
2521This will find arrays which could be assembled from existing IDE and
2522SCSI whole drives (not partitions), and store the information in the
2523format of a config file.
2524This file is very likely to contain unwanted detail, particularly
2525the
2526.B devices=
2527entries. It should be reviewed and edited before being used as an
2528actual config file.
2529
2530.B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions"
2531.br
2532.B " mdadm \-Ebsc partitions"
2533.br
2534Create a list of devices by reading
2535.BR /proc/partitions ,
2536scan these for RAID superblocks, and printout a brief listing of all
2537that were found.
2538
2539.B " mdadm \-Ac partitions \-m 0 /dev/md0"
2540.br
2541Scan all partitions and devices listed in
2542.BR /proc/partitions
2543and assemble
2544.B /dev/md0
2545out of all such devices with a RAID superblock with a minor number of 0.
2546
2547.B " mdadm \-\-monitor \-\-scan \-\-daemonise > /var/run/mdadm"
2548.br
2549If config file contains a mail address or alert program, run mdadm in
2550the background in monitor mode monitoring all md devices. Also write
2551pid of mdadm daemon to
2552.BR /var/run/mdadm .
2553
2554.B " mdadm \-Iq /dev/somedevice"
2555.br
2556Try to incorporate newly discovered device into some array as
2557appropriate.
2558
2559.B " mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan"
2560.br
2561Rebuild the array map from any current arrays, and then start any that
2562can be started.
2563
2564.B " mdadm /dev/md4 --fail detached --remove detached"
2565.br
2566Any devices which are components of /dev/md4 will be marked as faulty
2567and then remove from the array.
2568
2569.B " mdadm --grow /dev/md4 --level=6 --backup-file=/root/backup-md4
2570.br
2571The array
2572.B /dev/md4
2573which is currently a RAID5 array will be converted to RAID6. There
2574should normally already be a spare drive attached to the array as a
2575RAID6 needs one more drive than a matching RAID5.
2576
2577.B " mdadm --create /dev/md/ddf --metadata=ddf --raid-disks 6 /dev/sd[a-f]"
2578.br
2579Create a DDF array over 6 devices.
2580
2581.B " mdadm --create /dev/md/home -n3 -l5 -z 30000000 /dev/md/ddf"
2582.br
2583Create a RAID5 array over any 3 devices in the given DDF set. Use
2584only 30 gigabytes of each device.
2585
2586.B " mdadm -A /dev/md/ddf1 /dev/sd[a-f]"
2587.br
2588Assemble a pre-exist ddf array.
2589
2590.B " mdadm -I /dev/md/ddf1"
2591.br
2592Assemble all arrays contained in the ddf array, assigning names as
2593appropriate.
2594
2595.B " mdadm \-\-create \-\-help"
2596.br
2597Provide help about the Create mode.
2598
2599.B " mdadm \-\-config \-\-help"
2600.br
2601Provide help about the format of the config file.
2602
2603.B " mdadm \-\-help"
2604.br
2605Provide general help.
2606
2607.SH FILES
2608
2609.SS /proc/mdstat
2610
2611If you're using the
2612.B /proc
2613filesystem,
2614.B /proc/mdstat
2615lists all active md devices with information about them.
2616.I mdadm
2617uses this to find arrays when
2618.B \-\-scan
2619is given in Misc mode, and to monitor array reconstruction
2620on Monitor mode.
2621
2622.SS /etc/mdadm.conf
2623
2624The config file lists which devices may be scanned to see if
2625they contain MD super block, and gives identifying information
2626(e.g. UUID) about known MD arrays. See
2627.BR mdadm.conf (5)
2628for more details.
2629
2630.SS /var/run/mdadm/map
2631When
2632.B \-\-incremental
2633mode is used, this file gets a list of arrays currently being created.
2634If
2635.B /var/run/mdadm
2636does not exist as a directory, then
2637.B /var/run/mdadm.map
2638is used instead. If
2639.B /var/run
2640is not available (as may be the case during early boot),
2641.B /dev/.mdadm.map
2642is used on the basis that
2643.B /dev
2644is usually available very early in boot.
2645
2646.SH DEVICE NAMES
2647
2648.I mdadm
2649understand two sorts of names for array devices.
2650
2651The first is the so-called 'standard' format name, which matches the
2652names used by the kernel and which appear in
2653.IR /proc/mdstat .
2654
2655The second sort can be freely chosen, but must reside in
2656.IR /dev/md/ .
2657When giving a device name to
2658.I mdadm
2659to create or assemble an array, either full path name such as
2660.I /dev/md0
2661or
2662.I /dev/md/home
2663can be given, or just the suffix of the second sort of name, such as
2664.I home
2665can be given.
2666
2667When
2668.I mdadm
2669chooses device names during auto-assembly or incremental assembly, it
2670will sometimes add a small sequence number to the end of the name to
2671avoid conflicted between multiple arrays that have the same name. If
2672.I mdadm
2673can reasonably determine that the array really is meant for this host,
2674either by a hostname in the metadata, or by the presence of the array
2675in
2676.BR mdadm.conf ,
2677then it will leave off the suffix if possible.
2678Also if the homehost is specified as
2679.B <ignore>
2680.I mdadm
2681will only use a suffix if a different array of the same name already
2682exists or is listed in the config file.
2683
2684The standard names for non-partitioned arrays (the only sort of md
2685array available in 2.4 and earlier) are of the form
2686.IP
2687/dev/mdNN
2688.PP
2689where NN is a number.
2690The standard names for partitionable arrays (as available from 2.6
2691onwards) are of the form
2692.IP
2693/dev/md_dNN
2694.PP
2695Partition numbers should be indicated by added "pMM" to these, thus "/dev/md/d1p2".
2696.PP
2697From kernel version, 2.6.28 the "non-partitioned array" can actually
2698be partitioned. So the "md_dNN" names are no longer needed, and
2699partitions such as "/dev/mdNNpXX" are possible.
2700
2701.SH NOTE
2702.I mdadm
2703was previously known as
2704.IR mdctl .
2705.P
2706.I mdadm
2707is completely separate from the
2708.I raidtools
2709package, and does not use the
2710.I /etc/raidtab
2711configuration file at all.
2712
2713.SH SEE ALSO
2714For further information on mdadm usage, MD and the various levels of
2715RAID, see:
2716.IP
2717.B http://linux\-raid.osdl.org/
2718.PP
2719(based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO)
2720.\".PP
2721.\"for new releases of the RAID driver check out:
2722.\"
2723.\".IP
2724.\".UR ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
2725.\"ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches
2726.\".UE
2727.\".PP
2728.\"or
2729.\".IP
2730.\".UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
2731.\"http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/
2732.\".UE
2733.PP
2734The latest version of
2735.I mdadm
2736should always be available from
2737.IP
2738.B http://www.kernel.org/pub/linux/utils/raid/mdadm/
2739.PP
2740Related man pages:
2741.PP
2742.IR mdmon (8),
2743.IR mdadm.conf (5),
2744.IR md (4).
2745.PP
2746.IR raidtab (5),
2747.IR raid0run (8),
2748.IR raidstop (8),
2749.IR mkraid (8).