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