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