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