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