]> git.ipfire.org Git - thirdparty/mdadm.git/blob - mdadm.8.in
388e0edbf89a9aee719f8125c65221645fd4e8e5
[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.0
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 Recreate journal for RAID-4/5/6 array that lost a journal device. In the
1530 current implementation, this command cannot add a journal to an array
1531 that had a failed journal. To avoid interrupting on-going write opertions,
1532 .B \-\-add-journal
1533 only works for array in Read-Only state.
1534
1535 .TP
1536 .BR \-\-failfast
1537 Subsequent devices that are added or re\-added will have
1538 the 'failfast' flag set. This is only valid for RAID1 and RAID10 and
1539 means that the 'md' driver will avoid long timeouts on error handling
1540 where possible.
1541 .TP
1542 .BR \-\-nofailfast
1543 Subsequent devices that are re\-added will be re\-added without
1544 the 'failfast' flag set.
1545
1546 .P
1547 Each of these options requires that the first device listed is the array
1548 to be acted upon, and the remainder are component devices to be added,
1549 removed, marked as faulty, etc. Several different operations can be
1550 specified for different devices, e.g.
1551 .in +5
1552 mdadm /dev/md0 \-\-add /dev/sda1 \-\-fail /dev/sdb1 \-\-remove /dev/sdb1
1553 .in -5
1554 Each operation applies to all devices listed until the next
1555 operation.
1556
1557 If an array is using a write-intent bitmap, then devices which have
1558 been removed can be re\-added in a way that avoids a full
1559 reconstruction but instead just updates the blocks that have changed
1560 since the device was removed. For arrays with persistent metadata
1561 (superblocks) this is done automatically. For arrays created with
1562 .B \-\-build
1563 mdadm needs to be told that this device we removed recently with
1564 .BR \-\-re\-add .
1565
1566 Devices can only be removed from an array if they are not in active
1567 use, i.e. that must be spares or failed devices. To remove an active
1568 device, it must first be marked as
1569 .B faulty.
1570
1571 .SH For Misc mode:
1572
1573 .TP
1574 .BR \-Q ", " \-\-query
1575 Examine a device to see
1576 (1) if it is an md device and (2) if it is a component of an md
1577 array.
1578 Information about what is discovered is presented.
1579
1580 .TP
1581 .BR \-D ", " \-\-detail
1582 Print details of one or more md devices.
1583
1584 .TP
1585 .BR \-\-detail\-platform
1586 Print details of the platform's RAID capabilities (firmware / hardware
1587 topology) for a given metadata format. If used without argument, mdadm
1588 will scan all controllers looking for their capabilities. Otherwise, mdadm
1589 will only look at the controller specified by the argument in form of an
1590 absolute filepath or a link, e.g.
1591 .IR /sys/devices/pci0000:00/0000:00:1f.2 .
1592
1593 .TP
1594 .BR \-Y ", " \-\-export
1595 When used with
1596 .BR \-\-detail ,
1597 .BR \-\-detail-platform ,
1598 .BR \-\-examine ,
1599 or
1600 .B \-\-incremental
1601 output will be formatted as
1602 .B key=value
1603 pairs for easy import into the environment.
1604
1605 With
1606 .B \-\-incremental
1607 The value
1608 .B MD_STARTED
1609 indicates whether an array was started
1610 .RB ( yes )
1611 or not, which may include a reason
1612 .RB ( unsafe ", " nothing ", " no ).
1613 Also the value
1614 .B MD_FOREIGN
1615 indicates if the array is expected on this host
1616 .RB ( no ),
1617 or seems to be from elsewhere
1618 .RB ( yes ).
1619
1620 .TP
1621 .BR \-E ", " \-\-examine
1622 Print contents of the metadata stored on the named device(s).
1623 Note the contrast between
1624 .B \-\-examine
1625 and
1626 .BR \-\-detail .
1627 .B \-\-examine
1628 applies to devices which are components of an array, while
1629 .B \-\-detail
1630 applies to a whole array which is currently active.
1631 .TP
1632 .B \-\-sparc2.2
1633 If an array was created on a SPARC machine with a 2.2 Linux kernel
1634 patched with RAID support, the superblock will have been created
1635 incorrectly, or at least incompatibly with 2.4 and later kernels.
1636 Using the
1637 .B \-\-sparc2.2
1638 flag with
1639 .B \-\-examine
1640 will fix the superblock before displaying it. If this appears to do
1641 the right thing, then the array can be successfully assembled using
1642 .BR "\-\-assemble \-\-update=sparc2.2" .
1643
1644 .TP
1645 .BR \-X ", " \-\-examine\-bitmap
1646 Report information about a bitmap file.
1647 The argument is either an external bitmap file or an array component
1648 in case of an internal bitmap. Note that running this on an array
1649 device (e.g.
1650 .BR /dev/md0 )
1651 does not report the bitmap for that array.
1652
1653 .TP
1654 .B \-\-examine\-badblocks
1655 List the bad-blocks recorded for the device, if a bad-blocks list has
1656 been configured. Currently only
1657 .B 1.x
1658 metadata supports bad-blocks lists.
1659
1660 .TP
1661 .BI \-\-dump= directory
1662 .TP
1663 .BI \-\-restore= directory
1664 Save metadata from lists devices, or restore metadata to listed devices.
1665
1666 .TP
1667 .BR \-R ", " \-\-run
1668 start a partially assembled array. If
1669 .B \-\-assemble
1670 did not find enough devices to fully start the array, it might leaving
1671 it partially assembled. If you wish, you can then use
1672 .B \-\-run
1673 to start the array in degraded mode.
1674
1675 .TP
1676 .BR \-S ", " \-\-stop
1677 deactivate array, releasing all resources.
1678
1679 .TP
1680 .BR \-o ", " \-\-readonly
1681 mark array as readonly.
1682
1683 .TP
1684 .BR \-w ", " \-\-readwrite
1685 mark array as readwrite.
1686
1687 .TP
1688 .B \-\-zero\-superblock
1689 If the device contains a valid md superblock, the block is
1690 overwritten with zeros. With
1691 .B \-\-force
1692 the block where the superblock would be is overwritten even if it
1693 doesn't appear to be valid.
1694
1695 .TP
1696 .B \-\-kill\-subarray=
1697 If the device is a container and the argument to \-\-kill\-subarray
1698 specifies an inactive subarray in the container, then the subarray is
1699 deleted. Deleting all subarrays will leave an 'empty-container' or
1700 spare superblock on the drives. See
1701 .B \-\-zero\-superblock
1702 for completely
1703 removing a superblock. Note that some formats depend on the subarray
1704 index for generating a UUID, this command will fail if it would change
1705 the UUID of an active subarray.
1706
1707 .TP
1708 .B \-\-update\-subarray=
1709 If the device is a container and the argument to \-\-update\-subarray
1710 specifies a subarray in the container, then attempt to update the given
1711 superblock field in the subarray. See below in
1712 .B MISC MODE
1713 for details.
1714
1715 .TP
1716 .BR \-t ", " \-\-test
1717 When used with
1718 .BR \-\-detail ,
1719 the exit status of
1720 .I mdadm
1721 is set to reflect the status of the device. See below in
1722 .B MISC MODE
1723 for details.
1724
1725 .TP
1726 .BR \-W ", " \-\-wait
1727 For each md device given, wait for any resync, recovery, or reshape
1728 activity to finish before returning.
1729 .I mdadm
1730 will return with success if it actually waited for every device
1731 listed, otherwise it will return failure.
1732
1733 .TP
1734 .BR \-\-wait\-clean
1735 For each md device given, or each device in /proc/mdstat if
1736 .B \-\-scan
1737 is given, arrange for the array to be marked clean as soon as possible.
1738 .I mdadm
1739 will return with success if the array uses external metadata and we
1740 successfully waited. For native arrays this returns immediately as the
1741 kernel handles dirty-clean transitions at shutdown. No action is taken
1742 if safe-mode handling is disabled.
1743
1744 .TP
1745 .B \-\-action=
1746 Set the "sync_action" for all md devices given to one of
1747 .BR idle ,
1748 .BR frozen ,
1749 .BR check ,
1750 .BR repair .
1751 Setting to
1752 .B idle
1753 will abort any currently running action though some actions will
1754 automatically restart.
1755 Setting to
1756 .B frozen
1757 will abort any current action and ensure no other action starts
1758 automatically.
1759
1760 Details of
1761 .B check
1762 and
1763 .B repair
1764 can be found it
1765 .IR md (4)
1766 under
1767 .BR "SCRUBBING AND MISMATCHES" .
1768
1769 .SH For Incremental Assembly mode:
1770 .TP
1771 .BR \-\-rebuild\-map ", " \-r
1772 Rebuild the map file
1773 .RB ( {MAP_PATH} )
1774 that
1775 .I mdadm
1776 uses to help track which arrays are currently being assembled.
1777
1778 .TP
1779 .BR \-\-run ", " \-R
1780 Run any array assembled as soon as a minimal number of devices are
1781 available, rather than waiting until all expected devices are present.
1782
1783 .TP
1784 .BR \-\-scan ", " \-s
1785 Only meaningful with
1786 .B \-R
1787 this will scan the
1788 .B map
1789 file for arrays that are being incrementally assembled and will try to
1790 start any that are not already started. If any such array is listed
1791 in
1792 .B mdadm.conf
1793 as requiring an external bitmap, that bitmap will be attached first.
1794
1795 .TP
1796 .BR \-\-fail ", " \-f
1797 This allows the hot-plug system to remove devices that have fully disappeared
1798 from the kernel. It will first fail and then remove the device from any
1799 array it belongs to.
1800 The device name given should be a kernel device name such as "sda",
1801 not a name in
1802 .IR /dev .
1803
1804 .TP
1805 .BR \-\-path=
1806 Only used with \-\-fail. The 'path' given will be recorded so that if
1807 a new device appears at the same location it can be automatically
1808 added to the same array. This allows the failed device to be
1809 automatically replaced by a new device without metadata if it appears
1810 at specified path. This option is normally only set by a
1811 .I udev
1812 script.
1813
1814 .SH For Monitor mode:
1815 .TP
1816 .BR \-m ", " \-\-mail
1817 Give a mail address to send alerts to.
1818
1819 .TP
1820 .BR \-p ", " \-\-program ", " \-\-alert
1821 Give a program to be run whenever an event is detected.
1822
1823 .TP
1824 .BR \-y ", " \-\-syslog
1825 Cause all events to be reported through 'syslog'. The messages have
1826 facility of 'daemon' and varying priorities.
1827
1828 .TP
1829 .BR \-d ", " \-\-delay
1830 Give a delay in seconds.
1831 .I mdadm
1832 polls the md arrays and then waits this many seconds before polling
1833 again. The default is 60 seconds. Since 2.6.16, there is no need to
1834 reduce this as the kernel alerts
1835 .I mdadm
1836 immediately when there is any change.
1837
1838 .TP
1839 .BR \-r ", " \-\-increment
1840 Give a percentage increment.
1841 .I mdadm
1842 will generate RebuildNN events with the given percentage increment.
1843
1844 .TP
1845 .BR \-f ", " \-\-daemonise
1846 Tell
1847 .I mdadm
1848 to run as a background daemon if it decides to monitor anything. This
1849 causes it to fork and run in the child, and to disconnect from the
1850 terminal. The process id of the child is written to stdout.
1851 This is useful with
1852 .B \-\-scan
1853 which will only continue monitoring if a mail address or alert program
1854 is found in the config file.
1855
1856 .TP
1857 .BR \-i ", " \-\-pid\-file
1858 When
1859 .I mdadm
1860 is running in daemon mode, write the pid of the daemon process to
1861 the specified file, instead of printing it on standard output.
1862
1863 .TP
1864 .BR \-1 ", " \-\-oneshot
1865 Check arrays only once. This will generate
1866 .B NewArray
1867 events and more significantly
1868 .B DegradedArray
1869 and
1870 .B SparesMissing
1871 events. Running
1872 .in +5
1873 .B " mdadm \-\-monitor \-\-scan \-1"
1874 .in -5
1875 from a cron script will ensure regular notification of any degraded arrays.
1876
1877 .TP
1878 .BR \-t ", " \-\-test
1879 Generate a
1880 .B TestMessage
1881 alert for every array found at startup. This alert gets mailed and
1882 passed to the alert program. This can be used for testing that alert
1883 message do get through successfully.
1884
1885 .TP
1886 .BR \-\-no\-sharing
1887 This inhibits the functionality for moving spares between arrays.
1888 Only one monitoring process started with
1889 .B \-\-scan
1890 but without this flag is allowed, otherwise the two could interfere
1891 with each other.
1892
1893 .SH ASSEMBLE MODE
1894
1895 .HP 12
1896 Usage:
1897 .B mdadm \-\-assemble
1898 .I md-device options-and-component-devices...
1899 .HP 12
1900 Usage:
1901 .B mdadm \-\-assemble \-\-scan
1902 .I md-devices-and-options...
1903 .HP 12
1904 Usage:
1905 .B mdadm \-\-assemble \-\-scan
1906 .I options...
1907
1908 .PP
1909 This usage assembles one or more RAID arrays from pre-existing components.
1910 For each array, mdadm needs to know the md device, the identity of the
1911 array, and a number of component-devices. These can be found in a number of ways.
1912
1913 In the first usage example (without the
1914 .BR \-\-scan )
1915 the first device given is the md device.
1916 In the second usage example, all devices listed are treated as md
1917 devices and assembly is attempted.
1918 In the third (where no devices are listed) all md devices that are
1919 listed in the configuration file are assembled. If no arrays are
1920 described by the configuration file, then any arrays that
1921 can be found on unused devices will be assembled.
1922
1923 If precisely one device is listed, but
1924 .B \-\-scan
1925 is not given, then
1926 .I mdadm
1927 acts as though
1928 .B \-\-scan
1929 was given and identity information is extracted from the configuration file.
1930
1931 The identity can be given with the
1932 .B \-\-uuid
1933 option, the
1934 .B \-\-name
1935 option, or the
1936 .B \-\-super\-minor
1937 option, will be taken from the md-device record in the config file, or
1938 will be taken from the super block of the first component-device
1939 listed on the command line.
1940
1941 Devices can be given on the
1942 .B \-\-assemble
1943 command line or in the config file. Only devices which have an md
1944 superblock which contains the right identity will be considered for
1945 any array.
1946
1947 The config file is only used if explicitly named with
1948 .B \-\-config
1949 or requested with (a possibly implicit)
1950 .BR \-\-scan .
1951 In the later case,
1952 .B /etc/mdadm.conf
1953 or
1954 .B /etc/mdadm/mdadm.conf
1955 is used.
1956
1957 If
1958 .B \-\-scan
1959 is not given, then the config file will only be used to find the
1960 identity of md arrays.
1961
1962 Normally the array will be started after it is assembled. However if
1963 .B \-\-scan
1964 is not given and not all expected drives were listed, then the array
1965 is not started (to guard against usage errors). To insist that the
1966 array be started in this case (as may work for RAID1, 4, 5, 6, or 10),
1967 give the
1968 .B \-\-run
1969 flag.
1970
1971 If
1972 .I udev
1973 is active,
1974 .I mdadm
1975 does not create any entries in
1976 .B /dev
1977 but leaves that to
1978 .IR udev .
1979 It does record information in
1980 .B {MAP_PATH}
1981 which will allow
1982 .I udev
1983 to choose the correct name.
1984
1985 If
1986 .I mdadm
1987 detects that udev is not configured, it will create the devices in
1988 .B /dev
1989 itself.
1990
1991 In Linux kernels prior to version 2.6.28 there were two distinctly
1992 different types of md devices that could be created: one that could be
1993 partitioned using standard partitioning tools and one that could not.
1994 Since 2.6.28 that distinction is no longer relevant as both type of
1995 devices can be partitioned.
1996 .I mdadm
1997 will normally create the type that originally could not be partitioned
1998 as it has a well defined major number (9).
1999
2000 Prior to 2.6.28, it is important that mdadm chooses the correct type
2001 of array device to use. This can be controlled with the
2002 .B \-\-auto
2003 option. In particular, a value of "mdp" or "part" or "p" tells mdadm
2004 to use a partitionable device rather than the default.
2005
2006 In the no-udev case, the value given to
2007 .B \-\-auto
2008 can be suffixed by a number. This tells
2009 .I mdadm
2010 to create that number of partition devices rather than the default of 4.
2011
2012 The value given to
2013 .B \-\-auto
2014 can also be given in the configuration file as a word starting
2015 .B auto=
2016 on the ARRAY line for the relevant array.
2017
2018 .SS Auto Assembly
2019 When
2020 .B \-\-assemble
2021 is used with
2022 .B \-\-scan
2023 and no devices are listed,
2024 .I mdadm
2025 will first attempt to assemble all the arrays listed in the config
2026 file.
2027
2028 If no arrays are listed in the config (other than those marked
2029 .BR <ignore> )
2030 it will look through the available devices for possible arrays and
2031 will try to assemble anything that it finds. Arrays which are tagged
2032 as belonging to the given homehost will be assembled and started
2033 normally. Arrays which do not obviously belong to this host are given
2034 names that are expected not to conflict with anything local, and are
2035 started "read-auto" so that nothing is written to any device until the
2036 array is written to. i.e. automatic resync etc is delayed.
2037
2038 If
2039 .I mdadm
2040 finds a consistent set of devices that look like they should comprise
2041 an array, and if the superblock is tagged as belonging to the given
2042 home host, it will automatically choose a device name and try to
2043 assemble the array. If the array uses version-0.90 metadata, then the
2044 .B minor
2045 number as recorded in the superblock is used to create a name in
2046 .B /dev/md/
2047 so for example
2048 .BR /dev/md/3 .
2049 If the array uses version-1 metadata, then the
2050 .B name
2051 from the superblock is used to similarly create a name in
2052 .B /dev/md/
2053 (the name will have any 'host' prefix stripped first).
2054
2055 This behaviour can be modified by the
2056 .I AUTO
2057 line in the
2058 .I mdadm.conf
2059 configuration file. This line can indicate that specific metadata
2060 type should, or should not, be automatically assembled. If an array
2061 is found which is not listed in
2062 .I mdadm.conf
2063 and has a metadata format that is denied by the
2064 .I AUTO
2065 line, then it will not be assembled.
2066 The
2067 .I AUTO
2068 line can also request that all arrays identified as being for this
2069 homehost should be assembled regardless of their metadata type.
2070 See
2071 .IR mdadm.conf (5)
2072 for further details.
2073
2074 Note: Auto assembly cannot be used for assembling and activating some
2075 arrays which are undergoing reshape. In particular as the
2076 .B backup\-file
2077 cannot be given, any reshape which requires a backup-file to continue
2078 cannot be started by auto assembly. An array which is growing to more
2079 devices and has passed the critical section can be assembled using
2080 auto-assembly.
2081
2082 .SH BUILD MODE
2083
2084 .HP 12
2085 Usage:
2086 .B mdadm \-\-build
2087 .I md-device
2088 .BI \-\-chunk= X
2089 .BI \-\-level= Y
2090 .BI \-\-raid\-devices= Z
2091 .I devices
2092
2093 .PP
2094 This usage is similar to
2095 .BR \-\-create .
2096 The difference is that it creates an array without a superblock. With
2097 these arrays there is no difference between initially creating the array and
2098 subsequently assembling the array, except that hopefully there is useful
2099 data there in the second case.
2100
2101 The level may raid0, linear, raid1, raid10, multipath, or faulty, or
2102 one of their synonyms. All devices must be listed and the array will
2103 be started once complete. It will often be appropriate to use
2104 .B \-\-assume\-clean
2105 with levels raid1 or raid10.
2106
2107 .SH CREATE MODE
2108
2109 .HP 12
2110 Usage:
2111 .B mdadm \-\-create
2112 .I md-device
2113 .BI \-\-chunk= X
2114 .BI \-\-level= Y
2115 .br
2116 .BI \-\-raid\-devices= Z
2117 .I devices
2118
2119 .PP
2120 This usage will initialise a new md array, associate some devices with
2121 it, and activate the array.
2122
2123 The named device will normally not exist when
2124 .I "mdadm \-\-create"
2125 is run, but will be created by
2126 .I udev
2127 once the array becomes active.
2128
2129 As devices are added, they are checked to see if they contain RAID
2130 superblocks or filesystems. They are also checked to see if the variance in
2131 device size exceeds 1%.
2132
2133 If any discrepancy is found, the array will not automatically be run, though
2134 the presence of a
2135 .B \-\-run
2136 can override this caution.
2137
2138 To create a "degraded" array in which some devices are missing, simply
2139 give the word "\fBmissing\fP"
2140 in place of a device name. This will cause
2141 .I mdadm
2142 to leave the corresponding slot in the array empty.
2143 For a RAID4 or RAID5 array at most one slot can be
2144 "\fBmissing\fP"; for a RAID6 array at most two slots.
2145 For a RAID1 array, only one real device needs to be given. All of the
2146 others can be
2147 "\fBmissing\fP".
2148
2149 When creating a RAID5 array,
2150 .I mdadm
2151 will automatically create a degraded array with an extra spare drive.
2152 This is because building the spare into a degraded array is in general
2153 faster than resyncing the parity on a non-degraded, but not clean,
2154 array. This feature can be overridden with the
2155 .B \-\-force
2156 option.
2157
2158 When creating an array with version-1 metadata a name for the array is
2159 required.
2160 If this is not given with the
2161 .B \-\-name
2162 option,
2163 .I mdadm
2164 will choose a name based on the last component of the name of the
2165 device being created. So if
2166 .B /dev/md3
2167 is being created, then the name
2168 .B 3
2169 will be chosen.
2170 If
2171 .B /dev/md/home
2172 is being created, then the name
2173 .B home
2174 will be used.
2175
2176 When creating a partition based array, using
2177 .I mdadm
2178 with version-1.x metadata, the partition type should be set to
2179 .B 0xDA
2180 (non fs-data). This type selection allows for greater precision since
2181 using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)],
2182 might create problems in the event of array recovery through a live cdrom.
2183
2184 A new array will normally get a randomly assigned 128bit UUID which is
2185 very likely to be unique. If you have a specific need, you can choose
2186 a UUID for the array by giving the
2187 .B \-\-uuid=
2188 option. Be warned that creating two arrays with the same UUID is a
2189 recipe for disaster. Also, using
2190 .B \-\-uuid=
2191 when creating a v0.90 array will silently override any
2192 .B \-\-homehost=
2193 setting.
2194 .\"If the
2195 .\".B \-\-size
2196 .\"option is given, it is not necessary to list any component-devices in this command.
2197 .\"They can be added later, before a
2198 .\".B \-\-run.
2199 .\"If no
2200 .\".B \-\-size
2201 .\"is given, the apparent size of the smallest drive given is used.
2202
2203 If the array type supports a write-intent bitmap, and if the devices
2204 in the array exceed 100G is size, an internal write-intent bitmap
2205 will automatically be added unless some other option is explicitly
2206 requested with the
2207 .B \-\-bitmap
2208 option or a different consistency policy is selected with the
2209 .B \-\-consistency\-policy
2210 option. In any case space for a bitmap will be reserved so that one
2211 can be added later with
2212 .BR "\-\-grow \-\-bitmap=internal" .
2213
2214 If the metadata type supports it (currently only 1.x metadata), space
2215 will be allocated to store a bad block list. This allows a modest
2216 number of bad blocks to be recorded, allowing the drive to remain in
2217 service while only partially functional.
2218
2219 When creating an array within a
2220 .B CONTAINER
2221 .I mdadm
2222 can be given either the list of devices to use, or simply the name of
2223 the container. The former case gives control over which devices in
2224 the container will be used for the array. The latter case allows
2225 .I mdadm
2226 to automatically choose which devices to use based on how much spare
2227 space is available.
2228
2229 The General Management options that are valid with
2230 .B \-\-create
2231 are:
2232 .TP
2233 .B \-\-run
2234 insist on running the array even if some devices look like they might
2235 be in use.
2236
2237 .TP
2238 .B \-\-readonly
2239 start the array in readonly mode.
2240
2241 .SH MANAGE MODE
2242 .HP 12
2243 Usage:
2244 .B mdadm
2245 .I device
2246 .I options... devices...
2247 .PP
2248
2249 This usage will allow individual devices in an array to be failed,
2250 removed or added. It is possible to perform multiple operations with
2251 on command. For example:
2252 .br
2253 .B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1"
2254 .br
2255 will firstly mark
2256 .B /dev/hda1
2257 as faulty in
2258 .B /dev/md0
2259 and will then remove it from the array and finally add it back
2260 in as a spare. However only one md array can be affected by a single
2261 command.
2262
2263 When a device is added to an active array, mdadm checks to see if it
2264 has metadata on it which suggests that it was recently a member of the
2265 array. If it does, it tries to "re\-add" the device. If there have
2266 been no changes since the device was removed, or if the array has a
2267 write-intent bitmap which has recorded whatever changes there were,
2268 then the device will immediately become a full member of the array and
2269 those differences recorded in the bitmap will be resolved.
2270
2271 .SH MISC MODE
2272 .HP 12
2273 Usage:
2274 .B mdadm
2275 .I options ...
2276 .I devices ...
2277 .PP
2278
2279 MISC mode includes a number of distinct operations that
2280 operate on distinct devices. The operations are:
2281 .TP
2282 .B \-\-query
2283 The device is examined to see if it is
2284 (1) an active md array, or
2285 (2) a component of an md array.
2286 The information discovered is reported.
2287
2288 .TP
2289 .B \-\-detail
2290 The device should be an active md device.
2291 .B mdadm
2292 will display a detailed description of the array.
2293 .B \-\-brief
2294 or
2295 .B \-\-scan
2296 will cause the output to be less detailed and the format to be
2297 suitable for inclusion in
2298 .BR mdadm.conf .
2299 The exit status of
2300 .I mdadm
2301 will normally be 0 unless
2302 .I mdadm
2303 failed to get useful information about the device(s); however, if the
2304 .B \-\-test
2305 option is given, then the exit status will be:
2306 .RS
2307 .TP
2308 0
2309 The array is functioning normally.
2310 .TP
2311 1
2312 The array has at least one failed device.
2313 .TP
2314 2
2315 The array has multiple failed devices such that it is unusable.
2316 .TP
2317 4
2318 There was an error while trying to get information about the device.
2319 .RE
2320
2321 .TP
2322 .B \-\-detail\-platform
2323 Print detail of the platform's RAID capabilities (firmware / hardware
2324 topology). If the metadata is specified with
2325 .B \-e
2326 or
2327 .B \-\-metadata=
2328 then the return status will be:
2329 .RS
2330 .TP
2331 0
2332 metadata successfully enumerated its platform components on this system
2333 .TP
2334 1
2335 metadata is platform independent
2336 .TP
2337 2
2338 metadata failed to find its platform components on this system
2339 .RE
2340
2341 .TP
2342 .B \-\-update\-subarray=
2343 If the device is a container and the argument to \-\-update\-subarray
2344 specifies a subarray in the container, then attempt to update the given
2345 superblock field in the subarray. Similar to updating an array in
2346 "assemble" mode, the field to update is selected by
2347 .B \-U
2348 or
2349 .B \-\-update=
2350 option. The supported options are
2351 .BR name ,
2352 .B ppl
2353 and
2354 .BR no\-ppl .
2355
2356 The
2357 .B name
2358 option updates the subarray name in the metadata, it may not affect the
2359 device node name or the device node symlink until the subarray is
2360 re\-assembled. If updating
2361 .B name
2362 would change the UUID of an active subarray this operation is blocked,
2363 and the command will end in an error.
2364
2365 The
2366 .B ppl
2367 and
2368 .B no\-ppl
2369 options enable and disable PPL in the metadata. Currently supported only for
2370 IMSM subarrays.
2371
2372 .TP
2373 .B \-\-examine
2374 The device should be a component of an md array.
2375 .I mdadm
2376 will read the md superblock of the device and display the contents.
2377 If
2378 .B \-\-brief
2379 or
2380 .B \-\-scan
2381 is given, then multiple devices that are components of the one array
2382 are grouped together and reported in a single entry suitable
2383 for inclusion in
2384 .BR mdadm.conf .
2385
2386 Having
2387 .B \-\-scan
2388 without listing any devices will cause all devices listed in the
2389 config file to be examined.
2390
2391 .TP
2392 .BI \-\-dump= directory
2393 If the device contains RAID metadata, a file will be created in the
2394 .I directory
2395 and the metadata will be written to it. The file will be the same
2396 size as the device and have the metadata written in the file at the
2397 same locate that it exists in the device. However the file will be "sparse" so
2398 that only those blocks containing metadata will be allocated. The
2399 total space used will be small.
2400
2401 The file name used in the
2402 .I directory
2403 will be the base name of the device. Further if any links appear in
2404 .I /dev/disk/by-id
2405 which point to the device, then hard links to the file will be created
2406 in
2407 .I directory
2408 based on these
2409 .I by-id
2410 names.
2411
2412 Multiple devices can be listed and their metadata will all be stored
2413 in the one directory.
2414
2415 .TP
2416 .BI \-\-restore= directory
2417 This is the reverse of
2418 .BR \-\-dump .
2419 .I mdadm
2420 will locate a file in the directory that has a name appropriate for
2421 the given device and will restore metadata from it. Names that match
2422 .I /dev/disk/by-id
2423 names are preferred, however if two of those refer to different files,
2424 .I mdadm
2425 will not choose between them but will abort the operation.
2426
2427 If a file name is given instead of a
2428 .I directory
2429 then
2430 .I mdadm
2431 will restore from that file to a single device, always provided the
2432 size of the file matches that of the device, and the file contains
2433 valid metadata.
2434 .TP
2435 .B \-\-stop
2436 The devices should be active md arrays which will be deactivated, as
2437 long as they are not currently in use.
2438
2439 .TP
2440 .B \-\-run
2441 This will fully activate a partially assembled md array.
2442
2443 .TP
2444 .B \-\-readonly
2445 This will mark an active array as read-only, providing that it is
2446 not currently being used.
2447
2448 .TP
2449 .B \-\-readwrite
2450 This will change a
2451 .B readonly
2452 array back to being read/write.
2453
2454 .TP
2455 .B \-\-scan
2456 For all operations except
2457 .BR \-\-examine ,
2458 .B \-\-scan
2459 will cause the operation to be applied to all arrays listed in
2460 .BR /proc/mdstat .
2461 For
2462 .BR \-\-examine,
2463 .B \-\-scan
2464 causes all devices listed in the config file to be examined.
2465
2466 .TP
2467 .BR \-b ", " \-\-brief
2468 Be less verbose. This is used with
2469 .B \-\-detail
2470 and
2471 .BR \-\-examine .
2472 Using
2473 .B \-\-brief
2474 with
2475 .B \-\-verbose
2476 gives an intermediate level of verbosity.
2477
2478 .SH MONITOR MODE
2479
2480 .HP 12
2481 Usage:
2482 .B mdadm \-\-monitor
2483 .I options... devices...
2484
2485 .PP
2486 This usage causes
2487 .I mdadm
2488 to periodically poll a number of md arrays and to report on any events
2489 noticed.
2490 .I mdadm
2491 will never exit once it decides that there are arrays to be checked,
2492 so it should normally be run in the background.
2493
2494 As well as reporting events,
2495 .I mdadm
2496 may move a spare drive from one array to another if they are in the
2497 same
2498 .B spare-group
2499 or
2500 .B domain
2501 and if the destination array has a failed drive but no spares.
2502
2503 If any devices are listed on the command line,
2504 .I mdadm
2505 will only monitor those devices. Otherwise all arrays listed in the
2506 configuration file will be monitored. Further, if
2507 .B \-\-scan
2508 is given, then any other md devices that appear in
2509 .B /proc/mdstat
2510 will also be monitored.
2511
2512 The result of monitoring the arrays is the generation of events.
2513 These events are passed to a separate program (if specified) and may
2514 be mailed to a given E-mail address.
2515
2516 When passing events to a program, the program is run once for each event,
2517 and is given 2 or 3 command-line arguments: the first is the
2518 name of the event (see below), the second is the name of the
2519 md device which is affected, and the third is the name of a related
2520 device if relevant (such as a component device that has failed).
2521
2522 If
2523 .B \-\-scan
2524 is given, then a program or an E-mail address must be specified on the
2525 command line or in the config file. If neither are available, then
2526 .I mdadm
2527 will not monitor anything.
2528 Without
2529 .B \-\-scan,
2530 .I mdadm
2531 will continue monitoring as long as something was found to monitor. If
2532 no program or email is given, then each event is reported to
2533 .BR stdout .
2534
2535 The different events are:
2536
2537 .RS 4
2538 .TP
2539 .B DeviceDisappeared
2540 An md array which previously was configured appears to no longer be
2541 configured. (syslog priority: Critical)
2542
2543 If
2544 .I mdadm
2545 was told to monitor an array which is RAID0 or Linear, then it will
2546 report
2547 .B DeviceDisappeared
2548 with the extra information
2549 .BR Wrong-Level .
2550 This is because RAID0 and Linear do not support the device-failed,
2551 hot-spare and resync operations which are monitored.
2552
2553 .TP
2554 .B RebuildStarted
2555 An md array started reconstruction (e.g. recovery, resync, reshape,
2556 check, repair). (syslog priority: Warning)
2557
2558 .TP
2559 .BI Rebuild NN
2560 Where
2561 .I NN
2562 is a two-digit number (ie. 05, 48). This indicates that rebuild
2563 has passed that many percent of the total. The events are generated
2564 with fixed increment since 0. Increment size may be specified with
2565 a commandline option (default is 20). (syslog priority: Warning)
2566
2567 .TP
2568 .B RebuildFinished
2569 An md array that was rebuilding, isn't any more, either because it
2570 finished normally or was aborted. (syslog priority: Warning)
2571
2572 .TP
2573 .B Fail
2574 An active component device of an array has been marked as
2575 faulty. (syslog priority: Critical)
2576
2577 .TP
2578 .B FailSpare
2579 A spare component device which was being rebuilt to replace a faulty
2580 device has failed. (syslog priority: Critical)
2581
2582 .TP
2583 .B SpareActive
2584 A spare component device which was being rebuilt to replace a faulty
2585 device has been successfully rebuilt and has been made active.
2586 (syslog priority: Info)
2587
2588 .TP
2589 .B NewArray
2590 A new md array has been detected in the
2591 .B /proc/mdstat
2592 file. (syslog priority: Info)
2593
2594 .TP
2595 .B DegradedArray
2596 A newly noticed array appears to be degraded. This message is not
2597 generated when
2598 .I mdadm
2599 notices a drive failure which causes degradation, but only when
2600 .I mdadm
2601 notices that an array is degraded when it first sees the array.
2602 (syslog priority: Critical)
2603
2604 .TP
2605 .B MoveSpare
2606 A spare drive has been moved from one array in a
2607 .B spare-group
2608 or
2609 .B domain
2610 to another to allow a failed drive to be replaced.
2611 (syslog priority: Info)
2612
2613 .TP
2614 .B SparesMissing
2615 If
2616 .I mdadm
2617 has been told, via the config file, that an array should have a certain
2618 number of spare devices, and
2619 .I mdadm
2620 detects that it has fewer than this number when it first sees the
2621 array, it will report a
2622 .B SparesMissing
2623 message.
2624 (syslog priority: Warning)
2625
2626 .TP
2627 .B TestMessage
2628 An array was found at startup, and the
2629 .B \-\-test
2630 flag was given.
2631 (syslog priority: Info)
2632 .RE
2633
2634 Only
2635 .B Fail,
2636 .B FailSpare,
2637 .B DegradedArray,
2638 .B SparesMissing
2639 and
2640 .B TestMessage
2641 cause Email to be sent. All events cause the program to be run.
2642 The program is run with two or three arguments: the event
2643 name, the array device and possibly a second device.
2644
2645 Each event has an associated array device (e.g.
2646 .BR /dev/md1 )
2647 and possibly a second device. For
2648 .BR Fail ,
2649 .BR FailSpare ,
2650 and
2651 .B SpareActive
2652 the second device is the relevant component device.
2653 For
2654 .B MoveSpare
2655 the second device is the array that the spare was moved from.
2656
2657 For
2658 .I mdadm
2659 to move spares from one array to another, the different arrays need to
2660 be labeled with the same
2661 .B spare-group
2662 or the spares must be allowed to migrate through matching POLICY domains
2663 in the configuration file. The
2664 .B spare-group
2665 name can be any string; it is only necessary that different spare
2666 groups use different names.
2667
2668 When
2669 .I mdadm
2670 detects that an array in a spare group has fewer active
2671 devices than necessary for the complete array, and has no spare
2672 devices, it will look for another array in the same spare group that
2673 has a full complement of working drive and a spare. It will then
2674 attempt to remove the spare from the second drive and add it to the
2675 first.
2676 If the removal succeeds but the adding fails, then it is added back to
2677 the original array.
2678
2679 If the spare group for a degraded array is not defined,
2680 .I mdadm
2681 will look at the rules of spare migration specified by POLICY lines in
2682 .B mdadm.conf
2683 and then follow similar steps as above if a matching spare is found.
2684
2685 .SH GROW MODE
2686 The GROW mode is used for changing the size or shape of an active
2687 array.
2688 For this to work, the kernel must support the necessary change.
2689 Various types of growth are being added during 2.6 development.
2690
2691 Currently the supported changes include
2692 .IP \(bu 4
2693 change the "size" attribute for RAID1, RAID4, RAID5 and RAID6.
2694 .IP \(bu 4
2695 increase or decrease the "raid\-devices" attribute of RAID0, RAID1, RAID4,
2696 RAID5, and RAID6.
2697 .IP \(bu 4
2698 change the chunk-size and layout of RAID0, RAID4, RAID5, RAID6 and RAID10.
2699 .IP \(bu 4
2700 convert between RAID1 and RAID5, between RAID5 and RAID6, between
2701 RAID0, RAID4, and RAID5, and between RAID0 and RAID10 (in the near-2 mode).
2702 .IP \(bu 4
2703 add a write-intent bitmap to any array which supports these bitmaps, or
2704 remove a write-intent bitmap from such an array.
2705 .IP \(bu 4
2706 change the array's consistency policy.
2707 .PP
2708
2709 Using GROW on containers is currently supported only for Intel's IMSM
2710 container format. The number of devices in a container can be
2711 increased - which affects all arrays in the container - or an array
2712 in a container can be converted between levels where those levels are
2713 supported by the container, and the conversion is on of those listed
2714 above. Resizing arrays in an IMSM container with
2715 .B "--grow --size"
2716 is not yet supported.
2717
2718 Grow functionality (e.g. expand a number of raid devices) for Intel's
2719 IMSM container format has an experimental status. It is guarded by the
2720 .B MDADM_EXPERIMENTAL
2721 environment variable which must be set to '1' for a GROW command to
2722 succeed.
2723 This is for the following reasons:
2724
2725 .IP 1.
2726 Intel's native IMSM check-pointing is not fully tested yet.
2727 This can causes IMSM incompatibility during the grow process: an array
2728 which is growing cannot roam between Microsoft Windows(R) and Linux
2729 systems.
2730
2731 .IP 2.
2732 Interrupting a grow operation is not recommended, because it
2733 has not been fully tested for Intel's IMSM container format yet.
2734
2735 .PP
2736 Note: Intel's native checkpointing doesn't use
2737 .B --backup-file
2738 option and it is transparent for assembly feature.
2739
2740 .SS SIZE CHANGES
2741 Normally when an array is built the "size" is taken from the smallest
2742 of the drives. If all the small drives in an arrays are, one at a
2743 time, removed and replaced with larger drives, then you could have an
2744 array of large drives with only a small amount used. In this
2745 situation, changing the "size" with "GROW" mode will allow the extra
2746 space to start being used. If the size is increased in this way, a
2747 "resync" process will start to make sure the new parts of the array
2748 are synchronised.
2749
2750 Note that when an array changes size, any filesystem that may be
2751 stored in the array will not automatically grow or shrink to use or
2752 vacate the space. The
2753 filesystem will need to be explicitly told to use the extra space
2754 after growing, or to reduce its size
2755 .B prior
2756 to shrinking the array.
2757
2758 Also the size of an array cannot be changed while it has an active
2759 bitmap. If an array has a bitmap, it must be removed before the size
2760 can be changed. Once the change is complete a new bitmap can be created.
2761
2762 .SS RAID\-DEVICES CHANGES
2763
2764 A RAID1 array can work with any number of devices from 1 upwards
2765 (though 1 is not very useful). There may be times which you want to
2766 increase or decrease the number of active devices. Note that this is
2767 different to hot-add or hot-remove which changes the number of
2768 inactive devices.
2769
2770 When reducing the number of devices in a RAID1 array, the slots which
2771 are to be removed from the array must already be vacant. That is, the
2772 devices which were in those slots must be failed and removed.
2773
2774 When the number of devices is increased, any hot spares that are
2775 present will be activated immediately.
2776
2777 Changing the number of active devices in a RAID5 or RAID6 is much more
2778 effort. Every block in the array will need to be read and written
2779 back to a new location. From 2.6.17, the Linux Kernel is able to
2780 increase the number of devices in a RAID5 safely, including restarting
2781 an interrupted "reshape". From 2.6.31, the Linux Kernel is able to
2782 increase or decrease the number of devices in a RAID5 or RAID6.
2783
2784 From 2.6.35, the Linux Kernel is able to convert a RAID0 in to a RAID4
2785 or RAID5.
2786 .I mdadm
2787 uses this functionality and the ability to add
2788 devices to a RAID4 to allow devices to be added to a RAID0. When
2789 requested to do this,
2790 .I mdadm
2791 will convert the RAID0 to a RAID4, add the necessary disks and make
2792 the reshape happen, and then convert the RAID4 back to RAID0.
2793
2794 When decreasing the number of devices, the size of the array will also
2795 decrease. If there was data in the array, it could get destroyed and
2796 this is not reversible, so you should firstly shrink the filesystem on
2797 the array to fit within the new size. To help prevent accidents,
2798 .I mdadm
2799 requires that the size of the array be decreased first with
2800 .BR "mdadm --grow --array-size" .
2801 This is a reversible change which simply makes the end of the array
2802 inaccessible. The integrity of any data can then be checked before
2803 the non-reversible reduction in the number of devices is request.
2804
2805 When relocating the first few stripes on a RAID5 or RAID6, it is not
2806 possible to keep the data on disk completely consistent and
2807 crash-proof. To provide the required safety, mdadm disables writes to
2808 the array while this "critical section" is reshaped, and takes a
2809 backup of the data that is in that section. For grows, this backup may be
2810 stored in any spare devices that the array has, however it can also be
2811 stored in a separate file specified with the
2812 .B \-\-backup\-file
2813 option, and is required to be specified for shrinks, RAID level
2814 changes and layout changes. If this option is used, and the system
2815 does crash during the critical period, the same file must be passed to
2816 .B \-\-assemble
2817 to restore the backup and reassemble the array. When shrinking rather
2818 than growing the array, the reshape is done from the end towards the
2819 beginning, so the "critical section" is at the end of the reshape.
2820
2821 .SS LEVEL CHANGES
2822
2823 Changing the RAID level of any array happens instantaneously. However
2824 in the RAID5 to RAID6 case this requires a non-standard layout of the
2825 RAID6 data, and in the RAID6 to RAID5 case that non-standard layout is
2826 required before the change can be accomplished. So while the level
2827 change is instant, the accompanying layout change can take quite a
2828 long time. A
2829 .B \-\-backup\-file
2830 is required. If the array is not simultaneously being grown or
2831 shrunk, so that the array size will remain the same - for example,
2832 reshaping a 3-drive RAID5 into a 4-drive RAID6 - the backup file will
2833 be used not just for a "cricital section" but throughout the reshape
2834 operation, as described below under LAYOUT CHANGES.
2835
2836 .SS CHUNK-SIZE AND LAYOUT CHANGES
2837
2838 Changing the chunk-size of layout without also changing the number of
2839 devices as the same time will involve re-writing all blocks in-place.
2840 To ensure against data loss in the case of a crash, a
2841 .B --backup-file
2842 must be provided for these changes. Small sections of the array will
2843 be copied to the backup file while they are being rearranged. This
2844 means that all the data is copied twice, once to the backup and once
2845 to the new layout on the array, so this type of reshape will go very
2846 slowly.
2847
2848 If the reshape is interrupted for any reason, this backup file must be
2849 made available to
2850 .B "mdadm --assemble"
2851 so the array can be reassembled. Consequently the file cannot be
2852 stored on the device being reshaped.
2853
2854
2855 .SS BITMAP CHANGES
2856
2857 A write-intent bitmap can be added to, or removed from, an active
2858 array. Either internal bitmaps, or bitmaps stored in a separate file,
2859 can be added. Note that if you add a bitmap stored in a file which is
2860 in a filesystem that is on the RAID array being affected, the system
2861 will deadlock. The bitmap must be on a separate filesystem.
2862
2863 .SS CONSISTENCY POLICY CHANGES
2864
2865 The consistency policy of an active array can be changed by using the
2866 .B \-\-consistency\-policy
2867 option in Grow mode. Currently this works only for the
2868 .B ppl
2869 and
2870 .B resync
2871 policies and allows to enable or disable the RAID5 Partial Parity Log (PPL).
2872
2873 .SH INCREMENTAL MODE
2874
2875 .HP 12
2876 Usage:
2877 .B mdadm \-\-incremental
2878 .RB [ \-\-run ]
2879 .RB [ \-\-quiet ]
2880 .I component-device
2881 .RI [ optional-aliases-for-device ]
2882 .HP 12
2883 Usage:
2884 .B mdadm \-\-incremental \-\-fail
2885 .I component-device
2886 .HP 12
2887 Usage:
2888 .B mdadm \-\-incremental \-\-rebuild\-map
2889 .HP 12
2890 Usage:
2891 .B mdadm \-\-incremental \-\-run \-\-scan
2892
2893 .PP
2894 This mode is designed to be used in conjunction with a device
2895 discovery system. As devices are found in a system, they can be
2896 passed to
2897 .B "mdadm \-\-incremental"
2898 to be conditionally added to an appropriate array.
2899
2900 Conversely, it can also be used with the
2901 .B \-\-fail
2902 flag to do just the opposite and find whatever array a particular device
2903 is part of and remove the device from that array.
2904
2905 If the device passed is a
2906 .B CONTAINER
2907 device created by a previous call to
2908 .IR mdadm ,
2909 then rather than trying to add that device to an array, all the arrays
2910 described by the metadata of the container will be started.
2911
2912 .I mdadm
2913 performs a number of tests to determine if the device is part of an
2914 array, and which array it should be part of. If an appropriate array
2915 is found, or can be created,
2916 .I mdadm
2917 adds the device to the array and conditionally starts the array.
2918
2919 Note that
2920 .I mdadm
2921 will normally only add devices to an array which were previously working
2922 (active or spare) parts of that array. The support for automatic
2923 inclusion of a new drive as a spare in some array requires
2924 a configuration through POLICY in config file.
2925
2926 The tests that
2927 .I mdadm
2928 makes are as follow:
2929 .IP +
2930 Is the device permitted by
2931 .BR mdadm.conf ?
2932 That is, is it listed in a
2933 .B DEVICES
2934 line in that file. If
2935 .B DEVICES
2936 is absent then the default it to allow any device. Similarly if
2937 .B DEVICES
2938 contains the special word
2939 .B partitions
2940 then any device is allowed. Otherwise the device name given to
2941 .IR mdadm ,
2942 or one of the aliases given, or an alias found in the filesystem,
2943 must match one of the names or patterns in a
2944 .B DEVICES
2945 line.
2946
2947 This is the only context where the aliases are used. They are
2948 usually provided by a
2949 .I udev
2950 rules mentioning
2951 .BR ${DEVLINKS} .
2952
2953 .IP +
2954 Does the device have a valid md superblock? If a specific metadata
2955 version is requested with
2956 .B \-\-metadata
2957 or
2958 .B \-e
2959 then only that style of metadata is accepted, otherwise
2960 .I mdadm
2961 finds any known version of metadata. If no
2962 .I md
2963 metadata is found, the device may be still added to an array
2964 as a spare if POLICY allows.
2965
2966 .ig
2967 .IP +
2968 Does the metadata match an expected array?
2969 The metadata can match in two ways. Either there is an array listed
2970 in
2971 .B mdadm.conf
2972 which identifies the array (either by UUID, by name, by device list,
2973 or by minor-number), or the array was created with a
2974 .B homehost
2975 specified and that
2976 .B homehost
2977 matches the one in
2978 .B mdadm.conf
2979 or on the command line.
2980 If
2981 .I mdadm
2982 is not able to positively identify the array as belonging to the
2983 current host, the device will be rejected.
2984 ..
2985
2986 .PP
2987 .I mdadm
2988 keeps a list of arrays that it has partially assembled in
2989 .BR {MAP_PATH} .
2990 If no array exists which matches
2991 the metadata on the new device,
2992 .I mdadm
2993 must choose a device name and unit number. It does this based on any
2994 name given in
2995 .B mdadm.conf
2996 or any name information stored in the metadata. If this name
2997 suggests a unit number, that number will be used, otherwise a free
2998 unit number will be chosen. Normally
2999 .I mdadm
3000 will prefer to create a partitionable array, however if the
3001 .B CREATE
3002 line in
3003 .B mdadm.conf
3004 suggests that a non-partitionable array is preferred, that will be
3005 honoured.
3006
3007 If the array is not found in the config file and its metadata does not
3008 identify it as belonging to the "homehost", then
3009 .I mdadm
3010 will choose a name for the array which is certain not to conflict with
3011 any array which does belong to this host. It does this be adding an
3012 underscore and a small number to the name preferred by the metadata.
3013
3014 Once an appropriate array is found or created and the device is added,
3015 .I mdadm
3016 must decide if the array is ready to be started. It will
3017 normally compare the number of available (non-spare) devices to the
3018 number of devices that the metadata suggests need to be active. If
3019 there are at least that many, the array will be started. This means
3020 that if any devices are missing the array will not be restarted.
3021
3022 As an alternative,
3023 .B \-\-run
3024 may be passed to
3025 .I mdadm
3026 in which case the array will be run as soon as there are enough
3027 devices present for the data to be accessible. For a RAID1, that
3028 means one device will start the array. For a clean RAID5, the array
3029 will be started as soon as all but one drive is present.
3030
3031 Note that neither of these approaches is really ideal. If it can
3032 be known that all device discovery has completed, then
3033 .br
3034 .B " mdadm \-IRs"
3035 .br
3036 can be run which will try to start all arrays that are being
3037 incrementally assembled. They are started in "read-auto" mode in
3038 which they are read-only until the first write request. This means
3039 that no metadata updates are made and no attempt at resync or recovery
3040 happens. Further devices that are found before the first write can
3041 still be added safely.
3042
3043 .SH ENVIRONMENT
3044 This section describes environment variables that affect how mdadm
3045 operates.
3046
3047 .TP
3048 .B MDADM_NO_MDMON
3049 Setting this value to 1 will prevent mdadm from automatically launching
3050 mdmon. This variable is intended primarily for debugging mdadm/mdmon.
3051
3052 .TP
3053 .B MDADM_NO_UDEV
3054 Normally,
3055 .I mdadm
3056 does not create any device nodes in /dev, but leaves that task to
3057 .IR udev .
3058 If
3059 .I udev
3060 appears not to be configured, or if this environment variable is set
3061 to '1', the
3062 .I mdadm
3063 will create and devices that are needed.
3064
3065 .TP
3066 .B MDADM_NO_SYSTEMCTL
3067 If
3068 .I mdadm
3069 detects that
3070 .I systemd
3071 is in use it will normally request
3072 .I systemd
3073 to start various background tasks (particularly
3074 .IR mdmon )
3075 rather than forking and running them in the background. This can be
3076 suppressed by setting
3077 .BR MDADM_NO_SYSTEMCTL=1 .
3078
3079 .TP
3080 .B IMSM_NO_PLATFORM
3081 A key value of IMSM metadata is that it allows interoperability with
3082 boot ROMs on Intel platforms, and with other major operating systems.
3083 Consequently,
3084 .I mdadm
3085 will only allow an IMSM array to be created or modified if detects
3086 that it is running on an Intel platform which supports IMSM, and
3087 supports the particular configuration of IMSM that is being requested
3088 (some functionality requires newer OROM support).
3089
3090 These checks can be suppressed by setting IMSM_NO_PLATFORM=1 in the
3091 environment. This can be useful for testing or for disaster
3092 recovery. You should be aware that interoperability may be
3093 compromised by setting this value.
3094
3095 .TP
3096 .B MDADM_GROW_ALLOW_OLD
3097 If an array is stopped while it is performing a reshape and that
3098 reshape was making use of a backup file, then when the array is
3099 re-assembled
3100 .I mdadm
3101 will sometimes complain that the backup file is too old. If this
3102 happens and you are certain it is the right backup file, you can
3103 over-ride this check by setting
3104 .B MDADM_GROW_ALLOW_OLD=1
3105 in the environment.
3106
3107 .TP
3108 .B MDADM_CONF_AUTO
3109 Any string given in this variable is added to the start of the
3110 .B AUTO
3111 line in the config file, or treated as the whole
3112 .B AUTO
3113 line if none is given. It can be used to disable certain metadata
3114 types when
3115 .I mdadm
3116 is called from a boot script. For example
3117 .br
3118 .B " export MDADM_CONF_AUTO='-ddf -imsm'
3119 .br
3120 will make sure that
3121 .I mdadm
3122 does not automatically assemble any DDF or
3123 IMSM arrays that are found. This can be useful on systems configured
3124 to manage such arrays with
3125 .BR dmraid .
3126
3127
3128 .SH EXAMPLES
3129
3130 .B " mdadm \-\-query /dev/name-of-device"
3131 .br
3132 This will find out if a given device is a RAID array, or is part of
3133 one, and will provide brief information about the device.
3134
3135 .B " mdadm \-\-assemble \-\-scan"
3136 .br
3137 This will assemble and start all arrays listed in the standard config
3138 file. This command will typically go in a system startup file.
3139
3140 .B " mdadm \-\-stop \-\-scan"
3141 .br
3142 This will shut down all arrays that can be shut down (i.e. are not
3143 currently in use). This will typically go in a system shutdown script.
3144
3145 .B " mdadm \-\-follow \-\-scan \-\-delay=120"
3146 .br
3147 If (and only if) there is an Email address or program given in the
3148 standard config file, then
3149 monitor the status of all arrays listed in that file by
3150 polling them ever 2 minutes.
3151
3152 .B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1"
3153 .br
3154 Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.
3155
3156 .br
3157 .B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf"
3158 .br
3159 .B " mdadm \-\-detail \-\-scan >> mdadm.conf"
3160 .br
3161 This will create a prototype config file that describes currently
3162 active arrays that are known to be made from partitions of IDE or SCSI drives.
3163 This file should be reviewed before being used as it may
3164 contain unwanted detail.
3165
3166 .B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf"
3167 .br
3168 .B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf"
3169 .br
3170 This will find arrays which could be assembled from existing IDE and
3171 SCSI whole drives (not partitions), and store the information in the
3172 format of a config file.
3173 This file is very likely to contain unwanted detail, particularly
3174 the
3175 .B devices=
3176 entries. It should be reviewed and edited before being used as an
3177 actual config file.
3178
3179 .B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions"
3180 .br
3181 .B " mdadm \-Ebsc partitions"
3182 .br
3183 Create a list of devices by reading
3184 .BR /proc/partitions ,
3185 scan these for RAID superblocks, and printout a brief listing of all
3186 that were found.
3187
3188 .B " mdadm \-Ac partitions \-m 0 /dev/md0"
3189 .br
3190 Scan all partitions and devices listed in
3191 .BR /proc/partitions
3192 and assemble
3193 .B /dev/md0
3194 out of all such devices with a RAID superblock with a minor number of 0.
3195
3196 .B " mdadm \-\-monitor \-\-scan \-\-daemonise > /run/mdadm/mon.pid"
3197 .br
3198 If config file contains a mail address or alert program, run mdadm in
3199 the background in monitor mode monitoring all md devices. Also write
3200 pid of mdadm daemon to
3201 .BR /run/mdadm/mon.pid .
3202
3203 .B " mdadm \-Iq /dev/somedevice"
3204 .br
3205 Try to incorporate newly discovered device into some array as
3206 appropriate.
3207
3208 .B " mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan"
3209 .br
3210 Rebuild the array map from any current arrays, and then start any that
3211 can be started.
3212
3213 .B " mdadm /dev/md4 --fail detached --remove detached"
3214 .br
3215 Any devices which are components of /dev/md4 will be marked as faulty
3216 and then remove from the array.
3217
3218 .B " mdadm --grow /dev/md4 --level=6 --backup-file=/root/backup-md4"
3219 .br
3220 The array
3221 .B /dev/md4
3222 which is currently a RAID5 array will be converted to RAID6. There
3223 should normally already be a spare drive attached to the array as a
3224 RAID6 needs one more drive than a matching RAID5.
3225
3226 .B " mdadm --create /dev/md/ddf --metadata=ddf --raid-disks 6 /dev/sd[a-f]"
3227 .br
3228 Create a DDF array over 6 devices.
3229
3230 .B " mdadm --create /dev/md/home -n3 -l5 -z 30000000 /dev/md/ddf"
3231 .br
3232 Create a RAID5 array over any 3 devices in the given DDF set. Use
3233 only 30 gigabytes of each device.
3234
3235 .B " mdadm -A /dev/md/ddf1 /dev/sd[a-f]"
3236 .br
3237 Assemble a pre-exist ddf array.
3238
3239 .B " mdadm -I /dev/md/ddf1"
3240 .br
3241 Assemble all arrays contained in the ddf array, assigning names as
3242 appropriate.
3243
3244 .B " mdadm \-\-create \-\-help"
3245 .br
3246 Provide help about the Create mode.
3247
3248 .B " mdadm \-\-config \-\-help"
3249 .br
3250 Provide help about the format of the config file.
3251
3252 .B " mdadm \-\-help"
3253 .br
3254 Provide general help.
3255
3256 .SH FILES
3257
3258 .SS /proc/mdstat
3259
3260 If you're using the
3261 .B /proc
3262 filesystem,
3263 .B /proc/mdstat
3264 lists all active md devices with information about them.
3265 .I mdadm
3266 uses this to find arrays when
3267 .B \-\-scan
3268 is given in Misc mode, and to monitor array reconstruction
3269 on Monitor mode.
3270
3271 .SS /etc/mdadm.conf
3272
3273 The config file lists which devices may be scanned to see if
3274 they contain MD super block, and gives identifying information
3275 (e.g. UUID) about known MD arrays. See
3276 .BR mdadm.conf (5)
3277 for more details.
3278
3279 .SS /etc/mdadm.conf.d
3280
3281 A directory containing configuration files which are read in lexical
3282 order.
3283
3284 .SS {MAP_PATH}
3285 When
3286 .B \-\-incremental
3287 mode is used, this file gets a list of arrays currently being created.
3288
3289 .SH DEVICE NAMES
3290
3291 .I mdadm
3292 understand two sorts of names for array devices.
3293
3294 The first is the so-called 'standard' format name, which matches the
3295 names used by the kernel and which appear in
3296 .IR /proc/mdstat .
3297
3298 The second sort can be freely chosen, but must reside in
3299 .IR /dev/md/ .
3300 When giving a device name to
3301 .I mdadm
3302 to create or assemble an array, either full path name such as
3303 .I /dev/md0
3304 or
3305 .I /dev/md/home
3306 can be given, or just the suffix of the second sort of name, such as
3307 .I home
3308 can be given.
3309
3310 When
3311 .I mdadm
3312 chooses device names during auto-assembly or incremental assembly, it
3313 will sometimes add a small sequence number to the end of the name to
3314 avoid conflicted between multiple arrays that have the same name. If
3315 .I mdadm
3316 can reasonably determine that the array really is meant for this host,
3317 either by a hostname in the metadata, or by the presence of the array
3318 in
3319 .BR mdadm.conf ,
3320 then it will leave off the suffix if possible.
3321 Also if the homehost is specified as
3322 .B <ignore>
3323 .I mdadm
3324 will only use a suffix if a different array of the same name already
3325 exists or is listed in the config file.
3326
3327 The standard names for non-partitioned arrays (the only sort of md
3328 array available in 2.4 and earlier) are of the form
3329 .IP
3330 .RB /dev/md NN
3331 .PP
3332 where NN is a number.
3333 The standard names for partitionable arrays (as available from 2.6
3334 onwards) are of the form:
3335 .IP
3336 .RB /dev/md_d NN
3337 .PP
3338 Partition numbers should be indicated by adding "pMM" to these, thus "/dev/md/d1p2".
3339 .PP
3340 From kernel version 2.6.28 the "non-partitioned array" can actually
3341 be partitioned. So the "md_d\fBNN\fP"
3342 names are no longer needed, and
3343 partitions such as "/dev/md\fBNN\fPp\fBXX\fP"
3344 are possible.
3345 .PP
3346 From kernel version 2.6.29 standard names can be non-numeric following
3347 the form:
3348 .IP
3349 .RB /dev/md_ XXX
3350 .PP
3351 where
3352 .B XXX
3353 is any string. These names are supported by
3354 .I mdadm
3355 since version 3.3 provided they are enabled in
3356 .IR mdadm.conf .
3357
3358 .SH NOTE
3359 .I mdadm
3360 was previously known as
3361 .IR mdctl .
3362
3363 .SH SEE ALSO
3364 For further information on mdadm usage, MD and the various levels of
3365 RAID, see:
3366 .IP
3367 .B http://raid.wiki.kernel.org/
3368 .PP
3369 (based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO)
3370 .PP
3371 The latest version of
3372 .I mdadm
3373 should always be available from
3374 .IP
3375 .B http://www.kernel.org/pub/linux/utils/raid/mdadm/
3376 .PP
3377 Related man pages:
3378 .PP
3379 .IR mdmon (8),
3380 .IR mdadm.conf (5),
3381 .IR md (4).