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