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