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