]> git.ipfire.org Git - thirdparty/mdadm.git/blob - mdadm.8.in
Incremental: add --export handling.
[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
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 .SH For Incremental Assembly mode:
1592 .TP
1593 .BR \-\-rebuild\-map ", " \-r
1594 Rebuild the map file
1595 .RB ( {MAP_PATH} )
1596 that
1597 .I mdadm
1598 uses to help track which arrays are currently being assembled.
1599
1600 .TP
1601 .BR \-\-run ", " \-R
1602 Run any array assembled as soon as a minimal number of devices are
1603 available, rather than waiting until all expected devices are present.
1604
1605 .TP
1606 .BR \-\-scan ", " \-s
1607 Only meaningful with
1608 .B \-R
1609 this will scan the
1610 .B map
1611 file for arrays that are being incrementally assembled and will try to
1612 start any that are not already started. If any such array is listed
1613 in
1614 .B mdadm.conf
1615 as requiring an external bitmap, that bitmap will be attached first.
1616
1617 .TP
1618 .BR \-\-fail ", " \-f
1619 This allows the hot-plug system to remove devices that have fully disappeared
1620 from the kernel. It will first fail and then remove the device from any
1621 array it belongs to.
1622 The device name given should be a kernel device name such as "sda",
1623 not a name in
1624 .IR /dev .
1625
1626 .TP
1627 .BR \-\-path=
1628 Only used with \-\-fail. The 'path' given will be recorded so that if
1629 a new device appears at the same location it can be automatically
1630 added to the same array. This allows the failed device to be
1631 automatically replaced by a new device without metadata if it appears
1632 at specified path. This option is normally only set by a
1633 .I udev
1634 script.
1635
1636 .SH For Monitor mode:
1637 .TP
1638 .BR \-m ", " \-\-mail
1639 Give a mail address to send alerts to.
1640
1641 .TP
1642 .BR \-p ", " \-\-program ", " \-\-alert
1643 Give a program to be run whenever an event is detected.
1644
1645 .TP
1646 .BR \-y ", " \-\-syslog
1647 Cause all events to be reported through 'syslog'. The messages have
1648 facility of 'daemon' and varying priorities.
1649
1650 .TP
1651 .BR \-d ", " \-\-delay
1652 Give a delay in seconds.
1653 .I mdadm
1654 polls the md arrays and then waits this many seconds before polling
1655 again. The default is 60 seconds. Since 2.6.16, there is no need to
1656 reduce this as the kernel alerts
1657 .I mdadm
1658 immediately when there is any change.
1659
1660 .TP
1661 .BR \-r ", " \-\-increment
1662 Give a percentage increment.
1663 .I mdadm
1664 will generate RebuildNN events with the given percentage increment.
1665
1666 .TP
1667 .BR \-f ", " \-\-daemonise
1668 Tell
1669 .I mdadm
1670 to run as a background daemon if it decides to monitor anything. This
1671 causes it to fork and run in the child, and to disconnect from the
1672 terminal. The process id of the child is written to stdout.
1673 This is useful with
1674 .B \-\-scan
1675 which will only continue monitoring if a mail address or alert program
1676 is found in the config file.
1677
1678 .TP
1679 .BR \-i ", " \-\-pid\-file
1680 When
1681 .I mdadm
1682 is running in daemon mode, write the pid of the daemon process to
1683 the specified file, instead of printing it on standard output.
1684
1685 .TP
1686 .BR \-1 ", " \-\-oneshot
1687 Check arrays only once. This will generate
1688 .B NewArray
1689 events and more significantly
1690 .B DegradedArray
1691 and
1692 .B SparesMissing
1693 events. Running
1694 .in +5
1695 .B " mdadm \-\-monitor \-\-scan \-1"
1696 .in -5
1697 from a cron script will ensure regular notification of any degraded arrays.
1698
1699 .TP
1700 .BR \-t ", " \-\-test
1701 Generate a
1702 .B TestMessage
1703 alert for every array found at startup. This alert gets mailed and
1704 passed to the alert program. This can be used for testing that alert
1705 message do get through successfully.
1706
1707 .TP
1708 .BR \-\-no\-sharing
1709 This inhibits the functionality for moving spares between arrays.
1710 Only one monitoring process started with
1711 .B \-\-scan
1712 but without this flag is allowed, otherwise the two could interfere
1713 with each other.
1714
1715 .SH ASSEMBLE MODE
1716
1717 .HP 12
1718 Usage:
1719 .B mdadm \-\-assemble
1720 .I md-device options-and-component-devices...
1721 .HP 12
1722 Usage:
1723 .B mdadm \-\-assemble \-\-scan
1724 .I md-devices-and-options...
1725 .HP 12
1726 Usage:
1727 .B mdadm \-\-assemble \-\-scan
1728 .I options...
1729
1730 .PP
1731 This usage assembles one or more RAID arrays from pre-existing components.
1732 For each array, mdadm needs to know the md device, the identity of the
1733 array, and a number of component-devices. These can be found in a number of ways.
1734
1735 In the first usage example (without the
1736 .BR \-\-scan )
1737 the first device given is the md device.
1738 In the second usage example, all devices listed are treated as md
1739 devices and assembly is attempted.
1740 In the third (where no devices are listed) all md devices that are
1741 listed in the configuration file are assembled. If no arrays are
1742 described by the configuration file, then any arrays that
1743 can be found on unused devices will be assembled.
1744
1745 If precisely one device is listed, but
1746 .B \-\-scan
1747 is not given, then
1748 .I mdadm
1749 acts as though
1750 .B \-\-scan
1751 was given and identity information is extracted from the configuration file.
1752
1753 The identity can be given with the
1754 .B \-\-uuid
1755 option, the
1756 .B \-\-name
1757 option, or the
1758 .B \-\-super\-minor
1759 option, will be taken from the md-device record in the config file, or
1760 will be taken from the super block of the first component-device
1761 listed on the command line.
1762
1763 Devices can be given on the
1764 .B \-\-assemble
1765 command line or in the config file. Only devices which have an md
1766 superblock which contains the right identity will be considered for
1767 any array.
1768
1769 The config file is only used if explicitly named with
1770 .B \-\-config
1771 or requested with (a possibly implicit)
1772 .BR \-\-scan .
1773 In the later case,
1774 .B /etc/mdadm.conf
1775 or
1776 .B /etc/mdadm/mdadm.conf
1777 is used.
1778
1779 If
1780 .B \-\-scan
1781 is not given, then the config file will only be used to find the
1782 identity of md arrays.
1783
1784 Normally the array will be started after it is assembled. However if
1785 .B \-\-scan
1786 is not given and not all expected drives were listed, then the array
1787 is not started (to guard against usage errors). To insist that the
1788 array be started in this case (as may work for RAID1, 4, 5, 6, or 10),
1789 give the
1790 .B \-\-run
1791 flag.
1792
1793 If
1794 .I udev
1795 is active,
1796 .I mdadm
1797 does not create any entries in
1798 .B /dev
1799 but leaves that to
1800 .IR udev .
1801 It does record information in
1802 .B {MAP_PATH}
1803 which will allow
1804 .I udev
1805 to choose the correct name.
1806
1807 If
1808 .I mdadm
1809 detects that udev is not configured, it will create the devices in
1810 .B /dev
1811 itself.
1812
1813 In Linux kernels prior to version 2.6.28 there were two distinctly
1814 different types of md devices that could be created: one that could be
1815 partitioned using standard partitioning tools and one that could not.
1816 Since 2.6.28 that distinction is no longer relevant as both type of
1817 devices can be partitioned.
1818 .I mdadm
1819 will normally create the type that originally could not be partitioned
1820 as it has a well defined major number (9).
1821
1822 Prior to 2.6.28, it is important that mdadm chooses the correct type
1823 of array device to use. This can be controlled with the
1824 .B \-\-auto
1825 option. In particular, a value of "mdp" or "part" or "p" tells mdadm
1826 to use a partitionable device rather than the default.
1827
1828 In the no-udev case, the value given to
1829 .B \-\-auto
1830 can be suffixed by a number. This tells
1831 .I mdadm
1832 to create that number of partition devices rather than the default of 4.
1833
1834 The value given to
1835 .B \-\-auto
1836 can also be given in the configuration file as a word starting
1837 .B auto=
1838 on the ARRAY line for the relevant array.
1839
1840 .SS Auto Assembly
1841 When
1842 .B \-\-assemble
1843 is used with
1844 .B \-\-scan
1845 and no devices are listed,
1846 .I mdadm
1847 will first attempt to assemble all the arrays listed in the config
1848 file.
1849
1850 If no arrays are listed in the config (other than those marked
1851 .BR <ignore> )
1852 it will look through the available devices for possible arrays and
1853 will try to assemble anything that it finds. Arrays which are tagged
1854 as belonging to the given homehost will be assembled and started
1855 normally. Arrays which do not obviously belong to this host are given
1856 names that are expected not to conflict with anything local, and are
1857 started "read-auto" so that nothing is written to any device until the
1858 array is written to. i.e. automatic resync etc is delayed.
1859
1860 If
1861 .I mdadm
1862 finds a consistent set of devices that look like they should comprise
1863 an array, and if the superblock is tagged as belonging to the given
1864 home host, it will automatically choose a device name and try to
1865 assemble the array. If the array uses version-0.90 metadata, then the
1866 .B minor
1867 number as recorded in the superblock is used to create a name in
1868 .B /dev/md/
1869 so for example
1870 .BR /dev/md/3 .
1871 If the array uses version-1 metadata, then the
1872 .B name
1873 from the superblock is used to similarly create a name in
1874 .B /dev/md/
1875 (the name will have any 'host' prefix stripped first).
1876
1877 This behaviour can be modified by the
1878 .I AUTO
1879 line in the
1880 .I mdadm.conf
1881 configuration file. This line can indicate that specific metadata
1882 type should, or should not, be automatically assembled. If an array
1883 is found which is not listed in
1884 .I mdadm.conf
1885 and has a metadata format that is denied by the
1886 .I AUTO
1887 line, then it will not be assembled.
1888 The
1889 .I AUTO
1890 line can also request that all arrays identified as being for this
1891 homehost should be assembled regardless of their metadata type.
1892 See
1893 .IR mdadm.conf (5)
1894 for further details.
1895
1896 Note: Auto assembly cannot be used for assembling and activating some
1897 arrays which are undergoing reshape. In particular as the
1898 .B backup\-file
1899 cannot be given, any reshape which requires a backup-file to continue
1900 cannot be started by auto assembly. An array which is growing to more
1901 devices and has passed the critical section can be assembled using
1902 auto-assembly.
1903
1904 .SH BUILD MODE
1905
1906 .HP 12
1907 Usage:
1908 .B mdadm \-\-build
1909 .I md-device
1910 .BI \-\-chunk= X
1911 .BI \-\-level= Y
1912 .BI \-\-raid\-devices= Z
1913 .I devices
1914
1915 .PP
1916 This usage is similar to
1917 .BR \-\-create .
1918 The difference is that it creates an array without a superblock. With
1919 these arrays there is no difference between initially creating the array and
1920 subsequently assembling the array, except that hopefully there is useful
1921 data there in the second case.
1922
1923 The level may raid0, linear, raid1, raid10, multipath, or faulty, or
1924 one of their synonyms. All devices must be listed and the array will
1925 be started once complete. It will often be appropriate to use
1926 .B \-\-assume\-clean
1927 with levels raid1 or raid10.
1928
1929 .SH CREATE MODE
1930
1931 .HP 12
1932 Usage:
1933 .B mdadm \-\-create
1934 .I md-device
1935 .BI \-\-chunk= X
1936 .BI \-\-level= Y
1937 .br
1938 .BI \-\-raid\-devices= Z
1939 .I devices
1940
1941 .PP
1942 This usage will initialise a new md array, associate some devices with
1943 it, and activate the array.
1944
1945 The named device will normally not exist when
1946 .I "mdadm \-\-create"
1947 is run, but will be created by
1948 .I udev
1949 once the array becomes active.
1950
1951 As devices are added, they are checked to see if they contain RAID
1952 superblocks or filesystems. They are also checked to see if the variance in
1953 device size exceeds 1%.
1954
1955 If any discrepancy is found, the array will not automatically be run, though
1956 the presence of a
1957 .B \-\-run
1958 can override this caution.
1959
1960 To create a "degraded" array in which some devices are missing, simply
1961 give the word "\fBmissing\fP"
1962 in place of a device name. This will cause
1963 .I mdadm
1964 to leave the corresponding slot in the array empty.
1965 For a RAID4 or RAID5 array at most one slot can be
1966 "\fBmissing\fP"; for a RAID6 array at most two slots.
1967 For a RAID1 array, only one real device needs to be given. All of the
1968 others can be
1969 "\fBmissing\fP".
1970
1971 When creating a RAID5 array,
1972 .I mdadm
1973 will automatically create a degraded array with an extra spare drive.
1974 This is because building the spare into a degraded array is in general
1975 faster than resyncing the parity on a non-degraded, but not clean,
1976 array. This feature can be overridden with the
1977 .B \-\-force
1978 option.
1979
1980 When creating an array with version-1 metadata a name for the array is
1981 required.
1982 If this is not given with the
1983 .B \-\-name
1984 option,
1985 .I mdadm
1986 will choose a name based on the last component of the name of the
1987 device being created. So if
1988 .B /dev/md3
1989 is being created, then the name
1990 .B 3
1991 will be chosen.
1992 If
1993 .B /dev/md/home
1994 is being created, then the name
1995 .B home
1996 will be used.
1997
1998 When creating a partition based array, using
1999 .I mdadm
2000 with version-1.x metadata, the partition type should be set to
2001 .B 0xDA
2002 (non fs-data). This type selection allows for greater precision since
2003 using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)],
2004 might create problems in the event of array recovery through a live cdrom.
2005
2006 A new array will normally get a randomly assigned 128bit UUID which is
2007 very likely to be unique. If you have a specific need, you can choose
2008 a UUID for the array by giving the
2009 .B \-\-uuid=
2010 option. Be warned that creating two arrays with the same UUID is a
2011 recipe for disaster. Also, using
2012 .B \-\-uuid=
2013 when creating a v0.90 array will silently override any
2014 .B \-\-homehost=
2015 setting.
2016 .\"If the
2017 .\".B \-\-size
2018 .\"option is given, it is not necessary to list any component-devices in this command.
2019 .\"They can be added later, before a
2020 .\".B \-\-run.
2021 .\"If no
2022 .\".B \-\-size
2023 .\"is given, the apparent size of the smallest drive given is used.
2024
2025 If the array type supports a write-intent bitmap, and if the devices
2026 in the array exceed 100G is size, an internal write-intent bitmap
2027 will automatically be added unless some other option is explicitly
2028 requested with the
2029 .B \-\-bitmap
2030 option. In any case space for a bitmap will be reserved so that one
2031 can be added layer with
2032 .BR "\-\-grow \-\-bitmap=internal" .
2033
2034 If the metadata type supports it (currently only 1.x metadata), space
2035 will be allocated to store a bad block list. This allows a modest
2036 number of bad blocks to be recorded, allowing the drive to remain in
2037 service while only partially functional.
2038
2039 When creating an array within a
2040 .B CONTAINER
2041 .I mdadm
2042 can be given either the list of devices to use, or simply the name of
2043 the container. The former case gives control over which devices in
2044 the container will be used for the array. The latter case allows
2045 .I mdadm
2046 to automatically choose which devices to use based on how much spare
2047 space is available.
2048
2049 The General Management options that are valid with
2050 .B \-\-create
2051 are:
2052 .TP
2053 .B \-\-run
2054 insist on running the array even if some devices look like they might
2055 be in use.
2056
2057 .TP
2058 .B \-\-readonly
2059 start the array readonly \(em not supported yet.
2060
2061 .SH MANAGE MODE
2062 .HP 12
2063 Usage:
2064 .B mdadm
2065 .I device
2066 .I options... devices...
2067 .PP
2068
2069 This usage will allow individual devices in an array to be failed,
2070 removed or added. It is possible to perform multiple operations with
2071 on command. For example:
2072 .br
2073 .B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1"
2074 .br
2075 will firstly mark
2076 .B /dev/hda1
2077 as faulty in
2078 .B /dev/md0
2079 and will then remove it from the array and finally add it back
2080 in as a spare. However only one md array can be affected by a single
2081 command.
2082
2083 When a device is added to an active array, mdadm checks to see if it
2084 has metadata on it which suggests that it was recently a member of the
2085 array. If it does, it tries to "re\-add" the device. If there have
2086 been no changes since the device was removed, or if the array has a
2087 write-intent bitmap which has recorded whatever changes there were,
2088 then the device will immediately become a full member of the array and
2089 those differences recorded in the bitmap will be resolved.
2090
2091 .SH MISC MODE
2092 .HP 12
2093 Usage:
2094 .B mdadm
2095 .I options ...
2096 .I devices ...
2097 .PP
2098
2099 MISC mode includes a number of distinct operations that
2100 operate on distinct devices. The operations are:
2101 .TP
2102 .B \-\-query
2103 The device is examined to see if it is
2104 (1) an active md array, or
2105 (2) a component of an md array.
2106 The information discovered is reported.
2107
2108 .TP
2109 .B \-\-detail
2110 The device should be an active md device.
2111 .B mdadm
2112 will display a detailed description of the array.
2113 .B \-\-brief
2114 or
2115 .B \-\-scan
2116 will cause the output to be less detailed and the format to be
2117 suitable for inclusion in
2118 .BR mdadm.conf .
2119 The exit status of
2120 .I mdadm
2121 will normally be 0 unless
2122 .I mdadm
2123 failed to get useful information about the device(s); however, if the
2124 .B \-\-test
2125 option is given, then the exit status will be:
2126 .RS
2127 .TP
2128 0
2129 The array is functioning normally.
2130 .TP
2131 1
2132 The array has at least one failed device.
2133 .TP
2134 2
2135 The array has multiple failed devices such that it is unusable.
2136 .TP
2137 4
2138 There was an error while trying to get information about the device.
2139 .RE
2140
2141 .TP
2142 .B \-\-detail\-platform
2143 Print detail of the platform's RAID capabilities (firmware / hardware
2144 topology). If the metadata is specified with
2145 .B \-e
2146 or
2147 .B \-\-metadata=
2148 then the return status will be:
2149 .RS
2150 .TP
2151 0
2152 metadata successfully enumerated its platform components on this system
2153 .TP
2154 1
2155 metadata is platform independent
2156 .TP
2157 2
2158 metadata failed to find its platform components on this system
2159 .RE
2160
2161 .TP
2162 .B \-\-update\-subarray=
2163 If the device is a container and the argument to \-\-update\-subarray
2164 specifies a subarray in the container, then attempt to update the given
2165 superblock field in the subarray. Similar to updating an array in
2166 "assemble" mode, the field to update is selected by
2167 .B \-U
2168 or
2169 .B \-\-update=
2170 option. Currently only
2171 .B name
2172 is supported.
2173
2174 The
2175 .B name
2176 option updates the subarray name in the metadata, it may not affect the
2177 device node name or the device node symlink until the subarray is
2178 re\-assembled. If updating
2179 .B name
2180 would change the UUID of an active subarray this operation is blocked,
2181 and the command will end in an error.
2182
2183 .TP
2184 .B \-\-examine
2185 The device should be a component of an md array.
2186 .I mdadm
2187 will read the md superblock of the device and display the contents.
2188 If
2189 .B \-\-brief
2190 or
2191 .B \-\-scan
2192 is given, then multiple devices that are components of the one array
2193 are grouped together and reported in a single entry suitable
2194 for inclusion in
2195 .BR mdadm.conf .
2196
2197 Having
2198 .B \-\-scan
2199 without listing any devices will cause all devices listed in the
2200 config file to be examined.
2201
2202 .TP
2203 .BI \-\-dump= directory
2204 If the device contains RAID metadata, a file will be created in the
2205 .I directory
2206 and the metadata will be written to it. The file will be the same
2207 size as the device and have the metadata written in the file at the
2208 same locate that it exists in the device. However the file will be "sparse" so
2209 that only those blocks containing metadata will be allocated. The
2210 total space used will be small.
2211
2212 The file name used in the
2213 .I directory
2214 will be the base name of the device. Further if any links appear in
2215 .I /dev/disk/by-id
2216 which point to the device, then hard links to the file will be created
2217 in
2218 .I directory
2219 based on these
2220 .I by-id
2221 names.
2222
2223 Multiple devices can be listed and their metadata will all be stored
2224 in the one directory.
2225
2226 .TP
2227 .BI \-\-restore= directory
2228 This is the reverse of
2229 .BR \-\-dump .
2230 .I mdadm
2231 will locate a file in the directory that has a name appropriate for
2232 the given device and will restore metadata from it. Names that match
2233 .I /dev/disk/by-id
2234 names are preferred, however if two of those refer to different files,
2235 .I mdadm
2236 will not choose between them but will abort the operation.
2237
2238 If a file name is given instead of a
2239 .I directory
2240 then
2241 .I mdadm
2242 will restore from that file to a single device, always provided the
2243 size of the file matches that of the device, and the file contains
2244 valid metadata.
2245 .TP
2246 .B \-\-stop
2247 The devices should be active md arrays which will be deactivated, as
2248 long as they are not currently in use.
2249
2250 .TP
2251 .B \-\-run
2252 This will fully activate a partially assembled md array.
2253
2254 .TP
2255 .B \-\-readonly
2256 This will mark an active array as read-only, providing that it is
2257 not currently being used.
2258
2259 .TP
2260 .B \-\-readwrite
2261 This will change a
2262 .B readonly
2263 array back to being read/write.
2264
2265 .TP
2266 .B \-\-scan
2267 For all operations except
2268 .BR \-\-examine ,
2269 .B \-\-scan
2270 will cause the operation to be applied to all arrays listed in
2271 .BR /proc/mdstat .
2272 For
2273 .BR \-\-examine,
2274 .B \-\-scan
2275 causes all devices listed in the config file to be examined.
2276
2277 .TP
2278 .BR \-b ", " \-\-brief
2279 Be less verbose. This is used with
2280 .B \-\-detail
2281 and
2282 .BR \-\-examine .
2283 Using
2284 .B \-\-brief
2285 with
2286 .B \-\-verbose
2287 gives an intermediate level of verbosity.
2288
2289 .SH MONITOR MODE
2290
2291 .HP 12
2292 Usage:
2293 .B mdadm \-\-monitor
2294 .I options... devices...
2295
2296 .PP
2297 This usage causes
2298 .I mdadm
2299 to periodically poll a number of md arrays and to report on any events
2300 noticed.
2301 .I mdadm
2302 will never exit once it decides that there are arrays to be checked,
2303 so it should normally be run in the background.
2304
2305 As well as reporting events,
2306 .I mdadm
2307 may move a spare drive from one array to another if they are in the
2308 same
2309 .B spare-group
2310 or
2311 .B domain
2312 and if the destination array has a failed drive but no spares.
2313
2314 If any devices are listed on the command line,
2315 .I mdadm
2316 will only monitor those devices. Otherwise all arrays listed in the
2317 configuration file will be monitored. Further, if
2318 .B \-\-scan
2319 is given, then any other md devices that appear in
2320 .B /proc/mdstat
2321 will also be monitored.
2322
2323 The result of monitoring the arrays is the generation of events.
2324 These events are passed to a separate program (if specified) and may
2325 be mailed to a given E-mail address.
2326
2327 When passing events to a program, the program is run once for each event,
2328 and is given 2 or 3 command-line arguments: the first is the
2329 name of the event (see below), the second is the name of the
2330 md device which is affected, and the third is the name of a related
2331 device if relevant (such as a component device that has failed).
2332
2333 If
2334 .B \-\-scan
2335 is given, then a program or an E-mail address must be specified on the
2336 command line or in the config file. If neither are available, then
2337 .I mdadm
2338 will not monitor anything.
2339 Without
2340 .B \-\-scan,
2341 .I mdadm
2342 will continue monitoring as long as something was found to monitor. If
2343 no program or email is given, then each event is reported to
2344 .BR stdout .
2345
2346 The different events are:
2347
2348 .RS 4
2349 .TP
2350 .B DeviceDisappeared
2351 An md array which previously was configured appears to no longer be
2352 configured. (syslog priority: Critical)
2353
2354 If
2355 .I mdadm
2356 was told to monitor an array which is RAID0 or Linear, then it will
2357 report
2358 .B DeviceDisappeared
2359 with the extra information
2360 .BR Wrong-Level .
2361 This is because RAID0 and Linear do not support the device-failed,
2362 hot-spare and resync operations which are monitored.
2363
2364 .TP
2365 .B RebuildStarted
2366 An md array started reconstruction. (syslog priority: Warning)
2367
2368 .TP
2369 .BI Rebuild NN
2370 Where
2371 .I NN
2372 is a two-digit number (ie. 05, 48). This indicates that rebuild
2373 has passed that many percent of the total. The events are generated
2374 with fixed increment since 0. Increment size may be specified with
2375 a commandline option (default is 20). (syslog priority: Warning)
2376
2377 .TP
2378 .B RebuildFinished
2379 An md array that was rebuilding, isn't any more, either because it
2380 finished normally or was aborted. (syslog priority: Warning)
2381
2382 .TP
2383 .B Fail
2384 An active component device of an array has been marked as
2385 faulty. (syslog priority: Critical)
2386
2387 .TP
2388 .B FailSpare
2389 A spare component device which was being rebuilt to replace a faulty
2390 device has failed. (syslog priority: Critical)
2391
2392 .TP
2393 .B SpareActive
2394 A spare component device which was being rebuilt to replace a faulty
2395 device has been successfully rebuilt and has been made active.
2396 (syslog priority: Info)
2397
2398 .TP
2399 .B NewArray
2400 A new md array has been detected in the
2401 .B /proc/mdstat
2402 file. (syslog priority: Info)
2403
2404 .TP
2405 .B DegradedArray
2406 A newly noticed array appears to be degraded. This message is not
2407 generated when
2408 .I mdadm
2409 notices a drive failure which causes degradation, but only when
2410 .I mdadm
2411 notices that an array is degraded when it first sees the array.
2412 (syslog priority: Critical)
2413
2414 .TP
2415 .B MoveSpare
2416 A spare drive has been moved from one array in a
2417 .B spare-group
2418 or
2419 .B domain
2420 to another to allow a failed drive to be replaced.
2421 (syslog priority: Info)
2422
2423 .TP
2424 .B SparesMissing
2425 If
2426 .I mdadm
2427 has been told, via the config file, that an array should have a certain
2428 number of spare devices, and
2429 .I mdadm
2430 detects that it has fewer than this number when it first sees the
2431 array, it will report a
2432 .B SparesMissing
2433 message.
2434 (syslog priority: Warning)
2435
2436 .TP
2437 .B TestMessage
2438 An array was found at startup, and the
2439 .B \-\-test
2440 flag was given.
2441 (syslog priority: Info)
2442 .RE
2443
2444 Only
2445 .B Fail,
2446 .B FailSpare,
2447 .B DegradedArray,
2448 .B SparesMissing
2449 and
2450 .B TestMessage
2451 cause Email to be sent. All events cause the program to be run.
2452 The program is run with two or three arguments: the event
2453 name, the array device and possibly a second device.
2454
2455 Each event has an associated array device (e.g.
2456 .BR /dev/md1 )
2457 and possibly a second device. For
2458 .BR Fail ,
2459 .BR FailSpare ,
2460 and
2461 .B SpareActive
2462 the second device is the relevant component device.
2463 For
2464 .B MoveSpare
2465 the second device is the array that the spare was moved from.
2466
2467 For
2468 .I mdadm
2469 to move spares from one array to another, the different arrays need to
2470 be labeled with the same
2471 .B spare-group
2472 or the spares must be allowed to migrate through matching POLICY domains
2473 in the configuration file. The
2474 .B spare-group
2475 name can be any string; it is only necessary that different spare
2476 groups use different names.
2477
2478 When
2479 .I mdadm
2480 detects that an array in a spare group has fewer active
2481 devices than necessary for the complete array, and has no spare
2482 devices, it will look for another array in the same spare group that
2483 has a full complement of working drive and a spare. It will then
2484 attempt to remove the spare from the second drive and add it to the
2485 first.
2486 If the removal succeeds but the adding fails, then it is added back to
2487 the original array.
2488
2489 If the spare group for a degraded array is not defined,
2490 .I mdadm
2491 will look at the rules of spare migration specified by POLICY lines in
2492 .B mdadm.conf
2493 and then follow similar steps as above if a matching spare is found.
2494
2495 .SH GROW MODE
2496 The GROW mode is used for changing the size or shape of an active
2497 array.
2498 For this to work, the kernel must support the necessary change.
2499 Various types of growth are being added during 2.6 development.
2500
2501 Currently the supported changes include
2502 .IP \(bu 4
2503 change the "size" attribute for RAID1, RAID4, RAID5 and RAID6.
2504 .IP \(bu 4
2505 increase or decrease the "raid\-devices" attribute of RAID0, RAID1, RAID4,
2506 RAID5, and RAID6.
2507 .IP \(bu 4
2508 change the chunk-size and layout of RAID0, RAID4, RAID5, RAID6 and RAID10.
2509 .IP \(bu 4
2510 convert between RAID1 and RAID5, between RAID5 and RAID6, between
2511 RAID0, RAID4, and RAID5, and between RAID0 and RAID10 (in the near-2 mode).
2512 .IP \(bu 4
2513 add a write-intent bitmap to any array which supports these bitmaps, or
2514 remove a write-intent bitmap from such an array.
2515 .PP
2516
2517 Using GROW on containers is currently supported only for Intel's IMSM
2518 container format. The number of devices in a container can be
2519 increased - which affects all arrays in the container - or an array
2520 in a container can be converted between levels where those levels are
2521 supported by the container, and the conversion is on of those listed
2522 above. Resizing arrays in an IMSM container with
2523 .B "--grow --size"
2524 is not yet supported.
2525
2526 Grow functionality (e.g. expand a number of raid devices) for Intel's
2527 IMSM container format has an experimental status. It is guarded by the
2528 .B MDADM_EXPERIMENTAL
2529 environment variable which must be set to '1' for a GROW command to
2530 succeed.
2531 This is for the following reasons:
2532
2533 .IP 1.
2534 Intel's native IMSM check-pointing is not fully tested yet.
2535 This can causes IMSM incompatibility during the grow process: an array
2536 which is growing cannot roam between Microsoft Windows(R) and Linux
2537 systems.
2538
2539 .IP 2.
2540 Interrupting a grow operation is not recommended, because it
2541 has not been fully tested for Intel's IMSM container format yet.
2542
2543 .PP
2544 Note: Intel's native checkpointing doesn't use
2545 .B --backup-file
2546 option and it is transparent for assembly feature.
2547
2548 .SS SIZE CHANGES
2549 Normally when an array is built the "size" is taken from the smallest
2550 of the drives. If all the small drives in an arrays are, one at a
2551 time, removed and replaced with larger drives, then you could have an
2552 array of large drives with only a small amount used. In this
2553 situation, changing the "size" with "GROW" mode will allow the extra
2554 space to start being used. If the size is increased in this way, a
2555 "resync" process will start to make sure the new parts of the array
2556 are synchronised.
2557
2558 Note that when an array changes size, any filesystem that may be
2559 stored in the array will not automatically grow or shrink to use or
2560 vacate the space. The
2561 filesystem will need to be explicitly told to use the extra space
2562 after growing, or to reduce its size
2563 .B prior
2564 to shrinking the array.
2565
2566 Also the size of an array cannot be changed while it has an active
2567 bitmap. If an array has a bitmap, it must be removed before the size
2568 can be changed. Once the change is complete a new bitmap can be created.
2569
2570 .SS RAID\-DEVICES CHANGES
2571
2572 A RAID1 array can work with any number of devices from 1 upwards
2573 (though 1 is not very useful). There may be times which you want to
2574 increase or decrease the number of active devices. Note that this is
2575 different to hot-add or hot-remove which changes the number of
2576 inactive devices.
2577
2578 When reducing the number of devices in a RAID1 array, the slots which
2579 are to be removed from the array must already be vacant. That is, the
2580 devices which were in those slots must be failed and removed.
2581
2582 When the number of devices is increased, any hot spares that are
2583 present will be activated immediately.
2584
2585 Changing the number of active devices in a RAID5 or RAID6 is much more
2586 effort. Every block in the array will need to be read and written
2587 back to a new location. From 2.6.17, the Linux Kernel is able to
2588 increase the number of devices in a RAID5 safely, including restarting
2589 an interrupted "reshape". From 2.6.31, the Linux Kernel is able to
2590 increase or decrease the number of devices in a RAID5 or RAID6.
2591
2592 From 2.6.35, the Linux Kernel is able to convert a RAID0 in to a RAID4
2593 or RAID5.
2594 .I mdadm
2595 uses this functionality and the ability to add
2596 devices to a RAID4 to allow devices to be added to a RAID0. When
2597 requested to do this,
2598 .I mdadm
2599 will convert the RAID0 to a RAID4, add the necessary disks and make
2600 the reshape happen, and then convert the RAID4 back to RAID0.
2601
2602 When decreasing the number of devices, the size of the array will also
2603 decrease. If there was data in the array, it could get destroyed and
2604 this is not reversible, so you should firstly shrink the filesystem on
2605 the array to fit within the new size. To help prevent accidents,
2606 .I mdadm
2607 requires that the size of the array be decreased first with
2608 .BR "mdadm --grow --array-size" .
2609 This is a reversible change which simply makes the end of the array
2610 inaccessible. The integrity of any data can then be checked before
2611 the non-reversible reduction in the number of devices is request.
2612
2613 When relocating the first few stripes on a RAID5 or RAID6, it is not
2614 possible to keep the data on disk completely consistent and
2615 crash-proof. To provide the required safety, mdadm disables writes to
2616 the array while this "critical section" is reshaped, and takes a
2617 backup of the data that is in that section. For grows, this backup may be
2618 stored in any spare devices that the array has, however it can also be
2619 stored in a separate file specified with the
2620 .B \-\-backup\-file
2621 option, and is required to be specified for shrinks, RAID level
2622 changes and layout changes. If this option is used, and the system
2623 does crash during the critical period, the same file must be passed to
2624 .B \-\-assemble
2625 to restore the backup and reassemble the array. When shrinking rather
2626 than growing the array, the reshape is done from the end towards the
2627 beginning, so the "critical section" is at the end of the reshape.
2628
2629 .SS LEVEL CHANGES
2630
2631 Changing the RAID level of any array happens instantaneously. However
2632 in the RAID5 to RAID6 case this requires a non-standard layout of the
2633 RAID6 data, and in the RAID6 to RAID5 case that non-standard layout is
2634 required before the change can be accomplished. So while the level
2635 change is instant, the accompanying layout change can take quite a
2636 long time. A
2637 .B \-\-backup\-file
2638 is required. If the array is not simultaneously being grown or
2639 shrunk, so that the array size will remain the same - for example,
2640 reshaping a 3-drive RAID5 into a 4-drive RAID6 - the backup file will
2641 be used not just for a "cricital section" but throughout the reshape
2642 operation, as described below under LAYOUT CHANGES.
2643
2644 .SS CHUNK-SIZE AND LAYOUT CHANGES
2645
2646 Changing the chunk-size of layout without also changing the number of
2647 devices as the same time will involve re-writing all blocks in-place.
2648 To ensure against data loss in the case of a crash, a
2649 .B --backup-file
2650 must be provided for these changes. Small sections of the array will
2651 be copied to the backup file while they are being rearranged. This
2652 means that all the data is copied twice, once to the backup and once
2653 to the new layout on the array, so this type of reshape will go very
2654 slowly.
2655
2656 If the reshape is interrupted for any reason, this backup file must be
2657 made available to
2658 .B "mdadm --assemble"
2659 so the array can be reassembled. Consequently the file cannot be
2660 stored on the device being reshaped.
2661
2662
2663 .SS BITMAP CHANGES
2664
2665 A write-intent bitmap can be added to, or removed from, an active
2666 array. Either internal bitmaps, or bitmaps stored in a separate file,
2667 can be added. Note that if you add a bitmap stored in a file which is
2668 in a filesystem that is on the RAID array being affected, the system
2669 will deadlock. The bitmap must be on a separate filesystem.
2670
2671 .SH INCREMENTAL MODE
2672
2673 .HP 12
2674 Usage:
2675 .B mdadm \-\-incremental
2676 .RB [ \-\-run ]
2677 .RB [ \-\-quiet ]
2678 .I component-device
2679 .HP 12
2680 Usage:
2681 .B mdadm \-\-incremental \-\-fail
2682 .I component-device
2683 .HP 12
2684 Usage:
2685 .B mdadm \-\-incremental \-\-rebuild\-map
2686 .HP 12
2687 Usage:
2688 .B mdadm \-\-incremental \-\-run \-\-scan
2689
2690 .PP
2691 This mode is designed to be used in conjunction with a device
2692 discovery system. As devices are found in a system, they can be
2693 passed to
2694 .B "mdadm \-\-incremental"
2695 to be conditionally added to an appropriate array.
2696
2697 Conversely, it can also be used with the
2698 .B \-\-fail
2699 flag to do just the opposite and find whatever array a particular device
2700 is part of and remove the device from that array.
2701
2702 If the device passed is a
2703 .B CONTAINER
2704 device created by a previous call to
2705 .IR mdadm ,
2706 then rather than trying to add that device to an array, all the arrays
2707 described by the metadata of the container will be started.
2708
2709 .I mdadm
2710 performs a number of tests to determine if the device is part of an
2711 array, and which array it should be part of. If an appropriate array
2712 is found, or can be created,
2713 .I mdadm
2714 adds the device to the array and conditionally starts the array.
2715
2716 Note that
2717 .I mdadm
2718 will normally only add devices to an array which were previously working
2719 (active or spare) parts of that array. The support for automatic
2720 inclusion of a new drive as a spare in some array requires
2721 a configuration through POLICY in config file.
2722
2723 The tests that
2724 .I mdadm
2725 makes are as follow:
2726 .IP +
2727 Is the device permitted by
2728 .BR mdadm.conf ?
2729 That is, is it listed in a
2730 .B DEVICES
2731 line in that file. If
2732 .B DEVICES
2733 is absent then the default it to allow any device. Similar if
2734 .B DEVICES
2735 contains the special word
2736 .B partitions
2737 then any device is allowed. Otherwise the device name given to
2738 .I mdadm
2739 must match one of the names or patterns in a
2740 .B DEVICES
2741 line.
2742
2743 .IP +
2744 Does the device have a valid md superblock? If a specific metadata
2745 version is requested with
2746 .B \-\-metadata
2747 or
2748 .B \-e
2749 then only that style of metadata is accepted, otherwise
2750 .I mdadm
2751 finds any known version of metadata. If no
2752 .I md
2753 metadata is found, the device may be still added to an array
2754 as a spare if POLICY allows.
2755
2756 .ig
2757 .IP +
2758 Does the metadata match an expected array?
2759 The metadata can match in two ways. Either there is an array listed
2760 in
2761 .B mdadm.conf
2762 which identifies the array (either by UUID, by name, by device list,
2763 or by minor-number), or the array was created with a
2764 .B homehost
2765 specified and that
2766 .B homehost
2767 matches the one in
2768 .B mdadm.conf
2769 or on the command line.
2770 If
2771 .I mdadm
2772 is not able to positively identify the array as belonging to the
2773 current host, the device will be rejected.
2774 ..
2775
2776 .PP
2777 .I mdadm
2778 keeps a list of arrays that it has partially assembled in
2779 .BR {MAP_PATH} .
2780 If no array exists which matches
2781 the metadata on the new device,
2782 .I mdadm
2783 must choose a device name and unit number. It does this based on any
2784 name given in
2785 .B mdadm.conf
2786 or any name information stored in the metadata. If this name
2787 suggests a unit number, that number will be used, otherwise a free
2788 unit number will be chosen. Normally
2789 .I mdadm
2790 will prefer to create a partitionable array, however if the
2791 .B CREATE
2792 line in
2793 .B mdadm.conf
2794 suggests that a non-partitionable array is preferred, that will be
2795 honoured.
2796
2797 If the array is not found in the config file and its metadata does not
2798 identify it as belonging to the "homehost", then
2799 .I mdadm
2800 will choose a name for the array which is certain not to conflict with
2801 any array which does belong to this host. It does this be adding an
2802 underscore and a small number to the name preferred by the metadata.
2803
2804 Once an appropriate array is found or created and the device is added,
2805 .I mdadm
2806 must decide if the array is ready to be started. It will
2807 normally compare the number of available (non-spare) devices to the
2808 number of devices that the metadata suggests need to be active. If
2809 there are at least that many, the array will be started. This means
2810 that if any devices are missing the array will not be restarted.
2811
2812 As an alternative,
2813 .B \-\-run
2814 may be passed to
2815 .I mdadm
2816 in which case the array will be run as soon as there are enough
2817 devices present for the data to be accessible. For a RAID1, that
2818 means one device will start the array. For a clean RAID5, the array
2819 will be started as soon as all but one drive is present.
2820
2821 Note that neither of these approaches is really ideal. If it can
2822 be known that all device discovery has completed, then
2823 .br
2824 .B " mdadm \-IRs"
2825 .br
2826 can be run which will try to start all arrays that are being
2827 incrementally assembled. They are started in "read-auto" mode in
2828 which they are read-only until the first write request. This means
2829 that no metadata updates are made and no attempt at resync or recovery
2830 happens. Further devices that are found before the first write can
2831 still be added safely.
2832
2833 .SH ENVIRONMENT
2834 This section describes environment variables that affect how mdadm
2835 operates.
2836
2837 .TP
2838 .B MDADM_NO_MDMON
2839 Setting this value to 1 will prevent mdadm from automatically launching
2840 mdmon. This variable is intended primarily for debugging mdadm/mdmon.
2841
2842 .TP
2843 .B MDADM_NO_UDEV
2844 Normally,
2845 .I mdadm
2846 does not create any device nodes in /dev, but leaves that task to
2847 .IR udev .
2848 If
2849 .I udev
2850 appears not to be configured, or if this environment variable is set
2851 to '1', the
2852 .I mdadm
2853 will create and devices that are needed.
2854
2855 .TP
2856 .B IMSM_NO_PLATFORM
2857 A key value of IMSM metadata is that it allows interoperability with
2858 boot ROMs on Intel platforms, and with other major operating systems.
2859 Consequently,
2860 .I mdadm
2861 will only allow an IMSM array to be created or modified if detects
2862 that it is running on an Intel platform which supports IMSM, and
2863 supports the particular configuration of IMSM that is being requested
2864 (some functionality requires newer OROM support).
2865
2866 These checks can be suppressed by setting IMSM_NO_PLATFORM=1 in the
2867 environment. This can be useful for testing or for disaster
2868 recovery. You should be aware that interoperability may be
2869 compromised by setting this value.
2870
2871 .TP
2872 .B MDADM_CONF_AUTO
2873 Any string given in this variable is added to the start of the
2874 .B AUTO
2875 line in the config file, or treated as the whole
2876 .B AUTO
2877 line if none is given. It can be used to disable certain metadata
2878 types when
2879 .I mdadm
2880 is called from a boot script. For example
2881 .br
2882 .B " export MDADM_CONF_AUTO='-ddf -imsm'
2883 .br
2884 will make sure that
2885 .I mdadm
2886 does not automatically assemble any DDF or
2887 IMSM arrays that are found. This can be useful on systems configured
2888 to manage such arrays with
2889 .BR dmraid .
2890
2891
2892 .SH EXAMPLES
2893
2894 .B " mdadm \-\-query /dev/name-of-device"
2895 .br
2896 This will find out if a given device is a RAID array, or is part of
2897 one, and will provide brief information about the device.
2898
2899 .B " mdadm \-\-assemble \-\-scan"
2900 .br
2901 This will assemble and start all arrays listed in the standard config
2902 file. This command will typically go in a system startup file.
2903
2904 .B " mdadm \-\-stop \-\-scan"
2905 .br
2906 This will shut down all arrays that can be shut down (i.e. are not
2907 currently in use). This will typically go in a system shutdown script.
2908
2909 .B " mdadm \-\-follow \-\-scan \-\-delay=120"
2910 .br
2911 If (and only if) there is an Email address or program given in the
2912 standard config file, then
2913 monitor the status of all arrays listed in that file by
2914 polling them ever 2 minutes.
2915
2916 .B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1"
2917 .br
2918 Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.
2919
2920 .br
2921 .B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf"
2922 .br
2923 .B " mdadm \-\-detail \-\-scan >> mdadm.conf"
2924 .br
2925 This will create a prototype config file that describes currently
2926 active arrays that are known to be made from partitions of IDE or SCSI drives.
2927 This file should be reviewed before being used as it may
2928 contain unwanted detail.
2929
2930 .B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf"
2931 .br
2932 .B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf"
2933 .br
2934 This will find arrays which could be assembled from existing IDE and
2935 SCSI whole drives (not partitions), and store the information in the
2936 format of a config file.
2937 This file is very likely to contain unwanted detail, particularly
2938 the
2939 .B devices=
2940 entries. It should be reviewed and edited before being used as an
2941 actual config file.
2942
2943 .B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions"
2944 .br
2945 .B " mdadm \-Ebsc partitions"
2946 .br
2947 Create a list of devices by reading
2948 .BR /proc/partitions ,
2949 scan these for RAID superblocks, and printout a brief listing of all
2950 that were found.
2951
2952 .B " mdadm \-Ac partitions \-m 0 /dev/md0"
2953 .br
2954 Scan all partitions and devices listed in
2955 .BR /proc/partitions
2956 and assemble
2957 .B /dev/md0
2958 out of all such devices with a RAID superblock with a minor number of 0.
2959
2960 .B " mdadm \-\-monitor \-\-scan \-\-daemonise > /run/mdadm/mon.pid"
2961 .br
2962 If config file contains a mail address or alert program, run mdadm in
2963 the background in monitor mode monitoring all md devices. Also write
2964 pid of mdadm daemon to
2965 .BR /run/mdadm/mon.pid .
2966
2967 .B " mdadm \-Iq /dev/somedevice"
2968 .br
2969 Try to incorporate newly discovered device into some array as
2970 appropriate.
2971
2972 .B " mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan"
2973 .br
2974 Rebuild the array map from any current arrays, and then start any that
2975 can be started.
2976
2977 .B " mdadm /dev/md4 --fail detached --remove detached"
2978 .br
2979 Any devices which are components of /dev/md4 will be marked as faulty
2980 and then remove from the array.
2981
2982 .B " mdadm --grow /dev/md4 --level=6 --backup-file=/root/backup-md4"
2983 .br
2984 The array
2985 .B /dev/md4
2986 which is currently a RAID5 array will be converted to RAID6. There
2987 should normally already be a spare drive attached to the array as a
2988 RAID6 needs one more drive than a matching RAID5.
2989
2990 .B " mdadm --create /dev/md/ddf --metadata=ddf --raid-disks 6 /dev/sd[a-f]"
2991 .br
2992 Create a DDF array over 6 devices.
2993
2994 .B " mdadm --create /dev/md/home -n3 -l5 -z 30000000 /dev/md/ddf"
2995 .br
2996 Create a RAID5 array over any 3 devices in the given DDF set. Use
2997 only 30 gigabytes of each device.
2998
2999 .B " mdadm -A /dev/md/ddf1 /dev/sd[a-f]"
3000 .br
3001 Assemble a pre-exist ddf array.
3002
3003 .B " mdadm -I /dev/md/ddf1"
3004 .br
3005 Assemble all arrays contained in the ddf array, assigning names as
3006 appropriate.
3007
3008 .B " mdadm \-\-create \-\-help"
3009 .br
3010 Provide help about the Create mode.
3011
3012 .B " mdadm \-\-config \-\-help"
3013 .br
3014 Provide help about the format of the config file.
3015
3016 .B " mdadm \-\-help"
3017 .br
3018 Provide general help.
3019
3020 .SH FILES
3021
3022 .SS /proc/mdstat
3023
3024 If you're using the
3025 .B /proc
3026 filesystem,
3027 .B /proc/mdstat
3028 lists all active md devices with information about them.
3029 .I mdadm
3030 uses this to find arrays when
3031 .B \-\-scan
3032 is given in Misc mode, and to monitor array reconstruction
3033 on Monitor mode.
3034
3035 .SS /etc/mdadm.conf
3036
3037 The config file lists which devices may be scanned to see if
3038 they contain MD super block, and gives identifying information
3039 (e.g. UUID) about known MD arrays. See
3040 .BR mdadm.conf (5)
3041 for more details.
3042
3043 .SS /etc/mdadm.conf.d
3044
3045 A directory containing configuration files which are read in lexical
3046 order.
3047
3048 .SS {MAP_PATH}
3049 When
3050 .B \-\-incremental
3051 mode is used, this file gets a list of arrays currently being created.
3052
3053 .SH DEVICE NAMES
3054
3055 .I mdadm
3056 understand two sorts of names for array devices.
3057
3058 The first is the so-called 'standard' format name, which matches the
3059 names used by the kernel and which appear in
3060 .IR /proc/mdstat .
3061
3062 The second sort can be freely chosen, but must reside in
3063 .IR /dev/md/ .
3064 When giving a device name to
3065 .I mdadm
3066 to create or assemble an array, either full path name such as
3067 .I /dev/md0
3068 or
3069 .I /dev/md/home
3070 can be given, or just the suffix of the second sort of name, such as
3071 .I home
3072 can be given.
3073
3074 When
3075 .I mdadm
3076 chooses device names during auto-assembly or incremental assembly, it
3077 will sometimes add a small sequence number to the end of the name to
3078 avoid conflicted between multiple arrays that have the same name. If
3079 .I mdadm
3080 can reasonably determine that the array really is meant for this host,
3081 either by a hostname in the metadata, or by the presence of the array
3082 in
3083 .BR mdadm.conf ,
3084 then it will leave off the suffix if possible.
3085 Also if the homehost is specified as
3086 .B <ignore>
3087 .I mdadm
3088 will only use a suffix if a different array of the same name already
3089 exists or is listed in the config file.
3090
3091 The standard names for non-partitioned arrays (the only sort of md
3092 array available in 2.4 and earlier) are of the form
3093 .IP
3094 .RB /dev/md NN
3095 .PP
3096 where NN is a number.
3097 The standard names for partitionable arrays (as available from 2.6
3098 onwards) are of the form:
3099 .IP
3100 .RB /dev/md_d NN
3101 .PP
3102 Partition numbers should be indicated by adding "pMM" to these, thus "/dev/md/d1p2".
3103 .PP
3104 From kernel version 2.6.28 the "non-partitioned array" can actually
3105 be partitioned. So the "md_d\fBNN\fP"
3106 names are no longer needed, and
3107 partitions such as "/dev/md\fBNN\fPp\fBXX\fp"
3108 are possible.
3109 .PP
3110 From kernel version 2.6.29 standard names can be non-numeric following
3111 the form:
3112 .IP
3113 .RB /dev/md_ XXX
3114 .PP
3115 where
3116 .B XXX
3117 is any string. These names are supported by
3118 .I mdadm
3119 since version 3.3 provided they are enabled in
3120 .IR mdadm.conf .
3121
3122 .SH NOTE
3123 .I mdadm
3124 was previously known as
3125 .IR mdctl .
3126
3127 .SH SEE ALSO
3128 For further information on mdadm usage, MD and the various levels of
3129 RAID, see:
3130 .IP
3131 .B http://raid.wiki.kernel.org/
3132 .PP
3133 (based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO)
3134 .PP
3135 The latest version of
3136 .I mdadm
3137 should always be available from
3138 .IP
3139 .B http://www.kernel.org/pub/linux/utils/raid/mdadm/
3140 .PP
3141 Related man pages:
3142 .PP
3143 .IR mdmon (8),
3144 .IR mdadm.conf (5),
3145 .IR md (4).