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