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