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