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