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