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