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