]>
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. | |
d709d416 | 8 | .TH MDADM 8 "" v4.3 |
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, | |
17790db6 | 128 | changing the chunk size and layout for RAID 0,4,5,6,10 as well as adding or |
860f11ed | 129 | removing a write-intent bitmap and changing the array's consistency policy. |
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 | |
1a386f80 | 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 | |
4a984120 | 217 | one of |
7e23fc43 | 218 | .BR \-\-add , |
f33a71f1 N |
219 | .BR \-\-re\-add , |
220 | .BR \-\-add\-spare , | |
7e23fc43 | 221 | .BR \-\-fail , |
7e23fc43 | 222 | .BR \-\-remove , |
70c55e36 N |
223 | or |
224 | .BR \-\-replace , | |
e0fe762a | 225 | then the MANAGE mode is assumed. |
2ae555c3 NB |
226 | Anything other than these will cause the |
227 | .B Misc | |
228 | mode to be assumed. | |
dd0781e5 | 229 | |
2ae555c3 | 230 | .SH Options that are not mode-specific are: |
e793c2e5 | 231 | |
cd29a5c8 | 232 | .TP |
7e23fc43 | 233 | .BR \-h ", " \-\-help |
1a386f80 | 234 | Display a general help message or, after one of the above options, a |
93e790af | 235 | mode-specific help message. |
56eedc1a NB |
236 | |
237 | .TP | |
7e23fc43 | 238 | .B \-\-help\-options |
1a386f80 | 239 | Display more detailed help about command-line parsing and some commonly |
56eedc1a | 240 | used options. |
52826846 | 241 | |
cd29a5c8 | 242 | .TP |
7e23fc43 | 243 | .BR \-V ", " \-\-version |
9a9dab36 | 244 | Print version information for mdadm. |
52826846 | 245 | |
cd29a5c8 | 246 | .TP |
7e23fc43 | 247 | .BR \-v ", " \-\-verbose |
22892d56 NB |
248 | Be more verbose about what is happening. This can be used twice to be |
249 | extra-verbose. | |
a9d69660 | 250 | The extra verbosity currently only affects |
7e23fc43 | 251 | .B \-\-detail \-\-scan |
22892d56 | 252 | and |
7e23fc43 | 253 | .BR "\-\-examine \-\-scan" . |
52826846 | 254 | |
dab6685f | 255 | .TP |
7e23fc43 | 256 | .BR \-q ", " \-\-quiet |
dab6685f | 257 | Avoid printing purely informative messages. With this, |
51ac42e3 | 258 | .I mdadm |
dab6685f NB |
259 | will be silent unless there is something really important to report. |
260 | ||
08ca2adf | 261 | |
e0d19036 | 262 | .TP |
7e23fc43 | 263 | .BR \-f ", " \-\-force |
93e790af | 264 | Be more forceful about certain operations. See the various modes for |
e0d19036 NB |
265 | the exact meaning of this option in different contexts. |
266 | ||
267 | .TP | |
7e23fc43 | 268 | .BR \-c ", " \-\-config= |
1a386f80 | 269 | Specify the config file or directory. If not specified, the default config file |
24e075c6 LF |
270 | and default conf.d directory will be used. See |
271 | .BR mdadm.conf (5) | |
272 | for more details. | |
273 | ||
5787fa49 | 274 | If the config file given is |
93e790af | 275 | .B "partitions" |
5787fa49 NB |
276 | then nothing will be read, but |
277 | .I mdadm | |
278 | will act as though the config file contained exactly | |
9dc70cbc N |
279 | .br |
280 | .B " DEVICE partitions containers" | |
281 | .br | |
5787fa49 NB |
282 | and will read |
283 | .B /proc/partitions | |
8fd8d9c4 N |
284 | to find a list of devices to scan, and |
285 | .B /proc/mdstat | |
286 | to find a list of containers to examine. | |
d013a55e | 287 | If the word |
93e790af | 288 | .B "none" |
d013a55e NB |
289 | is given for the config file, then |
290 | .I mdadm | |
291 | will act as though the config file were empty. | |
e0d19036 | 292 | |
9dc70cbc N |
293 | If the name given is of a directory, then |
294 | .I mdadm | |
295 | will collect all the files contained in the directory with a name ending | |
296 | in | |
297 | .BR .conf , | |
298 | sort them lexically, and process all of those files as config files. | |
299 | ||
e0d19036 | 300 | .TP |
7e23fc43 | 301 | .BR \-s ", " \-\-scan |
93e790af | 302 | Scan config file or |
e0d19036 NB |
303 | .B /proc/mdstat |
304 | for missing information. | |
305 | In general, this option gives | |
51ac42e3 | 306 | .I mdadm |
93e790af SW |
307 | permission to get any missing information (like component devices, |
308 | array devices, array identities, and alert destination) from the | |
309 | configuration file (see previous option); | |
310 | one exception is MISC mode when using | |
7e23fc43 | 311 | .B \-\-detail |
e0d19036 | 312 | or |
93e790af | 313 | .B \-\-stop, |
e0d19036 | 314 | in which case |
7e23fc43 | 315 | .B \-\-scan |
e0d19036 NB |
316 | says to get a list of array devices from |
317 | .BR /proc/mdstat . | |
318 | ||
570c0542 | 319 | .TP |
d16c7af6 | 320 | .BR \-e ", " \-\-metadata= |
e0fe762a | 321 | Declare the style of RAID metadata (superblock) to be used. The |
26f467a9 | 322 | default is {DEFAULT_METADATA} for |
7e23fc43 | 323 | .BR \-\-create , |
53e8b987 | 324 | and to guess for other operations. |
2790ffe3 GB |
325 | The default can be overridden by setting the |
326 | .B metadata | |
327 | value for the | |
328 | .B CREATE | |
329 | keyword in | |
330 | .BR mdadm.conf . | |
570c0542 NB |
331 | |
332 | Options are: | |
333 | .RS | |
26f467a9 | 334 | .ie '{DEFAULT_METADATA}'0.90' |
335 | .IP "0, 0.90, default" | |
336 | .el | |
7d5c3964 | 337 | .IP "0, 0.90" |
570c0542 | 338 | Use the original 0.90 format superblock. This format limits arrays to |
93e790af | 339 | 28 component devices and limits component devices of levels 1 and |
cd19c0cf JR |
340 | greater to 2 terabytes. It is also possible for there to be confusion |
341 | about whether the superblock applies to a whole device or just the | |
342 | last partition, if that partition starts on a 64K boundary. | |
26f467a9 | 343 | .ie '{DEFAULT_METADATA}'0.90' |
344 | .IP "1, 1.0, 1.1, 1.2" | |
345 | .el | |
7d5c3964 | 346 | .IP "1, 1.0, 1.1, 1.2 default" |
cd19c0cf JR |
347 | Use the new version-1 format superblock. This has fewer restrictions. |
348 | It can easily be moved between hosts with different endian-ness, and a | |
349 | recovery operation can be checkpointed and restarted. The different | |
350 | sub-versions store the superblock at different locations on the | |
351 | device, either at the end (for 1.0), at the start (for 1.1) or 4K from | |
7050aa3f N |
352 | the start (for 1.2). "1" is equivalent to "1.2" (the commonly |
353 | preferred 1.x format). | |
26f467a9 | 354 | 'if '{DEFAULT_METADATA}'1.2' "default" is equivalent to "1.2". |
8fd8d9c4 | 355 | .IP ddf |
e0fe762a N |
356 | Use the "Industry Standard" DDF (Disk Data Format) format defined by |
357 | SNIA. | |
358 | When creating a DDF array a | |
8fd8d9c4 N |
359 | .B CONTAINER |
360 | will be created, and normal arrays can be created in that container. | |
361 | .IP imsm | |
4cce4069 | 362 | Use the Intel(R) Matrix Storage Manager metadata format. This creates a |
8fd8d9c4 | 363 | .B CONTAINER |
4cce4069 DW |
364 | which is managed in a similar manner to DDF, and is supported by an |
365 | option-rom on some platforms: | |
366 | .IP | |
e2eb503b | 367 | .B https://www.intel.com/content/www/us/en/support/products/122484 |
4cce4069 | 368 | .PP |
570c0542 NB |
369 | .RE |
370 | ||
41a3b72a | 371 | .TP |
7e23fc43 | 372 | .B \-\-homehost= |
35cc5be4 | 373 | This will override any |
41a3b72a | 374 | .B HOMEHOST |
93e790af | 375 | setting in the config file and provides the identity of the host which |
41a3b72a NB |
376 | should be considered the home for any arrays. |
377 | ||
378 | When creating an array, the | |
379 | .B homehost | |
e0fe762a | 380 | will be recorded in the metadata. For version-1 superblocks, it will |
93e790af | 381 | be prefixed to the array name. For version-0.90 superblocks, part of |
1a386f80 | 382 | the SHA1 hash of the hostname will be stored in the latter half of the |
41a3b72a NB |
383 | UUID. |
384 | ||
385 | When reporting information about an array, any array which is tagged | |
386 | for the given homehost will be reported as such. | |
387 | ||
388 | When using Auto-Assemble, only arrays tagged for the given homehost | |
0ac91628 | 389 | will be allowed to use 'local' names (i.e. not ending in '_' followed |
e0fe762a | 390 | by a digit string). See below under |
1a386f80 | 391 | .BR "Auto-Assembly" . |
41a3b72a | 392 | |
49325eac N |
393 | The special name "\fBany\fP" can be used as a wild card. If an array |
394 | is created with | |
395 | .B --homehost=any | |
396 | then the name "\fBany\fP" will be stored in the array and it can be | |
397 | assembled in the same way on any host. If an array is assembled with | |
398 | this option, then the homehost recorded on the array will be ignored. | |
399 | ||
c2ecf5f6 N |
400 | .TP |
401 | .B \-\-prefer= | |
402 | When | |
403 | .I mdadm | |
404 | needs to print the name for a device it normally finds the name in | |
405 | .B /dev | |
1a386f80 | 406 | which refers to the device and is the shortest. When a path component is |
c2ecf5f6 N |
407 | given with |
408 | .B \-\-prefer | |
409 | .I mdadm | |
410 | will prefer a longer name if it contains that component. For example | |
411 | .B \-\-prefer=by-uuid | |
412 | will prefer a name in a subdirectory of | |
413 | .B /dev | |
414 | called | |
415 | .BR by-uuid . | |
416 | ||
417 | This functionality is currently only provided by | |
418 | .B \-\-detail | |
419 | and | |
420 | .BR \-\-monitor . | |
421 | ||
7716570e GJ |
422 | .TP |
423 | .B \-\-home\-cluster= | |
424 | specifies the cluster name for the md device. The md device can be assembled | |
425 | only on the cluster which matches the name specified. If this option is not | |
426 | provided, mdadm tries to detect the cluster name automatically. | |
427 | ||
2ae555c3 NB |
428 | .SH For create, build, or grow: |
429 | ||
430 | .TP | |
7e23fc43 | 431 | .BR \-n ", " \-\-raid\-devices= |
2ae555c3 NB |
432 | Specify the number of active devices in the array. This, plus the |
433 | number of spare devices (see below) must equal the number of | |
434 | .I component-devices | |
435 | (including "\fBmissing\fP" devices) | |
436 | that are listed on the command line for | |
e0fe762a | 437 | .BR \-\-create . |
2ae555c3 NB |
438 | Setting a value of 1 is probably |
439 | a mistake and so requires that | |
7e23fc43 | 440 | .B \-\-force |
2ae555c3 | 441 | be specified first. A value of 1 will then be allowed for linear, |
e0fe762a | 442 | multipath, RAID0 and RAID1. It is never allowed for RAID4, RAID5 or RAID6. |
2ae555c3 NB |
443 | .br |
444 | This number can only be changed using | |
7e23fc43 | 445 | .B \-\-grow |
e0fe762a N |
446 | for RAID1, RAID4, RAID5 and RAID6 arrays, and only on kernels which provide |
447 | the necessary support. | |
2ae555c3 NB |
448 | |
449 | .TP | |
7e23fc43 | 450 | .BR \-x ", " \-\-spare\-devices= |
2ae555c3 NB |
451 | Specify the number of spare (eXtra) devices in the initial array. |
452 | Spares can also be added | |
453 | and removed later. The number of component devices listed | |
e0fe762a | 454 | on the command line must equal the number of RAID devices plus the |
2ae555c3 NB |
455 | number of spare devices. |
456 | ||
2ae555c3 | 457 | .TP |
7e23fc43 | 458 | .BR \-z ", " \-\-size= |
fea026b4 MK |
459 | Amount (in Kilobytes) of space to use from each drive in RAID levels 1/4/5/6/10 |
460 | and for RAID 0 on external metadata. | |
2ae555c3 NB |
461 | This must be a multiple of the chunk size, and must leave about 128Kb |
462 | of space at the end of the drive for the RAID superblock. | |
463 | If this is not specified | |
464 | (as it normally is not) the smallest drive (or partition) sets the | |
465 | size, though if there is a variance among the drives of greater than 1%, a warning is | |
466 | issued. | |
467 | ||
42e641ab KT |
468 | A suffix of 'K', 'M', 'G' or 'T' can be given to indicate Kilobytes, |
469 | Megabytes, Gigabytes or Terabytes respectively. | |
36fad8ec | 470 | |
9ab6e80a N |
471 | Sometimes a replacement drive can be a little smaller than the |
472 | original drives though this should be minimised by IDEMA standards. | |
473 | Such a replacement drive will be rejected by | |
474 | .IR md . | |
475 | To guard against this it can be useful to set the initial size | |
476 | slightly smaller than the smaller device with the aim that it will | |
477 | still be larger than any replacement. | |
478 | ||
fea026b4 MK |
479 | This option can be used with |
480 | .B \-\-create | |
1a386f80 | 481 | for determining the initial size of an array. For external metadata, |
fea026b4 | 482 | it can be used on a volume, but not on a container itself. |
1a386f80 | 483 | Setting the initial size of |
fea026b4 MK |
484 | .B RAID 0 |
485 | array is only valid for external metadata. | |
486 | ||
2ae555c3 | 487 | This value can be set with |
7e23fc43 | 488 | .B \-\-grow |
fea026b4 | 489 | for RAID level 1/4/5/6/10 though |
4431efeb | 490 | DDF arrays may not be able to support this. |
fea026b4 | 491 | RAID 0 array size cannot be changed. |
9ab6e80a N |
492 | If the array was created with a size smaller than the currently |
493 | active drives, the extra space can be accessed using | |
7e23fc43 | 494 | .BR \-\-grow . |
2ae555c3 NB |
495 | The size can be given as |
496 | .B max | |
497 | which means to choose the largest size that fits on all current drives. | |
52826846 | 498 | |
c26d78fe N |
499 | Before reducing the size of the array (with |
500 | .BR "\-\-grow \-\-size=" ) | |
501 | you should make sure that space isn't needed. If the device holds a | |
502 | filesystem, you would need to resize the filesystem to use less space. | |
503 | ||
504 | After reducing the array size you should check that the data stored in | |
505 | the device is still available. If the device holds a filesystem, then | |
506 | an 'fsck' of the filesystem is a minimum requirement. If there are | |
507 | problems the array can be made bigger again with no loss with another | |
508 | .B "\-\-grow \-\-size=" | |
509 | command. | |
510 | ||
f24e2d6c | 511 | .TP |
c26d78fe | 512 | .BR \-Z ", " \-\-array\-size= |
f24e2d6c N |
513 | This is only meaningful with |
514 | .B \-\-grow | |
36fad8ec | 515 | and its effect is not persistent: when the array is stopped and |
f24e2d6c N |
516 | restarted the default array size will be restored. |
517 | ||
518 | Setting the array-size causes the array to appear smaller to programs | |
519 | that access the data. This is particularly needed before reshaping an | |
520 | array so that it will be smaller. As the reshape is not reversible, | |
521 | but setting the size with | |
522 | .B \-\-array-size | |
523 | is, it is required that the array size is reduced as appropriate | |
524 | before the number of devices in the array is reduced. | |
525 | ||
c26d78fe N |
526 | Before reducing the size of the array you should make sure that space |
527 | isn't needed. If the device holds a filesystem, you would need to | |
528 | resize the filesystem to use less space. | |
529 | ||
530 | After reducing the array size you should check that the data stored in | |
531 | the device is still available. If the device holds a filesystem, then | |
532 | an 'fsck' of the filesystem is a minimum requirement. If there are | |
533 | problems the array can be made bigger again with no loss with another | |
534 | .B "\-\-grow \-\-array\-size=" | |
535 | command. | |
536 | ||
42e641ab KT |
537 | A suffix of 'K', 'M', 'G' or 'T' can be given to indicate Kilobytes, |
538 | Megabytes, Gigabytes or Terabytes respectively. | |
36fad8ec N |
539 | A value of |
540 | .B max | |
541 | restores the apparent size of the array to be whatever the real | |
542 | amount of available space is. | |
543 | ||
e39c76b9 ZL |
544 | Clustered arrays do not support this parameter yet. |
545 | ||
cd29a5c8 | 546 | .TP |
7e23fc43 | 547 | .BR \-c ", " \-\-chunk= |
1a386f80 | 548 | Specify chunk size in kilobytes. The default when creating an |
5f175898 | 549 | array is 512KB. To ensure compatibility with earlier versions, the |
422da715 | 550 | default when building an array with no persistent metadata is 64KB. |
e0fe762a | 551 | This is only meaningful for RAID0, RAID4, RAID5, RAID6, and RAID10. |
52826846 | 552 | |
a252c078 | 553 | RAID4, RAID5, RAID6, and RAID10 require the chunk size to be a power |
1a386f80 | 554 | of 2, with minimal chunk size being 4KB. |
a252c078 | 555 | |
42e641ab KT |
556 | A suffix of 'K', 'M', 'G' or 'T' can be given to indicate Kilobytes, |
557 | Megabytes, Gigabytes or Terabytes respectively. | |
36fad8ec | 558 | |
cd29a5c8 | 559 | .TP |
7e23fc43 | 560 | .BR \-\-rounding= |
1a386f80 | 561 | Specify the rounding factor for a Linear array. The size of each |
e0fe762a N |
562 | component will be rounded down to a multiple of this size. |
563 | This is a synonym for | |
564 | .B \-\-chunk | |
565 | but highlights the different meaning for Linear as compared to other | |
5f175898 N |
566 | RAID levels. The default is 64K if a kernel earlier than 2.6.16 is in |
567 | use, and is 0K (i.e. no rounding) in later kernels. | |
52826846 | 568 | |
cd29a5c8 | 569 | .TP |
7e23fc43 | 570 | .BR \-l ", " \-\-level= |
e0fe762a | 571 | Set RAID level. When used with |
7e23fc43 | 572 | .BR \-\-create , |
98c6faba | 573 | options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4, |
8fd8d9c4 N |
574 | raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty, container. |
575 | Obviously some of these are synonymous. | |
576 | ||
577 | When a | |
578 | .B CONTAINER | |
579 | metadata type is requested, only the | |
580 | .B container | |
581 | level is permitted, and it does not need to be explicitly given. | |
aa88f531 NB |
582 | |
583 | When used with | |
7e23fc43 | 584 | .BR \-\-build , |
a9d69660 | 585 | only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid. |
52826846 | 586 | |
fd547b50 N |
587 | Can be used with |
588 | .B \-\-grow | |
589 | to change the RAID level in some cases. See LEVEL CHANGES below. | |
2ae555c3 | 590 | |
cd29a5c8 | 591 | .TP |
7e23fc43 | 592 | .BR \-p ", " \-\-layout= |
f24e2d6c N |
593 | This option configures the fine details of data layout for RAID5, RAID6, |
594 | and RAID10 arrays, and controls the failure modes for | |
1a7dfc35 | 595 | .IR faulty . |
329dfc28 N |
596 | It can also be used for working around a kernel bug with RAID0, but generally |
597 | doesn't need to be used explicitly. | |
1a7dfc35 | 598 | |
e0fe762a | 599 | The layout of the RAID5 parity block can be one of |
7e23fc43 PS |
600 | .BR left\-asymmetric , |
601 | .BR left\-symmetric , | |
602 | .BR right\-asymmetric , | |
603 | .BR right\-symmetric , | |
53e8b987 PS |
604 | .BR la ", " ra ", " ls ", " rs . |
605 | The default is | |
7e23fc43 | 606 | .BR left\-symmetric . |
52826846 | 607 | |
cd19c0cf | 608 | It is also possible to cause RAID5 to use a RAID4-like layout by |
e0fe762a N |
609 | choosing |
610 | .BR parity\-first , | |
611 | or | |
612 | .BR parity\-last . | |
613 | ||
614 | Finally for RAID5 there are DDF\-compatible layouts, | |
615 | .BR ddf\-zero\-restart , | |
616 | .BR ddf\-N\-restart , | |
617 | and | |
618 | .BR ddf\-N\-continue . | |
619 | ||
620 | These same layouts are available for RAID6. There are also 4 layouts | |
621 | that will provide an intermediate stage for converting between RAID5 | |
622 | and RAID6. These provide a layout which is identical to the | |
623 | corresponding RAID5 layout on the first N\-1 devices, and has the 'Q' | |
624 | syndrome (the second 'parity' block used by RAID6) on the last device. | |
625 | These layouts are: | |
626 | .BR left\-symmetric\-6 , | |
627 | .BR right\-symmetric\-6 , | |
628 | .BR left\-asymmetric\-6 , | |
629 | .BR right\-asymmetric\-6 , | |
630 | and | |
10adfe9a | 631 | .BR parity\-first\-6 . |
e0fe762a | 632 | |
93e790af SW |
633 | When setting the failure mode for level |
634 | .I faulty, | |
1a7dfc35 | 635 | the options are: |
7e23fc43 PS |
636 | .BR write\-transient ", " wt , |
637 | .BR read\-transient ", " rt , | |
638 | .BR write\-persistent ", " wp , | |
639 | .BR read\-persistent ", " rp , | |
640 | .BR write\-all , | |
641 | .BR read\-fixable ", " rf , | |
53e8b987 | 642 | .BR clear ", " flush ", " none . |
b5e64645 | 643 | |
93e790af | 644 | Each failure mode can be followed by a number, which is used as a period |
b5e64645 NB |
645 | between fault generation. Without a number, the fault is generated |
646 | once on the first relevant request. With a number, the fault will be | |
93e790af | 647 | generated after that many requests, and will continue to be generated |
b5e64645 NB |
648 | every time the period elapses. |
649 | ||
650 | Multiple failure modes can be current simultaneously by using the | |
7e23fc43 | 651 | .B \-\-grow |
53e8b987 | 652 | option to set subsequent failure modes. |
b5e64645 NB |
653 | |
654 | "clear" or "none" will remove any pending or periodic failure modes, | |
2ae555c3 | 655 | and "flush" will clear any persistent faults. |
b5e64645 | 656 | |
329dfc28 | 657 | The layout options for RAID10 are one of 'n', 'o' or 'f' followed |
1a386f80 MG |
658 | by a small number signifying the number of copies of each datablock. |
659 | The default is 'n2'. The supported options are: | |
1a7dfc35 | 660 | |
93e790af | 661 | .I 'n' |
e0fe762a | 662 | signals 'near' copies. Multiple copies of one data block are at |
b578481c NB |
663 | similar offsets in different devices. |
664 | ||
93e790af | 665 | .I 'o' |
b578481c NB |
666 | signals 'offset' copies. Rather than the chunks being duplicated |
667 | within a stripe, whole stripes are duplicated but are rotated by one | |
668 | device so duplicate blocks are on different devices. Thus subsequent | |
669 | copies of a block are in the next drive, and are one chunk further | |
670 | down. | |
671 | ||
93e790af | 672 | .I 'f' |
1a7dfc35 | 673 | signals 'far' copies |
93e790af | 674 | (multiple copies have very different offsets). |
e0fe762a | 675 | See md(4) for more detail about 'near', 'offset', and 'far'. |
1a7dfc35 | 676 | |
1a386f80 | 677 | As for the number of copies of each data block, 2 is normal, 3 |
1a7dfc35 NB |
678 | can be useful. This number can be at most equal to the number of |
679 | devices in the array. It does not need to divide evenly into that | |
680 | number (e.g. it is perfectly legal to have an 'n2' layout for an array | |
681 | with an odd number of devices). | |
682 | ||
329dfc28 N |
683 | A bug introduced in Linux 3.14 means that RAID0 arrays |
684 | .B "with devices of differing sizes" | |
685 | started using a different layout. This could lead to | |
686 | data corruption. Since Linux 5.4 (and various stable releases that received | |
687 | backports), the kernel will not accept such an array unless | |
1a386f80 | 688 | a layout is explicitly set. It can be set to |
329dfc28 N |
689 | .RB ' original ' |
690 | or | |
691 | .RB ' alternate '. | |
692 | When creating a new array, | |
693 | .I mdadm | |
694 | will select | |
695 | .RB ' original ' | |
696 | by default, so the layout does not normally need to be set. | |
697 | An array created for either | |
698 | .RB ' original ' | |
699 | or | |
700 | .RB ' alternate ' | |
701 | will not be recognized by an (unpatched) kernel prior to 5.4. To create | |
702 | a RAID0 array with devices of differing sizes that can be used on an | |
703 | older kernel, you can set the layout to | |
704 | .RB ' dangerous '. | |
705 | This will use whichever layout the running kernel supports, so the data | |
706 | on the array may become corrupt when changing kernel from pre-3.14 to a | |
707 | later kernel. | |
708 | ||
f24e2d6c N |
709 | When an array is converted between RAID5 and RAID6 an intermediate |
710 | RAID6 layout is used in which the second parity block (Q) is always on | |
711 | the last device. To convert a RAID5 to RAID6 and leave it in this new | |
712 | layout (which does not require re-striping) use | |
713 | .BR \-\-layout=preserve . | |
714 | This will try to avoid any restriping. | |
715 | ||
716 | The converse of this is | |
717 | .B \-\-layout=normalise | |
718 | which will change a non-standard RAID6 layout into a more standard | |
719 | arrangement. | |
720 | ||
cd29a5c8 | 721 | .TP |
7e23fc43 | 722 | .BR \-\-parity= |
53e8b987 | 723 | same as |
7e23fc43 | 724 | .B \-\-layout |
53e8b987 | 725 | (thus explaining the p of |
7e23fc43 | 726 | .BR \-p ). |
52826846 | 727 | |
e793c2e5 | 728 | .TP |
7e23fc43 | 729 | .BR \-b ", " \-\-bitmap= |
e793c2e5 | 730 | Specify a file to store a write-intent bitmap in. The file should not |
53e8b987 | 731 | exist unless |
7e23fc43 | 732 | .B \-\-force |
53e8b987 | 733 | is also given. The same file should be provided |
2ae555c3 | 734 | when assembling the array. If the word |
93e790af | 735 | .B "internal" |
2ae555c3 NB |
736 | is given, then the bitmap is stored with the metadata on the array, |
737 | and so is replicated on all devices. If the word | |
93e790af | 738 | .B "none" |
2ae555c3 | 739 | is given with |
7e23fc43 | 740 | .B \-\-grow |
95a05b37 GJ |
741 | mode, then any bitmap that is present is removed. If the word |
742 | .B "clustered" | |
743 | is given, the array is created for a clustered environment. One bitmap | |
744 | is created for each node as defined by the | |
745 | .B \-\-nodes | |
746 | parameter and are stored internally. | |
e793c2e5 | 747 | |
2ae555c3 NB |
748 | To help catch typing errors, the filename must contain at least one |
749 | slash ('/') if it is a real file (not 'internal' or 'none'). | |
750 | ||
751 | Note: external bitmaps are only known to work on ext2 and ext3. | |
752 | Storing bitmap files on other filesystems may result in serious problems. | |
e793c2e5 | 753 | |
748952f7 N |
754 | When creating an array on devices which are 100G or larger, |
755 | .I mdadm | |
756 | automatically adds an internal bitmap as it will usually be | |
757 | beneficial. This can be suppressed with | |
5308f117 AP |
758 | .B "\-\-bitmap=none" |
759 | or by selecting a different consistency policy with | |
760 | .BR \-\-consistency\-policy . | |
748952f7 | 761 | |
cd29a5c8 | 762 | .TP |
7e23fc43 | 763 | .BR \-\-bitmap\-chunk= |
1a386f80 | 764 | Set the chunk size of the bitmap. Each bit corresponds to that many |
1bfdbe01 | 765 | Kilobytes of storage. |
1a386f80 MG |
766 | When using a file-based bitmap, the default is to use the smallest |
767 | size that is at least 4 and requires no more than 2^21 chunks. | |
2ae555c3 NB |
768 | When using an |
769 | .B internal | |
1a386f80 | 770 | bitmap, the chunk size defaults to 64Meg, or larger if necessary to |
b8ab2a50 | 771 | fit the bitmap into the available space. |
5787fa49 | 772 | |
42e641ab KT |
773 | A suffix of 'K', 'M', 'G' or 'T' can be given to indicate Kilobytes, |
774 | Megabytes, Gigabytes or Terabytes respectively. | |
36fad8ec | 775 | |
cd29a5c8 | 776 | .TP |
7e23fc43 | 777 | .BR \-W ", " \-\-write\-mostly |
e0fe762a | 778 | subsequent devices listed in a |
7e23fc43 PS |
779 | .BR \-\-build , |
780 | .BR \-\-create , | |
2ae555c3 | 781 | or |
7e23fc43 | 782 | .B \-\-add |
71574efb | 783 | command will be flagged as 'write\-mostly'. This is valid for RAID1 |
2ae555c3 NB |
784 | only and means that the 'md' driver will avoid reading from these |
785 | devices if at all possible. This can be useful if mirroring over a | |
786 | slow link. | |
52826846 | 787 | |
2ae555c3 | 788 | .TP |
7e23fc43 | 789 | .BR \-\-write\-behind= |
2ae555c3 | 790 | Specify that write-behind mode should be enabled (valid for RAID1 |
e0fe762a N |
791 | only). If an argument is specified, it will set the maximum number |
792 | of outstanding writes allowed. The default value is 256. | |
2ae555c3 NB |
793 | A write-intent bitmap is required in order to use write-behind |
794 | mode, and write-behind is only attempted on drives marked as | |
795 | .IR write-mostly . | |
dd0781e5 | 796 | |
71574efb N |
797 | .TP |
798 | .BR \-\-failfast | |
799 | subsequent devices listed in a | |
800 | .B \-\-create | |
801 | or | |
802 | .B \-\-add | |
803 | command will be flagged as 'failfast'. This is valid for RAID1 and | |
804 | RAID10 only. IO requests to these devices will be encouraged to fail | |
805 | quickly rather than cause long delays due to error handling. Also no | |
806 | attempt is made to repair a read error on these devices. | |
807 | ||
808 | If an array becomes degraded so that the 'failfast' device is the only | |
809 | usable device, the 'failfast' flag will then be ignored and extended | |
810 | delays will be preferred to complete failure. | |
811 | ||
812 | The 'failfast' flag is appropriate for storage arrays which have a | |
813 | low probability of true failure, but which may sometimes | |
814 | cause unacceptable delays due to internal maintenance functions. | |
815 | ||
dd0781e5 | 816 | .TP |
7e23fc43 | 817 | .BR \-\-assume\-clean |
dd0781e5 NB |
818 | Tell |
819 | .I mdadm | |
47d79ef8 NB |
820 | that the array pre-existed and is known to be clean. It can be useful |
821 | when trying to recover from a major failure as you can be sure that no | |
822 | data will be affected unless you actually write to the array. It can | |
823 | also be used when creating a RAID1 or RAID10 if you want to avoid the | |
b3f1c093 | 824 | initial resync, however this practice \(em while normally safe \(em is not |
e0fe762a | 825 | recommended. Use this only if you really know what you are doing. |
6acad481 ME |
826 | .IP |
827 | When the devices that will be part of a new array were filled | |
828 | with zeros before creation the operator knows the array is | |
829 | actually clean. If that is the case, such as after running | |
830 | badblocks, this argument can be used to tell mdadm the | |
831 | facts the operator knows. | |
ce52f92f N |
832 | .IP |
833 | When an array is resized to a larger size with | |
834 | .B "\-\-grow \-\-size=" | |
835 | the new space is normally resynced in that same way that the whole | |
6cbf8fb8 | 836 | array is resynced at creation. From Linux version 3.0, |
ce52f92f N |
837 | .B \-\-assume\-clean |
838 | can be used with that command to avoid the automatic resync. | |
dd0781e5 | 839 | |
33831d84 LG |
840 | .TP |
841 | .BR \-\-write-zeroes | |
842 | When creating an array, send write zeroes requests to all the block | |
843 | devices. This should zero the data area on all disks such that the | |
844 | initial sync is not necessary and, if successfull, will behave | |
845 | as if | |
846 | .B \-\-assume\-clean | |
847 | was specified. | |
848 | .IP | |
849 | This is intended for use with devices that have hardware offload for | |
850 | zeroing, but despite this zeroing can still take several minutes for | |
851 | large disks. Thus a message is printed before and after zeroing and | |
852 | each disk is zeroed in parallel with the others. | |
853 | .IP | |
854 | This is only meaningful with --create. | |
855 | ||
2ae555c3 | 856 | .TP |
7e23fc43 | 857 | .BR \-\-backup\-file= |
53e8b987 | 858 | This is needed when |
7e23fc43 | 859 | .B \-\-grow |
1a386f80 | 860 | is used to increase the number of raid devices in a RAID5 or RAID6 if |
cd19c0cf JR |
861 | there are no spare devices available, or to shrink, change RAID level |
862 | or layout. See the GROW MODE section below on RAID\-DEVICES CHANGES. | |
863 | The file must be stored on a separate device, not on the RAID array | |
864 | being reshaped. | |
2ae555c3 | 865 | |
40c9a66a N |
866 | .TP |
867 | .B \-\-data\-offset= | |
868 | Arrays with 1.x metadata can leave a gap between the start of the | |
869 | device and the start of array data. This gap can be used for various | |
870 | metadata. The start of data is known as the | |
871 | .IR data\-offset . | |
872 | Normally an appropriate data offset is computed automatically. | |
873 | However it can be useful to set it explicitly such as when re-creating | |
874 | an array which was originally created using a different version of | |
875 | .I mdadm | |
876 | which computed a different offset. | |
877 | ||
878 | Setting the offset explicitly over-rides the default. The value given | |
42e641ab KT |
879 | is in Kilobytes unless a suffix of 'K', 'M', 'G' or 'T' is used to explicitly |
880 | indicate Kilobytes, Megabytes, Gigabytes or Terabytes respectively. | |
40c9a66a N |
881 | |
882 | Since Linux 3.4, | |
883 | .B \-\-data\-offset | |
884 | can also be used with | |
885 | .B --grow | |
886 | for some RAID levels (initially on RAID10). This allows the | |
72ca9bcf | 887 | data\-offset to be changed as part of the reshape process. When the |
40c9a66a N |
888 | data offset is changed, no backup file is required as the difference |
889 | in offsets is used to provide the same functionality. | |
890 | ||
891 | When the new offset is earlier than the old offset, the number of | |
892 | devices in the array cannot shrink. When it is after the old offset, | |
893 | the number of devices in the array cannot increase. | |
894 | ||
72ca9bcf N |
895 | When creating an array, |
896 | .B \-\-data\-offset | |
897 | can be specified as | |
898 | .BR variable . | |
1a386f80 | 899 | In the case each member device is expected to have an offset appended |
72ca9bcf N |
900 | to the name, separated by a colon. This makes it possible to recreate |
901 | exactly an array which has varying data offsets (as can happen when | |
902 | different versions of | |
903 | .I mdadm | |
904 | are used to add different devices). | |
905 | ||
f211a137 AK |
906 | .TP |
907 | .BR \-\-continue | |
908 | This option is complementary to the | |
909 | .B \-\-freeze-reshape | |
910 | option for assembly. It is needed when | |
911 | .B \-\-grow | |
912 | operation is interrupted and it is not restarted automatically due to | |
913 | .B \-\-freeze-reshape | |
914 | usage during array assembly. This option is used together with | |
915 | .BR \-G | |
916 | , ( | |
917 | .BR \-\-grow | |
918 | ) command and device for a pending reshape to be continued. | |
919 | All parameters required for reshape continuation will be read from array metadata. | |
920 | If initial | |
921 | .BR \-\-grow | |
922 | command had required | |
923 | .BR \-\-backup\-file= | |
924 | option to be set, continuation option will require to have exactly the same | |
925 | backup file given as well. | |
926 | .IP | |
927 | Any other parameter passed together with | |
928 | .BR \-\-continue | |
929 | option will be ignored. | |
930 | ||
947fd4dd | 931 | .TP |
7e23fc43 | 932 | .BR \-N ", " \-\-name= |
947fd4dd NB |
933 | Set a |
934 | .B name | |
e2eb503b MT |
935 | for the array. It must be |
936 | .BR "POSIX PORTABLE NAME" | |
937 | compatible and cannot be longer than 32 chars. This is effective when creating an array | |
938 | with a v1 metadata, or an external array. | |
939 | ||
940 | If name is needed but not specified, it is taken from the basename of the device | |
941 | that is being created. See | |
942 | .BR "DEVICE NAMES" | |
947fd4dd | 943 | |
dd0781e5 | 944 | .TP |
7e23fc43 | 945 | .BR \-R ", " \-\-run |
dd0781e5 NB |
946 | Insist that |
947 | .I mdadm | |
948 | run the array, even if some of the components | |
949 | appear to be active in another array or filesystem. Normally | |
950 | .I mdadm | |
951 | will ask for confirmation before including such components in an | |
952 | array. This option causes that question to be suppressed. | |
953 | ||
954 | .TP | |
7e23fc43 | 955 | .BR \-f ", " \-\-force |
dd0781e5 NB |
956 | Insist that |
957 | .I mdadm | |
958 | accept the geometry and layout specified without question. Normally | |
959 | .I mdadm | |
1a386f80 | 960 | will not allow the creation of an array with only one device, and will try |
e0fe762a | 961 | to create a RAID5 array with one missing drive (as this makes the |
dd0781e5 | 962 | initial resync work faster). With |
7e23fc43 | 963 | .BR \-\-force , |
dd0781e5 NB |
964 | .I mdadm |
965 | will not try to be so clever. | |
966 | ||
0ea8f5b1 N |
967 | .TP |
968 | .BR \-o ", " \-\-readonly | |
969 | Start the array | |
970 | .B read only | |
971 | rather than read-write as normal. No writes will be allowed to the | |
8a70632f ZL |
972 | array, and no resync, recovery, or reshape will be started. It works with |
973 | Create, Assemble, Manage and Misc mode. | |
0ea8f5b1 | 974 | |
dd0781e5 | 975 | .TP |
257c1dc2 N |
976 | .BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}" |
977 | Instruct mdadm how to create the device file if needed, possibly allocating | |
48f7b27a | 978 | an unused minor number. "md" causes a non-partitionable array |
257c1dc2 N |
979 | to be used (though since Linux 2.6.28, these array devices are in fact |
980 | partitionable). "mdp", "part" or "p" causes a partitionable array (2.6 and | |
2ae555c3 | 981 | later) to be used. "yes" requires the named md device to have |
f9c25f1d | 982 | a 'standard' format, and the type and minor number will be determined |
257c1dc2 N |
983 | from this. With mdadm 3.0, device creation is normally left up to |
984 | .I udev | |
985 | so this option is unlikely to be needed. | |
986 | See DEVICE NAMES below. | |
48f7b27a | 987 | |
a9d69660 | 988 | The argument can also come immediately after |
7e23fc43 | 989 | "\-a". e.g. "\-ap". |
dd0781e5 | 990 | |
53e8b987 | 991 | If |
7e23fc43 | 992 | .B \-\-auto |
53e8b987 | 993 | is not given on the command line or in the config file, then |
75723446 | 994 | the default will be |
7e23fc43 | 995 | .BR \-\-auto=yes . |
75723446 | 996 | |
1337546d | 997 | If |
7e23fc43 | 998 | .B \-\-scan |
1337546d NB |
999 | is also given, then any |
1000 | .I auto= | |
35cc5be4 | 1001 | entries in the config file will override the |
7e23fc43 | 1002 | .B \-\-auto |
1337546d NB |
1003 | instruction given on the command line. |
1004 | ||
dd0781e5 NB |
1005 | For partitionable arrays, |
1006 | .I mdadm | |
1007 | will create the device file for the whole array and for the first 4 | |
1008 | partitions. A different number of partitions can be specified at the | |
1009 | end of this option (e.g. | |
7e23fc43 | 1010 | .BR \-\-auto=p7 ). |
2ae555c3 | 1011 | If the device name ends with a digit, the partition names add a 'p', |
e0fe762a N |
1012 | and a number, e.g. |
1013 | .IR /dev/md/home1p3 . | |
1014 | If there is no trailing digit, then the partition names just have a | |
1015 | number added, e.g. | |
1016 | .IR /dev/md/scratch3 . | |
dd0781e5 | 1017 | |
48f7b27a NB |
1018 | If the md device name is in a 'standard' format as described in DEVICE |
1019 | NAMES, then it will be created, if necessary, with the appropriate | |
e0fe762a | 1020 | device number based on that name. If the device name is not in one of these |
1a386f80 | 1021 | formats, then an unused device number will be allocated. The device |
48f7b27a NB |
1022 | number will be considered unused if there is no active array for that |
1023 | number, and there is no entry in /dev for that number and with a | |
e0fe762a | 1024 | non-standard name. Names that are not in 'standard' format are only |
8fd8d9c4 N |
1025 | allowed in "/dev/md/". |
1026 | ||
3c7efacb NK |
1027 | This is meaningful with |
1028 | .B \-\-create | |
1029 | or | |
1030 | .BR \-\-build . | |
1031 | ||
3c7efacb NK |
1032 | .TP |
1033 | .BR \-a ", " "\-\-add" | |
1034 | This option can be used in Grow mode in two cases. | |
1035 | ||
1036 | If the target array is a Linear array, then | |
1037 | .B \-\-add | |
1038 | can be used to add one or more devices to the array. They | |
1039 | are simply catenated on to the end of the array. Once added, the | |
1040 | devices cannot be removed. | |
1041 | ||
1042 | If the | |
1043 | .B \-\-raid\-disks | |
1044 | option is being used to increase the number of devices in an array, | |
1045 | then | |
1046 | .B \-\-add | |
1047 | can be used to add some extra devices to be included in the array. | |
1048 | In most cases this is not needed as the extra devices can be added as | |
1a386f80 MG |
1049 | spares first, and then the number of raid disks can be changed. |
1050 | However, for RAID0 it is not possible to add spares. So to increase | |
3c7efacb NK |
1051 | the number of devices in a RAID0, it is necessary to set the new |
1052 | number of devices, and to add the new devices, in the same command. | |
1053 | ||
529e2aa5 GJ |
1054 | .TP |
1055 | .BR \-\-nodes | |
1a386f80 | 1056 | Only works when the array is created for a clustered environment. It specifies |
529e2aa5 GJ |
1057 | the maximum number of nodes in the cluster that will use this device |
1058 | simultaneously. If not specified, this defaults to 4. | |
1059 | ||
28d74446 SL |
1060 | .TP |
1061 | .BR \-\-write-journal | |
1062 | Specify journal device for the RAID-4/5/6 array. The journal device | |
1a386f80 | 1063 | should be an SSD with a reasonable lifetime. |
28d74446 | 1064 | |
5308f117 AP |
1065 | .TP |
1066 | .BR \-k ", " \-\-consistency\-policy= | |
1a386f80 | 1067 | Specify how the array maintains consistency in the case of an unexpected shutdown. |
5308f117 AP |
1068 | Only relevant for RAID levels with redundancy. |
1069 | Currently supported options are: | |
1070 | .RS | |
1071 | ||
1072 | .TP | |
1073 | .B resync | |
1074 | Full resync is performed and all redundancy is regenerated when the array is | |
1a386f80 | 1075 | started after an unclean shutdown. |
5308f117 AP |
1076 | |
1077 | .TP | |
1078 | .B bitmap | |
1079 | Resync assisted by a write-intent bitmap. Implicitly selected when using | |
1080 | .BR \-\-bitmap . | |
1081 | ||
1082 | .TP | |
1083 | .B journal | |
1a386f80 MG |
1084 | For RAID levels 4/5/6, the journal device is used to log transactions and replay |
1085 | after an unclean shutdown. Implicitly selected when using | |
5308f117 AP |
1086 | .BR \-\-write\-journal . |
1087 | ||
1088 | .TP | |
1089 | .B ppl | |
1090 | For RAID5 only, Partial Parity Log is used to close the write hole and | |
1091 | eliminate resync. PPL is stored in the metadata region of RAID member drives, | |
1092 | no additional journal drive is needed. | |
860f11ed AP |
1093 | |
1094 | .PP | |
1095 | Can be used with \-\-grow to change the consistency policy of an active array | |
1096 | in some cases. See CONSISTENCY POLICY CHANGES below. | |
5308f117 AP |
1097 | .RE |
1098 | ||
28d74446 | 1099 | |
52826846 NB |
1100 | .SH For assemble: |
1101 | ||
cd29a5c8 | 1102 | .TP |
7e23fc43 | 1103 | .BR \-u ", " \-\-uuid= |
e0fe762a | 1104 | uuid of array to assemble. Devices which don't have this uuid are |
cd29a5c8 NB |
1105 | excluded |
1106 | ||
1107 | .TP | |
7e23fc43 | 1108 | .BR \-m ", " \-\-super\-minor= |
cd29a5c8 NB |
1109 | Minor number of device that array was created for. Devices which |
1110 | don't have this minor number are excluded. If you create an array as | |
2d465520 | 1111 | /dev/md1, then all superblocks will contain the minor number 1, even if |
cd29a5c8 NB |
1112 | the array is later assembled as /dev/md2. |
1113 | ||
d013a55e | 1114 | Giving the literal word "dev" for |
7e23fc43 | 1115 | .B \-\-super\-minor |
d013a55e NB |
1116 | will cause |
1117 | .I mdadm | |
1118 | to use the minor number of the md device that is being assembled. | |
1119 | e.g. when assembling | |
1120 | .BR /dev/md0 , | |
51ac42e3 | 1121 | .B \-\-super\-minor=dev |
d013a55e NB |
1122 | will look for super blocks with a minor number of 0. |
1123 | ||
e0fe762a N |
1124 | .B \-\-super\-minor |
1125 | is only relevant for v0.90 metadata, and should not normally be used. | |
1126 | Using | |
1127 | .B \-\-uuid | |
1128 | is much safer. | |
1129 | ||
947fd4dd | 1130 | .TP |
7e23fc43 | 1131 | .BR \-N ", " \-\-name= |
e2eb503b MT |
1132 | Specify the name of the array to assemble. It must be |
1133 | .BR "POSIX PORTABLE NAME" | |
1134 | compatible and cannot be longer than 32 chars. This must be the name | |
1135 | that was specified when creating the array. It must either match | |
93e790af | 1136 | the name stored in the superblock exactly, or it must match |
41a3b72a | 1137 | with the current |
624920bb | 1138 | .I homehost |
93e790af | 1139 | prefixed to the start of the given name. |
947fd4dd | 1140 | |
cd29a5c8 | 1141 | .TP |
7e23fc43 | 1142 | .BR \-f ", " \-\-force |
e0fe762a N |
1143 | Assemble the array even if the metadata on some devices appears to be |
1144 | out-of-date. If | |
1145 | .I mdadm | |
1146 | cannot find enough working devices to start the array, but can find | |
1147 | some devices that are recorded as having failed, then it will mark | |
92a647c8 MT |
1148 | those devices as working so that the array can be started. This works only for |
1149 | native. For external metadata it allows to start dirty degraded RAID 4, 5, 6. | |
e0fe762a N |
1150 | An array which requires |
1151 | .B \-\-force | |
1152 | to be started may contain data corruption. Use it carefully. | |
52826846 | 1153 | |
cd29a5c8 | 1154 | .TP |
7e23fc43 | 1155 | .BR \-R ", " \-\-run |
b8a8ccf9 NB |
1156 | Attempt to start the array even if fewer drives were given than were |
1157 | present last time the array was active. Normally if not all the | |
1158 | expected drives are found and | |
7e23fc43 | 1159 | .B \-\-scan |
cd29a5c8 NB |
1160 | is not used, then the array will be assembled but not started. |
1161 | With | |
7e23fc43 | 1162 | .B \-\-run |
cd29a5c8 | 1163 | an attempt will be made to start it anyway. |
52826846 | 1164 | |
b8a8ccf9 | 1165 | .TP |
7e23fc43 | 1166 | .B \-\-no\-degraded |
b8a8ccf9 | 1167 | This is the reverse of |
7e23fc43 | 1168 | .B \-\-run |
93e790af | 1169 | in that it inhibits the startup of array unless all expected drives |
b8a8ccf9 | 1170 | are present. This is only needed with |
93e790af SW |
1171 | .B \-\-scan, |
1172 | and can be used if the physical connections to devices are | |
b8a8ccf9 NB |
1173 | not as reliable as you would like. |
1174 | ||
dd0781e5 | 1175 | .TP |
7e23fc43 | 1176 | .BR \-a ", " "\-\-auto{=no,yes,md,mdp,part}" |
dd0781e5 NB |
1177 | See this option under Create and Build options. |
1178 | ||
e793c2e5 | 1179 | .TP |
7e23fc43 | 1180 | .BR \-b ", " \-\-bitmap= |
2ae555c3 NB |
1181 | Specify the bitmap file that was given when the array was created. If |
1182 | an array has an | |
1183 | .B internal | |
1184 | bitmap, there is no need to specify this when assembling the array. | |
1185 | ||
1186 | .TP | |
7e23fc43 | 1187 | .BR \-\-backup\-file= |
2ae555c3 | 1188 | If |
7e23fc43 | 1189 | .B \-\-backup\-file |
87f26d14 N |
1190 | was used while reshaping an array (e.g. changing number of devices or |
1191 | chunk size) and the system crashed during the critical section, then the same | |
7e23fc43 | 1192 | .B \-\-backup\-file |
53e8b987 | 1193 | must be presented to |
7e23fc43 | 1194 | .B \-\-assemble |
cd19c0cf JR |
1195 | to allow possibly corrupted data to be restored, and the reshape |
1196 | to be completed. | |
e793c2e5 | 1197 | |
87f26d14 N |
1198 | .TP |
1199 | .BR \-\-invalid\-backup | |
1200 | If the file needed for the above option is not available for any | |
1201 | reason an empty file can be given together with this option to | |
1202 | indicate that the backup file is invalid. In this case the data that | |
1203 | was being rearranged at the time of the crash could be irrecoverably | |
1204 | lost, but the rest of the array may still be recoverable. This option | |
1205 | should only be used as a last resort if there is no way to recover the | |
1206 | backup file. | |
1207 | ||
1208 | ||
5787fa49 | 1209 | .TP |
7e23fc43 | 1210 | .BR \-U ", " \-\-update= |
5787fa49 | 1211 | Update the superblock on each device while assembling the array. The |
feb716e9 NB |
1212 | argument given to this flag can be one of |
1213 | .BR sparc2.2 , | |
1214 | .BR summaries , | |
7d99579f | 1215 | .BR uuid , |
c4f12c13 | 1216 | .BR name , |
7e6e839a | 1217 | .BR nodes , |
0237e0ca | 1218 | .BR homehost , |
0aa2f15b | 1219 | .BR home-cluster , |
e5329c37 | 1220 | .BR resync , |
586ed405 | 1221 | .BR byteorder , |
bee8ec56 | 1222 | .BR devicesize , |
5a31170d | 1223 | .BR no\-bitmap , |
688e99a7 | 1224 | .BR bbl , |
47120ad5 | 1225 | .BR no\-bbl , |
e6e9dd3f AP |
1226 | .BR ppl , |
1227 | .BR no\-ppl , | |
027c099f N |
1228 | .BR layout\-original , |
1229 | .BR layout\-alternate , | |
97b51a2c | 1230 | .BR layout\-unspecified , |
afa368f4 | 1231 | .BR metadata , |
5787fa49 | 1232 | or |
7e23fc43 | 1233 | .BR super\-minor . |
5787fa49 NB |
1234 | |
1235 | The | |
1236 | .B sparc2.2 | |
7d99579f | 1237 | option will adjust the superblock of an array what was created on a Sparc |
5787fa49 NB |
1238 | machine running a patched 2.2 Linux kernel. This kernel got the |
1239 | alignment of part of the superblock wrong. You can use the | |
7e23fc43 | 1240 | .B "\-\-examine \-\-sparc2.2" |
5787fa49 NB |
1241 | option to |
1242 | .I mdadm | |
1243 | to see what effect this would have. | |
1244 | ||
1245 | The | |
7e23fc43 | 1246 | .B super\-minor |
5787fa49 | 1247 | option will update the |
2ae555c3 | 1248 | .B "preferred minor" |
5787fa49 | 1249 | field on each superblock to match the minor number of the array being |
45c073c9 NB |
1250 | assembled. |
1251 | This can be useful if | |
7e23fc43 | 1252 | .B \-\-examine |
45c073c9 | 1253 | reports a different "Preferred Minor" to |
7e23fc43 | 1254 | .BR \-\-detail . |
45c073c9 | 1255 | In some cases this update will be performed automatically |
1a386f80 | 1256 | by the kernel driver. In particular, the update happens automatically |
45c073c9 NB |
1257 | at the first write to an array with redundancy (RAID level 1 or |
1258 | greater) on a 2.6 (or later) kernel. | |
5787fa49 | 1259 | |
7d99579f NB |
1260 | The |
1261 | .B uuid | |
1262 | option will change the uuid of the array. If a UUID is given with the | |
7e23fc43 | 1263 | .B \-\-uuid |
53e8b987 | 1264 | option that UUID will be used as a new UUID and will |
7d99579f NB |
1265 | .B NOT |
1266 | be used to help identify the devices in the array. | |
53e8b987 | 1267 | If no |
7e23fc43 | 1268 | .B \-\-uuid |
53e8b987 | 1269 | is given, a random UUID is chosen. |
7d99579f | 1270 | |
c4f12c13 NB |
1271 | The |
1272 | .B name | |
1273 | option will change the | |
1274 | .I name | |
b3774a48 GJ |
1275 | of the array as stored in the superblock. This is only supported for |
1276 | version-1 superblocks. | |
7e6e839a GJ |
1277 | |
1278 | The | |
1279 | .B nodes | |
1280 | option will change the | |
1281 | .I nodes | |
b3774a48 GJ |
1282 | of the array as stored in the bitmap superblock. This option only |
1283 | works for a clustered environment. | |
c4f12c13 | 1284 | |
0237e0ca NB |
1285 | The |
1286 | .B homehost | |
1287 | option will change the | |
1288 | .I homehost | |
1289 | as recorded in the superblock. For version-0 superblocks, this is the | |
1290 | same as updating the UUID. | |
1291 | For version-1 superblocks, this involves updating the name. | |
1292 | ||
0aa2f15b GJ |
1293 | The |
1294 | .B home\-cluster | |
1295 | option will change the cluster name as recorded in the superblock and | |
1a386f80 | 1296 | bitmap. This option only works for a clustered environment. |
0aa2f15b | 1297 | |
e5329c37 NB |
1298 | The |
1299 | .B resync | |
1300 | option will cause the array to be marked | |
1301 | .I dirty | |
e0fe762a N |
1302 | meaning that any redundancy in the array (e.g. parity for RAID5, |
1303 | copies for RAID1) may be incorrect. This will cause the RAID system | |
e5329c37 NB |
1304 | to perform a "resync" pass to make sure that all redundant information |
1305 | is correct. | |
1306 | ||
586ed405 NB |
1307 | The |
1308 | .B byteorder | |
1309 | option allows arrays to be moved between machines with different | |
4224685f N |
1310 | byte-order, such as from a big-endian machine like a Sparc or some |
1311 | MIPS machines, to a little-endian x86_64 machine. | |
2ae555c3 | 1312 | When assembling such an array for the first time after a move, giving |
7e23fc43 | 1313 | .B "\-\-update=byteorder" |
586ed405 NB |
1314 | will cause |
1315 | .I mdadm | |
1316 | to expect superblocks to have their byteorder reversed, and will | |
1317 | correct that order before assembling the array. This is only valid | |
2ae555c3 | 1318 | with original (Version 0.90) superblocks. |
586ed405 | 1319 | |
feb716e9 NB |
1320 | The |
1321 | .B summaries | |
e0fe762a | 1322 | option will correct the summaries in the superblock. That is the |
feb716e9 | 1323 | counts of total, working, active, failed, and spare devices. |
5787fa49 | 1324 | |
bee8ec56 NB |
1325 | The |
1326 | .B devicesize | |
5a31170d | 1327 | option will rarely be of use. It applies to version 1.1 and 1.2 metadata |
bee8ec56 NB |
1328 | only (where the metadata is at the start of the device) and is only |
1329 | useful when the component device has changed size (typically become | |
1330 | larger). The version 1 metadata records the amount of the device that | |
1331 | can be used to store data, so if a device in a version 1.1 or 1.2 | |
1332 | array becomes larger, the metadata will still be visible, but the | |
1333 | extra space will not. In this case it might be useful to assemble the | |
1334 | array with | |
7e23fc43 | 1335 | .BR \-\-update=devicesize . |
bee8ec56 NB |
1336 | This will cause |
1337 | .I mdadm | |
1338 | to determine the maximum usable amount of space on each device and | |
1339 | update the relevant field in the metadata. | |
1340 | ||
afa368f4 N |
1341 | The |
1342 | .B metadata | |
1343 | option only works on v0.90 metadata arrays and will convert them to | |
1344 | v1.0 metadata. The array must not be dirty (i.e. it must not need a | |
1345 | sync) and it must not have a write-intent bitmap. | |
1346 | ||
1347 | The old metadata will remain on the devices, but will appear older | |
1348 | than the new metadata and so will usually be ignored. The old metadata | |
1349 | (or indeed the new metadata) can be removed by giving the appropriate | |
1350 | .B \-\-metadata= | |
1351 | option to | |
1352 | .BR \-\-zero\-superblock . | |
1353 | ||
5a31170d N |
1354 | The |
1355 | .B no\-bitmap | |
1356 | option can be used when an array has an internal bitmap which is | |
1357 | corrupt in some way so that assembling the array normally fails. It | |
1358 | will cause any internal bitmap to be ignored. | |
1359 | ||
688e99a7 N |
1360 | The |
1361 | .B bbl | |
1362 | option will reserve space in each device for a bad block list. This | |
1363 | will be 4K in size and positioned near the end of any free space | |
1364 | between the superblock and the data. | |
1365 | ||
1366 | The | |
1367 | .B no\-bbl | |
1368 | option will cause any reservation of space for a bad block list to be | |
1369 | removed. If the bad block list contains entries, this will fail, as | |
1370 | removing the list could cause data corruption. | |
1371 | ||
e6e9dd3f AP |
1372 | The |
1373 | .B ppl | |
1374 | option will enable PPL for a RAID5 array and reserve space for PPL on each | |
1375 | device. There must be enough free space between the data and superblock and a | |
1376 | write-intent bitmap or journal must not be used. | |
1377 | ||
1378 | The | |
1379 | .B no\-ppl | |
1380 | option will disable PPL in the superblock. | |
1381 | ||
027c099f N |
1382 | The |
1383 | .B layout\-original | |
1384 | and | |
1385 | .B layout\-alternate | |
97b51a2c N |
1386 | options are for RAID0 arrays with non-uniform devices size that were in |
1387 | use before Linux 5.4. If the array was being used with Linux 3.13 or | |
33831d84 | 1388 | earlier, then to assemble the array on a new kernel, |
027c099f N |
1389 | .B \-\-update=layout\-original |
1390 | must be given. If the array was created and used with a kernel from Linux 3.14 to | |
1391 | Linux 5.3, then | |
1392 | .B \-\-update=layout\-alternate | |
1393 | must be given. This only needs to be given once. Subsequent assembly of the array | |
1394 | will happen normally. | |
1395 | For more information, see | |
1396 | .IR md (4). | |
1397 | ||
97b51a2c N |
1398 | The |
1399 | .B layout\-unspecified | |
1400 | option reverts the effect of | |
1401 | .B layout\-orignal | |
1402 | or | |
1403 | .B layout\-alternate | |
1404 | and allows the array to be again used on a kernel prior to Linux 5.3. | |
1405 | This option should be used with great caution. | |
1406 | ||
afd0a969 AK |
1407 | .TP |
1408 | .BR \-\-freeze\-reshape | |
1a386f80 MG |
1409 | This option is intended to be used in start-up scripts during the initrd boot phase. |
1410 | When the array under reshape is assembled during the initrd phase, this option | |
1411 | stops the reshape after the reshape-critical section has been restored. This happens | |
1412 | before the file system pivot operation and avoids loss of filesystem context. | |
afd0a969 AK |
1413 | Losing file system context would cause reshape to be broken. |
1414 | ||
a6482415 N |
1415 | Reshape can be continued later using the |
1416 | .B \-\-continue | |
1417 | option for the grow command. | |
afd0a969 | 1418 | |
e0d19036 | 1419 | .SH For Manage mode: |
52826846 | 1420 | |
3d5279b0 N |
1421 | .TP |
1422 | .BR \-t ", " \-\-test | |
1423 | Unless a more serious error occurred, | |
1424 | .I mdadm | |
1425 | will exit with a status of 2 if no changes were made to the array and | |
1426 | 0 if at least one change was made. | |
1427 | This can be useful when an indirect specifier such as | |
1428 | .BR missing , | |
1429 | .B detached | |
1430 | or | |
1431 | .B faulty | |
1432 | is used in requesting an operation on the array. | |
1433 | .B \-\-test | |
1434 | will report failure if these specifiers didn't find any match. | |
1435 | ||
cd29a5c8 | 1436 | .TP |
7e23fc43 | 1437 | .BR \-a ", " \-\-add |
3d5279b0 N |
1438 | hot-add listed devices. |
1439 | If a device appears to have recently been part of the array | |
342460cb | 1440 | (possibly it failed or was removed) the device is re\-added as described |
3d5279b0 N |
1441 | in the next point. |
1442 | If that fails or the device was never part of the array, the device is | |
1443 | added as a hot-spare. | |
1444 | If the array is degraded, it will immediately start to rebuild data | |
1445 | onto that spare. | |
1446 | ||
1447 | Note that this and the following options are only meaningful on array | |
1448 | with redundancy. They don't apply to RAID0 or Linear. | |
52826846 | 1449 | |
fe80f49b | 1450 | .TP |
7e23fc43 | 1451 | .BR \-\-re\-add |
eae6b036 | 1452 | re\-add a device that was previously removed from an array. |
3d5279b0 N |
1453 | If the metadata on the device reports that it is a member of the |
1454 | array, and the slot that it used is still vacant, then the device will | |
1455 | be added back to the array in the same position. This will normally | |
1a386f80 | 1456 | cause the data for that device to be recovered. However, based on the |
3d5279b0 | 1457 | event count on the device, the recovery may only require sections that |
1a386f80 | 1458 | are flagged by a write-intent bitmap to be recovered or may not require |
3d5279b0 N |
1459 | any recovery at all. |
1460 | ||
1461 | When used on an array that has no metadata (i.e. it was built with | |
1462 | .BR \-\-build) | |
1463 | it will be assumed that bitmap-based recovery is enough to make the | |
1464 | device fully consistent with the array. | |
fe80f49b | 1465 | |
833bb0f8 | 1466 | .B \-\-re\-add |
1a386f80 | 1467 | can also be accompanied by |
688e99a7 N |
1468 | .BR \-\-update=devicesize , |
1469 | .BR \-\-update=bbl ", or" | |
1470 | .BR \-\-update=no\-bbl . | |
1a386f80 | 1471 | See descriptions of these options when used in Assemble mode for an |
688e99a7 | 1472 | explanation of their use. |
833bb0f8 | 1473 | |
a4e13010 N |
1474 | If the device name given is |
1475 | .B missing | |
262e3b7f N |
1476 | then |
1477 | .I mdadm | |
1478 | will try to find any device that looks like it should be | |
a4e13010 N |
1479 | part of the array but isn't and will try to re\-add all such devices. |
1480 | ||
262e3b7f N |
1481 | If the device name given is |
1482 | .B faulty | |
1483 | then | |
1484 | .I mdadm | |
1485 | will find all devices in the array that are marked | |
1486 | .BR faulty , | |
1487 | remove them and attempt to immediately re\-add them. This can be | |
1488 | useful if you are certain that the reason for failure has been | |
1489 | resolved. | |
1490 | ||
f33a71f1 N |
1491 | .TP |
1492 | .B \-\-add\-spare | |
1493 | Add a device as a spare. This is similar to | |
1494 | .B \-\-add | |
1495 | except that it does not attempt | |
1496 | .B \-\-re\-add | |
1497 | first. The device will be added as a spare even if it looks like it | |
1a386f80 | 1498 | could be a recent member of the array. |
f33a71f1 | 1499 | |
cd29a5c8 | 1500 | .TP |
7e23fc43 | 1501 | .BR \-r ", " \-\-remove |
2d465520 | 1502 | remove listed devices. They must not be active. i.e. they should |
64a78416 N |
1503 | be failed or spare devices. |
1504 | ||
1505 | As well as the name of a device file | |
b80da661 NB |
1506 | (e.g. |
1507 | .BR /dev/sda1 ) | |
1508 | the words | |
64a78416 | 1509 | .BR failed , |
b80da661 | 1510 | .B detached |
64a78416 N |
1511 | and names like |
1512 | .B set-A | |
b80da661 NB |
1513 | can be given to |
1514 | .BR \-\-remove . | |
1a386f80 | 1515 | The first causes all failed devices to be removed. The second causes |
93e790af | 1516 | any device which is no longer connected to the system (i.e an 'open' |
b80da661 NB |
1517 | returns |
1518 | .BR ENXIO ) | |
64a78416 | 1519 | to be removed. |
1a386f80 | 1520 | The third will remove a set as described below under |
64a78416 | 1521 | .BR \-\-fail . |
52826846 | 1522 | |
cd29a5c8 | 1523 | .TP |
7e23fc43 | 1524 | .BR \-f ", " \-\-fail |
70c55e36 | 1525 | Mark listed devices as faulty. |
b80da661 NB |
1526 | As well as the name of a device file, the word |
1527 | .B detached | |
64a78416 N |
1528 | or a set name like |
1529 | .B set\-A | |
1530 | can be given. The former will cause any device that has been detached from | |
b80da661 | 1531 | the system to be marked as failed. It can then be removed. |
52826846 | 1532 | |
64a78416 N |
1533 | For RAID10 arrays where the number of copies evenly divides the number |
1534 | of devices, the devices can be conceptually divided into sets where | |
1535 | each set contains a single complete copy of the data on the array. | |
1536 | Sometimes a RAID10 array will be configured so that these sets are on | |
1a386f80 | 1537 | separate controllers. In this case, all the devices in one set can be |
64a78416 N |
1538 | failed by giving a name like |
1539 | .B set\-A | |
1540 | or | |
1541 | .B set\-B | |
1542 | to | |
1543 | .BR \-\-fail . | |
1544 | The appropriate set names are reported by | |
1545 | .BR \-\-detail . | |
1546 | ||
cd29a5c8 | 1547 | .TP |
7e23fc43 | 1548 | .BR \-\-set\-faulty |
53e8b987 | 1549 | same as |
7e23fc43 | 1550 | .BR \-\-fail . |
52826846 | 1551 | |
70c55e36 N |
1552 | .TP |
1553 | .B \-\-replace | |
1554 | Mark listed devices as requiring replacement. As soon as a spare is | |
1555 | available, it will be rebuilt and will replace the marked device. | |
1556 | This is similar to marking a device as faulty, but the device remains | |
1557 | in service during the recovery process to increase resilience against | |
1558 | multiple failures. When the replacement process finishes, the | |
1559 | replaced device will be marked as faulty. | |
1560 | ||
1561 | .TP | |
1562 | .B \-\-with | |
1563 | This can follow a list of | |
1564 | .B \-\-replace | |
1565 | devices. The devices listed after | |
1566 | .B \-\-with | |
1a386f80 | 1567 | will preferentially be used to replace the devices listed after |
70c55e36 | 1568 | .BR \-\-replace . |
1a386f80 | 1569 | These devices must already be spare devices in the array. |
70c55e36 | 1570 | |
b3d31955 N |
1571 | .TP |
1572 | .BR \-\-write\-mostly | |
a4e13010 | 1573 | Subsequent devices that are added or re\-added will have the 'write-mostly' |
e0fe762a | 1574 | flag set. This is only valid for RAID1 and means that the 'md' driver |
b3d31955 N |
1575 | will avoid reading from these devices if possible. |
1576 | .TP | |
1577 | .BR \-\-readwrite | |
a4e13010 | 1578 | Subsequent devices that are added or re\-added will have the 'write-mostly' |
b3d31955 | 1579 | flag cleared. |
4de90913 GJ |
1580 | .TP |
1581 | .BR \-\-cluster\-confirm | |
1582 | Confirm the existence of the device. This is issued in response to an \-\-add | |
1583 | request by a node in a cluster. When a node adds a device it sends a message | |
1584 | to all nodes in the cluster to look for a device with a UUID. This translates | |
1585 | to a udev notification with the UUID of the device to be added and the slot | |
1586 | number. The receiving node must acknowledge this message | |
1587 | with \-\-cluster\-confirm. Valid arguments are <slot>:<devicename> in case | |
1588 | the device is found or <slot>:missing in case the device is not found. | |
b3d31955 | 1589 | |
ff3c881f SL |
1590 | .TP |
1591 | .BR \-\-add-journal | |
1a386f80 MG |
1592 | Add a journal to an existing array, or recreate journal for a RAID-4/5/6 array |
1593 | that lost a journal device. To avoid interrupting ongoing write operations, | |
ff3c881f SL |
1594 | .B \-\-add-journal |
1595 | only works for array in Read-Only state. | |
1596 | ||
71574efb N |
1597 | .TP |
1598 | .BR \-\-failfast | |
1599 | Subsequent devices that are added or re\-added will have | |
1600 | the 'failfast' flag set. This is only valid for RAID1 and RAID10 and | |
1601 | means that the 'md' driver will avoid long timeouts on error handling | |
1602 | where possible. | |
1603 | .TP | |
1604 | .BR \-\-nofailfast | |
1605 | Subsequent devices that are re\-added will be re\-added without | |
1606 | the 'failfast' flag set. | |
1607 | ||
2ae555c3 | 1608 | .P |
e0fe762a | 1609 | Each of these options requires that the first device listed is the array |
93e790af | 1610 | to be acted upon, and the remainder are component devices to be added, |
e0fe762a | 1611 | removed, marked as faulty, etc. Several different operations can be |
2ae555c3 NB |
1612 | specified for different devices, e.g. |
1613 | .in +5 | |
7e23fc43 | 1614 | mdadm /dev/md0 \-\-add /dev/sda1 \-\-fail /dev/sdb1 \-\-remove /dev/sdb1 |
2ae555c3 NB |
1615 | .in -5 |
1616 | Each operation applies to all devices listed until the next | |
93e790af | 1617 | operation. |
2ae555c3 NB |
1618 | |
1619 | If an array is using a write-intent bitmap, then devices which have | |
a4e13010 | 1620 | been removed can be re\-added in a way that avoids a full |
93e790af | 1621 | reconstruction but instead just updates the blocks that have changed |
2ae555c3 NB |
1622 | since the device was removed. For arrays with persistent metadata |
1623 | (superblocks) this is done automatically. For arrays created with | |
7e23fc43 | 1624 | .B \-\-build |
2ae555c3 | 1625 | mdadm needs to be told that this device we removed recently with |
7e23fc43 | 1626 | .BR \-\-re\-add . |
2ae555c3 NB |
1627 | |
1628 | Devices can only be removed from an array if they are not in active | |
93e790af SW |
1629 | use, i.e. that must be spares or failed devices. To remove an active |
1630 | device, it must first be marked as | |
1631 | .B faulty. | |
2ae555c3 NB |
1632 | |
1633 | .SH For Misc mode: | |
1634 | ||
1635 | .TP | |
7e23fc43 | 1636 | .BR \-Q ", " \-\-query |
2ae555c3 NB |
1637 | Examine a device to see |
1638 | (1) if it is an md device and (2) if it is a component of an md | |
1639 | array. | |
1640 | Information about what is discovered is presented. | |
1641 | ||
1642 | .TP | |
7e23fc43 | 1643 | .BR \-D ", " \-\-detail |
e0fe762a | 1644 | Print details of one or more md devices. |
5787fa49 | 1645 | |
4cce4069 DW |
1646 | .TP |
1647 | .BR \-\-detail\-platform | |
e0fe762a | 1648 | Print details of the platform's RAID capabilities (firmware / hardware |
1a386f80 | 1649 | topology) for a given metadata format. If used without an argument, mdadm |
9eafa1de | 1650 | will scan all controllers looking for their capabilities. Otherwise, mdadm |
1a386f80 | 1651 | will only look at the controller specified by the argument in the form of an |
9eafa1de MN |
1652 | absolute filepath or a link, e.g. |
1653 | .IR /sys/devices/pci0000:00/0000:00:1f.2 . | |
4cce4069 | 1654 | |
54bad364 KS |
1655 | .TP |
1656 | .BR \-Y ", " \-\-export | |
1657 | When used with | |
9ca39acb N |
1658 | .BR \-\-detail , |
1659 | .BR \-\-detail-platform , | |
0d726f17 | 1660 | .BR \-\-examine , |
9ca39acb N |
1661 | or |
1662 | .B \-\-incremental | |
54bad364 KS |
1663 | output will be formatted as |
1664 | .B key=value | |
1665 | pairs for easy import into the environment. | |
1666 | ||
9ca39acb N |
1667 | With |
1668 | .B \-\-incremental | |
1669 | The value | |
1670 | .B MD_STARTED | |
1671 | indicates whether an array was started | |
1672 | .RB ( yes ) | |
1673 | or not, which may include a reason | |
1674 | .RB ( unsafe ", " nothing ", " no ). | |
1675 | Also the value | |
1676 | .B MD_FOREIGN | |
1677 | indicates if the array is expected on this host | |
1678 | .RB ( no ), | |
1679 | or seems to be from elsewhere | |
1680 | .RB ( yes ). | |
1681 | ||
2ae555c3 | 1682 | .TP |
7e23fc43 | 1683 | .BR \-E ", " \-\-examine |
e0fe762a N |
1684 | Print contents of the metadata stored on the named device(s). |
1685 | Note the contrast between | |
1686 | .B \-\-examine | |
1687 | and | |
1688 | .BR \-\-detail . | |
1689 | .B \-\-examine | |
1690 | applies to devices which are components of an array, while | |
1691 | .B \-\-detail | |
1692 | applies to a whole array which is currently active. | |
5787fa49 | 1693 | .TP |
7e23fc43 | 1694 | .B \-\-sparc2.2 |
e0fe762a N |
1695 | If an array was created on a SPARC machine with a 2.2 Linux kernel |
1696 | patched with RAID support, the superblock will have been created | |
1697 | incorrectly, or at least incompatibly with 2.4 and later kernels. | |
1698 | Using the | |
7e23fc43 | 1699 | .B \-\-sparc2.2 |
5787fa49 | 1700 | flag with |
7e23fc43 | 1701 | .B \-\-examine |
5787fa49 NB |
1702 | will fix the superblock before displaying it. If this appears to do |
1703 | the right thing, then the array can be successfully assembled using | |
7e23fc43 | 1704 | .BR "\-\-assemble \-\-update=sparc2.2" . |
5787fa49 | 1705 | |
2ae555c3 | 1706 | .TP |
7e23fc43 | 1707 | .BR \-X ", " \-\-examine\-bitmap |
2ae555c3 | 1708 | Report information about a bitmap file. |
01d9299c | 1709 | The argument is either an external bitmap file or an array component |
e0fe762a N |
1710 | in case of an internal bitmap. Note that running this on an array |
1711 | device (e.g. | |
1712 | .BR /dev/md0 ) | |
1713 | does not report the bitmap for that array. | |
e0d19036 | 1714 | |
6d388a88 N |
1715 | .TP |
1716 | .B \-\-examine\-badblocks | |
1717 | List the bad-blocks recorded for the device, if a bad-blocks list has | |
5f418455 | 1718 | been configured. Currently only |
6d388a88 | 1719 | .B 1.x |
5f418455 MT |
1720 | and |
1721 | .B IMSM | |
1722 | metadata support bad-blocks lists. | |
6d388a88 | 1723 | |
74db60b0 N |
1724 | .TP |
1725 | .BI \-\-dump= directory | |
1726 | .TP | |
1727 | .BI \-\-restore= directory | |
1728 | Save metadata from lists devices, or restore metadata to listed devices. | |
1729 | ||
cd29a5c8 | 1730 | .TP |
7e23fc43 | 1731 | .BR \-R ", " \-\-run |
e0fe762a N |
1732 | start a partially assembled array. If |
1733 | .B \-\-assemble | |
1734 | did not find enough devices to fully start the array, it might leaving | |
1735 | it partially assembled. If you wish, you can then use | |
1736 | .B \-\-run | |
1737 | to start the array in degraded mode. | |
52826846 | 1738 | |
cd29a5c8 | 1739 | .TP |
7e23fc43 | 1740 | .BR \-S ", " \-\-stop |
cd29a5c8 | 1741 | deactivate array, releasing all resources. |
52826846 | 1742 | |
cd29a5c8 | 1743 | .TP |
7e23fc43 | 1744 | .BR \-o ", " \-\-readonly |
cd29a5c8 | 1745 | mark array as readonly. |
52826846 | 1746 | |
cd29a5c8 | 1747 | .TP |
7e23fc43 | 1748 | .BR \-w ", " \-\-readwrite |
cd29a5c8 | 1749 | mark array as readwrite. |
52826846 | 1750 | |
e0d19036 | 1751 | .TP |
7e23fc43 | 1752 | .B \-\-zero\-superblock |
e0d19036 | 1753 | If the device contains a valid md superblock, the block is |
35cc5be4 | 1754 | overwritten with zeros. With |
7e23fc43 | 1755 | .B \-\-force |
35cc5be4 | 1756 | the block where the superblock would be is overwritten even if it |
e0d19036 | 1757 | doesn't appear to be valid. |
52826846 | 1758 | |
b2a613dd | 1759 | .B Note: |
1a386f80 MG |
1760 | Be careful when calling \-\-zero\-superblock with clustered raid. Make sure |
1761 | the array isn't used or assembled in another cluster node before executing it. | |
b2a613dd | 1762 | |
33414a01 DW |
1763 | .TP |
1764 | .B \-\-kill\-subarray= | |
1765 | If the device is a container and the argument to \-\-kill\-subarray | |
1766 | specifies an inactive subarray in the container, then the subarray is | |
1767 | deleted. Deleting all subarrays will leave an 'empty-container' or | |
afa368f4 N |
1768 | spare superblock on the drives. See |
1769 | .B \-\-zero\-superblock | |
1770 | for completely | |
33414a01 DW |
1771 | removing a superblock. Note that some formats depend on the subarray |
1772 | index for generating a UUID, this command will fail if it would change | |
1773 | the UUID of an active subarray. | |
1774 | ||
aa534678 DW |
1775 | .TP |
1776 | .B \-\-update\-subarray= | |
1777 | If the device is a container and the argument to \-\-update\-subarray | |
1778 | specifies a subarray in the container, then attempt to update the given | |
1779 | superblock field in the subarray. See below in | |
1780 | .B MISC MODE | |
1781 | for details. | |
1782 | ||
feb716e9 | 1783 | .TP |
7e23fc43 | 1784 | .BR \-t ", " \-\-test |
feb716e9 | 1785 | When used with |
7e23fc43 | 1786 | .BR \-\-detail , |
feb716e9 NB |
1787 | the exit status of |
1788 | .I mdadm | |
e0fe762a N |
1789 | is set to reflect the status of the device. See below in |
1790 | .B MISC MODE | |
1791 | for details. | |
feb716e9 | 1792 | |
b90c0e9a | 1793 | .TP |
7e23fc43 | 1794 | .BR \-W ", " \-\-wait |
b90c0e9a NB |
1795 | For each md device given, wait for any resync, recovery, or reshape |
1796 | activity to finish before returning. | |
1797 | .I mdadm | |
1798 | will return with success if it actually waited for every device | |
1799 | listed, otherwise it will return failure. | |
1800 | ||
1770662b DW |
1801 | .TP |
1802 | .BR \-\-wait\-clean | |
fabbfd48 DW |
1803 | For each md device given, or each device in /proc/mdstat if |
1804 | .B \-\-scan | |
1805 | is given, arrange for the array to be marked clean as soon as possible. | |
7146ec6a DW |
1806 | .I mdadm |
1807 | will return with success if the array uses external metadata and we | |
1a386f80 | 1808 | successfully waited. For native arrays, this returns immediately as the |
6a0ee6a0 DW |
1809 | kernel handles dirty-clean transitions at shutdown. No action is taken |
1810 | if safe-mode handling is disabled. | |
1770662b | 1811 | |
a740cf64 N |
1812 | .TP |
1813 | .B \-\-action= | |
1814 | Set the "sync_action" for all md devices given to one of | |
1815 | .BR idle , | |
1816 | .BR frozen , | |
1817 | .BR check , | |
1818 | .BR repair . | |
1819 | Setting to | |
1820 | .B idle | |
1821 | will abort any currently running action though some actions will | |
1822 | automatically restart. | |
1823 | Setting to | |
1824 | .B frozen | |
1825 | will abort any current action and ensure no other action starts | |
1826 | automatically. | |
1827 | ||
1828 | Details of | |
1829 | .B check | |
1830 | and | |
1831 | .B repair | |
1832 | can be found it | |
1833 | .IR md (4) | |
1834 | under | |
1835 | .BR "SCRUBBING AND MISMATCHES" . | |
1836 | ||
8382f19b NB |
1837 | .SH For Incremental Assembly mode: |
1838 | .TP | |
7e23fc43 | 1839 | .BR \-\-rebuild\-map ", " \-r |
8382f19b | 1840 | Rebuild the map file |
96fd06ed | 1841 | .RB ( {MAP_PATH} ) |
8382f19b NB |
1842 | that |
1843 | .I mdadm | |
1844 | uses to help track which arrays are currently being assembled. | |
1845 | ||
1846 | .TP | |
7e23fc43 | 1847 | .BR \-\-run ", " \-R |
1a386f80 | 1848 | Run any array assembled as soon as a minimal number of devices is |
8382f19b NB |
1849 | available, rather than waiting until all expected devices are present. |
1850 | ||
1851 | .TP | |
7e23fc43 | 1852 | .BR \-\-scan ", " \-s |
8382f19b | 1853 | Only meaningful with |
7e23fc43 | 1854 | .B \-R |
8382f19b NB |
1855 | this will scan the |
1856 | .B map | |
1857 | file for arrays that are being incrementally assembled and will try to | |
1858 | start any that are not already started. If any such array is listed | |
1859 | in | |
1860 | .B mdadm.conf | |
1861 | as requiring an external bitmap, that bitmap will be attached first. | |
1862 | ||
29ba4804 N |
1863 | .TP |
1864 | .BR \-\-fail ", " \-f | |
1865 | This allows the hot-plug system to remove devices that have fully disappeared | |
1866 | from the kernel. It will first fail and then remove the device from any | |
1867 | array it belongs to. | |
1868 | The device name given should be a kernel device name such as "sda", | |
1869 | not a name in | |
1870 | .IR /dev . | |
1871 | ||
210597d1 PC |
1872 | .TP |
1873 | .BR \-\-path= | |
87eb4fab N |
1874 | Only used with \-\-fail. The 'path' given will be recorded so that if |
1875 | a new device appears at the same location it can be automatically | |
1876 | added to the same array. This allows the failed device to be | |
1877 | automatically replaced by a new device without metadata if it appears | |
1a386f80 | 1878 | at specified path. This option is normally only set by an |
87eb4fab N |
1879 | .I udev |
1880 | script. | |
210597d1 | 1881 | |
e0d19036 NB |
1882 | .SH For Monitor mode: |
1883 | .TP | |
7e23fc43 | 1884 | .BR \-m ", " \-\-mail |
e0d19036 NB |
1885 | Give a mail address to send alerts to. |
1886 | ||
1887 | .TP | |
7e23fc43 | 1888 | .BR \-p ", " \-\-program ", " \-\-alert |
e0d19036 NB |
1889 | Give a program to be run whenever an event is detected. |
1890 | ||
773135f5 | 1891 | .TP |
7e23fc43 | 1892 | .BR \-y ", " \-\-syslog |
773135f5 NB |
1893 | Cause all events to be reported through 'syslog'. The messages have |
1894 | facility of 'daemon' and varying priorities. | |
1895 | ||
e0d19036 | 1896 | .TP |
7e23fc43 | 1897 | .BR \-d ", " \-\-delay |
e0d19036 | 1898 | Give a delay in seconds. |
51ac42e3 | 1899 | .I mdadm |
e0d19036 | 1900 | polls the md arrays and then waits this many seconds before polling |
e0fe762a N |
1901 | again. The default is 60 seconds. Since 2.6.16, there is no need to |
1902 | reduce this as the kernel alerts | |
1903 | .I mdadm | |
1904 | immediately when there is any change. | |
e0d19036 | 1905 | |
9a36a9b7 ZB |
1906 | .TP |
1907 | .BR \-r ", " \-\-increment | |
1908 | Give a percentage increment. | |
1909 | .I mdadm | |
1910 | will generate RebuildNN events with the given percentage increment. | |
1911 | ||
d013a55e | 1912 | .TP |
7e23fc43 | 1913 | .BR \-f ", " \-\-daemonise |
d013a55e | 1914 | Tell |
51ac42e3 | 1915 | .I mdadm |
d013a55e | 1916 | to run as a background daemon if it decides to monitor anything. This |
e0fe762a | 1917 | causes it to fork and run in the child, and to disconnect from the |
d013a55e NB |
1918 | terminal. The process id of the child is written to stdout. |
1919 | This is useful with | |
7e23fc43 | 1920 | .B \-\-scan |
d013a55e NB |
1921 | which will only continue monitoring if a mail address or alert program |
1922 | is found in the config file. | |
1923 | ||
b5e64645 | 1924 | .TP |
7e23fc43 | 1925 | .BR \-i ", " \-\-pid\-file |
b5e64645 | 1926 | When |
51ac42e3 | 1927 | .I mdadm |
b5e64645 NB |
1928 | is running in daemon mode, write the pid of the daemon process to |
1929 | the specified file, instead of printing it on standard output. | |
1930 | ||
aa88f531 | 1931 | .TP |
7e23fc43 | 1932 | .BR \-1 ", " \-\-oneshot |
aa88f531 NB |
1933 | Check arrays only once. This will generate |
1934 | .B NewArray | |
1935 | events and more significantly | |
1936 | .B DegradedArray | |
a9d69660 NB |
1937 | and |
1938 | .B SparesMissing | |
aa88f531 NB |
1939 | events. Running |
1940 | .in +5 | |
7e23fc43 | 1941 | .B " mdadm \-\-monitor \-\-scan \-1" |
aa88f531 NB |
1942 | .in -5 |
1943 | from a cron script will ensure regular notification of any degraded arrays. | |
1944 | ||
98c6faba | 1945 | .TP |
7e23fc43 | 1946 | .BR \-t ", " \-\-test |
98c6faba NB |
1947 | Generate a |
1948 | .B TestMessage | |
1949 | alert for every array found at startup. This alert gets mailed and | |
1950 | passed to the alert program. This can be used for testing that alert | |
a9d69660 | 1951 | message do get through successfully. |
98c6faba | 1952 | |
210597d1 PC |
1953 | .TP |
1954 | .BR \-\-no\-sharing | |
87eb4fab | 1955 | This inhibits the functionality for moving spares between arrays. |
210597d1 PC |
1956 | Only one monitoring process started with |
1957 | .B \-\-scan | |
87eb4fab N |
1958 | but without this flag is allowed, otherwise the two could interfere |
1959 | with each other. | |
210597d1 | 1960 | |
e0d19036 | 1961 | .SH ASSEMBLE MODE |
52826846 | 1962 | |
cd29a5c8 NB |
1963 | .HP 12 |
1964 | Usage: | |
7e23fc43 | 1965 | .B mdadm \-\-assemble |
5787fa49 NB |
1966 | .I md-device options-and-component-devices... |
1967 | .HP 12 | |
1968 | Usage: | |
7e23fc43 | 1969 | .B mdadm \-\-assemble \-\-scan |
e0fe762a | 1970 | .I md-devices-and-options... |
cd29a5c8 NB |
1971 | .HP 12 |
1972 | Usage: | |
7e23fc43 | 1973 | .B mdadm \-\-assemble \-\-scan |
e0fe762a | 1974 | .I options... |
52826846 | 1975 | |
cd29a5c8 | 1976 | .PP |
e0fe762a | 1977 | This usage assembles one or more RAID arrays from pre-existing components. |
9a9dab36 | 1978 | For each array, mdadm needs to know the md device, the identity of the |
1a386f80 | 1979 | array, and the number of component devices. These can be found in a number of ways. |
52826846 | 1980 | |
5787fa49 | 1981 | In the first usage example (without the |
7e23fc43 | 1982 | .BR \-\-scan ) |
5787fa49 NB |
1983 | the first device given is the md device. |
1984 | In the second usage example, all devices listed are treated as md | |
1985 | devices and assembly is attempted. | |
1986 | In the third (where no devices are listed) all md devices that are | |
cb77f620 | 1987 | listed in the configuration file are assembled. If no arrays are |
e0fe762a N |
1988 | described by the configuration file, then any arrays that |
1989 | can be found on unused devices will be assembled. | |
52826846 | 1990 | |
d013a55e | 1991 | If precisely one device is listed, but |
7e23fc43 | 1992 | .B \-\-scan |
dd0781e5 | 1993 | is not given, then |
d013a55e NB |
1994 | .I mdadm |
1995 | acts as though | |
7e23fc43 | 1996 | .B \-\-scan |
93e790af | 1997 | was given and identity information is extracted from the configuration file. |
d013a55e | 1998 | |
2ae555c3 | 1999 | The identity can be given with the |
7e23fc43 | 2000 | .B \-\-uuid |
e0fe762a N |
2001 | option, the |
2002 | .B \-\-name | |
2003 | option, or the | |
7e23fc43 | 2004 | .B \-\-super\-minor |
93e790af SW |
2005 | option, will be taken from the md-device record in the config file, or |
2006 | will be taken from the super block of the first component-device | |
2007 | listed on the command line. | |
52826846 | 2008 | |
2ae555c3 | 2009 | Devices can be given on the |
7e23fc43 | 2010 | .B \-\-assemble |
e0fe762a | 2011 | command line or in the config file. Only devices which have an md |
5787fa49 NB |
2012 | superblock which contains the right identity will be considered for |
2013 | any array. | |
52826846 | 2014 | |
2ae555c3 | 2015 | The config file is only used if explicitly named with |
7e23fc43 | 2016 | .B \-\-config |
d013a55e | 2017 | or requested with (a possibly implicit) |
7e23fc43 | 2018 | .BR \-\-scan . |
1a386f80 | 2019 | In the latter case, the default config file is used. See |
24e075c6 LF |
2020 | .BR mdadm.conf (5) |
2021 | for more details. | |
52826846 | 2022 | |
2ae555c3 | 2023 | If |
7e23fc43 | 2024 | .B \-\-scan |
cd29a5c8 NB |
2025 | is not given, then the config file will only be used to find the |
2026 | identity of md arrays. | |
52826846 | 2027 | |
2d465520 | 2028 | Normally the array will be started after it is assembled. However if |
7e23fc43 | 2029 | .B \-\-scan |
e0fe762a N |
2030 | is not given and not all expected drives were listed, then the array |
2031 | is not started (to guard against usage errors). To insist that the | |
2032 | array be started in this case (as may work for RAID1, 4, 5, 6, or 10), | |
2033 | give the | |
7e23fc43 | 2034 | .B \-\-run |
cd29a5c8 | 2035 | flag. |
52826846 | 2036 | |
e0fe762a N |
2037 | If |
2038 | .I udev | |
2039 | is active, | |
2040 | .I mdadm | |
2041 | does not create any entries in | |
dd0781e5 | 2042 | .B /dev |
e0fe762a N |
2043 | but leaves that to |
2044 | .IR udev . | |
2045 | It does record information in | |
96fd06ed | 2046 | .B {MAP_PATH} |
e0fe762a N |
2047 | which will allow |
2048 | .I udev | |
2049 | to choose the correct name. | |
dd0781e5 | 2050 | |
e0fe762a N |
2051 | If |
2052 | .I mdadm | |
2053 | detects that udev is not configured, it will create the devices in | |
2054 | .B /dev | |
2055 | itself. | |
dd0781e5 | 2056 | |
1a386f80 MG |
2057 | In Linux kernels prior to version 2.6.28 there were two distinct |
2058 | types of md devices that could be created: one that could be | |
e0fe762a | 2059 | partitioned using standard partitioning tools and one that could not. |
1a386f80 | 2060 | Since 2.6.28 that distinction is no longer relevant as both types of |
e0fe762a N |
2061 | devices can be partitioned. |
2062 | .I mdadm | |
2063 | will normally create the type that originally could not be partitioned | |
1a386f80 | 2064 | as it has a well-defined major number (9). |
dd0781e5 | 2065 | |
e0fe762a N |
2066 | Prior to 2.6.28, it is important that mdadm chooses the correct type |
2067 | of array device to use. This can be controlled with the | |
2068 | .B \-\-auto | |
2069 | option. In particular, a value of "mdp" or "part" or "p" tells mdadm | |
2070 | to use a partitionable device rather than the default. | |
dd0781e5 | 2071 | |
e0fe762a N |
2072 | In the no-udev case, the value given to |
2073 | .B \-\-auto | |
2074 | can be suffixed by a number. This tells | |
2075 | .I mdadm | |
2076 | to create that number of partition devices rather than the default of 4. | |
dd0781e5 | 2077 | |
e0fe762a | 2078 | The value given to |
7e23fc43 | 2079 | .B \-\-auto |
e0fe762a N |
2080 | can also be given in the configuration file as a word starting |
2081 | .B auto= | |
2082 | on the ARRAY line for the relevant array. | |
52826846 | 2083 | |
1a386f80 | 2084 | .SS Auto-Assembly |
41a3b72a | 2085 | When |
7e23fc43 | 2086 | .B \-\-assemble |
41a3b72a | 2087 | is used with |
7e23fc43 | 2088 | .B \-\-scan |
41a3b72a NB |
2089 | and no devices are listed, |
2090 | .I mdadm | |
2091 | will first attempt to assemble all the arrays listed in the config | |
2092 | file. | |
2093 | ||
cb77f620 | 2094 | If no arrays are listed in the config (other than those marked |
e0fe762a N |
2095 | .BR <ignore> ) |
2096 | it will look through the available devices for possible arrays and | |
2097 | will try to assemble anything that it finds. Arrays which are tagged | |
2098 | as belonging to the given homehost will be assembled and started | |
2099 | normally. Arrays which do not obviously belong to this host are given | |
2100 | names that are expected not to conflict with anything local, and are | |
2101 | started "read-auto" so that nothing is written to any device until the | |
2102 | array is written to. i.e. automatic resync etc is delayed. | |
41a3b72a NB |
2103 | |
2104 | If | |
2105 | .I mdadm | |
2106 | finds a consistent set of devices that look like they should comprise | |
2107 | an array, and if the superblock is tagged as belonging to the given | |
2108 | home host, it will automatically choose a device name and try to | |
2109 | assemble the array. If the array uses version-0.90 metadata, then the | |
2110 | .B minor | |
2111 | number as recorded in the superblock is used to create a name in | |
2112 | .B /dev/md/ | |
2113 | so for example | |
2114 | .BR /dev/md/3 . | |
2115 | If the array uses version-1 metadata, then the | |
2116 | .B name | |
2117 | from the superblock is used to similarly create a name in | |
e0fe762a | 2118 | .B /dev/md/ |
93e790af | 2119 | (the name will have any 'host' prefix stripped first). |
41a3b72a | 2120 | |
c64ba03a N |
2121 | This behaviour can be modified by the |
2122 | .I AUTO | |
2123 | line in the | |
2124 | .I mdadm.conf | |
2125 | configuration file. This line can indicate that specific metadata | |
2126 | type should, or should not, be automatically assembled. If an array | |
2127 | is found which is not listed in | |
2128 | .I mdadm.conf | |
2129 | and has a metadata format that is denied by the | |
2130 | .I AUTO | |
2131 | line, then it will not be assembled. | |
2132 | The | |
2133 | .I AUTO | |
2134 | line can also request that all arrays identified as being for this | |
2135 | homehost should be assembled regardless of their metadata type. | |
2136 | See | |
2137 | .IR mdadm.conf (5) | |
2138 | for further details. | |
2139 | ||
1a386f80 | 2140 | Note: Auto-assembly cannot be used for assembling and activating some |
246cebdb AK |
2141 | arrays which are undergoing reshape. In particular as the |
2142 | .B backup\-file | |
1a386f80 MG |
2143 | cannot be given, any reshape which requires a backup file to continue |
2144 | cannot be started by auto-assembly. An array which is growing to more | |
246cebdb AK |
2145 | devices and has passed the critical section can be assembled using |
2146 | auto-assembly. | |
41a3b72a | 2147 | |
cd29a5c8 | 2148 | .SH BUILD MODE |
52826846 | 2149 | |
cd29a5c8 NB |
2150 | .HP 12 |
2151 | Usage: | |
7e23fc43 | 2152 | .B mdadm \-\-build |
93e790af | 2153 | .I md-device |
7e23fc43 PS |
2154 | .BI \-\-chunk= X |
2155 | .BI \-\-level= Y | |
2156 | .BI \-\-raid\-devices= Z | |
cd29a5c8 NB |
2157 | .I devices |
2158 | ||
2159 | .PP | |
2ae555c3 | 2160 | This usage is similar to |
7e23fc43 | 2161 | .BR \-\-create . |
e0fe762a | 2162 | The difference is that it creates an array without a superblock. With |
cd29a5c8 | 2163 | these arrays there is no difference between initially creating the array and |
52826846 NB |
2164 | subsequently assembling the array, except that hopefully there is useful |
2165 | data there in the second case. | |
2166 | ||
e0fe762a N |
2167 | The level may raid0, linear, raid1, raid10, multipath, or faulty, or |
2168 | one of their synonyms. All devices must be listed and the array will | |
2169 | be started once complete. It will often be appropriate to use | |
2170 | .B \-\-assume\-clean | |
2171 | with levels raid1 or raid10. | |
cd29a5c8 NB |
2172 | |
2173 | .SH CREATE MODE | |
2174 | ||
2175 | .HP 12 | |
2176 | Usage: | |
7e23fc43 | 2177 | .B mdadm \-\-create |
93e790af | 2178 | .I md-device |
7e23fc43 PS |
2179 | .BI \-\-chunk= X |
2180 | .BI \-\-level= Y | |
7e23fc43 | 2181 | .BI \-\-raid\-devices= Z |
e0fe762a | 2182 | .I devices |
cd29a5c8 NB |
2183 | |
2184 | .PP | |
e2eb503b | 2185 | This usage will initialize a new md array, associate some devices with |
cd29a5c8 NB |
2186 | it, and activate the array. |
2187 | ||
e2eb503b MT |
2188 | .I md-device |
2189 | is a new device. This could be standard name or chosen name. For details see: | |
2190 | .BR "DEVICE NAMES" | |
2191 | ||
e0fe762a N |
2192 | The named device will normally not exist when |
2193 | .I "mdadm \-\-create" | |
2194 | is run, but will be created by | |
2195 | .I udev | |
2196 | once the array becomes active. | |
dd0781e5 | 2197 | |
ced5fa8b BK |
2198 | The max length md-device name is limited to 32 characters. |
2199 | Different metadata types have more strict limitation | |
2200 | (like IMSM where only 16 characters are allowed). | |
2201 | For that reason, long name could be truncated or rejected, it depends on metadata policy. | |
2202 | ||
e0fe762a N |
2203 | As devices are added, they are checked to see if they contain RAID |
2204 | superblocks or filesystems. They are also checked to see if the variance in | |
cd29a5c8 NB |
2205 | device size exceeds 1%. |
2206 | ||
2207 | If any discrepancy is found, the array will not automatically be run, though | |
2ae555c3 | 2208 | the presence of a |
7e23fc43 | 2209 | .B \-\-run |
cd29a5c8 NB |
2210 | can override this caution. |
2211 | ||
2d465520 | 2212 | To create a "degraded" array in which some devices are missing, simply |
d013a55e | 2213 | give the word "\fBmissing\fP" |
2d465520 | 2214 | in place of a device name. This will cause |
51ac42e3 | 2215 | .I mdadm |
2d465520 NB |
2216 | to leave the corresponding slot in the array empty. |
2217 | For a RAID4 or RAID5 array at most one slot can be | |
98c6faba | 2218 | "\fBmissing\fP"; for a RAID6 array at most two slots. |
2d465520 NB |
2219 | For a RAID1 array, only one real device needs to be given. All of the |
2220 | others can be | |
d013a55e | 2221 | "\fBmissing\fP". |
2d465520 | 2222 | |
feb716e9 | 2223 | When creating a RAID5 array, |
51ac42e3 | 2224 | .I mdadm |
feb716e9 | 2225 | will automatically create a degraded array with an extra spare drive. |
e0fe762a N |
2226 | This is because building the spare into a degraded array is in general |
2227 | faster than resyncing the parity on a non-degraded, but not clean, | |
2228 | array. This feature can be overridden with the | |
7e23fc43 | 2229 | .B \-\-force |
feb716e9 NB |
2230 | option. |
2231 | ||
e0fe762a N |
2232 | When creating a partition based array, using |
2233 | .I mdadm | |
2234 | with version-1.x metadata, the partition type should be set to | |
e0f31f50 | 2235 | .B 0xDA |
1a386f80 | 2236 | (non fs-data). This type of selection allows for greater precision since |
e0f31f50 PC |
2237 | using any other [RAID auto-detect (0xFD) or a GNU/Linux partition (0x83)], |
2238 | might create problems in the event of array recovery through a live cdrom. | |
2239 | ||
3d3dd91e NB |
2240 | A new array will normally get a randomly assigned 128bit UUID which is |
2241 | very likely to be unique. If you have a specific need, you can choose | |
2242 | a UUID for the array by giving the | |
7e23fc43 | 2243 | .B \-\-uuid= |
3d3dd91e NB |
2244 | option. Be warned that creating two arrays with the same UUID is a |
2245 | recipe for disaster. Also, using | |
7e23fc43 | 2246 | .B \-\-uuid= |
3d3dd91e | 2247 | when creating a v0.90 array will silently override any |
7e23fc43 | 2248 | .B \-\-homehost= |
3d3dd91e | 2249 | setting. |
e43d0cda NB |
2250 | .\"If the |
2251 | .\".B \-\-size | |
1a386f80 | 2252 | .\"option is given, it is not necessary to list any component devices in this command. |
e43d0cda NB |
2253 | .\"They can be added later, before a |
2254 | .\".B \-\-run. | |
2255 | .\"If no | |
2256 | .\".B \-\-size | |
2257 | .\"is given, the apparent size of the smallest drive given is used. | |
cd29a5c8 | 2258 | |
748952f7 N |
2259 | If the array type supports a write-intent bitmap, and if the devices |
2260 | in the array exceed 100G is size, an internal write-intent bitmap | |
2261 | will automatically be added unless some other option is explicitly | |
2262 | requested with the | |
2263 | .B \-\-bitmap | |
5308f117 AP |
2264 | option or a different consistency policy is selected with the |
2265 | .B \-\-consistency\-policy | |
1a386f80 | 2266 | option. In any case, space for a bitmap will be reserved so that one |
5308f117 | 2267 | can be added later with |
748952f7 N |
2268 | .BR "\-\-grow \-\-bitmap=internal" . |
2269 | ||
8fac4a54 TM |
2270 | If the metadata type supports it (currently only 1.x and IMSM metadata), |
2271 | space will be allocated to store a bad block list. This allows a modest | |
bf95d0f3 N |
2272 | number of bad blocks to be recorded, allowing the drive to remain in |
2273 | service while only partially functional. | |
2274 | ||
8fd8d9c4 N |
2275 | When creating an array within a |
2276 | .B CONTAINER | |
2277 | .I mdadm | |
2278 | can be given either the list of devices to use, or simply the name of | |
2279 | the container. The former case gives control over which devices in | |
2280 | the container will be used for the array. The latter case allows | |
2281 | .I mdadm | |
2282 | to automatically choose which devices to use based on how much spare | |
2283 | space is available. | |
2284 | ||
53e8b987 | 2285 | The General Management options that are valid with |
7e23fc43 | 2286 | .B \-\-create |
53e8b987 | 2287 | are: |
cd29a5c8 | 2288 | .TP |
7e23fc43 | 2289 | .B \-\-run |
dd0781e5 | 2290 | insist on running the array even if some devices look like they might |
cd29a5c8 NB |
2291 | be in use. |
2292 | ||
2293 | .TP | |
7e23fc43 | 2294 | .B \-\-readonly |
8a70632f | 2295 | start the array in readonly mode. |
52826846 | 2296 | |
e0d19036 | 2297 | .SH MANAGE MODE |
cd29a5c8 NB |
2298 | .HP 12 |
2299 | Usage: | |
e0d19036 NB |
2300 | .B mdadm |
2301 | .I device | |
2302 | .I options... devices... | |
cd29a5c8 NB |
2303 | .PP |
2304 | ||
e0d19036 NB |
2305 | This usage will allow individual devices in an array to be failed, |
2306 | removed or added. It is possible to perform multiple operations with | |
e0fe762a | 2307 | on command. For example: |
e0d19036 | 2308 | .br |
7e23fc43 | 2309 | .B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1" |
e0d19036 NB |
2310 | .br |
2311 | will firstly mark | |
2312 | .B /dev/hda1 | |
2313 | as faulty in | |
2314 | .B /dev/md0 | |
2315 | and will then remove it from the array and finally add it back | |
1a386f80 | 2316 | in as a spare. However, only one md array can be affected by a single |
2ae555c3 | 2317 | command. |
e0d19036 | 2318 | |
e0fe762a N |
2319 | When a device is added to an active array, mdadm checks to see if it |
2320 | has metadata on it which suggests that it was recently a member of the | |
a4e13010 | 2321 | array. If it does, it tries to "re\-add" the device. If there have |
e0fe762a N |
2322 | been no changes since the device was removed, or if the array has a |
2323 | write-intent bitmap which has recorded whatever changes there were, | |
2324 | then the device will immediately become a full member of the array and | |
2325 | those differences recorded in the bitmap will be resolved. | |
2326 | ||
e0d19036 NB |
2327 | .SH MISC MODE |
2328 | .HP 12 | |
2329 | Usage: | |
9a9dab36 | 2330 | .B mdadm |
e0d19036 | 2331 | .I options ... |
e0fe762a | 2332 | .I devices ... |
e0d19036 | 2333 | .PP |
cd29a5c8 | 2334 | |
b5e64645 | 2335 | MISC mode includes a number of distinct operations that |
e0d19036 NB |
2336 | operate on distinct devices. The operations are: |
2337 | .TP | |
962a108f | 2338 | .B \-\-query |
e0d19036 NB |
2339 | The device is examined to see if it is |
2340 | (1) an active md array, or | |
2341 | (2) a component of an md array. | |
2342 | The information discovered is reported. | |
2343 | ||
2344 | .TP | |
962a108f | 2345 | .B \-\-detail |
2d465520 | 2346 | The device should be an active md device. |
e0fe762a | 2347 | .B mdadm |
2d465520 | 2348 | will display a detailed description of the array. |
7e23fc43 | 2349 | .B \-\-brief |
2d465520 | 2350 | or |
7e23fc43 | 2351 | .B \-\-scan |
2d465520 | 2352 | will cause the output to be less detailed and the format to be |
e0d19036 | 2353 | suitable for inclusion in |
87eb4fab | 2354 | .BR mdadm.conf . |
feb716e9 NB |
2355 | The exit status of |
2356 | .I mdadm | |
2357 | will normally be 0 unless | |
2358 | .I mdadm | |
93e790af | 2359 | failed to get useful information about the device(s); however, if the |
7e23fc43 | 2360 | .B \-\-test |
feb716e9 NB |
2361 | option is given, then the exit status will be: |
2362 | .RS | |
2363 | .TP | |
2364 | 0 | |
2365 | The array is functioning normally. | |
2366 | .TP | |
2367 | 1 | |
2368 | The array has at least one failed device. | |
2369 | .TP | |
2370 | 2 | |
a77be586 | 2371 | The array has multiple failed devices such that it is unusable. |
feb716e9 NB |
2372 | .TP |
2373 | 4 | |
2374 | There was an error while trying to get information about the device. | |
2375 | .RE | |
cd29a5c8 | 2376 | |
4cce4069 DW |
2377 | .TP |
2378 | .B \-\-detail\-platform | |
e0fe762a | 2379 | Print detail of the platform's RAID capabilities (firmware / hardware |
4cce4069 DW |
2380 | topology). If the metadata is specified with |
2381 | .B \-e | |
2382 | or | |
2383 | .B \-\-metadata= | |
2384 | then the return status will be: | |
2385 | .RS | |
2386 | .TP | |
2387 | 0 | |
2388 | metadata successfully enumerated its platform components on this system | |
2389 | .TP | |
2390 | 1 | |
2391 | metadata is platform independent | |
2392 | .TP | |
2393 | 2 | |
2394 | metadata failed to find its platform components on this system | |
2395 | .RE | |
2396 | ||
aa534678 DW |
2397 | .TP |
2398 | .B \-\-update\-subarray= | |
2399 | If the device is a container and the argument to \-\-update\-subarray | |
2400 | specifies a subarray in the container, then attempt to update the given | |
2401 | superblock field in the subarray. Similar to updating an array in | |
2402 | "assemble" mode, the field to update is selected by | |
2403 | .B \-U | |
2404 | or | |
2405 | .B \-\-update= | |
e6e9dd3f AP |
2406 | option. The supported options are |
2407 | .BR name , | |
dc95f821 JR |
2408 | .BR ppl , |
2409 | .BR no\-ppl , | |
2410 | .BR bitmap | |
e6e9dd3f | 2411 | and |
dc95f821 | 2412 | .BR no\-bitmap . |
aa534678 | 2413 | |
bcbb92d4 | 2414 | The |
aa534678 | 2415 | .B name |
e2eb503b MT |
2416 | option updates the subarray name in the metadata. It must be |
2417 | .BR "POSIX PORTABLE NAME" | |
2418 | compatible and cannot be longer than 32 chars. If successes, new value will be respected after | |
2419 | next assembly. | |
aa534678 | 2420 | |
e6e9dd3f AP |
2421 | The |
2422 | .B ppl | |
2423 | and | |
2424 | .B no\-ppl | |
2425 | options enable and disable PPL in the metadata. Currently supported only for | |
2426 | IMSM subarrays. | |
2427 | ||
dc95f821 JR |
2428 | The |
2429 | .B bitmap | |
2430 | and | |
2431 | .B no\-bitmap | |
2432 | options enable and disable write-intent bitmap in the metadata. Currently supported only for | |
2433 | IMSM subarrays. | |
2434 | ||
e0d19036 | 2435 | .TP |
962a108f | 2436 | .B \-\-examine |
2d465520 | 2437 | The device should be a component of an md array. |
51ac42e3 | 2438 | .I mdadm |
2d465520 | 2439 | will read the md superblock of the device and display the contents. |
e0d19036 | 2440 | If |
7e23fc43 | 2441 | .B \-\-brief |
93e790af | 2442 | or |
7e23fc43 | 2443 | .B \-\-scan |
93e790af | 2444 | is given, then multiple devices that are components of the one array |
e0d19036 NB |
2445 | are grouped together and reported in a single entry suitable |
2446 | for inclusion in | |
87eb4fab | 2447 | .BR mdadm.conf . |
e0d19036 | 2448 | |
2d465520 | 2449 | Having |
7e23fc43 | 2450 | .B \-\-scan |
e0d19036 NB |
2451 | without listing any devices will cause all devices listed in the |
2452 | config file to be examined. | |
2453 | ||
74db60b0 N |
2454 | .TP |
2455 | .BI \-\-dump= directory | |
2456 | If the device contains RAID metadata, a file will be created in the | |
2457 | .I directory | |
2458 | and the metadata will be written to it. The file will be the same | |
1a386f80 MG |
2459 | size as the device and will have the metadata written at the |
2460 | same location as it exists in the device. However, the file will be "sparse" so | |
74db60b0 N |
2461 | that only those blocks containing metadata will be allocated. The |
2462 | total space used will be small. | |
2463 | ||
1a386f80 | 2464 | The filename used in the |
74db60b0 | 2465 | .I directory |
1a386f80 | 2466 | will be the base name of the device. Further, if any links appear in |
74db60b0 N |
2467 | .I /dev/disk/by-id |
2468 | which point to the device, then hard links to the file will be created | |
2469 | in | |
2470 | .I directory | |
2471 | based on these | |
2472 | .I by-id | |
2473 | names. | |
2474 | ||
2475 | Multiple devices can be listed and their metadata will all be stored | |
2476 | in the one directory. | |
2477 | ||
2478 | .TP | |
2479 | .BI \-\-restore= directory | |
2480 | This is the reverse of | |
2481 | .BR \-\-dump . | |
2482 | .I mdadm | |
2483 | will locate a file in the directory that has a name appropriate for | |
2484 | the given device and will restore metadata from it. Names that match | |
2485 | .I /dev/disk/by-id | |
2486 | names are preferred, however if two of those refer to different files, | |
2487 | .I mdadm | |
2488 | will not choose between them but will abort the operation. | |
2489 | ||
2490 | If a file name is given instead of a | |
2491 | .I directory | |
2492 | then | |
2493 | .I mdadm | |
2494 | will restore from that file to a single device, always provided the | |
2495 | size of the file matches that of the device, and the file contains | |
2496 | valid metadata. | |
e0d19036 | 2497 | .TP |
962a108f | 2498 | .B \-\-stop |
98c6faba NB |
2499 | The devices should be active md arrays which will be deactivated, as |
2500 | long as they are not currently in use. | |
e0d19036 NB |
2501 | |
2502 | .TP | |
962a108f | 2503 | .B \-\-run |
e0d19036 NB |
2504 | This will fully activate a partially assembled md array. |
2505 | ||
2506 | .TP | |
962a108f | 2507 | .B \-\-readonly |
e0d19036 NB |
2508 | This will mark an active array as read-only, providing that it is |
2509 | not currently being used. | |
2510 | ||
2511 | .TP | |
962a108f | 2512 | .B \-\-readwrite |
e0d19036 NB |
2513 | This will change a |
2514 | .B readonly | |
2515 | array back to being read/write. | |
2516 | ||
2d465520 | 2517 | .TP |
962a108f | 2518 | .B \-\-scan |
2d465520 | 2519 | For all operations except |
7e23fc43 PS |
2520 | .BR \-\-examine , |
2521 | .B \-\-scan | |
2d465520 NB |
2522 | will cause the operation to be applied to all arrays listed in |
2523 | .BR /proc/mdstat . | |
2524 | For | |
7e23fc43 PS |
2525 | .BR \-\-examine, |
2526 | .B \-\-scan | |
2d465520 NB |
2527 | causes all devices listed in the config file to be examined. |
2528 | ||
a1331cc4 N |
2529 | .TP |
2530 | .BR \-b ", " \-\-brief | |
2531 | Be less verbose. This is used with | |
2532 | .B \-\-detail | |
2533 | and | |
2534 | .BR \-\-examine . | |
2535 | Using | |
2536 | .B \-\-brief | |
2537 | with | |
2538 | .B \-\-verbose | |
2539 | gives an intermediate level of verbosity. | |
2540 | ||
e0d19036 NB |
2541 | .SH MONITOR MODE |
2542 | ||
cd29a5c8 NB |
2543 | .HP 12 |
2544 | Usage: | |
7e23fc43 | 2545 | .B mdadm \-\-monitor |
e0d19036 NB |
2546 | .I options... devices... |
2547 | ||
cd29a5c8 | 2548 | .PP |
725e37cd BK |
2549 | Monitor option can work in two modes: |
2550 | .IP \(bu 4 | |
2551 | system wide mode, follow all md devices based on | |
2552 | .B /proc/mdstat, | |
2553 | .IP \(bu 4 | |
2554 | follow only specified MD devices in command line. | |
2555 | .PP | |
2556 | ||
2557 | .B \-\-scan - | |
2558 | indicates system wide mode. Option causes the | |
2559 | .I monitor | |
2560 | to track all md devices that appear in | |
2561 | .B /proc/mdstat. | |
2562 | If it is not set, then at least one | |
2563 | .B device | |
2564 | must be specified. | |
2565 | ||
2566 | Monitor usage causes | |
51ac42e3 | 2567 | .I mdadm |
e0d19036 NB |
2568 | to periodically poll a number of md arrays and to report on any events |
2569 | noticed. | |
725e37cd BK |
2570 | |
2571 | In both modes, | |
2572 | .I monitor | |
2573 | will work as long as there is an active array with redundancy and it is defined to follow (for | |
2574 | .B \-\-scan | |
2575 | every array is followed). | |
e0d19036 | 2576 | |
2d465520 | 2577 | As well as reporting events, |
51ac42e3 | 2578 | .I mdadm |
2d465520 NB |
2579 | may move a spare drive from one array to another if they are in the |
2580 | same | |
2581 | .B spare-group | |
210597d1 PC |
2582 | or |
2583 | .B domain | |
a9d69660 | 2584 | and if the destination array has a failed drive but no spares. |
2d465520 | 2585 | |
e0d19036 | 2586 | The result of monitoring the arrays is the generation of events. |
bd526cee | 2587 | These events are passed to a separate program (if specified) and may |
2d465520 | 2588 | be mailed to a given E-mail address. |
e0d19036 | 2589 | |
93e790af SW |
2590 | When passing events to a program, the program is run once for each event, |
2591 | and is given 2 or 3 command-line arguments: the first is the | |
2592 | name of the event (see below), the second is the name of the | |
bd526cee | 2593 | md device which is affected, and the third is the name of a related |
93e790af | 2594 | device if relevant (such as a component device that has failed). |
cd29a5c8 NB |
2595 | |
2596 | If | |
7e23fc43 | 2597 | .B \-\-scan |
725e37cd BK |
2598 | is given, then a |
2599 | .B program | |
2600 | or an | |
2601 | .B e-mail | |
2602 | address must be specified on the | |
2603 | command line or in the config file. If neither are available, then | |
51ac42e3 | 2604 | .I mdadm |
e0d19036 | 2605 | will not monitor anything. |
725e37cd BK |
2606 | For devices given directly in command line, without |
2607 | .B program | |
2608 | or | |
2609 | .B email | |
2610 | specified, each event is reported to | |
2611 | .BR stdout. | |
2612 | ||
2613 | Note: For systems where | |
2614 | .If mdadm monitor | |
2615 | is configured via systemd, | |
2616 | .B mdmonitor(mdmonitor.service) | |
2617 | should be configured. The service is designed to be primary solution for array monitoring, | |
2618 | it is configured to work in system wide mode. | |
2619 | It is automatically started and stopped according to current state and types of MD arrays in system. | |
2620 | The service may require additional configuration, like | |
2621 | .B e-mail | |
2622 | or | |
2623 | .B delay. | |
2624 | That should be done in | |
2625 | .B mdadm.conf. | |
cd29a5c8 | 2626 | |
e0d19036 NB |
2627 | The different events are: |
2628 | ||
2629 | .RS 4 | |
2630 | .TP | |
2631 | .B DeviceDisappeared | |
2d465520 | 2632 | An md array which previously was configured appears to no longer be |
773135f5 | 2633 | configured. (syslog priority: Critical) |
e0d19036 | 2634 | |
b8f72a62 NB |
2635 | If |
2636 | .I mdadm | |
2637 | was told to monitor an array which is RAID0 or Linear, then it will | |
2638 | report | |
2639 | .B DeviceDisappeared | |
2640 | with the extra information | |
2641 | .BR Wrong-Level . | |
2642 | This is because RAID0 and Linear do not support the device-failed, | |
2643 | hot-spare and resync operations which are monitored. | |
2644 | ||
e0d19036 NB |
2645 | .TP |
2646 | .B RebuildStarted | |
2ca20929 JC |
2647 | An md array started reconstruction (e.g. recovery, resync, reshape, |
2648 | check, repair). (syslog priority: Warning) | |
e0d19036 NB |
2649 | |
2650 | .TP | |
2651 | .BI Rebuild NN | |
2652 | Where | |
2653 | .I NN | |
1a386f80 MG |
2654 | is a two-digit number (eg. 05, 48). This indicates that the rebuild |
2655 | has reached that percentage of the total. The events are generated | |
2656 | at a fixed increment from 0. The increment size may be specified with | |
2657 | a command-line option (the default is 20). (syslog priority: Warning) | |
e0d19036 | 2658 | |
98c6faba NB |
2659 | .TP |
2660 | .B RebuildFinished | |
2661 | An md array that was rebuilding, isn't any more, either because it | |
773135f5 | 2662 | finished normally or was aborted. (syslog priority: Warning) |
98c6faba | 2663 | |
e0d19036 NB |
2664 | .TP |
2665 | .B Fail | |
773135f5 NB |
2666 | An active component device of an array has been marked as |
2667 | faulty. (syslog priority: Critical) | |
e0d19036 NB |
2668 | |
2669 | .TP | |
2670 | .B FailSpare | |
2671 | A spare component device which was being rebuilt to replace a faulty | |
93e790af | 2672 | device has failed. (syslog priority: Critical) |
e0d19036 NB |
2673 | |
2674 | .TP | |
2675 | .B SpareActive | |
2676 | A spare component device which was being rebuilt to replace a faulty | |
98b24a2a | 2677 | device has been successfully rebuilt and has been made active. |
773135f5 | 2678 | (syslog priority: Info) |
e0d19036 NB |
2679 | |
2680 | .TP | |
2681 | .B NewArray | |
2682 | A new md array has been detected in the | |
2683 | .B /proc/mdstat | |
e0fe762a | 2684 | file. (syslog priority: Info) |
e0d19036 | 2685 | |
aa88f531 NB |
2686 | .TP |
2687 | .B DegradedArray | |
2688 | A newly noticed array appears to be degraded. This message is not | |
2689 | generated when | |
2690 | .I mdadm | |
2691 | notices a drive failure which causes degradation, but only when | |
2692 | .I mdadm | |
2693 | notices that an array is degraded when it first sees the array. | |
93e790af | 2694 | (syslog priority: Critical) |
aa88f531 | 2695 | |
e0d19036 NB |
2696 | .TP |
2697 | .B MoveSpare | |
2698 | A spare drive has been moved from one array in a | |
2699 | .B spare-group | |
210597d1 PC |
2700 | or |
2701 | .B domain | |
e0d19036 | 2702 | to another to allow a failed drive to be replaced. |
773135f5 | 2703 | (syslog priority: Info) |
e0d19036 | 2704 | |
b8f72a62 NB |
2705 | .TP |
2706 | .B SparesMissing | |
2707 | If | |
2708 | .I mdadm | |
2709 | has been told, via the config file, that an array should have a certain | |
2710 | number of spare devices, and | |
2711 | .I mdadm | |
93e790af | 2712 | detects that it has fewer than this number when it first sees the |
b8f72a62 NB |
2713 | array, it will report a |
2714 | .B SparesMissing | |
2715 | message. | |
d1732eeb | 2716 | (syslog priority: Warning) |
b8f72a62 | 2717 | |
98c6faba NB |
2718 | .TP |
2719 | .B TestMessage | |
2720 | An array was found at startup, and the | |
7e23fc43 | 2721 | .B \-\-test |
98c6faba | 2722 | flag was given. |
773135f5 | 2723 | (syslog priority: Info) |
e0d19036 NB |
2724 | .RE |
2725 | ||
2726 | Only | |
93e790af SW |
2727 | .B Fail, |
2728 | .B FailSpare, | |
2729 | .B DegradedArray, | |
2730 | .B SparesMissing | |
e0d19036 | 2731 | and |
98c6faba | 2732 | .B TestMessage |
e0d19036 | 2733 | cause Email to be sent. All events cause the program to be run. |
93e790af | 2734 | The program is run with two or three arguments: the event |
e0d19036 NB |
2735 | name, the array device and possibly a second device. |
2736 | ||
2737 | Each event has an associated array device (e.g. | |
2738 | .BR /dev/md1 ) | |
2739 | and possibly a second device. For | |
2740 | .BR Fail , | |
2741 | .BR FailSpare , | |
2742 | and | |
2743 | .B SpareActive | |
2744 | the second device is the relevant component device. | |
2745 | For | |
2746 | .B MoveSpare | |
2747 | the second device is the array that the spare was moved from. | |
2748 | ||
2749 | For | |
51ac42e3 | 2750 | .I mdadm |
e0d19036 | 2751 | to move spares from one array to another, the different arrays need to |
93e790af | 2752 | be labeled with the same |
e0d19036 | 2753 | .B spare-group |
210597d1 | 2754 | or the spares must be allowed to migrate through matching POLICY domains |
e0d19036 NB |
2755 | in the configuration file. The |
2756 | .B spare-group | |
93e790af | 2757 | name can be any string; it is only necessary that different spare |
2d465520 | 2758 | groups use different names. |
e0d19036 NB |
2759 | |
2760 | When | |
51ac42e3 | 2761 | .I mdadm |
93e790af | 2762 | detects that an array in a spare group has fewer active |
e0d19036 NB |
2763 | devices than necessary for the complete array, and has no spare |
2764 | devices, it will look for another array in the same spare group that | |
1a386f80 MG |
2765 | has a full complement of working drives and a spare. It will then |
2766 | attempt to remove the spare from the second array and add it to the | |
e0d19036 NB |
2767 | first. |
2768 | If the removal succeeds but the adding fails, then it is added back to | |
2769 | the original array. | |
2770 | ||
210597d1 PC |
2771 | If the spare group for a degraded array is not defined, |
2772 | .I mdadm | |
2773 | will look at the rules of spare migration specified by POLICY lines in | |
87eb4fab | 2774 | .B mdadm.conf |
210597d1 PC |
2775 | and then follow similar steps as above if a matching spare is found. |
2776 | ||
dd0781e5 NB |
2777 | .SH GROW MODE |
2778 | The GROW mode is used for changing the size or shape of an active | |
2779 | array. | |
dd0781e5 | 2780 | |
1a386f80 | 2781 | During the kernel 2.6 era the following changes were added: |
dfd4d8ee | 2782 | .IP \(bu 4 |
c64881d7 | 2783 | change the "size" attribute for RAID1, RAID4, RAID5 and RAID6. |
dfd4d8ee | 2784 | .IP \(bu 4 |
c64881d7 N |
2785 | increase or decrease the "raid\-devices" attribute of RAID0, RAID1, RAID4, |
2786 | RAID5, and RAID6. | |
cb77f620 | 2787 | .IP \(bu 4 |
17790db6 | 2788 | change the chunk-size and layout of RAID0, RAID4, RAID5, RAID6 and RAID10. |
cb77f620 | 2789 | .IP \(bu 4 |
c64881d7 | 2790 | convert between RAID1 and RAID5, between RAID5 and RAID6, between |
cb77f620 | 2791 | RAID0, RAID4, and RAID5, and between RAID0 and RAID10 (in the near-2 mode). |
dfd4d8ee | 2792 | .IP \(bu 4 |
93e790af | 2793 | add a write-intent bitmap to any array which supports these bitmaps, or |
2ae555c3 | 2794 | remove a write-intent bitmap from such an array. |
860f11ed AP |
2795 | .IP \(bu 4 |
2796 | change the array's consistency policy. | |
dfd4d8ee | 2797 | .PP |
dd0781e5 | 2798 | |
9ab6e80a | 2799 | Using GROW on containers is currently supported only for Intel's IMSM |
c64881d7 N |
2800 | container format. The number of devices in a container can be |
2801 | increased - which affects all arrays in the container - or an array | |
2802 | in a container can be converted between levels where those levels are | |
2803 | supported by the container, and the conversion is on of those listed | |
4431efeb | 2804 | above. |
8fd8d9c4 | 2805 | |
0de8d44d | 2806 | .PP |
5a5b3a67 MZ |
2807 | Notes: |
2808 | .IP \(bu 4 | |
2809 | Intel's native checkpointing doesn't use | |
0de8d44d AK |
2810 | .B --backup-file |
2811 | option and it is transparent for assembly feature. | |
5a5b3a67 MZ |
2812 | .IP \(bu 4 |
2813 | Roaming between Windows(R) and Linux systems for IMSM metadata is not | |
2814 | supported during grow process. | |
2551061c CL |
2815 | .IP \(bu 4 |
2816 | When growing a raid0 device, the new component disk size (or external | |
2817 | backup size) should be larger than LCM(old, new) * chunk-size * 2, | |
2818 | where LCM() is the least common multiple of the old and new count of | |
2819 | component disks, and "* 2" comes from the fact that mdadm refuses to | |
2820 | use more than half of a spare device for backup space. | |
0de8d44d | 2821 | |
2ae555c3 | 2822 | .SS SIZE CHANGES |
c64881d7 | 2823 | Normally when an array is built the "size" is taken from the smallest |
1a386f80 MG |
2824 | of the drives. If all the small drives in an arrays are, over time, |
2825 | removed and replaced with larger drives, then you could have an | |
dd0781e5 NB |
2826 | array of large drives with only a small amount used. In this |
2827 | situation, changing the "size" with "GROW" mode will allow the extra | |
2828 | space to start being used. If the size is increased in this way, a | |
2829 | "resync" process will start to make sure the new parts of the array | |
2830 | are synchronised. | |
2831 | ||
2832 | Note that when an array changes size, any filesystem that may be | |
cb77f620 | 2833 | stored in the array will not automatically grow or shrink to use or |
88b496c2 | 2834 | vacate the space. The |
666bba9b N |
2835 | filesystem will need to be explicitly told to use the extra space |
2836 | after growing, or to reduce its size | |
2837 | .B prior | |
2838 | to shrinking the array. | |
dd0781e5 | 2839 | |
1a386f80 | 2840 | Also, the size of an array cannot be changed while it has an active |
e0fe762a | 2841 | bitmap. If an array has a bitmap, it must be removed before the size |
cb77f620 | 2842 | can be changed. Once the change is complete a new bitmap can be created. |
e0fe762a | 2843 | |
7fa9af4c ZL |
2844 | .PP |
2845 | Note: | |
2846 | .B "--grow --size" | |
2847 | is not yet supported for external file bitmap. | |
2848 | ||
e0fe762a | 2849 | .SS RAID\-DEVICES CHANGES |
2ae555c3 | 2850 | |
dd0781e5 NB |
2851 | A RAID1 array can work with any number of devices from 1 upwards |
2852 | (though 1 is not very useful). There may be times which you want to | |
2853 | increase or decrease the number of active devices. Note that this is | |
2854 | different to hot-add or hot-remove which changes the number of | |
2855 | inactive devices. | |
2856 | ||
2857 | When reducing the number of devices in a RAID1 array, the slots which | |
2858 | are to be removed from the array must already be vacant. That is, the | |
93e790af | 2859 | devices which were in those slots must be failed and removed. |
dd0781e5 NB |
2860 | |
2861 | When the number of devices is increased, any hot spares that are | |
a9d69660 | 2862 | present will be activated immediately. |
dd0781e5 | 2863 | |
f24e2d6c | 2864 | Changing the number of active devices in a RAID5 or RAID6 is much more |
2ae555c3 | 2865 | effort. Every block in the array will need to be read and written |
f24e2d6c | 2866 | back to a new location. From 2.6.17, the Linux Kernel is able to |
ca4f89a3 N |
2867 | increase the number of devices in a RAID5 safely, including restarting |
2868 | an interrupted "reshape". From 2.6.31, the Linux Kernel is able to | |
f24e2d6c N |
2869 | increase or decrease the number of devices in a RAID5 or RAID6. |
2870 | ||
c64881d7 N |
2871 | From 2.6.35, the Linux Kernel is able to convert a RAID0 in to a RAID4 |
2872 | or RAID5. | |
2873 | .I mdadm | |
2874 | uses this functionality and the ability to add | |
2875 | devices to a RAID4 to allow devices to be added to a RAID0. When | |
2876 | requested to do this, | |
2877 | .I mdadm | |
2878 | will convert the RAID0 to a RAID4, add the necessary disks and make | |
2879 | the reshape happen, and then convert the RAID4 back to RAID0. | |
2880 | ||
f24e2d6c N |
2881 | When decreasing the number of devices, the size of the array will also |
2882 | decrease. If there was data in the array, it could get destroyed and | |
666bba9b N |
2883 | this is not reversible, so you should firstly shrink the filesystem on |
2884 | the array to fit within the new size. To help prevent accidents, | |
f24e2d6c N |
2885 | .I mdadm |
2886 | requires that the size of the array be decreased first with | |
2887 | .BR "mdadm --grow --array-size" . | |
2888 | This is a reversible change which simply makes the end of the array | |
2889 | inaccessible. The integrity of any data can then be checked before | |
2890 | the non-reversible reduction in the number of devices is request. | |
2ae555c3 | 2891 | |
cd19c0cf JR |
2892 | When relocating the first few stripes on a RAID5 or RAID6, it is not |
2893 | possible to keep the data on disk completely consistent and | |
2894 | crash-proof. To provide the required safety, mdadm disables writes to | |
2895 | the array while this "critical section" is reshaped, and takes a | |
2896 | backup of the data that is in that section. For grows, this backup may be | |
2897 | stored in any spare devices that the array has, however it can also be | |
2898 | stored in a separate file specified with the | |
7e23fc43 | 2899 | .B \-\-backup\-file |
cd19c0cf JR |
2900 | option, and is required to be specified for shrinks, RAID level |
2901 | changes and layout changes. If this option is used, and the system | |
2902 | does crash during the critical period, the same file must be passed to | |
7e23fc43 | 2903 | .B \-\-assemble |
cd19c0cf JR |
2904 | to restore the backup and reassemble the array. When shrinking rather |
2905 | than growing the array, the reshape is done from the end towards the | |
2906 | beginning, so the "critical section" is at the end of the reshape. | |
2ae555c3 | 2907 | |
f24e2d6c N |
2908 | .SS LEVEL CHANGES |
2909 | ||
2910 | Changing the RAID level of any array happens instantaneously. However | |
cd19c0cf | 2911 | in the RAID5 to RAID6 case this requires a non-standard layout of the |
f24e2d6c | 2912 | RAID6 data, and in the RAID6 to RAID5 case that non-standard layout is |
cd19c0cf | 2913 | required before the change can be accomplished. So while the level |
f24e2d6c | 2914 | change is instant, the accompanying layout change can take quite a |
cd19c0cf JR |
2915 | long time. A |
2916 | .B \-\-backup\-file | |
2917 | is required. If the array is not simultaneously being grown or | |
2918 | shrunk, so that the array size will remain the same - for example, | |
2919 | reshaping a 3-drive RAID5 into a 4-drive RAID6 - the backup file will | |
1a386f80 | 2920 | be used not just for a "critical section" but throughout the reshape |
cd19c0cf | 2921 | operation, as described below under LAYOUT CHANGES. |
f24e2d6c N |
2922 | |
2923 | .SS CHUNK-SIZE AND LAYOUT CHANGES | |
2924 | ||
ec7d7cee | 2925 | Changing the chunk-size or layout without also changing the number of |
f24e2d6c N |
2926 | devices as the same time will involve re-writing all blocks in-place. |
2927 | To ensure against data loss in the case of a crash, a | |
2928 | .B --backup-file | |
2929 | must be provided for these changes. Small sections of the array will | |
cd19c0cf JR |
2930 | be copied to the backup file while they are being rearranged. This |
2931 | means that all the data is copied twice, once to the backup and once | |
2932 | to the new layout on the array, so this type of reshape will go very | |
2933 | slowly. | |
f24e2d6c N |
2934 | |
2935 | If the reshape is interrupted for any reason, this backup file must be | |
cd19c0cf | 2936 | made available to |
f24e2d6c | 2937 | .B "mdadm --assemble" |
1a386f80 | 2938 | so the array can be reassembled. Consequently, the file cannot be |
f24e2d6c N |
2939 | stored on the device being reshaped. |
2940 | ||
2941 | ||
2ae555c3 NB |
2942 | .SS BITMAP CHANGES |
2943 | ||
2944 | A write-intent bitmap can be added to, or removed from, an active | |
93e790af | 2945 | array. Either internal bitmaps, or bitmaps stored in a separate file, |
fe80f49b | 2946 | can be added. Note that if you add a bitmap stored in a file which is |
e0fe762a | 2947 | in a filesystem that is on the RAID array being affected, the system |
fe80f49b NB |
2948 | will deadlock. The bitmap must be on a separate filesystem. |
2949 | ||
860f11ed AP |
2950 | .SS CONSISTENCY POLICY CHANGES |
2951 | ||
2952 | The consistency policy of an active array can be changed by using the | |
2953 | .B \-\-consistency\-policy | |
2954 | option in Grow mode. Currently this works only for the | |
2955 | .B ppl | |
2956 | and | |
2957 | .B resync | |
2958 | policies and allows to enable or disable the RAID5 Partial Parity Log (PPL). | |
2959 | ||
8382f19b NB |
2960 | .SH INCREMENTAL MODE |
2961 | ||
2962 | .HP 12 | |
2963 | Usage: | |
7e23fc43 PS |
2964 | .B mdadm \-\-incremental |
2965 | .RB [ \-\-run ] | |
2966 | .RB [ \-\-quiet ] | |
8382f19b | 2967 | .I component-device |
b11fe74d | 2968 | .RI [ optional-aliases-for-device ] |
8382f19b NB |
2969 | .HP 12 |
2970 | Usage: | |
29ba4804 N |
2971 | .B mdadm \-\-incremental \-\-fail |
2972 | .I component-device | |
2973 | .HP 12 | |
2974 | Usage: | |
7e6140e6 | 2975 | .B mdadm \-\-incremental \-\-rebuild\-map |
8382f19b NB |
2976 | .HP 12 |
2977 | Usage: | |
7e23fc43 | 2978 | .B mdadm \-\-incremental \-\-run \-\-scan |
8382f19b | 2979 | |
8382f19b NB |
2980 | .PP |
2981 | This mode is designed to be used in conjunction with a device | |
2982 | discovery system. As devices are found in a system, they can be | |
2983 | passed to | |
7e23fc43 | 2984 | .B "mdadm \-\-incremental" |
8382f19b NB |
2985 | to be conditionally added to an appropriate array. |
2986 | ||
29ba4804 N |
2987 | Conversely, it can also be used with the |
2988 | .B \-\-fail | |
2989 | flag to do just the opposite and find whatever array a particular device | |
2990 | is part of and remove the device from that array. | |
2991 | ||
8fd8d9c4 N |
2992 | If the device passed is a |
2993 | .B CONTAINER | |
2994 | device created by a previous call to | |
2995 | .IR mdadm , | |
2996 | then rather than trying to add that device to an array, all the arrays | |
2997 | described by the metadata of the container will be started. | |
2998 | ||
8382f19b NB |
2999 | .I mdadm |
3000 | performs a number of tests to determine if the device is part of an | |
93e790af | 3001 | array, and which array it should be part of. If an appropriate array |
8382f19b NB |
3002 | is found, or can be created, |
3003 | .I mdadm | |
3004 | adds the device to the array and conditionally starts the array. | |
3005 | ||
3006 | Note that | |
3007 | .I mdadm | |
87eb4fab N |
3008 | will normally only add devices to an array which were previously working |
3009 | (active or spare) parts of that array. The support for automatic | |
210597d1 PC |
3010 | inclusion of a new drive as a spare in some array requires |
3011 | a configuration through POLICY in config file. | |
8382f19b | 3012 | |
8382f19b NB |
3013 | The tests that |
3014 | .I mdadm | |
3015 | makes are as follow: | |
3016 | .IP + | |
3017 | Is the device permitted by | |
3018 | .BR mdadm.conf ? | |
3019 | That is, is it listed in a | |
3020 | .B DEVICES | |
3021 | line in that file. If | |
3022 | .B DEVICES | |
b11fe74d | 3023 | is absent then the default it to allow any device. Similarly if |
8382f19b NB |
3024 | .B DEVICES |
3025 | contains the special word | |
3026 | .B partitions | |
3027 | then any device is allowed. Otherwise the device name given to | |
b11fe74d N |
3028 | .IR mdadm , |
3029 | or one of the aliases given, or an alias found in the filesystem, | |
8382f19b NB |
3030 | must match one of the names or patterns in a |
3031 | .B DEVICES | |
3032 | line. | |
3033 | ||
b11fe74d N |
3034 | This is the only context where the aliases are used. They are |
3035 | usually provided by a | |
3036 | .I udev | |
3037 | rules mentioning | |
ceb5f8ef | 3038 | .BR $env{DEVLINKS} . |
b11fe74d | 3039 | |
8382f19b | 3040 | .IP + |
cb77f620 NK |
3041 | Does the device have a valid md superblock? If a specific metadata |
3042 | version is requested with | |
7e23fc43 | 3043 | .B \-\-metadata |
8382f19b | 3044 | or |
7e23fc43 | 3045 | .B \-e |
8382f19b NB |
3046 | then only that style of metadata is accepted, otherwise |
3047 | .I mdadm | |
3048 | finds any known version of metadata. If no | |
3049 | .I md | |
210597d1 PC |
3050 | metadata is found, the device may be still added to an array |
3051 | as a spare if POLICY allows. | |
8382f19b | 3052 | |
d1302dd8 | 3053 | .ig |
8382f19b NB |
3054 | .IP + |
3055 | Does the metadata match an expected array? | |
3056 | The metadata can match in two ways. Either there is an array listed | |
3057 | in | |
3058 | .B mdadm.conf | |
3059 | which identifies the array (either by UUID, by name, by device list, | |
93e790af | 3060 | or by minor-number), or the array was created with a |
8382f19b | 3061 | .B homehost |
93e790af | 3062 | specified and that |
8382f19b | 3063 | .B homehost |
93e790af | 3064 | matches the one in |
8382f19b NB |
3065 | .B mdadm.conf |
3066 | or on the command line. | |
3067 | If | |
3068 | .I mdadm | |
3069 | is not able to positively identify the array as belonging to the | |
3070 | current host, the device will be rejected. | |
d1302dd8 | 3071 | .. |
8382f19b | 3072 | |
cb77f620 | 3073 | .PP |
8382f19b | 3074 | .I mdadm |
93e790af | 3075 | keeps a list of arrays that it has partially assembled in |
96fd06ed | 3076 | .BR {MAP_PATH} . |
e0fe762a | 3077 | If no array exists which matches |
8382f19b NB |
3078 | the metadata on the new device, |
3079 | .I mdadm | |
3080 | must choose a device name and unit number. It does this based on any | |
3081 | name given in | |
3082 | .B mdadm.conf | |
3083 | or any name information stored in the metadata. If this name | |
3084 | suggests a unit number, that number will be used, otherwise a free | |
3085 | unit number will be chosen. Normally | |
3086 | .I mdadm | |
3087 | will prefer to create a partitionable array, however if the | |
3088 | .B CREATE | |
3089 | line in | |
3090 | .B mdadm.conf | |
3091 | suggests that a non-partitionable array is preferred, that will be | |
3092 | honoured. | |
3093 | ||
e0fe762a N |
3094 | If the array is not found in the config file and its metadata does not |
3095 | identify it as belonging to the "homehost", then | |
3096 | .I mdadm | |
3097 | will choose a name for the array which is certain not to conflict with | |
3098 | any array which does belong to this host. It does this be adding an | |
3099 | underscore and a small number to the name preferred by the metadata. | |
3100 | ||
8382f19b NB |
3101 | Once an appropriate array is found or created and the device is added, |
3102 | .I mdadm | |
3103 | must decide if the array is ready to be started. It will | |
3104 | normally compare the number of available (non-spare) devices to the | |
3105 | number of devices that the metadata suggests need to be active. If | |
3106 | there are at least that many, the array will be started. This means | |
3107 | that if any devices are missing the array will not be restarted. | |
3108 | ||
3109 | As an alternative, | |
7e23fc43 | 3110 | .B \-\-run |
8382f19b | 3111 | may be passed to |
51ac42e3 | 3112 | .I mdadm |
8382f19b | 3113 | in which case the array will be run as soon as there are enough |
e0fe762a N |
3114 | devices present for the data to be accessible. For a RAID1, that |
3115 | means one device will start the array. For a clean RAID5, the array | |
8382f19b NB |
3116 | will be started as soon as all but one drive is present. |
3117 | ||
93e790af | 3118 | Note that neither of these approaches is really ideal. If it can |
8382f19b NB |
3119 | be known that all device discovery has completed, then |
3120 | .br | |
7e23fc43 | 3121 | .B " mdadm \-IRs" |
8382f19b NB |
3122 | .br |
3123 | can be run which will try to start all arrays that are being | |
3124 | incrementally assembled. They are started in "read-auto" mode in | |
3125 | which they are read-only until the first write request. This means | |
3126 | that no metadata updates are made and no attempt at resync or recovery | |
3127 | happens. Further devices that are found before the first write can | |
3128 | still be added safely. | |
3129 | ||
5545fa6d DW |
3130 | .SH ENVIRONMENT |
3131 | This section describes environment variables that affect how mdadm | |
3132 | operates. | |
3133 | ||
3134 | .TP | |
3135 | .B MDADM_NO_MDMON | |
3136 | Setting this value to 1 will prevent mdadm from automatically launching | |
3137 | mdmon. This variable is intended primarily for debugging mdadm/mdmon. | |
3138 | ||
8fd8d9c4 N |
3139 | .TP |
3140 | .B MDADM_NO_UDEV | |
3141 | Normally, | |
3142 | .I mdadm | |
3143 | does not create any device nodes in /dev, but leaves that task to | |
3144 | .IR udev . | |
3145 | If | |
3146 | .I udev | |
3147 | appears not to be configured, or if this environment variable is set | |
3148 | to '1', the | |
3149 | .I mdadm | |
3150 | will create and devices that are needed. | |
3151 | ||
f66585eb N |
3152 | .TP |
3153 | .B MDADM_NO_SYSTEMCTL | |
3154 | If | |
3155 | .I mdadm | |
3156 | detects that | |
3157 | .I systemd | |
3158 | is in use it will normally request | |
3159 | .I systemd | |
3160 | to start various background tasks (particularly | |
3161 | .IR mdmon ) | |
3162 | rather than forking and running them in the background. This can be | |
3163 | suppressed by setting | |
3164 | .BR MDADM_NO_SYSTEMCTL=1 . | |
3165 | ||
401f095c N |
3166 | .TP |
3167 | .B IMSM_NO_PLATFORM | |
3168 | A key value of IMSM metadata is that it allows interoperability with | |
3169 | boot ROMs on Intel platforms, and with other major operating systems. | |
3170 | Consequently, | |
3171 | .I mdadm | |
3172 | will only allow an IMSM array to be created or modified if detects | |
3173 | that it is running on an Intel platform which supports IMSM, and | |
3174 | supports the particular configuration of IMSM that is being requested | |
3175 | (some functionality requires newer OROM support). | |
3176 | ||
3177 | These checks can be suppressed by setting IMSM_NO_PLATFORM=1 in the | |
3178 | environment. This can be useful for testing or for disaster | |
3179 | recovery. You should be aware that interoperability may be | |
3180 | compromised by setting this value. | |
2dfb675b | 3181 | |
37eeae38 | 3182 | These change can also be suppressed by adding |
420dafcd N |
3183 | .B mdadm.imsm.test=1 |
3184 | to the kernel command line. This makes it easy to test IMSM | |
3185 | code in a virtual machine that doesn't have IMSM virtual hardware. | |
3186 | ||
f66585eb N |
3187 | .TP |
3188 | .B MDADM_GROW_ALLOW_OLD | |
3189 | If an array is stopped while it is performing a reshape and that | |
3190 | reshape was making use of a backup file, then when the array is | |
3191 | re-assembled | |
3192 | .I mdadm | |
3193 | will sometimes complain that the backup file is too old. If this | |
3194 | happens and you are certain it is the right backup file, you can | |
3195 | over-ride this check by setting | |
3196 | .B MDADM_GROW_ALLOW_OLD=1 | |
3197 | in the environment. | |
3198 | ||
2dfb675b N |
3199 | .TP |
3200 | .B MDADM_CONF_AUTO | |
3201 | Any string given in this variable is added to the start of the | |
3202 | .B AUTO | |
3203 | line in the config file, or treated as the whole | |
3204 | .B AUTO | |
3205 | line if none is given. It can be used to disable certain metadata | |
3206 | types when | |
3207 | .I mdadm | |
3208 | is called from a boot script. For example | |
3209 | .br | |
3210 | .B " export MDADM_CONF_AUTO='-ddf -imsm' | |
3211 | .br | |
3212 | will make sure that | |
3213 | .I mdadm | |
3214 | does not automatically assemble any DDF or | |
3215 | IMSM arrays that are found. This can be useful on systems configured | |
3216 | to manage such arrays with | |
3217 | .BR dmraid . | |
3218 | ||
3219 | ||
2d465520 NB |
3220 | .SH EXAMPLES |
3221 | ||
7e23fc43 | 3222 | .B " mdadm \-\-query /dev/name-of-device" |
2d465520 | 3223 | .br |
e0fe762a | 3224 | This will find out if a given device is a RAID array, or is part of |
5787fa49 | 3225 | one, and will provide brief information about the device. |
2d465520 | 3226 | |
7e23fc43 | 3227 | .B " mdadm \-\-assemble \-\-scan" |
2d465520 | 3228 | .br |
93e790af | 3229 | This will assemble and start all arrays listed in the standard config |
5787fa49 | 3230 | file. This command will typically go in a system startup file. |
2d465520 | 3231 | |
7e23fc43 | 3232 | .B " mdadm \-\-stop \-\-scan" |
5787fa49 | 3233 | .br |
93e790af | 3234 | This will shut down all arrays that can be shut down (i.e. are not |
19f8b8fc | 3235 | currently in use). This will typically go in a system shutdown script. |
2d465520 | 3236 | |
7e23fc43 | 3237 | .B " mdadm \-\-follow \-\-scan \-\-delay=120" |
2d465520 | 3238 | .br |
5787fa49 NB |
3239 | If (and only if) there is an Email address or program given in the |
3240 | standard config file, then | |
3241 | monitor the status of all arrays listed in that file by | |
3242 | polling them ever 2 minutes. | |
2d465520 | 3243 | |
7e23fc43 | 3244 | .B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1" |
2d465520 | 3245 | .br |
5787fa49 | 3246 | Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1. |
2d465520 | 3247 | |
2d465520 | 3248 | .br |
7e23fc43 | 3249 | .B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf" |
2d465520 | 3250 | .br |
7e23fc43 | 3251 | .B " mdadm \-\-detail \-\-scan >> mdadm.conf" |
2d465520 | 3252 | .br |
5787fa49 NB |
3253 | This will create a prototype config file that describes currently |
3254 | active arrays that are known to be made from partitions of IDE or SCSI drives. | |
2d465520 NB |
3255 | This file should be reviewed before being used as it may |
3256 | contain unwanted detail. | |
3257 | ||
7e23fc43 | 3258 | .B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf" |
2d465520 | 3259 | .br |
7e23fc43 | 3260 | .B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf" |
93e790af SW |
3261 | .br |
3262 | This will find arrays which could be assembled from existing IDE and | |
3263 | SCSI whole drives (not partitions), and store the information in the | |
5787fa49 | 3264 | format of a config file. |
2d465520 NB |
3265 | This file is very likely to contain unwanted detail, particularly |
3266 | the | |
3267 | .B devices= | |
5787fa49 NB |
3268 | entries. It should be reviewed and edited before being used as an |
3269 | actual config file. | |
2d465520 | 3270 | |
7e23fc43 | 3271 | .B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions" |
2d465520 | 3272 | .br |
7e23fc43 | 3273 | .B " mdadm \-Ebsc partitions" |
5787fa49 NB |
3274 | .br |
3275 | Create a list of devices by reading | |
3276 | .BR /proc/partitions , | |
3277 | scan these for RAID superblocks, and printout a brief listing of all | |
93e790af | 3278 | that were found. |
2d465520 | 3279 | |
7e23fc43 | 3280 | .B " mdadm \-Ac partitions \-m 0 /dev/md0" |
2d465520 | 3281 | .br |
5787fa49 NB |
3282 | Scan all partitions and devices listed in |
3283 | .BR /proc/partitions | |
3284 | and assemble | |
3285 | .B /dev/md0 | |
3286 | out of all such devices with a RAID superblock with a minor number of 0. | |
2d465520 | 3287 | |
96fd06ed | 3288 | .B " mdadm \-\-monitor \-\-scan \-\-daemonise > /run/mdadm/mon.pid" |
d013a55e NB |
3289 | .br |
3290 | If config file contains a mail address or alert program, run mdadm in | |
3291 | the background in monitor mode monitoring all md devices. Also write | |
3292 | pid of mdadm daemon to | |
96fd06ed | 3293 | .BR /run/mdadm/mon.pid . |
d013a55e | 3294 | |
7e23fc43 | 3295 | .B " mdadm \-Iq /dev/somedevice" |
8382f19b NB |
3296 | .br |
3297 | Try to incorporate newly discovered device into some array as | |
3298 | appropriate. | |
3299 | ||
7e6140e6 | 3300 | .B " mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan" |
8382f19b NB |
3301 | .br |
3302 | Rebuild the array map from any current arrays, and then start any that | |
3303 | can be started. | |
3304 | ||
b80da661 NB |
3305 | .B " mdadm /dev/md4 --fail detached --remove detached" |
3306 | .br | |
3307 | Any devices which are components of /dev/md4 will be marked as faulty | |
3308 | and then remove from the array. | |
3309 | ||
cb77f620 | 3310 | .B " mdadm --grow /dev/md4 --level=6 --backup-file=/root/backup-md4" |
f24e2d6c N |
3311 | .br |
3312 | The array | |
3313 | .B /dev/md4 | |
3314 | which is currently a RAID5 array will be converted to RAID6. There | |
3315 | should normally already be a spare drive attached to the array as a | |
3316 | RAID6 needs one more drive than a matching RAID5. | |
3317 | ||
8fd8d9c4 N |
3318 | .B " mdadm --create /dev/md/ddf --metadata=ddf --raid-disks 6 /dev/sd[a-f]" |
3319 | .br | |
3320 | Create a DDF array over 6 devices. | |
3321 | ||
3322 | .B " mdadm --create /dev/md/home -n3 -l5 -z 30000000 /dev/md/ddf" | |
3323 | .br | |
e0fe762a | 3324 | Create a RAID5 array over any 3 devices in the given DDF set. Use |
8fd8d9c4 N |
3325 | only 30 gigabytes of each device. |
3326 | ||
3327 | .B " mdadm -A /dev/md/ddf1 /dev/sd[a-f]" | |
3328 | .br | |
3329 | Assemble a pre-exist ddf array. | |
3330 | ||
3331 | .B " mdadm -I /dev/md/ddf1" | |
3332 | .br | |
3333 | Assemble all arrays contained in the ddf array, assigning names as | |
3334 | appropriate. | |
3335 | ||
7e23fc43 | 3336 | .B " mdadm \-\-create \-\-help" |
2d465520 | 3337 | .br |
2ae555c3 | 3338 | Provide help about the Create mode. |
2d465520 | 3339 | |
7e23fc43 | 3340 | .B " mdadm \-\-config \-\-help" |
5787fa49 NB |
3341 | .br |
3342 | Provide help about the format of the config file. | |
2d465520 | 3343 | |
7e23fc43 | 3344 | .B " mdadm \-\-help" |
5787fa49 NB |
3345 | .br |
3346 | Provide general help. | |
cd29a5c8 | 3347 | |
cd29a5c8 NB |
3348 | .SH FILES |
3349 | ||
3350 | .SS /proc/mdstat | |
3351 | ||
2ae555c3 NB |
3352 | If you're using the |
3353 | .B /proc | |
cd29a5c8 NB |
3354 | filesystem, |
3355 | .B /proc/mdstat | |
2d465520 | 3356 | lists all active md devices with information about them. |
51ac42e3 | 3357 | .I mdadm |
2d465520 | 3358 | uses this to find arrays when |
7e23fc43 | 3359 | .B \-\-scan |
2d465520 NB |
3360 | is given in Misc mode, and to monitor array reconstruction |
3361 | on Monitor mode. | |
3362 | ||
e9dd5644 | 3363 | .SS {CONFFILE} (or {CONFFILE2}) |
cd29a5c8 | 3364 | |
24e075c6 | 3365 | Default config file. See |
11a3e71d NB |
3366 | .BR mdadm.conf (5) |
3367 | for more details. | |
cd29a5c8 | 3368 | |
e9dd5644 | 3369 | .SS {CONFFILE}.d (or {CONFFILE2}.d) |
9dc70cbc | 3370 | |
24e075c6 LF |
3371 | Default directory containing configuration files. See |
3372 | .BR mdadm.conf (5) | |
3373 | for more details. | |
9dc70cbc | 3374 | |
96fd06ed | 3375 | .SS {MAP_PATH} |
8382f19b | 3376 | When |
7e23fc43 | 3377 | .B \-\-incremental |
93e790af | 3378 | mode is used, this file gets a list of arrays currently being created. |
8382f19b | 3379 | |
e2eb503b MT |
3380 | .SH POSIX PORTABLE NAME |
3381 | A valid name can only consist of characters "A-Za-z0-9.-_". | |
3382 | The name cannot start with a leading "-" and cannot exceed 255 chars. | |
3383 | ||
48f7b27a NB |
3384 | .SH DEVICE NAMES |
3385 | ||
48f7b27a | 3386 | .I mdadm |
8fd8d9c4 N |
3387 | understand two sorts of names for array devices. |
3388 | ||
3389 | The first is the so-called 'standard' format name, which matches the | |
3390 | names used by the kernel and which appear in | |
3391 | .IR /proc/mdstat . | |
3392 | ||
3393 | The second sort can be freely chosen, but must reside in | |
3394 | .IR /dev/md/ . | |
3395 | When giving a device name to | |
3396 | .I mdadm | |
3397 | to create or assemble an array, either full path name such as | |
3398 | .I /dev/md0 | |
3399 | or | |
3400 | .I /dev/md/home | |
3401 | can be given, or just the suffix of the second sort of name, such as | |
3402 | .I home | |
3403 | can be given. | |
3404 | ||
e2eb503b MT |
3405 | In every style, raw name must be compatible with |
3406 | .BR "POSIX PORTABLE NAME" | |
3407 | and has to be no longer than 32 chars. | |
3408 | ||
8fd8d9c4 N |
3409 | When |
3410 | .I mdadm | |
e0fe762a N |
3411 | chooses device names during auto-assembly or incremental assembly, it |
3412 | will sometimes add a small sequence number to the end of the name to | |
3413 | avoid conflicted between multiple arrays that have the same name. If | |
8fd8d9c4 N |
3414 | .I mdadm |
3415 | can reasonably determine that the array really is meant for this host, | |
3416 | either by a hostname in the metadata, or by the presence of the array | |
87eb4fab N |
3417 | in |
3418 | .BR mdadm.conf , | |
3419 | then it will leave off the suffix if possible. | |
e0fe762a N |
3420 | Also if the homehost is specified as |
3421 | .B <ignore> | |
3422 | .I mdadm | |
3423 | will only use a suffix if a different array of the same name already | |
3424 | exists or is listed in the config file. | |
48f7b27a NB |
3425 | |
3426 | The standard names for non-partitioned arrays (the only sort of md | |
8fd8d9c4 | 3427 | array available in 2.4 and earlier) are of the form |
48f7b27a | 3428 | .IP |
eca944fa | 3429 | .RB /dev/md NN |
48f7b27a NB |
3430 | .PP |
3431 | where NN is a number. | |
3432 | The standard names for partitionable arrays (as available from 2.6 | |
eca944fa | 3433 | onwards) are of the form: |
48f7b27a | 3434 | .IP |
eca944fa | 3435 | .RB /dev/md_d NN |
48f7b27a | 3436 | .PP |
eca944fa | 3437 | Partition numbers should be indicated by adding "pMM" to these, thus "/dev/md/d1p2". |
8fd8d9c4 | 3438 | .PP |
eca944fa N |
3439 | From kernel version 2.6.28 the "non-partitioned array" can actually |
3440 | be partitioned. So the "md_d\fBNN\fP" | |
3441 | names are no longer needed, and | |
0de5349e | 3442 | partitions such as "/dev/md\fBNN\fPp\fBXX\fP" |
eca944fa N |
3443 | are possible. |
3444 | .PP | |
3445 | From kernel version 2.6.29 standard names can be non-numeric following | |
3446 | the form: | |
3447 | .IP | |
3448 | .RB /dev/md_ XXX | |
3449 | .PP | |
3450 | where | |
3451 | .B XXX | |
3452 | is any string. These names are supported by | |
3453 | .I mdadm | |
3454 | since version 3.3 provided they are enabled in | |
3455 | .IR mdadm.conf . | |
52826846 | 3456 | |
37eeae38 MK |
3457 | .SH UNDERSTANDING OUTPUT |
3458 | ||
3459 | .TP | |
3460 | EXAMINE | |
3461 | ||
3462 | .TP | |
3463 | .B checkpoint | |
3464 | Checkpoint value is reported when array is performing some action including | |
3465 | resync, recovery or reshape. Checkpoints allow resuming action from certain | |
3466 | point if it was interrupted. | |
3467 | ||
3468 | Checkpoint is reported as combination of two values: current migration unit | |
3469 | and number of blocks per unit. By multiplying those values and dividing by | |
3470 | array size checkpoint progress percentage can be obtained in relation to | |
3471 | current progress reported in /proc/mdstat. Checkpoint is also related to (and | |
3472 | sometimes based on) sysfs entry sync_completed but depending on action units | |
3473 | may differ. Even if units are the same, it should not be expected that | |
3474 | checkpoint and sync_completed will be exact match nor updated simultaneously. | |
3475 | ||
2d465520 | 3476 | .SH NOTE |
51ac42e3 | 3477 | .I mdadm |
2d465520 | 3478 | was previously known as |
51ac42e3 | 3479 | .IR mdctl . |
a9d69660 | 3480 | |
52826846 | 3481 | .SH SEE ALSO |
75f74377 | 3482 | For further information on mdadm usage, MD and the various levels of |
3cdfb6a7 | 3483 | RAID, see: |
3cdfb6a7 | 3484 | .IP |
8e41153c | 3485 | .B https://raid.wiki.kernel.org/ |
75f74377 DG |
3486 | .PP |
3487 | (based upon Jakob \(/Ostergaard's Software\-RAID.HOWTO) | |
cd29a5c8 | 3488 | .PP |
2ae555c3 | 3489 | The latest version of |
a9d69660 NB |
3490 | .I mdadm |
3491 | should always be available from | |
cd29a5c8 | 3492 | .IP |
8e41153c | 3493 | .B https://www.kernel.org/pub/linux/utils/raid/mdadm/ |
11cd8b79 N |
3494 | .PP |
3495 | Related man pages: | |
cd29a5c8 | 3496 | .PP |
e0fe762a | 3497 | .IR mdmon (8), |
a9d69660 NB |
3498 | .IR mdadm.conf (5), |
3499 | .IR md (4). |