]>
Commit | Line | Data |
---|---|---|
52826846 | 1 | .\" -*- nroff -*- |
00b738b2 | 2 | .TH MDADM 8 "" v2.4 |
52826846 | 3 | .SH NAME |
9a9dab36 | 4 | mdadm \- manage MD devices |
cd29a5c8 NB |
5 | .I aka |
6 | Linux Software Raid. | |
7 | ||
52826846 NB |
8 | .SH SYNOPSIS |
9 | ||
e0d19036 | 10 | .BI mdadm " [mode] <raiddevice> [options] <component-devices>" |
52826846 | 11 | |
2ae555c3 | 12 | .SH DESCRIPTION |
52826846 | 13 | RAID devices are virtual devices created from two or more |
cd29a5c8 NB |
14 | real block devices. This allows multiple devices (typically disk |
15 | drives or partitions there-of) to be combined into a single device to | |
16 | hold (for example) a single filesystem. | |
2d465520 | 17 | Some RAID levels include redundancy and so can survive some degree of |
cd29a5c8 NB |
18 | device failure. |
19 | ||
2d465520 NB |
20 | Linux Software RAID devices are implemented through the md (Multiple |
21 | Devices) device driver. | |
cd29a5c8 NB |
22 | |
23 | Currently, Linux supports | |
24 | .B LINEAR | |
25 | md devices, | |
26 | .B RAID0 | |
27 | (striping), | |
28 | .B RAID1 | |
29 | (mirroring), | |
d013a55e NB |
30 | .BR RAID4 , |
31 | .BR RAID5 , | |
98c6faba | 32 | .BR RAID6 , |
1a7dfc35 | 33 | .BR RAID10 , |
b5e64645 | 34 | .BR MULTIPATH , |
cd29a5c8 | 35 | and |
b5e64645 | 36 | .BR FAULTY . |
d013a55e | 37 | |
a9d69660 NB |
38 | .B MULTIPATH |
39 | is not a Software RAID mechanism, but does involve | |
d013a55e NB |
40 | multiple devices. For |
41 | .B MULTIPATH | |
42 | each device is a path to one common physical storage device. | |
43 | ||
a9d69660 NB |
44 | .B FAULTY |
45 | is also not true RAID, and it only involves one device. It | |
b5e64645 | 46 | provides a layer over a true device that can be used to inject faults. |
52826846 | 47 | |
a9d69660 NB |
48 | '''.B mdadm |
49 | '''is a program that can be used to create, manage, and monitor | |
50 | '''MD devices. As | |
51 | '''such it provides a similar set of functionality to the | |
52 | '''.B raidtools | |
53 | '''packages. | |
54 | '''The key differences between | |
55 | '''.B mdadm | |
56 | '''and | |
57 | '''.B raidtools | |
58 | '''are: | |
59 | '''.IP \(bu 4 | |
60 | '''.B mdadm | |
61 | '''is a single program and not a collection of programs. | |
62 | '''.IP \(bu 4 | |
63 | '''.B mdadm | |
64 | '''can perform (almost) all of its functions without having a | |
65 | '''configuration file and does not use one by default. Also | |
66 | '''.B mdadm | |
67 | '''helps with management of the configuration | |
68 | '''file. | |
69 | '''.IP \(bu 4 | |
70 | '''.B mdadm | |
71 | '''can provide information about your arrays (through Query, Detail, and Examine) | |
72 | '''that | |
73 | '''.B raidtools | |
74 | '''cannot. | |
75 | '''.P | |
76 | '''.I mdadm | |
77 | '''does not use | |
78 | '''.IR /etc/raidtab , | |
79 | '''the | |
80 | '''.B raidtools | |
81 | '''configuration file, at all. It has a different configuration file | |
82 | '''with a different format and an different purpose. | |
52826846 NB |
83 | |
84 | .SH MODES | |
dd0781e5 | 85 | mdadm has 7 major modes of operation: |
cd29a5c8 NB |
86 | .TP |
87 | .B Assemble | |
88 | Assemble the parts of a previously created | |
52826846 | 89 | array into an active array. Components can be explicitly given |
2ae555c3 | 90 | or can be searched for. |
9a9dab36 | 91 | .B mdadm |
cd29a5c8 NB |
92 | checks that the components |
93 | do form a bona fide array, and can, on request, fiddle superblock | |
94 | information so as to assemble a faulty array. | |
95 | ||
96 | .TP | |
97 | .B Build | |
a9d69660 NB |
98 | Build an array that doesn't have per-device superblocks. For these |
99 | sorts of arrays, | |
100 | .I mdadm | |
101 | cannot differentiate between initial creation and subsequent assembly | |
102 | of an array. It also cannot perform any checks that appropriate | |
103 | devices have been requested. Because of this, the | |
104 | .B Build | |
105 | mode should only be used together with a complete understanding of | |
106 | what you are doing. | |
cd29a5c8 NB |
107 | |
108 | .TP | |
109 | .B Create | |
110 | Create a new array with per-device superblocks. | |
111 | '''It can progress | |
112 | '''in several step create-add-add-run or it can all happen with one command. | |
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 |
1a7dfc35 | 117 | only meaningful for raid1, 4, 5, 6, 10 or multipath arrays as |
98c6faba NB |
118 | only these have interesting state. raid0 or linear never have |
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 | |
2ae555c3 | 125 | of component devices in RAID level 1/4/5/6 and changing the number of |
dd0781e5 | 126 | active devices in RAID1. |
cd29a5c8 | 127 | |
2ae555c3 NB |
128 | .TP |
129 | .B Manage | |
130 | This is for doing things to specific components of an array such as | |
131 | adding new spares and removing faulty devices. | |
132 | ||
133 | .TP | |
134 | .B Misc | |
135 | This is an 'everything else' mode that supports operations on active | |
136 | arrays, operations on component devices such as erasing old superblocks, and | |
137 | information gathering operations. | |
138 | '''This mode allows operations on independent devices such as examine MD | |
139 | '''superblocks, erasing old superblocks and stopping active arrays. | |
140 | ||
52826846 NB |
141 | .SH OPTIONS |
142 | ||
2ae555c3 | 143 | .SH Options for selecting a mode are: |
52826846 | 144 | |
cd29a5c8 NB |
145 | .TP |
146 | .BR -A ", " --assemble | |
2d465520 | 147 | Assemble a pre-existing array. |
52826846 | 148 | |
cd29a5c8 NB |
149 | .TP |
150 | .BR -B ", " --build | |
151 | Build a legacy array without superblocks. | |
52826846 | 152 | |
cd29a5c8 NB |
153 | .TP |
154 | .BR -C ", " --create | |
155 | Create a new array. | |
52826846 | 156 | |
cd29a5c8 NB |
157 | .TP |
158 | .BR -F ", " --follow ", " --monitor | |
159 | Select | |
160 | .B Monitor | |
161 | mode. | |
52826846 | 162 | |
dd0781e5 NB |
163 | .TP |
164 | .BR -G ", " --grow | |
165 | Change the size or shape of an active array. | |
2ae555c3 NB |
166 | .P |
167 | If a device is given before any options, or if the first option is | |
168 | .BR --add , | |
169 | .BR --fail , | |
170 | or | |
171 | .BR --remove , | |
172 | then the MANAGE mode is assume. | |
173 | Anything other than these will cause the | |
174 | .B Misc | |
175 | mode to be assumed. | |
dd0781e5 | 176 | |
2ae555c3 | 177 | .SH Options that are not mode-specific are: |
e793c2e5 | 178 | |
cd29a5c8 NB |
179 | .TP |
180 | .BR -h ", " --help | |
a9d69660 NB |
181 | Display general help message or, after one of the above options, a |
182 | mode specific help message. | |
56eedc1a NB |
183 | |
184 | .TP | |
185 | .B --help-options | |
186 | Display more detailed help about command line parsing and some commonly | |
187 | used options. | |
52826846 | 188 | |
cd29a5c8 NB |
189 | .TP |
190 | .BR -V ", " --version | |
9a9dab36 | 191 | Print version information for mdadm. |
52826846 | 192 | |
cd29a5c8 NB |
193 | .TP |
194 | .BR -v ", " --verbose | |
22892d56 NB |
195 | Be more verbose about what is happening. This can be used twice to be |
196 | extra-verbose. | |
a9d69660 | 197 | The extra verbosity currently only affects |
22892d56 NB |
198 | .B --detail --scan |
199 | and | |
200 | .BR "--examine --scan" . | |
52826846 | 201 | |
dab6685f NB |
202 | .TP |
203 | .BR -q ", " --quiet | |
204 | Avoid printing purely informative messages. With this, | |
205 | .B mdadm | |
206 | will be silent unless there is something really important to report. | |
207 | ||
cd29a5c8 NB |
208 | .TP |
209 | .BR -b ", " --brief | |
210 | Be less verbose. This is used with | |
211 | .B --detail | |
212 | and | |
213 | .BR --examine . | |
22892d56 NB |
214 | Using |
215 | .B --brief | |
216 | with | |
217 | .B --verbose | |
218 | gives an intermediate level of verbosity. | |
52826846 | 219 | |
e0d19036 NB |
220 | .TP |
221 | .BR -f ", " --force | |
222 | Be more forceful about certain operations. See the various modes of | |
223 | the exact meaning of this option in different contexts. | |
224 | ||
225 | .TP | |
226 | .BR -c ", " --config= | |
2ae555c3 NB |
227 | Specify the config file. Default is to use |
228 | .BR /etc/mdadm.conf , | |
229 | or if that is missing, then | |
230 | .BR /etc/mdadm/mdadm.conf . | |
5787fa49 NB |
231 | If the config file given is |
232 | .B partitions | |
233 | then nothing will be read, but | |
234 | .I mdadm | |
235 | will act as though the config file contained exactly | |
236 | .B "DEVICE partitions" | |
237 | and will read | |
238 | .B /proc/partitions | |
239 | to find a list of devices to scan. | |
d013a55e NB |
240 | If the word |
241 | .B none | |
242 | is given for the config file, then | |
243 | .I mdadm | |
244 | will act as though the config file were empty. | |
e0d19036 NB |
245 | |
246 | .TP | |
247 | .BR -s ", " --scan | |
248 | scan config file or | |
249 | .B /proc/mdstat | |
250 | for missing information. | |
251 | In general, this option gives | |
252 | .B mdadm | |
253 | permission to get any missing information, like component devices, | |
254 | array devices, array identities, and alert destination from the | |
255 | configuration file: | |
256 | .BR /etc/mdadm.conf . | |
257 | One exception is MISC mode when using | |
258 | .B --detail | |
259 | or | |
260 | .B --stop | |
261 | in which case | |
262 | .B --scan | |
263 | says to get a list of array devices from | |
264 | .BR /proc/mdstat . | |
265 | ||
570c0542 NB |
266 | .TP |
267 | .B -e ", " --metadata= | |
268 | Declare the style of superblock (raid metadata) to be used. The | |
269 | default is 0.90 for --create, and to guess for other operations. | |
270 | ||
271 | Options are: | |
272 | .RS | |
273 | .IP "0, 0.90, default" | |
274 | Use the original 0.90 format superblock. This format limits arrays to | |
275 | 28 componenet devices and limits component devices of levels 1 and | |
276 | greater to 2 terabytes. | |
277 | .IP "1, 1.0, 1.1, 1.2" | |
278 | Use the new version-1 format superblock. This has few restrictions. | |
279 | The different subversion store the superblock at different locations | |
280 | on the device, either at the end (for 1.0), at the start (for 1.1) or | |
281 | 4K from the start (for 1.2). | |
282 | .RE | |
283 | ||
2ae555c3 NB |
284 | .SH For create, build, or grow: |
285 | ||
286 | .TP | |
287 | .BR -n ", " --raid-devices= | |
288 | Specify the number of active devices in the array. This, plus the | |
289 | number of spare devices (see below) must equal the number of | |
290 | .I component-devices | |
291 | (including "\fBmissing\fP" devices) | |
292 | that are listed on the command line for | |
293 | .BR --create . | |
294 | Setting a value of 1 is probably | |
295 | a mistake and so requires that | |
296 | .B --force | |
297 | be specified first. A value of 1 will then be allowed for linear, | |
298 | multipath, raid0 and raid1. It is never allowed for raid4 or raid5. | |
299 | .br | |
300 | This number can only be changed using | |
301 | .B --grow | |
302 | for RAID1 arrays, and only on kernels which provide necessary support. | |
303 | ||
304 | .TP | |
305 | .BR -x ", " --spare-devices= | |
306 | Specify the number of spare (eXtra) devices in the initial array. | |
307 | Spares can also be added | |
308 | and removed later. The number of component devices listed | |
309 | on the command line must equal the number of raid devices plus the | |
310 | number of spare devices. | |
311 | ||
312 | ||
313 | .TP | |
314 | .BR -z ", " --size= | |
315 | Amount (in Kibibytes) of space to use from each drive in RAID1/4/5/6. | |
316 | This must be a multiple of the chunk size, and must leave about 128Kb | |
317 | of space at the end of the drive for the RAID superblock. | |
318 | If this is not specified | |
319 | (as it normally is not) the smallest drive (or partition) sets the | |
320 | size, though if there is a variance among the drives of greater than 1%, a warning is | |
321 | issued. | |
322 | ||
323 | This value can be set with | |
324 | .B --grow | |
325 | for RAID level 1/4/5/6. If the array was created with a size smaller | |
326 | than the currently active drives, the extra space can be accessed | |
327 | using | |
328 | .BR --grow . | |
329 | The size can be given as | |
330 | .B max | |
331 | which means to choose the largest size that fits on all current drives. | |
52826846 | 332 | |
cd29a5c8 NB |
333 | .TP |
334 | .BR -c ", " --chunk= | |
335 | Specify chunk size of kibibytes. The default is 64. | |
52826846 | 336 | |
cd29a5c8 NB |
337 | .TP |
338 | .BR --rounding= | |
339 | Specify rounding factor for linear array (==chunk size) | |
52826846 | 340 | |
cd29a5c8 NB |
341 | .TP |
342 | .BR -l ", " --level= | |
aa88f531 NB |
343 | Set raid level. When used with |
344 | .IR --create , | |
98c6faba | 345 | options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4, |
2ae555c3 | 346 | raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty. Obviously some of these are synonymous. |
aa88f531 NB |
347 | |
348 | When used with | |
349 | .IR --build , | |
a9d69660 | 350 | only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid. |
52826846 | 351 | |
2ae555c3 NB |
352 | Not yet supported with |
353 | .IR --grow . | |
354 | ||
cd29a5c8 | 355 | .TP |
1a7dfc35 NB |
356 | .BR -p ", " --layout= |
357 | This option configures the fine details of data layout for raid5, | |
358 | and raid10 arrays, and controls the failure modes for | |
359 | .IR faulty . | |
360 | ||
361 | The layout of the raid5 parity block can be one of | |
2d465520 NB |
362 | left-asymmetric, |
363 | left-symmetric, | |
364 | right-asymmetric, | |
365 | right-symmetric, | |
366 | la, ra, ls, rs. The default is left-symmetric. | |
52826846 | 367 | |
1a7dfc35 NB |
368 | When setting the failure mode for |
369 | .I faulty | |
370 | the options are: | |
b5e64645 NB |
371 | write-transient, |
372 | wt, | |
373 | read-transient, | |
374 | rt, | |
2ae555c3 | 375 | write-persistent, |
b5e64645 NB |
376 | wp, |
377 | read-persistent, | |
378 | rp, | |
379 | write-all, | |
380 | read-fixable, | |
381 | rf, | |
382 | clear, | |
383 | flush, | |
384 | none. | |
385 | ||
386 | Each mode can be followed by a number which is used as a period | |
387 | between fault generation. Without a number, the fault is generated | |
388 | once on the first relevant request. With a number, the fault will be | |
389 | generated after that many request, and will continue to be generated | |
390 | every time the period elapses. | |
391 | ||
392 | Multiple failure modes can be current simultaneously by using the | |
393 | "--grow" option to set subsequent failure modes. | |
394 | ||
395 | "clear" or "none" will remove any pending or periodic failure modes, | |
2ae555c3 | 396 | and "flush" will clear any persistent faults. |
b5e64645 NB |
397 | |
398 | To set the parity with "--grow", the level of the array ("faulty") | |
399 | must be specified before the fault mode is specified. | |
400 | ||
1a7dfc35 NB |
401 | Finally, the layout options for RAID10 are either 'n' or 'p' followed |
402 | by a small number. The default is 'n2'. | |
403 | ||
404 | .I n | |
405 | signals 'near' copies (multiple copies of one data block are at | |
406 | similar offsets in different devices) while | |
407 | .I f | |
408 | signals 'far' copies | |
409 | (multiple copies have very different offsets). See md(4) for more | |
410 | detail about 'near' and 'far'. | |
411 | ||
412 | The number is the number of copies of each datablock. 2 is normal, 3 | |
413 | can be useful. This number can be at most equal to the number of | |
414 | devices in the array. It does not need to divide evenly into that | |
415 | number (e.g. it is perfectly legal to have an 'n2' layout for an array | |
416 | with an odd number of devices). | |
417 | ||
cd29a5c8 | 418 | .TP |
1a7dfc35 NB |
419 | .BR --parity= |
420 | same as --layout (thus explaining the p of | |
421 | .IR -p ). | |
52826846 | 422 | |
e793c2e5 NB |
423 | .TP |
424 | .BR -b ", " --bitmap= | |
425 | Specify a file to store a write-intent bitmap in. The file should not | |
426 | exist unless --force is also given. The same file should be provided | |
2ae555c3 NB |
427 | when assembling the array. If the word |
428 | .B internal | |
429 | is given, then the bitmap is stored with the metadata on the array, | |
430 | and so is replicated on all devices. If the word | |
431 | .B none | |
432 | is given with | |
433 | .B --grow | |
434 | mode, then any bitmap that is present is removed. | |
e793c2e5 | 435 | |
2ae555c3 NB |
436 | To help catch typing errors, the filename must contain at least one |
437 | slash ('/') if it is a real file (not 'internal' or 'none'). | |
438 | ||
439 | Note: external bitmaps are only known to work on ext2 and ext3. | |
440 | Storing bitmap files on other filesystems may result in serious problems. | |
e793c2e5 | 441 | |
cd29a5c8 NB |
442 | |
443 | .TP | |
2ae555c3 NB |
444 | .BR --bitmap-chunk= |
445 | Set the chunksize of the bitmap. Each bit corresponds to that many | |
446 | Kilobytes of storage. Default is 4 when using a file based bitmap. | |
447 | When using an | |
448 | .B internal | |
449 | bitmap, the chunksize is automatically determined to make best use of | |
450 | available space. | |
5787fa49 | 451 | |
cd29a5c8 NB |
452 | |
453 | .TP | |
2ae555c3 NB |
454 | .BR -W ", " --write-mostly |
455 | subsequent devices lists in a | |
456 | .BR --build , | |
457 | .BR --create , | |
458 | or | |
459 | .B --add | |
460 | command will be flagged as 'write-mostly'. This is valid for RAID1 | |
461 | only and means that the 'md' driver will avoid reading from these | |
462 | devices if at all possible. This can be useful if mirroring over a | |
463 | slow link. | |
52826846 | 464 | |
2ae555c3 NB |
465 | .TP |
466 | .BR --write-behind= | |
467 | Specify that write-behind mode should be enabled (valid for RAID1 | |
468 | only). If an argument is specified, it will set the maximum number | |
469 | of outstanding writes allowed. The default value is 256. | |
470 | A write-intent bitmap is required in order to use write-behind | |
471 | mode, and write-behind is only attempted on drives marked as | |
472 | .IR write-mostly . | |
dd0781e5 NB |
473 | |
474 | .TP | |
475 | .BR --assume-clean | |
476 | Tell | |
477 | .I mdadm | |
47d79ef8 NB |
478 | that the array pre-existed and is known to be clean. It can be useful |
479 | when trying to recover from a major failure as you can be sure that no | |
480 | data will be affected unless you actually write to the array. It can | |
481 | also be used when creating a RAID1 or RAID10 if you want to avoid the | |
482 | initial resync, however this practice - while normally safe - is not | |
483 | recommended. Use this ony if you really know what you are doing. | |
dd0781e5 | 484 | |
2ae555c3 NB |
485 | .TP |
486 | .BR --backup-file= | |
487 | This is needed when --grow is used to increase the number of | |
488 | raid-devices in a RAID5 if there are no spare devices available. | |
489 | See the section below on RAID_DEVICE CHANGES. The file should be | |
490 | stored on a separate device, not on the raid array being reshaped. | |
491 | ||
947fd4dd NB |
492 | .TP |
493 | .BR -N ", " --name= | |
494 | Set a | |
495 | .B name | |
496 | for the array. This is currently only effective when creating an | |
497 | array with a version-1 superblock. The name is a simple textual | |
498 | string that can be used to identify array components when assembling. | |
499 | ||
dd0781e5 NB |
500 | .TP |
501 | .BR -R ", " --run | |
502 | Insist that | |
503 | .I mdadm | |
504 | run the array, even if some of the components | |
505 | appear to be active in another array or filesystem. Normally | |
506 | .I mdadm | |
507 | will ask for confirmation before including such components in an | |
508 | array. This option causes that question to be suppressed. | |
509 | ||
510 | .TP | |
511 | .BR -f ", " --force | |
512 | Insist that | |
513 | .I mdadm | |
514 | accept the geometry and layout specified without question. Normally | |
515 | .I mdadm | |
516 | will not allow creation of an array with only one device, and will try | |
517 | to create a raid5 array with one missing drive (as this makes the | |
518 | initial resync work faster). With | |
519 | .BR --force , | |
520 | .I mdadm | |
521 | will not try to be so clever. | |
522 | ||
523 | .TP | |
524 | .BR -a ", " "--auto{=no,yes,md,mdp,part,p}{NN}" | |
48f7b27a NB |
525 | Instruct mdadm to create the device file if needed, possibly allocating |
526 | an unused minor number. "md" causes a non-partitionable array | |
dd0781e5 | 527 | to be used. "mdp", "part" or "p" causes a partitionable array (2.6 and |
2ae555c3 | 528 | later) to be used. "yes" requires the named md device to have |
f9c25f1d | 529 | a 'standard' format, and the type and minor number will be determined |
48f7b27a NB |
530 | from this. See DEVICE NAMES below. |
531 | ||
a9d69660 | 532 | The argument can also come immediately after |
dd0781e5 NB |
533 | "-a". e.g. "-ap". |
534 | ||
1337546d NB |
535 | If |
536 | .I --scan | |
537 | is also given, then any | |
538 | .I auto= | |
539 | entries in the config file will over-ride the | |
540 | .I --auto | |
541 | instruction given on the command line. | |
542 | ||
dd0781e5 NB |
543 | For partitionable arrays, |
544 | .I mdadm | |
545 | will create the device file for the whole array and for the first 4 | |
546 | partitions. A different number of partitions can be specified at the | |
547 | end of this option (e.g. | |
548 | .BR --auto=p7 ). | |
2ae555c3 | 549 | If the device name ends with a digit, the partition names add a 'p', |
48f7b27a | 550 | and a number, e.g. "/dev/home1p3". If there is no |
dd0781e5 NB |
551 | trailing digit, then the partition names just have a number added, |
552 | e.g. "/dev/scratch3". | |
553 | ||
48f7b27a NB |
554 | If the md device name is in a 'standard' format as described in DEVICE |
555 | NAMES, then it will be created, if necessary, with the appropriate | |
556 | number based on that name. If the device name is not in one of these | |
a9d69660 | 557 | formats, then a unused minor number will be allocated. The minor |
48f7b27a NB |
558 | number will be considered unused if there is no active array for that |
559 | number, and there is no entry in /dev for that number and with a | |
560 | non-standard name. | |
561 | ||
52826846 NB |
562 | .SH For assemble: |
563 | ||
cd29a5c8 NB |
564 | .TP |
565 | .BR -u ", " --uuid= | |
566 | uuid of array to assemble. Devices which don't have this uuid are | |
567 | excluded | |
568 | ||
569 | .TP | |
570 | .BR -m ", " --super-minor= | |
571 | Minor number of device that array was created for. Devices which | |
572 | don't have this minor number are excluded. If you create an array as | |
2d465520 | 573 | /dev/md1, then all superblocks will contain the minor number 1, even if |
cd29a5c8 NB |
574 | the array is later assembled as /dev/md2. |
575 | ||
d013a55e NB |
576 | Giving the literal word "dev" for |
577 | .B --super-minor | |
578 | will cause | |
579 | .I mdadm | |
580 | to use the minor number of the md device that is being assembled. | |
581 | e.g. when assembling | |
582 | .BR /dev/md0 , | |
583 | .M --super-minor=dev | |
584 | will look for super blocks with a minor number of 0. | |
585 | ||
947fd4dd NB |
586 | .TP |
587 | .BR -N ", " --name= | |
588 | Specify the name of the array to assemble. This must be the name | |
589 | that was specified when creating the array. | |
590 | ||
cd29a5c8 NB |
591 | .TP |
592 | .BR -f ", " --force | |
52826846 NB |
593 | Assemble the array even if some superblocks appear out-of-date |
594 | ||
cd29a5c8 NB |
595 | .TP |
596 | .BR -R ", " --run | |
597 | Attempt to start the array even if fewer drives were given than are | |
598 | needed for a full array. Normally if not all drives are found and | |
599 | .B --scan | |
600 | is not used, then the array will be assembled but not started. | |
601 | With | |
602 | .B --run | |
603 | an attempt will be made to start it anyway. | |
52826846 | 604 | |
dd0781e5 NB |
605 | .TP |
606 | .BR -a ", " "--auto{=no,yes,md,mdp,part}" | |
607 | See this option under Create and Build options. | |
608 | ||
e793c2e5 NB |
609 | .TP |
610 | .BR -b ", " --bitmap= | |
2ae555c3 NB |
611 | Specify the bitmap file that was given when the array was created. If |
612 | an array has an | |
613 | .B internal | |
614 | bitmap, there is no need to specify this when assembling the array. | |
615 | ||
616 | .TP | |
617 | .BR --backup-file= | |
618 | If | |
619 | .B --backup-file | |
620 | was used to grow the number of raid-devices in a RAID5, and the system | |
621 | crashed during the critical section, then the same | |
622 | .B --backup-file | |
623 | must be presented to --assemble to allow possibly corrupted data to be | |
624 | restored. | |
e793c2e5 | 625 | |
5787fa49 NB |
626 | .TP |
627 | .BR -U ", " --update= | |
628 | Update the superblock on each device while assembling the array. The | |
feb716e9 NB |
629 | argument given to this flag can be one of |
630 | .BR sparc2.2 , | |
631 | .BR summaries , | |
7d99579f | 632 | .BR uuid , |
e5329c37 | 633 | .BR resync , |
586ed405 | 634 | .BR byteorder , |
5787fa49 NB |
635 | or |
636 | .BR super-minor . | |
637 | ||
638 | The | |
639 | .B sparc2.2 | |
7d99579f | 640 | option will adjust the superblock of an array what was created on a Sparc |
5787fa49 NB |
641 | machine running a patched 2.2 Linux kernel. This kernel got the |
642 | alignment of part of the superblock wrong. You can use the | |
643 | .B "--examine --sparc2.2" | |
644 | option to | |
645 | .I mdadm | |
646 | to see what effect this would have. | |
647 | ||
648 | The | |
649 | .B super-minor | |
650 | option will update the | |
2ae555c3 | 651 | .B "preferred minor" |
5787fa49 | 652 | field on each superblock to match the minor number of the array being |
feb716e9 | 653 | assembled. This is not needed on 2.6 and later kernels as they make |
5787fa49 NB |
654 | this adjustment automatically. |
655 | ||
7d99579f NB |
656 | The |
657 | .B uuid | |
658 | option will change the uuid of the array. If a UUID is given with the | |
659 | "--uuid" option that UUID will be used as a new UUID and with | |
660 | .B NOT | |
661 | be used to help identify the devices in the array. | |
662 | If no "--uuid" is given, a random uuid is chosen. | |
663 | ||
e5329c37 NB |
664 | The |
665 | .B resync | |
666 | option will cause the array to be marked | |
667 | .I dirty | |
668 | meaning that any redundancy in the array (e.g. parity for raid5, | |
669 | copies for raid1) may be incorrect. This will cause the raid system | |
670 | to perform a "resync" pass to make sure that all redundant information | |
671 | is correct. | |
672 | ||
586ed405 NB |
673 | The |
674 | .B byteorder | |
675 | option allows arrays to be moved between machines with different | |
676 | byte-order. | |
2ae555c3 | 677 | When assembling such an array for the first time after a move, giving |
586ed405 NB |
678 | .B "--update=byteorder" |
679 | will cause | |
680 | .I mdadm | |
681 | to expect superblocks to have their byteorder reversed, and will | |
682 | correct that order before assembling the array. This is only valid | |
2ae555c3 | 683 | with original (Version 0.90) superblocks. |
586ed405 | 684 | |
feb716e9 NB |
685 | The |
686 | .B summaries | |
687 | option will correct the summaries in the superblock. That is the | |
688 | counts of total, working, active, failed, and spare devices. | |
5787fa49 | 689 | |
e0d19036 | 690 | .SH For Manage mode: |
52826846 | 691 | |
cd29a5c8 NB |
692 | .TP |
693 | .BR -a ", " --add | |
2ae555c3 | 694 | hot-add listed devices. |
52826846 | 695 | |
fe80f49b NB |
696 | .TP |
697 | .BR --re-add | |
2ae555c3 | 698 | re-add a device that was recently removed from an array. |
fe80f49b | 699 | |
cd29a5c8 NB |
700 | .TP |
701 | .BR -r ", " --remove | |
2d465520 | 702 | remove listed devices. They must not be active. i.e. they should |
cd29a5c8 | 703 | be failed or spare devices. |
52826846 | 704 | |
cd29a5c8 NB |
705 | .TP |
706 | .BR -f ", " --fail | |
707 | mark listed devices as faulty. | |
52826846 | 708 | |
cd29a5c8 NB |
709 | .TP |
710 | .BR --set-faulty | |
711 | same as --fail. | |
52826846 | 712 | |
2ae555c3 NB |
713 | .P |
714 | Each of these options require that the first device list is the array | |
715 | to be acted upon and the remainder are component devices to be added, | |
716 | removed, or marked as fault. Several different operations can be | |
717 | specified for different devices, e.g. | |
718 | .in +5 | |
719 | mdadm /dev/md0 --add /dev/sda1 --fail /dev/sdb1 --remove /dev/sdb1 | |
720 | .in -5 | |
721 | Each operation applies to all devices listed until the next | |
722 | operations. | |
723 | ||
724 | If an array is using a write-intent bitmap, then devices which have | |
725 | been removed can be re-added in a way that avoids a full | |
726 | reconstruction but instead just updated the blocks that have changed | |
727 | since the device was removed. For arrays with persistent metadata | |
728 | (superblocks) this is done automatically. For arrays created with | |
729 | .B --build | |
730 | mdadm needs to be told that this device we removed recently with | |
731 | .B --re-add. | |
732 | ||
733 | Devices can only be removed from an array if they are not in active | |
734 | use. i.e. that must be spares or failed devices. To remove an active | |
735 | device, it must be marked as | |
736 | .B faulty | |
737 | first. | |
738 | ||
739 | .SH For Misc mode: | |
740 | ||
741 | .TP | |
742 | .BR -Q ", " --query | |
743 | Examine a device to see | |
744 | (1) if it is an md device and (2) if it is a component of an md | |
745 | array. | |
746 | Information about what is discovered is presented. | |
747 | ||
748 | .TP | |
749 | .BR -D ", " --detail | |
750 | Print detail of one or more md devices. | |
5787fa49 | 751 | |
2ae555c3 NB |
752 | .TP |
753 | .BR -E ", " --examine | |
754 | Print content of md superblock on device(s). | |
5787fa49 NB |
755 | .TP |
756 | .B --sparc2.2 | |
a9d69660 | 757 | If an array was created on a 2.2 Linux kernel patched with RAID |
5787fa49 NB |
758 | support, the superblock will have been created incorrectly, or at |
759 | least incompatibly with 2.4 and later kernels. Using the | |
760 | .B --sparc2.2 | |
761 | flag with | |
762 | .B --examine | |
763 | will fix the superblock before displaying it. If this appears to do | |
764 | the right thing, then the array can be successfully assembled using | |
765 | .BR "--assemble --update=sparc2.2" . | |
766 | ||
2ae555c3 NB |
767 | .TP |
768 | .BR -X ", " --examine-bitmap | |
769 | Report information about a bitmap file. | |
e0d19036 | 770 | |
cd29a5c8 NB |
771 | .TP |
772 | .BR -R ", " --run | |
773 | start a partially built array. | |
52826846 | 774 | |
cd29a5c8 NB |
775 | .TP |
776 | .BR -S ", " --stop | |
777 | deactivate array, releasing all resources. | |
52826846 | 778 | |
cd29a5c8 NB |
779 | .TP |
780 | .BR -o ", " --readonly | |
781 | mark array as readonly. | |
52826846 | 782 | |
cd29a5c8 NB |
783 | .TP |
784 | .BR -w ", " --readwrite | |
785 | mark array as readwrite. | |
52826846 | 786 | |
e0d19036 NB |
787 | .TP |
788 | .B --zero-superblock | |
789 | If the device contains a valid md superblock, the block is | |
790 | over-written with zeros. With | |
791 | --force | |
792 | the block where the superblock would be is over-written even if it | |
793 | doesn't appear to be valid. | |
52826846 | 794 | |
feb716e9 NB |
795 | .TP |
796 | .BR -t ", " --test | |
797 | When used with | |
798 | .BR --detail , | |
799 | the exit status of | |
800 | .I mdadm | |
801 | is set to reflect the status of the device. | |
802 | ||
e0d19036 NB |
803 | .SH For Monitor mode: |
804 | .TP | |
805 | .BR -m ", " --mail | |
806 | Give a mail address to send alerts to. | |
807 | ||
808 | .TP | |
809 | .BR -p ", " --program ", " --alert | |
810 | Give a program to be run whenever an event is detected. | |
811 | ||
773135f5 NB |
812 | .TP |
813 | .BR -y ", " --syslog | |
814 | Cause all events to be reported through 'syslog'. The messages have | |
815 | facility of 'daemon' and varying priorities. | |
816 | ||
e0d19036 NB |
817 | .TP |
818 | .BR -d ", " --delay | |
819 | Give a delay in seconds. | |
820 | .B mdadm | |
821 | polls the md arrays and then waits this many seconds before polling | |
822 | again. The default is 60 seconds. | |
823 | ||
d013a55e NB |
824 | .TP |
825 | .BR -f ", " --daemonise | |
826 | Tell | |
827 | .B mdadm | |
828 | to run as a background daemon if it decides to monitor anything. This | |
829 | causes it to fork and run in the child, and to disconnect form the | |
830 | terminal. The process id of the child is written to stdout. | |
831 | This is useful with | |
832 | .B --scan | |
833 | which will only continue monitoring if a mail address or alert program | |
834 | is found in the config file. | |
835 | ||
b5e64645 NB |
836 | .TP |
837 | .BR -i ", " --pid-file | |
838 | When | |
839 | .B mdadm | |
840 | is running in daemon mode, write the pid of the daemon process to | |
841 | the specified file, instead of printing it on standard output. | |
842 | ||
aa88f531 NB |
843 | .TP |
844 | .BR -1 ", " --oneshot | |
845 | Check arrays only once. This will generate | |
846 | .B NewArray | |
847 | events and more significantly | |
848 | .B DegradedArray | |
a9d69660 NB |
849 | and |
850 | .B SparesMissing | |
aa88f531 NB |
851 | events. Running |
852 | .in +5 | |
853 | .B " mdadm --monitor --scan -1" | |
854 | .in -5 | |
855 | from a cron script will ensure regular notification of any degraded arrays. | |
856 | ||
98c6faba NB |
857 | .TP |
858 | .BR -t ", " --test | |
859 | Generate a | |
860 | .B TestMessage | |
861 | alert for every array found at startup. This alert gets mailed and | |
862 | passed to the alert program. This can be used for testing that alert | |
a9d69660 | 863 | message do get through successfully. |
98c6faba | 864 | |
e0d19036 | 865 | .SH ASSEMBLE MODE |
52826846 | 866 | |
cd29a5c8 NB |
867 | .HP 12 |
868 | Usage: | |
9a9dab36 | 869 | .B mdadm --assemble |
5787fa49 NB |
870 | .I md-device options-and-component-devices... |
871 | .HP 12 | |
872 | Usage: | |
873 | .B mdadm --assemble --scan | |
874 | .I md-devices-and-options... | |
cd29a5c8 NB |
875 | .HP 12 |
876 | Usage: | |
9a9dab36 | 877 | .B mdadm --assemble --scan |
cd29a5c8 | 878 | .I options... |
52826846 | 879 | |
cd29a5c8 | 880 | .PP |
52826846 | 881 | This usage assembles one or more raid arrays from pre-existing components. |
9a9dab36 | 882 | For each array, mdadm needs to know the md device, the identity of the |
e0d19036 | 883 | array, and a number of component-devices. These can be found in a number of ways. |
52826846 | 884 | |
5787fa49 NB |
885 | In the first usage example (without the |
886 | .BR --scan ) | |
887 | the first device given is the md device. | |
888 | In the second usage example, all devices listed are treated as md | |
889 | devices and assembly is attempted. | |
890 | In the third (where no devices are listed) all md devices that are | |
891 | listed in the configuration file are assembled. | |
52826846 | 892 | |
d013a55e NB |
893 | If precisely one device is listed, but |
894 | .B --scan | |
dd0781e5 | 895 | is not given, then |
d013a55e NB |
896 | .I mdadm |
897 | acts as though | |
898 | .B --scan | |
899 | was given and identify information is extracted from the configuration file. | |
900 | ||
2ae555c3 | 901 | The identity can be given with the |
52826846 | 902 | .B --uuid |
cd29a5c8 NB |
903 | option, with the |
904 | .B --super-minor | |
5787fa49 | 905 | option, can be found in the config file, or will be taken from the |
e0d19036 | 906 | super block on the first component-device listed on the command line. |
52826846 | 907 | |
2ae555c3 | 908 | Devices can be given on the |
52826846 | 909 | .B --assemble |
5787fa49 NB |
910 | command line or in the config file. Only devices which have an md |
911 | superblock which contains the right identity will be considered for | |
912 | any array. | |
52826846 | 913 | |
2ae555c3 | 914 | The config file is only used if explicitly named with |
52826846 | 915 | .B --config |
d013a55e | 916 | or requested with (a possibly implicit) |
2ae555c3 | 917 | .B --scan. |
52826846 | 918 | In the later case, |
9a9dab36 | 919 | .B /etc/mdadm.conf |
52826846 NB |
920 | is used. |
921 | ||
2ae555c3 | 922 | If |
52826846 | 923 | .B --scan |
cd29a5c8 NB |
924 | is not given, then the config file will only be used to find the |
925 | identity of md arrays. | |
52826846 | 926 | |
2d465520 | 927 | Normally the array will be started after it is assembled. However if |
cd29a5c8 | 928 | .B --scan |
2d465520 | 929 | is not given and insufficient drives were listed to start a complete |
cd29a5c8 NB |
930 | (non-degraded) array, then the array is not started (to guard against |
931 | usage errors). To insist that the array be started in this case (as | |
1a7dfc35 | 932 | may work for RAID1, 4, 5, 6, or 10), give the |
cd29a5c8 NB |
933 | .B --run |
934 | flag. | |
52826846 | 935 | |
dd0781e5 NB |
936 | If an |
937 | .B auto | |
938 | option is given, either on the command line (--auto) or in the | |
939 | configuration file (e.g. auto=part), then | |
940 | .I mdadm | |
941 | will create the md device if necessary or will re-create it if it | |
942 | doesn't look usable as it is. | |
943 | ||
944 | This can be useful for handling partitioned devices (which don't have | |
945 | a stable device number - it can change after a reboot) and when using | |
946 | "udev" to manage your | |
947 | .B /dev | |
948 | tree (udev cannot handle md devices because of the unusual device | |
949 | initialisation conventions). | |
950 | ||
951 | If the option to "auto" is "mdp" or "part" or (on the command line | |
952 | only) "p", then mdadm will create a partitionable array, using the | |
2ae555c3 | 953 | first free one that is not in use, and does not already have an entry |
dd0781e5 NB |
954 | in /dev (apart from numeric /dev/md* entries). |
955 | ||
956 | If the option to "auto" is "yes" or "md" or (on the command line) | |
957 | nothing, then mdadm will create a traditional, non-partitionable md | |
958 | array. | |
959 | ||
960 | It is expected that the "auto" functionality will be used to create | |
961 | device entries with meaningful names such as "/dev/md/home" or | |
962 | "/dev/md/root", rather than names based on the numerical array number. | |
963 | ||
964 | When using this option to create a partitionable array, the device | |
965 | files for the first 4 partitions are also created. If a different | |
966 | number is required it can be simply appended to the auto option. | |
967 | e.g. "auto=part8". Partition names are created by appending a digit | |
a9d69660 | 968 | string to the device name, with an intervening "p" if the device name |
dd0781e5 NB |
969 | ends with a digit. |
970 | ||
971 | The | |
972 | .B --auto | |
973 | option is also available in Build and Create modes. As those modes do | |
974 | not use a config file, the "auto=" config option does not apply to | |
975 | these modes. | |
52826846 | 976 | |
cd29a5c8 | 977 | .SH BUILD MODE |
52826846 | 978 | |
cd29a5c8 NB |
979 | .HP 12 |
980 | Usage: | |
9a9dab36 | 981 | .B mdadm --build |
cd29a5c8 NB |
982 | .I device |
983 | .BI --chunk= X | |
984 | .BI --level= Y | |
b83d95f3 | 985 | .BI --raid-devices= Z |
cd29a5c8 NB |
986 | .I devices |
987 | ||
988 | .PP | |
2ae555c3 | 989 | This usage is similar to |
cd29a5c8 | 990 | .BR --create . |
a9d69660 | 991 | The difference is that it creates an array without a superblock. With |
cd29a5c8 | 992 | these arrays there is no difference between initially creating the array and |
52826846 NB |
993 | subsequently assembling the array, except that hopefully there is useful |
994 | data there in the second case. | |
995 | ||
a9d69660 NB |
996 | The level may raid0, linear, multipath, or faulty, or one of their |
997 | synonyms. All devices must be listed and the array will be started | |
998 | once complete. | |
cd29a5c8 NB |
999 | |
1000 | .SH CREATE MODE | |
1001 | ||
1002 | .HP 12 | |
1003 | Usage: | |
9a9dab36 | 1004 | .B mdadm --create |
cd29a5c8 NB |
1005 | .I device |
1006 | .BI --chunk= X | |
1007 | .BI --level= Y | |
1008 | .br | |
b83d95f3 | 1009 | .BI --raid-devices= Z |
cd29a5c8 NB |
1010 | .I devices |
1011 | ||
1012 | .PP | |
1013 | This usage will initialise a new md array, associate some devices with | |
1014 | it, and activate the array. | |
1015 | ||
a9d69660 | 1016 | If the |
dd0781e5 NB |
1017 | .B --auto |
1018 | option is given (as described in more detail in the section on | |
1019 | Assemble mode), then the md device will be created with a suitable | |
1020 | device number if necessary. | |
1021 | ||
cd29a5c8 | 1022 | As devices are added, they are checked to see if they contain raid |
2d465520 | 1023 | superblocks or filesystems. They are also checked to see if the variance in |
cd29a5c8 NB |
1024 | device size exceeds 1%. |
1025 | ||
1026 | If any discrepancy is found, the array will not automatically be run, though | |
2ae555c3 | 1027 | the presence of a |
cd29a5c8 NB |
1028 | .B --run |
1029 | can override this caution. | |
1030 | ||
2d465520 | 1031 | To create a "degraded" array in which some devices are missing, simply |
d013a55e | 1032 | give the word "\fBmissing\fP" |
2d465520 NB |
1033 | in place of a device name. This will cause |
1034 | .B mdadm | |
1035 | to leave the corresponding slot in the array empty. | |
1036 | For a RAID4 or RAID5 array at most one slot can be | |
98c6faba | 1037 | "\fBmissing\fP"; for a RAID6 array at most two slots. |
2d465520 NB |
1038 | For a RAID1 array, only one real device needs to be given. All of the |
1039 | others can be | |
d013a55e | 1040 | "\fBmissing\fP". |
2d465520 | 1041 | |
feb716e9 NB |
1042 | When creating a RAID5 array, |
1043 | .B mdadm | |
1044 | will automatically create a degraded array with an extra spare drive. | |
1045 | This is because building the spare into a degraded array is in general faster than resyncing | |
1046 | the parity on a non-degraded, but not clean, array. This feature can | |
1047 | be over-ridden with the | |
b5e64645 | 1048 | .I --force |
feb716e9 NB |
1049 | option. |
1050 | ||
2ae555c3 | 1051 | '''If the |
cd29a5c8 | 1052 | '''.B --size |
e0d19036 | 1053 | '''option is given, it is not necessary to list any component-devices in this command. |
cd29a5c8 | 1054 | '''They can be added later, before a |
2ae555c3 NB |
1055 | '''.B --run. |
1056 | '''If no | |
cd29a5c8 NB |
1057 | '''.B --size |
1058 | '''is given, the apparent size of the smallest drive given is used. | |
1059 | ||
1060 | The General Management options that are valid with --create are: | |
1061 | .TP | |
1062 | .B --run | |
dd0781e5 | 1063 | insist on running the array even if some devices look like they might |
cd29a5c8 NB |
1064 | be in use. |
1065 | ||
1066 | .TP | |
1067 | .B --readonly | |
1068 | start the array readonly - not supported yet. | |
52826846 | 1069 | |
2ae555c3 | 1070 | |
e0d19036 | 1071 | .SH MANAGE MODE |
cd29a5c8 NB |
1072 | .HP 12 |
1073 | Usage: | |
e0d19036 NB |
1074 | .B mdadm |
1075 | .I device | |
1076 | .I options... devices... | |
cd29a5c8 NB |
1077 | .PP |
1078 | ||
e0d19036 NB |
1079 | This usage will allow individual devices in an array to be failed, |
1080 | removed or added. It is possible to perform multiple operations with | |
1081 | on command. For example: | |
1082 | .br | |
5787fa49 | 1083 | .B " mdadm /dev/md0 -f /dev/hda1 -r /dev/hda1 -a /dev/hda1" |
e0d19036 NB |
1084 | .br |
1085 | will firstly mark | |
1086 | .B /dev/hda1 | |
1087 | as faulty in | |
1088 | .B /dev/md0 | |
1089 | and will then remove it from the array and finally add it back | |
2d465520 | 1090 | in as a spare. However only one md array can be affected by a single |
2ae555c3 | 1091 | command. |
e0d19036 NB |
1092 | |
1093 | .SH MISC MODE | |
1094 | .HP 12 | |
1095 | Usage: | |
9a9dab36 | 1096 | .B mdadm |
e0d19036 NB |
1097 | .I options ... |
1098 | .I devices ... | |
1099 | .PP | |
cd29a5c8 | 1100 | |
b5e64645 | 1101 | MISC mode includes a number of distinct operations that |
e0d19036 NB |
1102 | operate on distinct devices. The operations are: |
1103 | .TP | |
1104 | --query | |
1105 | The device is examined to see if it is | |
1106 | (1) an active md array, or | |
1107 | (2) a component of an md array. | |
1108 | The information discovered is reported. | |
1109 | ||
1110 | .TP | |
1111 | --detail | |
2d465520 NB |
1112 | The device should be an active md device. |
1113 | .B mdadm | |
1114 | will display a detailed description of the array. | |
cd29a5c8 | 1115 | .B --brief |
2d465520 NB |
1116 | or |
1117 | .B --scan | |
1118 | will cause the output to be less detailed and the format to be | |
e0d19036 | 1119 | suitable for inclusion in |
9a9dab36 | 1120 | .BR /etc/mdadm.conf . |
feb716e9 NB |
1121 | The exit status of |
1122 | .I mdadm | |
1123 | will normally be 0 unless | |
1124 | .I mdadm | |
1125 | failed to get useful information about the device(s). However if the | |
1126 | .B --test | |
1127 | option is given, then the exit status will be: | |
1128 | .RS | |
1129 | .TP | |
1130 | 0 | |
1131 | The array is functioning normally. | |
1132 | .TP | |
1133 | 1 | |
1134 | The array has at least one failed device. | |
1135 | .TP | |
1136 | 2 | |
1137 | The array has multiple failed devices and hence is unusable (raid4 or | |
1138 | raid5). | |
1139 | .TP | |
1140 | 4 | |
1141 | There was an error while trying to get information about the device. | |
1142 | .RE | |
cd29a5c8 | 1143 | |
e0d19036 NB |
1144 | .TP |
1145 | --examine | |
2d465520 NB |
1146 | The device should be a component of an md array. |
1147 | .B mdadm | |
1148 | will read the md superblock of the device and display the contents. | |
e0d19036 NB |
1149 | If |
1150 | .B --brief | |
1151 | is given, or | |
1152 | .B --scan | |
1153 | then multiple devices that are components of the one array | |
1154 | are grouped together and reported in a single entry suitable | |
1155 | for inclusion in | |
1156 | .BR /etc/mdadm.conf . | |
1157 | ||
2d465520 | 1158 | Having |
e0d19036 NB |
1159 | .B --scan |
1160 | without listing any devices will cause all devices listed in the | |
1161 | config file to be examined. | |
1162 | ||
1163 | .TP | |
1164 | --stop | |
98c6faba NB |
1165 | The devices should be active md arrays which will be deactivated, as |
1166 | long as they are not currently in use. | |
e0d19036 NB |
1167 | |
1168 | .TP | |
1169 | --run | |
1170 | This will fully activate a partially assembled md array. | |
1171 | ||
1172 | .TP | |
1173 | --readonly | |
1174 | This will mark an active array as read-only, providing that it is | |
1175 | not currently being used. | |
1176 | ||
1177 | .TP | |
1178 | --readwrite | |
1179 | This will change a | |
1180 | .B readonly | |
1181 | array back to being read/write. | |
1182 | ||
2d465520 NB |
1183 | .TP |
1184 | --scan | |
1185 | For all operations except | |
1186 | .BR --examine , | |
1187 | .B --scan | |
1188 | will cause the operation to be applied to all arrays listed in | |
1189 | .BR /proc/mdstat . | |
1190 | For | |
1191 | .BR --examine, | |
1192 | .B --scan | |
1193 | causes all devices listed in the config file to be examined. | |
1194 | ||
1195 | ||
e0d19036 NB |
1196 | .SH MONITOR MODE |
1197 | ||
cd29a5c8 NB |
1198 | .HP 12 |
1199 | Usage: | |
e0d19036 NB |
1200 | .B mdadm --monitor |
1201 | .I options... devices... | |
1202 | ||
cd29a5c8 | 1203 | .PP |
e0d19036 NB |
1204 | This usage causes |
1205 | .B mdadm | |
1206 | to periodically poll a number of md arrays and to report on any events | |
1207 | noticed. | |
1208 | .B mdadm | |
1209 | will never exit once it decides that there are arrays to be checked, | |
1210 | so it should normally be run in the background. | |
1211 | ||
2d465520 NB |
1212 | As well as reporting events, |
1213 | .B mdadm | |
1214 | may move a spare drive from one array to another if they are in the | |
1215 | same | |
1216 | .B spare-group | |
a9d69660 | 1217 | and if the destination array has a failed drive but no spares. |
2d465520 | 1218 | |
e0d19036 NB |
1219 | If any devices are listed on the command line, |
1220 | .B mdadm | |
1221 | will only monitor those devices. Otherwise all arrays listed in the | |
1222 | configuration file will be monitored. Further, if | |
1223 | .B --scan | |
1224 | is given, then any other md devices that appear in | |
1225 | .B /proc/mdstat | |
1226 | will also be monitored. | |
1227 | ||
1228 | The result of monitoring the arrays is the generation of events. | |
bd526cee | 1229 | These events are passed to a separate program (if specified) and may |
2d465520 | 1230 | be mailed to a given E-mail address. |
e0d19036 | 1231 | |
bd526cee | 1232 | When passing event to program, the program is run once for each event |
2ae555c3 | 1233 | and is given 2 or 3 command-line arguments. The first is the |
bd526cee NB |
1234 | name of the event (see below). The second is the name of the |
1235 | md device which is affected, and the third is the name of a related | |
1236 | device if relevant, such as a component device that has failed. | |
cd29a5c8 NB |
1237 | |
1238 | If | |
1239 | .B --scan | |
e0d19036 NB |
1240 | is given, then a program or an E-mail address must be specified on the |
1241 | command line or in the config file. If neither are available, then | |
1242 | .B mdadm | |
1243 | will not monitor anything. | |
1244 | Without | |
cd29a5c8 | 1245 | .B --scan |
e0d19036 | 1246 | .B mdadm |
2d465520 | 1247 | will continue monitoring as long as something was found to monitor. If |
e0d19036 NB |
1248 | no program or email is given, then each event is reported to |
1249 | .BR stdout . | |
cd29a5c8 | 1250 | |
e0d19036 NB |
1251 | The different events are: |
1252 | ||
1253 | .RS 4 | |
1254 | .TP | |
1255 | .B DeviceDisappeared | |
2d465520 | 1256 | An md array which previously was configured appears to no longer be |
773135f5 | 1257 | configured. (syslog priority: Critical) |
e0d19036 | 1258 | |
b8f72a62 NB |
1259 | If |
1260 | .I mdadm | |
1261 | was told to monitor an array which is RAID0 or Linear, then it will | |
1262 | report | |
1263 | .B DeviceDisappeared | |
1264 | with the extra information | |
1265 | .BR Wrong-Level . | |
1266 | This is because RAID0 and Linear do not support the device-failed, | |
1267 | hot-spare and resync operations which are monitored. | |
1268 | ||
e0d19036 NB |
1269 | .TP |
1270 | .B RebuildStarted | |
773135f5 | 1271 | An md array started reconstruction. (syslog priority: Warning) |
e0d19036 NB |
1272 | |
1273 | .TP | |
1274 | .BI Rebuild NN | |
1275 | Where | |
1276 | .I NN | |
1277 | is 20, 40, 60, or 80, this indicates that rebuild has passed that many | |
773135f5 | 1278 | percentage of the total. (syslog priority: Warning) |
e0d19036 | 1279 | |
98c6faba NB |
1280 | .TP |
1281 | .B RebuildFinished | |
1282 | An md array that was rebuilding, isn't any more, either because it | |
773135f5 | 1283 | finished normally or was aborted. (syslog priority: Warning) |
98c6faba | 1284 | |
e0d19036 NB |
1285 | .TP |
1286 | .B Fail | |
773135f5 NB |
1287 | An active component device of an array has been marked as |
1288 | faulty. (syslog priority: Critical) | |
e0d19036 NB |
1289 | |
1290 | .TP | |
1291 | .B FailSpare | |
1292 | A spare component device which was being rebuilt to replace a faulty | |
773135f5 | 1293 | device has failed. (syslog priority: Critial) |
e0d19036 NB |
1294 | |
1295 | .TP | |
1296 | .B SpareActive | |
1297 | A spare component device which was being rebuilt to replace a faulty | |
1298 | device as been successfully rebuild and has been made active. | |
773135f5 | 1299 | (syslog priority: Info) |
e0d19036 NB |
1300 | |
1301 | .TP | |
1302 | .B NewArray | |
1303 | A new md array has been detected in the | |
1304 | .B /proc/mdstat | |
773135f5 | 1305 | file. (syslog priority: Info) |
e0d19036 | 1306 | |
aa88f531 NB |
1307 | .TP |
1308 | .B DegradedArray | |
1309 | A newly noticed array appears to be degraded. This message is not | |
1310 | generated when | |
1311 | .I mdadm | |
1312 | notices a drive failure which causes degradation, but only when | |
1313 | .I mdadm | |
1314 | notices that an array is degraded when it first sees the array. | |
773135f5 | 1315 | (syslog priority: Critial) |
aa88f531 | 1316 | |
e0d19036 NB |
1317 | .TP |
1318 | .B MoveSpare | |
1319 | A spare drive has been moved from one array in a | |
1320 | .B spare-group | |
1321 | to another to allow a failed drive to be replaced. | |
773135f5 | 1322 | (syslog priority: Info) |
e0d19036 | 1323 | |
b8f72a62 NB |
1324 | .TP |
1325 | .B SparesMissing | |
1326 | If | |
1327 | .I mdadm | |
1328 | has been told, via the config file, that an array should have a certain | |
1329 | number of spare devices, and | |
1330 | .I mdadm | |
1331 | detects that it has fewer that this number when it first sees the | |
1332 | array, it will report a | |
1333 | .B SparesMissing | |
1334 | message. | |
773135f5 | 1335 | (syslog priority: Info) |
b8f72a62 | 1336 | |
98c6faba NB |
1337 | .TP |
1338 | .B TestMessage | |
1339 | An array was found at startup, and the | |
1340 | .B --test | |
1341 | flag was given. | |
773135f5 | 1342 | (syslog priority: Info) |
e0d19036 NB |
1343 | .RE |
1344 | ||
1345 | Only | |
98c6faba NB |
1346 | .B Fail , |
1347 | .B FailSpare , | |
1348 | .B DegradedArray , | |
e0d19036 | 1349 | and |
98c6faba | 1350 | .B TestMessage |
e0d19036 NB |
1351 | cause Email to be sent. All events cause the program to be run. |
1352 | The program is run with two or three arguments, they being the event | |
1353 | name, the array device and possibly a second device. | |
1354 | ||
1355 | Each event has an associated array device (e.g. | |
1356 | .BR /dev/md1 ) | |
1357 | and possibly a second device. For | |
1358 | .BR Fail , | |
1359 | .BR FailSpare , | |
1360 | and | |
1361 | .B SpareActive | |
1362 | the second device is the relevant component device. | |
1363 | For | |
1364 | .B MoveSpare | |
1365 | the second device is the array that the spare was moved from. | |
1366 | ||
1367 | For | |
1368 | .B mdadm | |
1369 | to move spares from one array to another, the different arrays need to | |
1370 | be labelled with the same | |
1371 | .B spare-group | |
1372 | in the configuration file. The | |
1373 | .B spare-group | |
1374 | name can be any string. It is only necessary that different spare | |
2d465520 | 1375 | groups use different names. |
e0d19036 NB |
1376 | |
1377 | When | |
9a9dab36 | 1378 | .B mdadm |
e0d19036 NB |
1379 | detects that an array which is in a spare group has fewer active |
1380 | devices than necessary for the complete array, and has no spare | |
1381 | devices, it will look for another array in the same spare group that | |
1382 | has a full complement of working drive and a spare. It will then | |
1383 | attempt to remove the spare from the second drive and add it to the | |
1384 | first. | |
1385 | If the removal succeeds but the adding fails, then it is added back to | |
1386 | the original array. | |
1387 | ||
dd0781e5 NB |
1388 | .SH GROW MODE |
1389 | The GROW mode is used for changing the size or shape of an active | |
1390 | array. | |
1391 | For this to work, the kernel must support the necessary change. | |
2ae555c3 | 1392 | Various types of growth are being added during 2.6 development, |
dd0781e5 NB |
1393 | including restructuring a raid5 array to have more active devices. |
1394 | ||
dfd4d8ee NB |
1395 | Currently the only support available is to |
1396 | .IP \(bu 4 | |
1397 | change the "size" attribute | |
1398 | for RAID1, RAID5 and RAID6. | |
1399 | .IP \(bu 4 | |
2ae555c3 | 1400 | increase the "raid-disks" attribute of RAID1 and RAID5. |
dfd4d8ee | 1401 | .IP \(bu 4 |
2ae555c3 NB |
1402 | add a write-intent bitmap to any array which support these bitmaps, or |
1403 | remove a write-intent bitmap from such an array. | |
dfd4d8ee | 1404 | .PP |
dd0781e5 | 1405 | |
2ae555c3 | 1406 | .SS SIZE CHANGES |
fe80f49b | 1407 | Normally when an array is built the "size" it taken from the smallest |
dd0781e5 NB |
1408 | of the drives. If all the small drives in an arrays are, one at a |
1409 | time, removed and replaced with larger drives, then you could have an | |
1410 | array of large drives with only a small amount used. In this | |
1411 | situation, changing the "size" with "GROW" mode will allow the extra | |
1412 | space to start being used. If the size is increased in this way, a | |
1413 | "resync" process will start to make sure the new parts of the array | |
1414 | are synchronised. | |
1415 | ||
1416 | Note that when an array changes size, any filesystem that may be | |
1417 | stored in the array will not automatically grow to use the space. The | |
1418 | filesystem will need to be explicitly told to use the extra space. | |
1419 | ||
2ae555c3 NB |
1420 | .SS RAID-DEVICES CHANGES |
1421 | ||
dd0781e5 NB |
1422 | A RAID1 array can work with any number of devices from 1 upwards |
1423 | (though 1 is not very useful). There may be times which you want to | |
1424 | increase or decrease the number of active devices. Note that this is | |
1425 | different to hot-add or hot-remove which changes the number of | |
1426 | inactive devices. | |
1427 | ||
1428 | When reducing the number of devices in a RAID1 array, the slots which | |
1429 | are to be removed from the array must already be vacant. That is, the | |
1430 | devices that which were in those slots must be failed and removed. | |
1431 | ||
1432 | When the number of devices is increased, any hot spares that are | |
a9d69660 | 1433 | present will be activated immediately. |
dd0781e5 | 1434 | |
2ae555c3 NB |
1435 | Increasing the number of active devices in a RAID5 is much more |
1436 | effort. Every block in the array will need to be read and written | |
1437 | back to a new location. From 2.6.17, the Linux Kernel is able to do | |
1438 | this safely, including restart and interrupted "reshape". | |
1439 | ||
1440 | When relocating the first few stripes on a raid5, it is not possible | |
1441 | to keep the data on disk completely consistent and crash-proof. To | |
1442 | provide the required safety, mdadm disables writes to the array while | |
1443 | this "critical section" is reshaped, and takes a backup of the data | |
1444 | that is in that section. This backup is normally stored in any spare | |
1445 | devices that the array has, however it can also be stored in a | |
1446 | separate file specified with the | |
1447 | .B --backup-file | |
1448 | option. If this option is used, and the system does crash during the | |
1449 | critical period, the same file must be passed to | |
1450 | .B --assemble | |
1451 | to restore the backup and reassemble the array. | |
1452 | ||
1453 | .SS BITMAP CHANGES | |
1454 | ||
1455 | A write-intent bitmap can be added to, or removed from, an active | |
1456 | array. Either internal bitmaps, or bitmaps stored in a separate file | |
fe80f49b NB |
1457 | can be added. Note that if you add a bitmap stored in a file which is |
1458 | in a filesystem that is on the raid array being affected, the system | |
1459 | will deadlock. The bitmap must be on a separate filesystem. | |
1460 | ||
2d465520 NB |
1461 | .SH EXAMPLES |
1462 | ||
5787fa49 | 1463 | .B " mdadm --query /dev/name-of-device" |
2d465520 | 1464 | .br |
5787fa49 NB |
1465 | This will find out if a given device is a raid array, or is part of |
1466 | one, and will provide brief information about the device. | |
2d465520 | 1467 | |
5787fa49 | 1468 | .B " mdadm --assemble --scan" |
2d465520 | 1469 | .br |
2ae555c3 | 1470 | This will assemble and start all arrays listed in the standard config file |
5787fa49 | 1471 | file. This command will typically go in a system startup file. |
2d465520 | 1472 | |
2d465520 | 1473 | .B " mdadm --stop --scan" |
5787fa49 NB |
1474 | .br |
1475 | This will shut down all array that can be shut down (i.e. are not | |
19f8b8fc | 1476 | currently in use). This will typically go in a system shutdown script. |
2d465520 | 1477 | |
5787fa49 | 1478 | .B " mdadm --follow --scan --delay=120" |
2d465520 | 1479 | .br |
5787fa49 NB |
1480 | If (and only if) there is an Email address or program given in the |
1481 | standard config file, then | |
1482 | monitor the status of all arrays listed in that file by | |
1483 | polling them ever 2 minutes. | |
2d465520 | 1484 | |
5787fa49 | 1485 | .B " mdadm --create /dev/md0 --level=1 --raid-devices=2 /dev/hd[ac]1" |
2d465520 | 1486 | .br |
5787fa49 | 1487 | Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1. |
2d465520 | 1488 | |
2d465520 NB |
1489 | .br |
1490 | .B " echo 'DEVICE /dev/hd*[0-9] /dev/sd*[0-9]' > mdadm.conf" | |
1491 | .br | |
1492 | .B " mdadm --detail --scan >> mdadm.conf" | |
1493 | .br | |
5787fa49 NB |
1494 | This will create a prototype config file that describes currently |
1495 | active arrays that are known to be made from partitions of IDE or SCSI drives. | |
2d465520 NB |
1496 | This file should be reviewed before being used as it may |
1497 | contain unwanted detail. | |
1498 | ||
2d465520 NB |
1499 | .B " echo 'DEVICE /dev/hd[a-z] /dev/sd*[a-z]' > mdadm.conf" |
1500 | .br | |
5787fa49 NB |
1501 | .B " mdadm --examine --scan --config=mdadm.conf >> mdadm.conf" |
1502 | .ber | |
2ae555c3 | 1503 | This will find what arrays could be assembled from existing IDE and |
5787fa49 NB |
1504 | SCSI whole drives (not partitions) and store the information is the |
1505 | format of a config file. | |
2d465520 NB |
1506 | This file is very likely to contain unwanted detail, particularly |
1507 | the | |
1508 | .B devices= | |
5787fa49 NB |
1509 | entries. It should be reviewed and edited before being used as an |
1510 | actual config file. | |
2d465520 | 1511 | |
5787fa49 | 1512 | .B " mdadm --examine --brief --scan --config=partitions" |
2d465520 | 1513 | .br |
5787fa49 NB |
1514 | .B " mdadm -Ebsc partitions" |
1515 | .br | |
1516 | Create a list of devices by reading | |
1517 | .BR /proc/partitions , | |
1518 | scan these for RAID superblocks, and printout a brief listing of all | |
1519 | that was found. | |
2d465520 | 1520 | |
5787fa49 | 1521 | .B " mdadm -Ac partitions -m 0 /dev/md0" |
2d465520 | 1522 | .br |
5787fa49 NB |
1523 | Scan all partitions and devices listed in |
1524 | .BR /proc/partitions | |
1525 | and assemble | |
1526 | .B /dev/md0 | |
1527 | out of all such devices with a RAID superblock with a minor number of 0. | |
2d465520 | 1528 | |
d013a55e NB |
1529 | .B " mdadm --monitor --scan --daemonise > /var/run/mdadm" |
1530 | .br | |
1531 | If config file contains a mail address or alert program, run mdadm in | |
1532 | the background in monitor mode monitoring all md devices. Also write | |
1533 | pid of mdadm daemon to | |
1534 | .BR /var/run/mdadm . | |
1535 | ||
5787fa49 | 1536 | .B " mdadm --create --help" |
2d465520 | 1537 | .br |
2ae555c3 | 1538 | Provide help about the Create mode. |
2d465520 | 1539 | |
5787fa49 NB |
1540 | .B " mdadm --config --help" |
1541 | .br | |
1542 | Provide help about the format of the config file. | |
2d465520 | 1543 | |
5787fa49 NB |
1544 | .B " mdadm --help" |
1545 | .br | |
1546 | Provide general help. | |
cd29a5c8 | 1547 | |
cd29a5c8 NB |
1548 | |
1549 | .SH FILES | |
1550 | ||
1551 | .SS /proc/mdstat | |
1552 | ||
2ae555c3 NB |
1553 | If you're using the |
1554 | .B /proc | |
cd29a5c8 NB |
1555 | filesystem, |
1556 | .B /proc/mdstat | |
2d465520 NB |
1557 | lists all active md devices with information about them. |
1558 | .B mdadm | |
1559 | uses this to find arrays when | |
1560 | .B --scan | |
1561 | is given in Misc mode, and to monitor array reconstruction | |
1562 | on Monitor mode. | |
1563 | ||
cd29a5c8 | 1564 | |
9a9dab36 | 1565 | .SS /etc/mdadm.conf |
cd29a5c8 | 1566 | |
11a3e71d NB |
1567 | The config file lists which devices may be scanned to see if |
1568 | they contain MD super block, and gives identifying information | |
1569 | (e.g. UUID) about known MD arrays. See | |
1570 | .BR mdadm.conf (5) | |
1571 | for more details. | |
cd29a5c8 | 1572 | |
48f7b27a NB |
1573 | .SH DEVICE NAMES |
1574 | ||
1575 | While entries in the /dev directory can have any format you like, | |
1576 | .I mdadm | |
1577 | has an understanding of 'standard' formats which it uses to guide its | |
1578 | behaviour when creating device files via the | |
1579 | .I --auto | |
1580 | option. | |
1581 | ||
1582 | The standard names for non-partitioned arrays (the only sort of md | |
1583 | array available in 2.4 and earlier) either of | |
1584 | .IP | |
1585 | /dev/mdNN | |
1586 | .br | |
1587 | /dev/md/NN | |
1588 | .PP | |
1589 | where NN is a number. | |
1590 | The standard names for partitionable arrays (as available from 2.6 | |
1591 | onwards) is one of | |
1592 | .IP | |
1593 | /dev/md/dNN | |
1594 | .br | |
1595 | /dev/md_dNN | |
1596 | .PP | |
1597 | Partition numbers should be indicated by added "pMM" to these, thus "/dev/md/d1p2". | |
52826846 | 1598 | |
2d465520 NB |
1599 | .SH NOTE |
1600 | .B mdadm | |
1601 | was previously known as | |
1602 | .BR mdctl . | |
a9d69660 NB |
1603 | .P |
1604 | .B mdadm | |
1605 | is completely separate from the | |
1606 | .B raidtools | |
1607 | package, and does not use the | |
1608 | .I /etc/raidtab | |
1609 | configuration file at all. | |
1610 | ||
52826846 | 1611 | .SH SEE ALSO |
cd29a5c8 NB |
1612 | For information on the various levels of |
1613 | RAID, check out: | |
1614 | ||
1615 | .IP | |
1616 | .UR http://ostenfeld.dk/~jakob/Software-RAID.HOWTO/ | |
1617 | http://ostenfeld.dk/~jakob/Software-RAID.HOWTO/ | |
1618 | .UE | |
a9d69660 NB |
1619 | '''.PP |
1620 | '''for new releases of the RAID driver check out: | |
1621 | ''' | |
1622 | '''.IP | |
1623 | '''.UR ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches | |
1624 | '''ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches | |
1625 | '''.UE | |
1626 | '''.PP | |
1627 | '''or | |
1628 | '''.IP | |
1629 | '''.UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/ | |
1630 | '''http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/ | |
1631 | '''.UE | |
cd29a5c8 | 1632 | .PP |
2ae555c3 | 1633 | The latest version of |
a9d69660 NB |
1634 | .I mdadm |
1635 | should always be available from | |
cd29a5c8 | 1636 | .IP |
a9d69660 NB |
1637 | .UR http://www.kernel.org/pub/linux/utils/raid/mdadm/ |
1638 | http://www.kernel.org/pub/linux/utils/raid/mdadm/ | |
cd29a5c8 NB |
1639 | .UE |
1640 | .PP | |
a9d69660 NB |
1641 | .IR mdadm.conf (5), |
1642 | .IR md (4). | |
56eb10c0 | 1643 | .PP |
52826846 NB |
1644 | .IR raidtab (5), |
1645 | .IR raid0run (8), | |
1646 | .IR raidstop (8), | |
a9d69660 | 1647 | .IR mkraid (8). |