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