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