]>
Commit | Line | Data |
---|---|---|
52826846 | 1 | .\" -*- nroff -*- |
90fc992e 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. | |
e003092c | 8 | .TH MDADM 8 "" v2.6.1 |
52826846 | 9 | .SH NAME |
9a9dab36 | 10 | mdadm \- manage MD devices |
cd29a5c8 NB |
11 | .I aka |
12 | Linux Software Raid. | |
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 |
cd29a5c8 | 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 , |
cd29a5c8 | 41 | and |
b5e64645 | 42 | .BR FAULTY . |
d013a55e | 43 | |
a9d69660 NB |
44 | .B MULTIPATH |
45 | is not a Software RAID mechanism, but does involve | |
d013a55e NB |
46 | multiple devices. For |
47 | .B MULTIPATH | |
48 | each device is a path to one common physical storage device. | |
49 | ||
a9d69660 NB |
50 | .B FAULTY |
51 | is also not true RAID, and it only involves one device. It | |
b5e64645 | 52 | provides a layer over a true device that can be used to inject faults. |
52826846 | 53 | |
a9d69660 NB |
54 | '''.B mdadm |
55 | '''is a program that can be used to create, manage, and monitor | |
56 | '''MD devices. As | |
57 | '''such it provides a similar set of functionality to the | |
58 | '''.B raidtools | |
59 | '''packages. | |
60 | '''The key differences between | |
61 | '''.B mdadm | |
62 | '''and | |
63 | '''.B raidtools | |
64 | '''are: | |
65 | '''.IP \(bu 4 | |
66 | '''.B mdadm | |
67 | '''is a single program and not a collection of programs. | |
68 | '''.IP \(bu 4 | |
69 | '''.B mdadm | |
70 | '''can perform (almost) all of its functions without having a | |
71 | '''configuration file and does not use one by default. Also | |
72 | '''.B mdadm | |
73 | '''helps with management of the configuration | |
74 | '''file. | |
75 | '''.IP \(bu 4 | |
76 | '''.B mdadm | |
77 | '''can provide information about your arrays (through Query, Detail, and Examine) | |
78 | '''that | |
79 | '''.B raidtools | |
80 | '''cannot. | |
81 | '''.P | |
82 | '''.I mdadm | |
83 | '''does not use | |
84 | '''.IR /etc/raidtab , | |
85 | '''the | |
86 | '''.B raidtools | |
87 | '''configuration file, at all. It has a different configuration file | |
98b24a2a | 88 | '''with a different format and a different purpose. |
52826846 NB |
89 | |
90 | .SH MODES | |
8382f19b | 91 | mdadm has several major modes of operation: |
cd29a5c8 NB |
92 | .TP |
93 | .B Assemble | |
94 | Assemble the parts of a previously created | |
52826846 | 95 | array into an active array. Components can be explicitly given |
2ae555c3 | 96 | or can be searched for. |
9a9dab36 | 97 | .B mdadm |
cd29a5c8 NB |
98 | checks that the components |
99 | do form a bona fide array, and can, on request, fiddle superblock | |
100 | information so as to assemble a faulty array. | |
101 | ||
102 | .TP | |
103 | .B Build | |
a9d69660 NB |
104 | Build an array that doesn't have per-device superblocks. For these |
105 | sorts of arrays, | |
106 | .I mdadm | |
107 | cannot differentiate between initial creation and subsequent assembly | |
108 | of an array. It also cannot perform any checks that appropriate | |
109 | devices have been requested. Because of this, the | |
110 | .B Build | |
111 | mode should only be used together with a complete understanding of | |
112 | what you are doing. | |
cd29a5c8 NB |
113 | |
114 | .TP | |
115 | .B Create | |
116 | Create a new array with per-device superblocks. | |
117 | '''It can progress | |
118 | '''in several step create-add-add-run or it can all happen with one command. | |
119 | ||
cd29a5c8 NB |
120 | .TP |
121 | .B "Follow or Monitor" | |
5787fa49 | 122 | Monitor one or more md devices and act on any state changes. This is |
1a7dfc35 | 123 | only meaningful for raid1, 4, 5, 6, 10 or multipath arrays as |
98c6faba NB |
124 | only these have interesting state. raid0 or linear never have |
125 | missing, spare, or failed drives, so there is nothing to monitor. | |
5787fa49 | 126 | |
dd0781e5 NB |
127 | .TP |
128 | .B "Grow" | |
129 | Grow (or shrink) an array, or otherwise reshape it in some way. | |
130 | Currently supported growth options including changing the active size | |
2ae555c3 | 131 | of component devices in RAID level 1/4/5/6 and changing the number of |
00be0b12 | 132 | active devices in RAID1/5/6. |
cd29a5c8 | 133 | |
8382f19b NB |
134 | .TP |
135 | .B "Incremental Assembly" | |
136 | Add a single device to an appropriate array. If the addition of the | |
137 | device makes the array runnable, the array will be started. | |
138 | This provides a convenient interface to a | |
139 | .I hot-plug | |
140 | system. As each device is detected, | |
141 | .I mdadm | |
142 | has a chance to include it in some array as appropriate. | |
143 | ||
2ae555c3 NB |
144 | .TP |
145 | .B Manage | |
146 | This is for doing things to specific components of an array such as | |
147 | adding new spares and removing faulty devices. | |
148 | ||
149 | .TP | |
150 | .B Misc | |
151 | This is an 'everything else' mode that supports operations on active | |
152 | arrays, operations on component devices such as erasing old superblocks, and | |
153 | information gathering operations. | |
154 | '''This mode allows operations on independent devices such as examine MD | |
155 | '''superblocks, erasing old superblocks and stopping active arrays. | |
156 | ||
52826846 NB |
157 | .SH OPTIONS |
158 | ||
2ae555c3 | 159 | .SH Options for selecting a mode are: |
52826846 | 160 | |
cd29a5c8 | 161 | .TP |
7e23fc43 | 162 | .BR \-A ", " \-\-assemble |
2d465520 | 163 | Assemble a pre-existing array. |
52826846 | 164 | |
cd29a5c8 | 165 | .TP |
7e23fc43 | 166 | .BR \-B ", " \-\-build |
cd29a5c8 | 167 | Build a legacy array without superblocks. |
52826846 | 168 | |
cd29a5c8 | 169 | .TP |
7e23fc43 | 170 | .BR \-C ", " \-\-create |
cd29a5c8 | 171 | Create a new array. |
52826846 | 172 | |
cd29a5c8 | 173 | .TP |
7e23fc43 | 174 | .BR \-F ", " \-\-follow ", " \-\-monitor |
cd29a5c8 NB |
175 | Select |
176 | .B Monitor | |
177 | mode. | |
52826846 | 178 | |
dd0781e5 | 179 | .TP |
7e23fc43 | 180 | .BR \-G ", " \-\-grow |
dd0781e5 | 181 | Change the size or shape of an active array. |
8382f19b NB |
182 | |
183 | .TP | |
7e23fc43 | 184 | .BE \-I ", " \-\-incremental |
8382f19b NB |
185 | Add a single device into an appropriate array, and possibly start the array. |
186 | ||
2ae555c3 NB |
187 | .P |
188 | If a device is given before any options, or if the first option is | |
7e23fc43 PS |
189 | .BR \-\-add , |
190 | .BR \-\-fail , | |
2ae555c3 | 191 | or |
7e23fc43 | 192 | .BR \-\-remove , |
2ae555c3 NB |
193 | then the MANAGE mode is assume. |
194 | Anything other than these will cause the | |
195 | .B Misc | |
196 | mode to be assumed. | |
dd0781e5 | 197 | |
2ae555c3 | 198 | .SH Options that are not mode-specific are: |
e793c2e5 | 199 | |
cd29a5c8 | 200 | .TP |
7e23fc43 | 201 | .BR \-h ", " \-\-help |
a9d69660 NB |
202 | Display general help message or, after one of the above options, a |
203 | mode specific help message. | |
56eedc1a NB |
204 | |
205 | .TP | |
7e23fc43 | 206 | .B \-\-help\-options |
56eedc1a NB |
207 | Display more detailed help about command line parsing and some commonly |
208 | used options. | |
52826846 | 209 | |
cd29a5c8 | 210 | .TP |
7e23fc43 | 211 | .BR \-V ", " \-\-version |
9a9dab36 | 212 | Print version information for mdadm. |
52826846 | 213 | |
cd29a5c8 | 214 | .TP |
7e23fc43 | 215 | .BR \-v ", " \-\-verbose |
22892d56 NB |
216 | Be more verbose about what is happening. This can be used twice to be |
217 | extra-verbose. | |
a9d69660 | 218 | The extra verbosity currently only affects |
7e23fc43 | 219 | .B \-\-detail \-\-scan |
22892d56 | 220 | and |
7e23fc43 | 221 | .BR "\-\-examine \-\-scan" . |
52826846 | 222 | |
dab6685f | 223 | .TP |
7e23fc43 | 224 | .BR \-q ", " \-\-quiet |
dab6685f NB |
225 | Avoid printing purely informative messages. With this, |
226 | .B mdadm | |
227 | will be silent unless there is something really important to report. | |
228 | ||
cd29a5c8 | 229 | .TP |
7e23fc43 | 230 | .BR \-b ", " \-\-brief |
cd29a5c8 | 231 | Be less verbose. This is used with |
7e23fc43 | 232 | .B \-\-detail |
cd29a5c8 | 233 | and |
7e23fc43 | 234 | .BR \-\-examine . |
22892d56 | 235 | Using |
7e23fc43 | 236 | .B \-\-brief |
22892d56 | 237 | with |
7e23fc43 | 238 | .B \-\-verbose |
22892d56 | 239 | gives an intermediate level of verbosity. |
52826846 | 240 | |
e0d19036 | 241 | .TP |
7e23fc43 | 242 | .BR \-f ", " \-\-force |
e0d19036 NB |
243 | Be more forceful about certain operations. See the various modes of |
244 | the exact meaning of this option in different contexts. | |
245 | ||
246 | .TP | |
7e23fc43 | 247 | .BR \-c ", " \-\-config= |
2ae555c3 NB |
248 | Specify the config file. Default is to use |
249 | .BR /etc/mdadm.conf , | |
250 | or if that is missing, then | |
251 | .BR /etc/mdadm/mdadm.conf . | |
5787fa49 NB |
252 | If the config file given is |
253 | .B partitions | |
254 | then nothing will be read, but | |
255 | .I mdadm | |
256 | will act as though the config file contained exactly | |
257 | .B "DEVICE partitions" | |
258 | and will read | |
259 | .B /proc/partitions | |
260 | to find a list of devices to scan. | |
d013a55e NB |
261 | If the word |
262 | .B none | |
263 | is given for the config file, then | |
264 | .I mdadm | |
265 | will act as though the config file were empty. | |
e0d19036 NB |
266 | |
267 | .TP | |
7e23fc43 | 268 | .BR \-s ", " \-\-scan |
e0d19036 NB |
269 | scan config file or |
270 | .B /proc/mdstat | |
271 | for missing information. | |
272 | In general, this option gives | |
273 | .B mdadm | |
274 | permission to get any missing information, like component devices, | |
275 | array devices, array identities, and alert destination from the | |
276 | configuration file: | |
277 | .BR /etc/mdadm.conf . | |
278 | One exception is MISC mode when using | |
7e23fc43 | 279 | .B \-\-detail |
e0d19036 | 280 | or |
7e23fc43 | 281 | .B \-\-stop |
e0d19036 | 282 | in which case |
7e23fc43 | 283 | .B \-\-scan |
e0d19036 NB |
284 | says to get a list of array devices from |
285 | .BR /proc/mdstat . | |
286 | ||
570c0542 | 287 | .TP |
7e23fc43 | 288 | .B \-e ", " \-\-metadata= |
570c0542 | 289 | Declare the style of superblock (raid metadata) to be used. The |
53e8b987 | 290 | default is 0.90 for |
7e23fc43 | 291 | .BR \-\-create , |
53e8b987 | 292 | and to guess for other operations. |
2790ffe3 GB |
293 | The default can be overridden by setting the |
294 | .B metadata | |
295 | value for the | |
296 | .B CREATE | |
297 | keyword in | |
298 | .BR mdadm.conf . | |
570c0542 NB |
299 | |
300 | Options are: | |
301 | .RS | |
302 | .IP "0, 0.90, default" | |
303 | Use the original 0.90 format superblock. This format limits arrays to | |
304 | 28 componenet devices and limits component devices of levels 1 and | |
305 | greater to 2 terabytes. | |
306 | .IP "1, 1.0, 1.1, 1.2" | |
307 | Use the new version-1 format superblock. This has few restrictions. | |
308 | The different subversion store the superblock at different locations | |
309 | on the device, either at the end (for 1.0), at the start (for 1.1) or | |
310 | 4K from the start (for 1.2). | |
311 | .RE | |
312 | ||
41a3b72a | 313 | .TP |
7e23fc43 | 314 | .B \-\-homehost= |
35cc5be4 | 315 | This will override any |
41a3b72a NB |
316 | .B HOMEHOST |
317 | setting in the config file and provides the identify of the host which | |
318 | should be considered the home for any arrays. | |
319 | ||
320 | When creating an array, the | |
321 | .B homehost | |
322 | will be recorded in the superblock. For version-1 superblocks, it will | |
323 | be prefixed to the array name. For version-0.90 superblocks part of | |
324 | the SHA1 hash of the hostname will be stored in the later half of the | |
325 | UUID. | |
326 | ||
327 | When reporting information about an array, any array which is tagged | |
328 | for the given homehost will be reported as such. | |
329 | ||
330 | When using Auto-Assemble, only arrays tagged for the given homehost | |
331 | will be assembled. | |
332 | ||
2ae555c3 NB |
333 | .SH For create, build, or grow: |
334 | ||
335 | .TP | |
7e23fc43 | 336 | .BR \-n ", " \-\-raid\-devices= |
2ae555c3 NB |
337 | Specify the number of active devices in the array. This, plus the |
338 | number of spare devices (see below) must equal the number of | |
339 | .I component-devices | |
340 | (including "\fBmissing\fP" devices) | |
341 | that are listed on the command line for | |
7e23fc43 | 342 | .BR \-\-create . |
2ae555c3 NB |
343 | Setting a value of 1 is probably |
344 | a mistake and so requires that | |
7e23fc43 | 345 | .B \-\-force |
2ae555c3 NB |
346 | be specified first. A value of 1 will then be allowed for linear, |
347 | multipath, raid0 and raid1. It is never allowed for raid4 or raid5. | |
348 | .br | |
349 | This number can only be changed using | |
7e23fc43 | 350 | .B \-\-grow |
00be0b12 NB |
351 | for RAID1, RAID5 and RAID6 arrays, and only on kernels which provide |
352 | necessary support. | |
2ae555c3 NB |
353 | |
354 | .TP | |
7e23fc43 | 355 | .BR \-x ", " \-\-spare\-devices= |
2ae555c3 NB |
356 | Specify the number of spare (eXtra) devices in the initial array. |
357 | Spares can also be added | |
358 | and removed later. The number of component devices listed | |
359 | on the command line must equal the number of raid devices plus the | |
360 | number of spare devices. | |
361 | ||
362 | ||
363 | .TP | |
7e23fc43 | 364 | .BR \-z ", " \-\-size= |
2ae555c3 NB |
365 | Amount (in Kibibytes) of space to use from each drive in RAID1/4/5/6. |
366 | This must be a multiple of the chunk size, and must leave about 128Kb | |
367 | of space at the end of the drive for the RAID superblock. | |
368 | If this is not specified | |
369 | (as it normally is not) the smallest drive (or partition) sets the | |
370 | size, though if there is a variance among the drives of greater than 1%, a warning is | |
371 | issued. | |
372 | ||
373 | This value can be set with | |
7e23fc43 | 374 | .B \-\-grow |
2ae555c3 NB |
375 | for RAID level 1/4/5/6. If the array was created with a size smaller |
376 | than the currently active drives, the extra space can be accessed | |
377 | using | |
7e23fc43 | 378 | .BR \-\-grow . |
2ae555c3 NB |
379 | The size can be given as |
380 | .B max | |
381 | which means to choose the largest size that fits on all current drives. | |
52826846 | 382 | |
cd29a5c8 | 383 | .TP |
7e23fc43 | 384 | .BR \-c ", " \-\-chunk= |
cd29a5c8 | 385 | Specify chunk size of kibibytes. The default is 64. |
52826846 | 386 | |
cd29a5c8 | 387 | .TP |
7e23fc43 | 388 | .BR \-\-rounding= |
cd29a5c8 | 389 | Specify rounding factor for linear array (==chunk size) |
52826846 | 390 | |
cd29a5c8 | 391 | .TP |
7e23fc43 | 392 | .BR \-l ", " \-\-level= |
aa88f531 | 393 | Set raid level. When used with |
7e23fc43 | 394 | .BR \-\-create , |
98c6faba | 395 | options are: linear, raid0, 0, stripe, raid1, 1, mirror, raid4, 4, |
2ae555c3 | 396 | raid5, 5, raid6, 6, raid10, 10, multipath, mp, faulty. Obviously some of these are synonymous. |
aa88f531 NB |
397 | |
398 | When used with | |
7e23fc43 | 399 | .BR \-\-build , |
a9d69660 | 400 | only linear, stripe, raid0, 0, raid1, multipath, mp, and faulty are valid. |
52826846 | 401 | |
2ae555c3 | 402 | Not yet supported with |
7e23fc43 | 403 | .BR \-\-grow . |
2ae555c3 | 404 | |
cd29a5c8 | 405 | .TP |
7e23fc43 | 406 | .BR \-p ", " \-\-layout= |
1a7dfc35 NB |
407 | This option configures the fine details of data layout for raid5, |
408 | and raid10 arrays, and controls the failure modes for | |
409 | .IR faulty . | |
410 | ||
411 | The layout of the raid5 parity block can be one of | |
7e23fc43 PS |
412 | .BR left\-asymmetric , |
413 | .BR left\-symmetric , | |
414 | .BR right\-asymmetric , | |
415 | .BR right\-symmetric , | |
53e8b987 PS |
416 | .BR la ", " ra ", " ls ", " rs . |
417 | The default is | |
7e23fc43 | 418 | .BR left\-symmetric . |
52826846 | 419 | |
1a7dfc35 NB |
420 | When setting the failure mode for |
421 | .I faulty | |
422 | the options are: | |
7e23fc43 PS |
423 | .BR write\-transient ", " wt , |
424 | .BR read\-transient ", " rt , | |
425 | .BR write\-persistent ", " wp , | |
426 | .BR read\-persistent ", " rp , | |
427 | .BR write\-all , | |
428 | .BR read\-fixable ", " rf , | |
53e8b987 | 429 | .BR clear ", " flush ", " none . |
b5e64645 NB |
430 | |
431 | Each mode can be followed by a number which is used as a period | |
432 | between fault generation. Without a number, the fault is generated | |
433 | once on the first relevant request. With a number, the fault will be | |
434 | generated after that many request, and will continue to be generated | |
435 | every time the period elapses. | |
436 | ||
437 | Multiple failure modes can be current simultaneously by using the | |
7e23fc43 | 438 | .B \-\-grow |
53e8b987 | 439 | option to set subsequent failure modes. |
b5e64645 NB |
440 | |
441 | "clear" or "none" will remove any pending or periodic failure modes, | |
2ae555c3 | 442 | and "flush" will clear any persistent faults. |
b5e64645 | 443 | |
53e8b987 | 444 | To set the parity with |
7e23fc43 | 445 | .BR \-\-grow , |
53e8b987 | 446 | the level of the array ("faulty") |
b5e64645 NB |
447 | must be specified before the fault mode is specified. |
448 | ||
6f9a21a7 | 449 | Finally, the layout options for RAID10 are one of 'n', 'o' or 'f' followed |
1a7dfc35 NB |
450 | by a small number. The default is 'n2'. |
451 | ||
452 | .I n | |
b578481c NB |
453 | signals 'near' copies. Multiple copies of one data block are at |
454 | similar offsets in different devices. | |
455 | ||
456 | .I o | |
457 | signals 'offset' copies. Rather than the chunks being duplicated | |
458 | within a stripe, whole stripes are duplicated but are rotated by one | |
459 | device so duplicate blocks are on different devices. Thus subsequent | |
460 | copies of a block are in the next drive, and are one chunk further | |
461 | down. | |
462 | ||
1a7dfc35 NB |
463 | .I f |
464 | signals 'far' copies | |
465 | (multiple copies have very different offsets). See md(4) for more | |
466 | detail about 'near' and 'far'. | |
467 | ||
468 | The number is the number of copies of each datablock. 2 is normal, 3 | |
469 | can be useful. This number can be at most equal to the number of | |
470 | devices in the array. It does not need to divide evenly into that | |
471 | number (e.g. it is perfectly legal to have an 'n2' layout for an array | |
472 | with an odd number of devices). | |
473 | ||
cd29a5c8 | 474 | .TP |
7e23fc43 | 475 | .BR \-\-parity= |
53e8b987 | 476 | same as |
7e23fc43 | 477 | .B \-\-layout |
53e8b987 | 478 | (thus explaining the p of |
7e23fc43 | 479 | .BR \-p ). |
52826846 | 480 | |
e793c2e5 | 481 | .TP |
7e23fc43 | 482 | .BR \-b ", " \-\-bitmap= |
e793c2e5 | 483 | Specify a file to store a write-intent bitmap in. The file should not |
53e8b987 | 484 | exist unless |
7e23fc43 | 485 | .B \-\-force |
53e8b987 | 486 | is also given. The same file should be provided |
2ae555c3 NB |
487 | when assembling the array. If the word |
488 | .B internal | |
489 | is given, then the bitmap is stored with the metadata on the array, | |
490 | and so is replicated on all devices. If the word | |
491 | .B none | |
492 | is given with | |
7e23fc43 | 493 | .B \-\-grow |
2ae555c3 | 494 | mode, then any bitmap that is present is removed. |
e793c2e5 | 495 | |
2ae555c3 NB |
496 | To help catch typing errors, the filename must contain at least one |
497 | slash ('/') if it is a real file (not 'internal' or 'none'). | |
498 | ||
499 | Note: external bitmaps are only known to work on ext2 and ext3. | |
500 | Storing bitmap files on other filesystems may result in serious problems. | |
e793c2e5 | 501 | |
cd29a5c8 | 502 | .TP |
7e23fc43 | 503 | .BR \-\-bitmap\-chunk= |
2ae555c3 | 504 | Set the chunksize of the bitmap. Each bit corresponds to that many |
1bfdbe01 NB |
505 | Kilobytes of storage. |
506 | When using a file based bitmap, the default is to use the smallest | |
507 | size that is atleast 4 and requires no more than 2^21 chunks. | |
2ae555c3 NB |
508 | When using an |
509 | .B internal | |
510 | bitmap, the chunksize is automatically determined to make best use of | |
511 | available space. | |
5787fa49 | 512 | |
cd29a5c8 NB |
513 | |
514 | .TP | |
7e23fc43 | 515 | .BR \-W ", " \-\-write\-mostly |
2ae555c3 | 516 | subsequent devices lists in a |
7e23fc43 PS |
517 | .BR \-\-build , |
518 | .BR \-\-create , | |
2ae555c3 | 519 | or |
7e23fc43 | 520 | .B \-\-add |
2ae555c3 NB |
521 | command will be flagged as 'write-mostly'. This is valid for RAID1 |
522 | only and means that the 'md' driver will avoid reading from these | |
523 | devices if at all possible. This can be useful if mirroring over a | |
524 | slow link. | |
52826846 | 525 | |
2ae555c3 | 526 | .TP |
7e23fc43 | 527 | .BR \-\-write\-behind= |
2ae555c3 NB |
528 | Specify that write-behind mode should be enabled (valid for RAID1 |
529 | only). If an argument is specified, it will set the maximum number | |
530 | of outstanding writes allowed. The default value is 256. | |
531 | A write-intent bitmap is required in order to use write-behind | |
532 | mode, and write-behind is only attempted on drives marked as | |
533 | .IR write-mostly . | |
dd0781e5 NB |
534 | |
535 | .TP | |
7e23fc43 | 536 | .BR \-\-assume\-clean |
dd0781e5 NB |
537 | Tell |
538 | .I mdadm | |
47d79ef8 NB |
539 | that the array pre-existed and is known to be clean. It can be useful |
540 | when trying to recover from a major failure as you can be sure that no | |
541 | data will be affected unless you actually write to the array. It can | |
542 | also be used when creating a RAID1 or RAID10 if you want to avoid the | |
b3f1c093 | 543 | initial resync, however this practice \(em while normally safe \(em is not |
47d79ef8 | 544 | recommended. Use this ony if you really know what you are doing. |
dd0781e5 | 545 | |
2ae555c3 | 546 | .TP |
7e23fc43 | 547 | .BR \-\-backup\-file= |
53e8b987 | 548 | This is needed when |
7e23fc43 | 549 | .B \-\-grow |
53e8b987 | 550 | is used to increase the number of |
2ae555c3 NB |
551 | raid-devices in a RAID5 if there are no spare devices available. |
552 | See the section below on RAID_DEVICE CHANGES. The file should be | |
553 | stored on a separate device, not on the raid array being reshaped. | |
554 | ||
947fd4dd | 555 | .TP |
7e23fc43 | 556 | .BR \-N ", " \-\-name= |
947fd4dd NB |
557 | Set a |
558 | .B name | |
559 | for the array. This is currently only effective when creating an | |
560 | array with a version-1 superblock. The name is a simple textual | |
561 | string that can be used to identify array components when assembling. | |
562 | ||
dd0781e5 | 563 | .TP |
7e23fc43 | 564 | .BR \-R ", " \-\-run |
dd0781e5 NB |
565 | Insist that |
566 | .I mdadm | |
567 | run the array, even if some of the components | |
568 | appear to be active in another array or filesystem. Normally | |
569 | .I mdadm | |
570 | will ask for confirmation before including such components in an | |
571 | array. This option causes that question to be suppressed. | |
572 | ||
573 | .TP | |
7e23fc43 | 574 | .BR \-f ", " \-\-force |
dd0781e5 NB |
575 | Insist that |
576 | .I mdadm | |
577 | accept the geometry and layout specified without question. Normally | |
578 | .I mdadm | |
579 | will not allow creation of an array with only one device, and will try | |
580 | to create a raid5 array with one missing drive (as this makes the | |
581 | initial resync work faster). With | |
7e23fc43 | 582 | .BR \-\-force , |
dd0781e5 NB |
583 | .I mdadm |
584 | will not try to be so clever. | |
585 | ||
586 | .TP | |
7e23fc43 | 587 | .BR \-a ", " "\-\-auto{=no,yes,md,mdp,part,p}{NN}" |
48f7b27a NB |
588 | Instruct mdadm to create the device file if needed, possibly allocating |
589 | an unused minor number. "md" causes a non-partitionable array | |
dd0781e5 | 590 | to be used. "mdp", "part" or "p" causes a partitionable array (2.6 and |
2ae555c3 | 591 | later) to be used. "yes" requires the named md device to have |
f9c25f1d | 592 | a 'standard' format, and the type and minor number will be determined |
48f7b27a NB |
593 | from this. See DEVICE NAMES below. |
594 | ||
a9d69660 | 595 | The argument can also come immediately after |
7e23fc43 | 596 | "\-a". e.g. "\-ap". |
dd0781e5 | 597 | |
53e8b987 | 598 | If |
7e23fc43 | 599 | .B \-\-auto |
53e8b987 | 600 | is not given on the command line or in the config file, then |
75723446 | 601 | the default will be |
7e23fc43 | 602 | .BR \-\-auto=yes . |
75723446 | 603 | |
1337546d | 604 | If |
7e23fc43 | 605 | .B \-\-scan |
1337546d NB |
606 | is also given, then any |
607 | .I auto= | |
35cc5be4 | 608 | entries in the config file will override the |
7e23fc43 | 609 | .B \-\-auto |
1337546d NB |
610 | instruction given on the command line. |
611 | ||
dd0781e5 NB |
612 | For partitionable arrays, |
613 | .I mdadm | |
614 | will create the device file for the whole array and for the first 4 | |
615 | partitions. A different number of partitions can be specified at the | |
616 | end of this option (e.g. | |
7e23fc43 | 617 | .BR \-\-auto=p7 ). |
2ae555c3 | 618 | If the device name ends with a digit, the partition names add a 'p', |
48f7b27a | 619 | and a number, e.g. "/dev/home1p3". If there is no |
dd0781e5 NB |
620 | trailing digit, then the partition names just have a number added, |
621 | e.g. "/dev/scratch3". | |
622 | ||
48f7b27a NB |
623 | If the md device name is in a 'standard' format as described in DEVICE |
624 | NAMES, then it will be created, if necessary, with the appropriate | |
625 | number based on that name. If the device name is not in one of these | |
a9d69660 | 626 | formats, then a unused minor number will be allocated. The minor |
48f7b27a NB |
627 | number will be considered unused if there is no active array for that |
628 | number, and there is no entry in /dev for that number and with a | |
629 | non-standard name. | |
630 | ||
38098016 | 631 | .TP |
7e23fc43 | 632 | .BR \-\-symlink = no |
38098016 | 633 | Normally when |
7e23fc43 | 634 | .B \-\-auto |
38098016 NB |
635 | causes |
636 | .I mdadm | |
637 | to create devices in | |
638 | .B /dev/md/ | |
639 | it will also create symlinks from | |
640 | .B /dev/ | |
641 | with names starting with | |
642 | .B md | |
643 | or | |
644 | .BR md_ . | |
645 | Use | |
7e23fc43 | 646 | .B \-\-symlink=no |
38098016 | 647 | to suppress this, or |
7e23fc43 | 648 | .B \-\-symlink=yes |
38098016 NB |
649 | to enforce this even if it is suppressing |
650 | .IR mdadm.conf . | |
651 | ||
652 | ||
52826846 NB |
653 | .SH For assemble: |
654 | ||
cd29a5c8 | 655 | .TP |
7e23fc43 | 656 | .BR \-u ", " \-\-uuid= |
cd29a5c8 NB |
657 | uuid of array to assemble. Devices which don't have this uuid are |
658 | excluded | |
659 | ||
660 | .TP | |
7e23fc43 | 661 | .BR \-m ", " \-\-super\-minor= |
cd29a5c8 NB |
662 | Minor number of device that array was created for. Devices which |
663 | don't have this minor number are excluded. If you create an array as | |
2d465520 | 664 | /dev/md1, then all superblocks will contain the minor number 1, even if |
cd29a5c8 NB |
665 | the array is later assembled as /dev/md2. |
666 | ||
d013a55e | 667 | Giving the literal word "dev" for |
7e23fc43 | 668 | .B \-\-super\-minor |
d013a55e NB |
669 | will cause |
670 | .I mdadm | |
671 | to use the minor number of the md device that is being assembled. | |
672 | e.g. when assembling | |
673 | .BR /dev/md0 , | |
7e23fc43 | 674 | .M \-\-super\-minor=dev |
d013a55e NB |
675 | will look for super blocks with a minor number of 0. |
676 | ||
947fd4dd | 677 | .TP |
7e23fc43 | 678 | .BR \-N ", " \-\-name= |
947fd4dd | 679 | Specify the name of the array to assemble. This must be the name |
624920bb NB |
680 | that was specified when creating the array. It must either match |
681 | then name stored in the superblock exactly, or it must match | |
41a3b72a | 682 | with the current |
624920bb NB |
683 | .I homehost |
684 | is added to the start of the given name. | |
947fd4dd | 685 | |
cd29a5c8 | 686 | .TP |
7e23fc43 | 687 | .BR \-f ", " \-\-force |
52826846 NB |
688 | Assemble the array even if some superblocks appear out-of-date |
689 | ||
cd29a5c8 | 690 | .TP |
7e23fc43 | 691 | .BR \-R ", " \-\-run |
b8a8ccf9 NB |
692 | Attempt to start the array even if fewer drives were given than were |
693 | present last time the array was active. Normally if not all the | |
694 | expected drives are found and | |
7e23fc43 | 695 | .B \-\-scan |
cd29a5c8 NB |
696 | is not used, then the array will be assembled but not started. |
697 | With | |
7e23fc43 | 698 | .B \-\-run |
cd29a5c8 | 699 | an attempt will be made to start it anyway. |
52826846 | 700 | |
b8a8ccf9 | 701 | .TP |
7e23fc43 | 702 | .B \-\-no\-degraded |
b8a8ccf9 | 703 | This is the reverse of |
7e23fc43 | 704 | .B \-\-run |
b8a8ccf9 NB |
705 | in that it inhibits the started if array unless all expected drives |
706 | are present. This is only needed with | |
7e23fc43 | 707 | .B \-\-scan |
b8a8ccf9 NB |
708 | and can be used if you physical connections to devices are |
709 | not as reliable as you would like. | |
710 | ||
dd0781e5 | 711 | .TP |
7e23fc43 | 712 | .BR \-a ", " "\-\-auto{=no,yes,md,mdp,part}" |
dd0781e5 NB |
713 | See this option under Create and Build options. |
714 | ||
e793c2e5 | 715 | .TP |
7e23fc43 | 716 | .BR \-b ", " \-\-bitmap= |
2ae555c3 NB |
717 | Specify the bitmap file that was given when the array was created. If |
718 | an array has an | |
719 | .B internal | |
720 | bitmap, there is no need to specify this when assembling the array. | |
721 | ||
722 | .TP | |
7e23fc43 | 723 | .BR \-\-backup\-file= |
2ae555c3 | 724 | If |
7e23fc43 | 725 | .B \-\-backup\-file |
2ae555c3 NB |
726 | was used to grow the number of raid-devices in a RAID5, and the system |
727 | crashed during the critical section, then the same | |
7e23fc43 | 728 | .B \-\-backup\-file |
53e8b987 | 729 | must be presented to |
7e23fc43 | 730 | .B \-\-assemble |
53e8b987 | 731 | to allow possibly corrupted data to be restored. |
e793c2e5 | 732 | |
5787fa49 | 733 | .TP |
7e23fc43 | 734 | .BR \-U ", " \-\-update= |
5787fa49 | 735 | Update the superblock on each device while assembling the array. The |
feb716e9 NB |
736 | argument given to this flag can be one of |
737 | .BR sparc2.2 , | |
738 | .BR summaries , | |
7d99579f | 739 | .BR uuid , |
c4f12c13 | 740 | .BR name , |
0237e0ca | 741 | .BR homehost , |
e5329c37 | 742 | .BR resync , |
586ed405 | 743 | .BR byteorder , |
bee8ec56 | 744 | .BR devicesize , |
5787fa49 | 745 | or |
7e23fc43 | 746 | .BR super\-minor . |
5787fa49 NB |
747 | |
748 | The | |
749 | .B sparc2.2 | |
7d99579f | 750 | option will adjust the superblock of an array what was created on a Sparc |
5787fa49 NB |
751 | machine running a patched 2.2 Linux kernel. This kernel got the |
752 | alignment of part of the superblock wrong. You can use the | |
7e23fc43 | 753 | .B "\-\-examine \-\-sparc2.2" |
5787fa49 NB |
754 | option to |
755 | .I mdadm | |
756 | to see what effect this would have. | |
757 | ||
758 | The | |
7e23fc43 | 759 | .B super\-minor |
5787fa49 | 760 | option will update the |
2ae555c3 | 761 | .B "preferred minor" |
5787fa49 | 762 | field on each superblock to match the minor number of the array being |
45c073c9 NB |
763 | assembled. |
764 | This can be useful if | |
7e23fc43 | 765 | .B \-\-examine |
45c073c9 | 766 | reports a different "Preferred Minor" to |
7e23fc43 | 767 | .BR \-\-detail . |
45c073c9 NB |
768 | In some cases this update will be performed automatically |
769 | by the kernel driver. In particular the update happens automatically | |
770 | at the first write to an array with redundancy (RAID level 1 or | |
771 | greater) on a 2.6 (or later) kernel. | |
5787fa49 | 772 | |
7d99579f NB |
773 | The |
774 | .B uuid | |
775 | option will change the uuid of the array. If a UUID is given with the | |
7e23fc43 | 776 | .B \-\-uuid |
53e8b987 | 777 | option that UUID will be used as a new UUID and will |
7d99579f NB |
778 | .B NOT |
779 | be used to help identify the devices in the array. | |
53e8b987 | 780 | If no |
7e23fc43 | 781 | .B \-\-uuid |
53e8b987 | 782 | is given, a random UUID is chosen. |
7d99579f | 783 | |
c4f12c13 NB |
784 | The |
785 | .B name | |
786 | option will change the | |
787 | .I name | |
788 | of the array as stored in the superblock. This is only supported for | |
789 | version-1 superblocks. | |
790 | ||
0237e0ca NB |
791 | The |
792 | .B homehost | |
793 | option will change the | |
794 | .I homehost | |
795 | as recorded in the superblock. For version-0 superblocks, this is the | |
796 | same as updating the UUID. | |
797 | For version-1 superblocks, this involves updating the name. | |
798 | ||
e5329c37 NB |
799 | The |
800 | .B resync | |
801 | option will cause the array to be marked | |
802 | .I dirty | |
803 | meaning that any redundancy in the array (e.g. parity for raid5, | |
804 | copies for raid1) may be incorrect. This will cause the raid system | |
805 | to perform a "resync" pass to make sure that all redundant information | |
806 | is correct. | |
807 | ||
586ed405 NB |
808 | The |
809 | .B byteorder | |
810 | option allows arrays to be moved between machines with different | |
811 | byte-order. | |
2ae555c3 | 812 | When assembling such an array for the first time after a move, giving |
7e23fc43 | 813 | .B "\-\-update=byteorder" |
586ed405 NB |
814 | will cause |
815 | .I mdadm | |
816 | to expect superblocks to have their byteorder reversed, and will | |
817 | correct that order before assembling the array. This is only valid | |
2ae555c3 | 818 | with original (Version 0.90) superblocks. |
586ed405 | 819 | |
feb716e9 NB |
820 | The |
821 | .B summaries | |
822 | option will correct the summaries in the superblock. That is the | |
823 | counts of total, working, active, failed, and spare devices. | |
5787fa49 | 824 | |
bee8ec56 NB |
825 | The |
826 | .B devicesize | |
827 | will rarely be of use. It applies to version 1.1 and 1.2 metadata | |
828 | only (where the metadata is at the start of the device) and is only | |
829 | useful when the component device has changed size (typically become | |
830 | larger). The version 1 metadata records the amount of the device that | |
831 | can be used to store data, so if a device in a version 1.1 or 1.2 | |
832 | array becomes larger, the metadata will still be visible, but the | |
833 | extra space will not. In this case it might be useful to assemble the | |
834 | array with | |
7e23fc43 | 835 | .BR \-\-update=devicesize . |
bee8ec56 NB |
836 | This will cause |
837 | .I mdadm | |
838 | to determine the maximum usable amount of space on each device and | |
839 | update the relevant field in the metadata. | |
840 | ||
41a3b72a | 841 | .TP |
7e23fc43 | 842 | .B \-\-auto\-update\-homehost |
41a3b72a NB |
843 | This flag is only meaning with auto-assembly (see discussion below). |
844 | In that situation, if no suitable arrays are found for this homehost, | |
845 | .I mdadm | |
846 | will recan for any arrays at all and will assemble them and update the | |
847 | homehost to match the current host. | |
848 | ||
e0d19036 | 849 | .SH For Manage mode: |
52826846 | 850 | |
cd29a5c8 | 851 | .TP |
7e23fc43 | 852 | .BR \-a ", " \-\-add |
2ae555c3 | 853 | hot-add listed devices. |
52826846 | 854 | |
fe80f49b | 855 | .TP |
7e23fc43 | 856 | .BR \-\-re\-add |
2ae555c3 | 857 | re-add a device that was recently removed from an array. |
fe80f49b | 858 | |
cd29a5c8 | 859 | .TP |
7e23fc43 | 860 | .BR \-r ", " \-\-remove |
2d465520 | 861 | remove listed devices. They must not be active. i.e. they should |
b80da661 NB |
862 | be failed or spare devices. As well as the name of a device file |
863 | (e.g. | |
864 | .BR /dev/sda1 ) | |
865 | the words | |
866 | .B failed | |
867 | and | |
868 | .B detached | |
869 | can be given to | |
870 | .BR \-\-remove . | |
871 | The first causes all failed device to be removed. The second causes | |
872 | any device which is no longer connected to the system (i.e and open | |
873 | returns | |
874 | .BR ENXIO ) | |
875 | to be removed. This will only succeed for devices that are spares or | |
876 | have already been marked as failed. | |
52826846 | 877 | |
cd29a5c8 | 878 | .TP |
7e23fc43 | 879 | .BR \-f ", " \-\-fail |
cd29a5c8 | 880 | mark listed devices as faulty. |
b80da661 NB |
881 | As well as the name of a device file, the word |
882 | .B detached | |
883 | can be given. This will cause any device that has been detached from | |
884 | the system to be marked as failed. It can then be removed. | |
52826846 | 885 | |
cd29a5c8 | 886 | .TP |
7e23fc43 | 887 | .BR \-\-set\-faulty |
53e8b987 | 888 | same as |
7e23fc43 | 889 | .BR \-\-fail . |
52826846 | 890 | |
2ae555c3 NB |
891 | .P |
892 | Each of these options require that the first device list is the array | |
893 | to be acted upon and the remainder are component devices to be added, | |
894 | removed, or marked as fault. Several different operations can be | |
895 | specified for different devices, e.g. | |
896 | .in +5 | |
7e23fc43 | 897 | mdadm /dev/md0 \-\-add /dev/sda1 \-\-fail /dev/sdb1 \-\-remove /dev/sdb1 |
2ae555c3 NB |
898 | .in -5 |
899 | Each operation applies to all devices listed until the next | |
900 | operations. | |
901 | ||
902 | If an array is using a write-intent bitmap, then devices which have | |
903 | been removed can be re-added in a way that avoids a full | |
904 | reconstruction but instead just updated the blocks that have changed | |
905 | since the device was removed. For arrays with persistent metadata | |
906 | (superblocks) this is done automatically. For arrays created with | |
7e23fc43 | 907 | .B \-\-build |
2ae555c3 | 908 | mdadm needs to be told that this device we removed recently with |
7e23fc43 | 909 | .BR \-\-re\-add . |
2ae555c3 NB |
910 | |
911 | Devices can only be removed from an array if they are not in active | |
912 | use. i.e. that must be spares or failed devices. To remove an active | |
913 | device, it must be marked as | |
914 | .B faulty | |
915 | first. | |
916 | ||
917 | .SH For Misc mode: | |
918 | ||
919 | .TP | |
7e23fc43 | 920 | .BR \-Q ", " \-\-query |
2ae555c3 NB |
921 | Examine a device to see |
922 | (1) if it is an md device and (2) if it is a component of an md | |
923 | array. | |
924 | Information about what is discovered is presented. | |
925 | ||
926 | .TP | |
7e23fc43 | 927 | .BR \-D ", " \-\-detail |
2ae555c3 | 928 | Print detail of one or more md devices. |
5787fa49 | 929 | |
54bad364 KS |
930 | .TP |
931 | .BR \-Y ", " \-\-export | |
932 | When used with | |
933 | .BR \-\-detail , | |
934 | output will be formatted as | |
935 | .B key=value | |
936 | pairs for easy import into the environment. | |
937 | ||
2ae555c3 | 938 | .TP |
7e23fc43 | 939 | .BR \-E ", " \-\-examine |
2ae555c3 | 940 | Print content of md superblock on device(s). |
5787fa49 | 941 | .TP |
7e23fc43 | 942 | .B \-\-sparc2.2 |
a9d69660 | 943 | If an array was created on a 2.2 Linux kernel patched with RAID |
5787fa49 NB |
944 | support, the superblock will have been created incorrectly, or at |
945 | least incompatibly with 2.4 and later kernels. Using the | |
7e23fc43 | 946 | .B \-\-sparc2.2 |
5787fa49 | 947 | flag with |
7e23fc43 | 948 | .B \-\-examine |
5787fa49 NB |
949 | will fix the superblock before displaying it. If this appears to do |
950 | the right thing, then the array can be successfully assembled using | |
7e23fc43 | 951 | .BR "\-\-assemble \-\-update=sparc2.2" . |
5787fa49 | 952 | |
2ae555c3 | 953 | .TP |
7e23fc43 | 954 | .BR \-X ", " \-\-examine\-bitmap |
2ae555c3 | 955 | Report information about a bitmap file. |
e0d19036 | 956 | |
cd29a5c8 | 957 | .TP |
7e23fc43 | 958 | .BR \-R ", " \-\-run |
cd29a5c8 | 959 | start a partially built array. |
52826846 | 960 | |
cd29a5c8 | 961 | .TP |
7e23fc43 | 962 | .BR \-S ", " \-\-stop |
cd29a5c8 | 963 | deactivate array, releasing all resources. |
52826846 | 964 | |
cd29a5c8 | 965 | .TP |
7e23fc43 | 966 | .BR \-o ", " \-\-readonly |
cd29a5c8 | 967 | mark array as readonly. |
52826846 | 968 | |
cd29a5c8 | 969 | .TP |
7e23fc43 | 970 | .BR \-w ", " \-\-readwrite |
cd29a5c8 | 971 | mark array as readwrite. |
52826846 | 972 | |
e0d19036 | 973 | .TP |
7e23fc43 | 974 | .B \-\-zero\-superblock |
e0d19036 | 975 | If the device contains a valid md superblock, the block is |
35cc5be4 | 976 | overwritten with zeros. With |
7e23fc43 | 977 | .B \-\-force |
35cc5be4 | 978 | the block where the superblock would be is overwritten even if it |
e0d19036 | 979 | doesn't appear to be valid. |
52826846 | 980 | |
feb716e9 | 981 | .TP |
7e23fc43 | 982 | .BR \-t ", " \-\-test |
feb716e9 | 983 | When used with |
7e23fc43 | 984 | .BR \-\-detail , |
feb716e9 NB |
985 | the exit status of |
986 | .I mdadm | |
987 | is set to reflect the status of the device. | |
988 | ||
b90c0e9a | 989 | .TP |
7e23fc43 | 990 | .BR \-W ", " \-\-wait |
b90c0e9a NB |
991 | For each md device given, wait for any resync, recovery, or reshape |
992 | activity to finish before returning. | |
993 | .I mdadm | |
994 | will return with success if it actually waited for every device | |
995 | listed, otherwise it will return failure. | |
996 | ||
8382f19b NB |
997 | .SH For Incremental Assembly mode: |
998 | .TP | |
7e23fc43 | 999 | .BR \-\-rebuild\-map ", " \-r |
8382f19b NB |
1000 | Rebuild the map file |
1001 | .RB ( /var/run/mdadm/map ) | |
1002 | that | |
1003 | .I mdadm | |
1004 | uses to help track which arrays are currently being assembled. | |
1005 | ||
1006 | .TP | |
7e23fc43 | 1007 | .BR \-\-run ", " \-R |
8382f19b NB |
1008 | Run any array assembled as soon as a minimal number of devices are |
1009 | available, rather than waiting until all expected devices are present. | |
1010 | ||
1011 | .TP | |
7e23fc43 | 1012 | .BR \-\-scan ", " \-s |
8382f19b | 1013 | Only meaningful with |
7e23fc43 | 1014 | .B \-R |
8382f19b NB |
1015 | this will scan the |
1016 | .B map | |
1017 | file for arrays that are being incrementally assembled and will try to | |
1018 | start any that are not already started. If any such array is listed | |
1019 | in | |
1020 | .B mdadm.conf | |
1021 | as requiring an external bitmap, that bitmap will be attached first. | |
1022 | ||
e0d19036 NB |
1023 | .SH For Monitor mode: |
1024 | .TP | |
7e23fc43 | 1025 | .BR \-m ", " \-\-mail |
e0d19036 NB |
1026 | Give a mail address to send alerts to. |
1027 | ||
1028 | .TP | |
7e23fc43 | 1029 | .BR \-p ", " \-\-program ", " \-\-alert |
e0d19036 NB |
1030 | Give a program to be run whenever an event is detected. |
1031 | ||
773135f5 | 1032 | .TP |
7e23fc43 | 1033 | .BR \-y ", " \-\-syslog |
773135f5 NB |
1034 | Cause all events to be reported through 'syslog'. The messages have |
1035 | facility of 'daemon' and varying priorities. | |
1036 | ||
e0d19036 | 1037 | .TP |
7e23fc43 | 1038 | .BR \-d ", " \-\-delay |
e0d19036 NB |
1039 | Give a delay in seconds. |
1040 | .B mdadm | |
1041 | polls the md arrays and then waits this many seconds before polling | |
1042 | again. The default is 60 seconds. | |
1043 | ||
d013a55e | 1044 | .TP |
7e23fc43 | 1045 | .BR \-f ", " \-\-daemonise |
d013a55e NB |
1046 | Tell |
1047 | .B mdadm | |
1048 | to run as a background daemon if it decides to monitor anything. This | |
1049 | causes it to fork and run in the child, and to disconnect form the | |
1050 | terminal. The process id of the child is written to stdout. | |
1051 | This is useful with | |
7e23fc43 | 1052 | .B \-\-scan |
d013a55e NB |
1053 | which will only continue monitoring if a mail address or alert program |
1054 | is found in the config file. | |
1055 | ||
b5e64645 | 1056 | .TP |
7e23fc43 | 1057 | .BR \-i ", " \-\-pid\-file |
b5e64645 NB |
1058 | When |
1059 | .B mdadm | |
1060 | is running in daemon mode, write the pid of the daemon process to | |
1061 | the specified file, instead of printing it on standard output. | |
1062 | ||
aa88f531 | 1063 | .TP |
7e23fc43 | 1064 | .BR \-1 ", " \-\-oneshot |
aa88f531 NB |
1065 | Check arrays only once. This will generate |
1066 | .B NewArray | |
1067 | events and more significantly | |
1068 | .B DegradedArray | |
a9d69660 NB |
1069 | and |
1070 | .B SparesMissing | |
aa88f531 NB |
1071 | events. Running |
1072 | .in +5 | |
7e23fc43 | 1073 | .B " mdadm \-\-monitor \-\-scan \-1" |
aa88f531 NB |
1074 | .in -5 |
1075 | from a cron script will ensure regular notification of any degraded arrays. | |
1076 | ||
98c6faba | 1077 | .TP |
7e23fc43 | 1078 | .BR \-t ", " \-\-test |
98c6faba NB |
1079 | Generate a |
1080 | .B TestMessage | |
1081 | alert for every array found at startup. This alert gets mailed and | |
1082 | passed to the alert program. This can be used for testing that alert | |
a9d69660 | 1083 | message do get through successfully. |
98c6faba | 1084 | |
e0d19036 | 1085 | .SH ASSEMBLE MODE |
52826846 | 1086 | |
cd29a5c8 NB |
1087 | .HP 12 |
1088 | Usage: | |
7e23fc43 | 1089 | .B mdadm \-\-assemble |
5787fa49 NB |
1090 | .I md-device options-and-component-devices... |
1091 | .HP 12 | |
1092 | Usage: | |
7e23fc43 | 1093 | .B mdadm \-\-assemble \-\-scan |
5787fa49 | 1094 | .I md-devices-and-options... |
cd29a5c8 NB |
1095 | .HP 12 |
1096 | Usage: | |
7e23fc43 | 1097 | .B mdadm \-\-assemble \-\-scan |
cd29a5c8 | 1098 | .I options... |
52826846 | 1099 | |
cd29a5c8 | 1100 | .PP |
52826846 | 1101 | This usage assembles one or more raid arrays from pre-existing components. |
9a9dab36 | 1102 | For each array, mdadm needs to know the md device, the identity of the |
e0d19036 | 1103 | array, and a number of component-devices. These can be found in a number of ways. |
52826846 | 1104 | |
5787fa49 | 1105 | In the first usage example (without the |
7e23fc43 | 1106 | .BR \-\-scan ) |
5787fa49 NB |
1107 | the first device given is the md device. |
1108 | In the second usage example, all devices listed are treated as md | |
1109 | devices and assembly is attempted. | |
1110 | In the third (where no devices are listed) all md devices that are | |
1111 | listed in the configuration file are assembled. | |
52826846 | 1112 | |
d013a55e | 1113 | If precisely one device is listed, but |
7e23fc43 | 1114 | .B \-\-scan |
dd0781e5 | 1115 | is not given, then |
d013a55e NB |
1116 | .I mdadm |
1117 | acts as though | |
7e23fc43 | 1118 | .B \-\-scan |
d013a55e NB |
1119 | was given and identify information is extracted from the configuration file. |
1120 | ||
2ae555c3 | 1121 | The identity can be given with the |
7e23fc43 | 1122 | .B \-\-uuid |
cd29a5c8 | 1123 | option, with the |
7e23fc43 | 1124 | .B \-\-super\-minor |
5787fa49 | 1125 | option, can be found in the config file, or will be taken from the |
e0d19036 | 1126 | super block on the first component-device listed on the command line. |
52826846 | 1127 | |
2ae555c3 | 1128 | Devices can be given on the |
7e23fc43 | 1129 | .B \-\-assemble |
5787fa49 NB |
1130 | command line or in the config file. Only devices which have an md |
1131 | superblock which contains the right identity will be considered for | |
1132 | any array. | |
52826846 | 1133 | |
2ae555c3 | 1134 | The config file is only used if explicitly named with |
7e23fc43 | 1135 | .B \-\-config |
d013a55e | 1136 | or requested with (a possibly implicit) |
7e23fc43 | 1137 | .BR \-\-scan . |
52826846 | 1138 | In the later case, |
9a9dab36 | 1139 | .B /etc/mdadm.conf |
52826846 NB |
1140 | is used. |
1141 | ||
2ae555c3 | 1142 | If |
7e23fc43 | 1143 | .B \-\-scan |
cd29a5c8 NB |
1144 | is not given, then the config file will only be used to find the |
1145 | identity of md arrays. | |
52826846 | 1146 | |
2d465520 | 1147 | Normally the array will be started after it is assembled. However if |
7e23fc43 | 1148 | .B \-\-scan |
2d465520 | 1149 | is not given and insufficient drives were listed to start a complete |
cd29a5c8 NB |
1150 | (non-degraded) array, then the array is not started (to guard against |
1151 | usage errors). To insist that the array be started in this case (as | |
1a7dfc35 | 1152 | may work for RAID1, 4, 5, 6, or 10), give the |
7e23fc43 | 1153 | .B \-\-run |
cd29a5c8 | 1154 | flag. |
52826846 | 1155 | |
75723446 NB |
1156 | If the md device does not exist, then it will be created providing the |
1157 | intent is clear. i.e. the name must be in a standard form, or the | |
7e23fc43 | 1158 | .B \-\-auto |
75723446 NB |
1159 | option must be given to clarify how and whether the device should be |
1160 | created. | |
dd0781e5 NB |
1161 | |
1162 | This can be useful for handling partitioned devices (which don't have | |
b3f1c093 | 1163 | a stable device number \(em it can change after a reboot) and when using |
dd0781e5 NB |
1164 | "udev" to manage your |
1165 | .B /dev | |
1166 | tree (udev cannot handle md devices because of the unusual device | |
1167 | initialisation conventions). | |
1168 | ||
1169 | If the option to "auto" is "mdp" or "part" or (on the command line | |
1170 | only) "p", then mdadm will create a partitionable array, using the | |
2ae555c3 | 1171 | first free one that is not in use, and does not already have an entry |
dd0781e5 NB |
1172 | in /dev (apart from numeric /dev/md* entries). |
1173 | ||
1174 | If the option to "auto" is "yes" or "md" or (on the command line) | |
1175 | nothing, then mdadm will create a traditional, non-partitionable md | |
1176 | array. | |
1177 | ||
1178 | It is expected that the "auto" functionality will be used to create | |
1179 | device entries with meaningful names such as "/dev/md/home" or | |
1180 | "/dev/md/root", rather than names based on the numerical array number. | |
1181 | ||
1182 | When using this option to create a partitionable array, the device | |
1183 | files for the first 4 partitions are also created. If a different | |
1184 | number is required it can be simply appended to the auto option. | |
1185 | e.g. "auto=part8". Partition names are created by appending a digit | |
a9d69660 | 1186 | string to the device name, with an intervening "p" if the device name |
dd0781e5 NB |
1187 | ends with a digit. |
1188 | ||
1189 | The | |
7e23fc43 | 1190 | .B \-\-auto |
dd0781e5 NB |
1191 | option is also available in Build and Create modes. As those modes do |
1192 | not use a config file, the "auto=" config option does not apply to | |
1193 | these modes. | |
52826846 | 1194 | |
41a3b72a NB |
1195 | .SS Auto Assembly |
1196 | When | |
7e23fc43 | 1197 | .B \-\-assemble |
41a3b72a | 1198 | is used with |
7e23fc43 | 1199 | .B \-\-scan |
41a3b72a NB |
1200 | and no devices are listed, |
1201 | .I mdadm | |
1202 | will first attempt to assemble all the arrays listed in the config | |
1203 | file. | |
1204 | ||
1205 | If a | |
1206 | .B homehost | |
1207 | has been specified (either in the config file or on the command line), | |
1208 | .I mdadm | |
1209 | will look further for possible arrays and will try to assemble | |
1210 | anything that it finds which is tagged as belonging to the given | |
1211 | homehost. This is the only situation where | |
1212 | .I mdadm | |
1213 | will assemble arrays without being given specific device name or | |
1214 | identify information for the array. | |
1215 | ||
1216 | If | |
1217 | .I mdadm | |
1218 | finds a consistent set of devices that look like they should comprise | |
1219 | an array, and if the superblock is tagged as belonging to the given | |
1220 | home host, it will automatically choose a device name and try to | |
1221 | assemble the array. If the array uses version-0.90 metadata, then the | |
1222 | .B minor | |
1223 | number as recorded in the superblock is used to create a name in | |
1224 | .B /dev/md/ | |
1225 | so for example | |
1226 | .BR /dev/md/3 . | |
1227 | If the array uses version-1 metadata, then the | |
1228 | .B name | |
1229 | from the superblock is used to similarly create a name in | |
1230 | .BR /dev/md . | |
1231 | The name will have any 'host' prefix stripped first. | |
1232 | ||
1233 | If | |
1234 | .I mdadm | |
1235 | cannot find any array for the given host at all, and if | |
7e23fc43 | 1236 | .B \-\-auto\-update\-homehost |
41a3b72a NB |
1237 | is given, then |
1238 | .I mdadm | |
1239 | will search again for any array (not just an array created for this | |
1240 | host) and will assemble each assuming | |
7e23fc43 | 1241 | .BR \-\-update=homehost . |
41a3b72a NB |
1242 | This will change the host tag in the superblock so that on the next run, |
1243 | these arrays will be found without the second pass. The intention of | |
1244 | this feature is to support transitioning a set of md arrays to using | |
1245 | homehost tagging. | |
1246 | ||
1247 | The reason for requiring arrays to be tagged with the homehost for | |
1248 | auto assembly is to guard against problems that can arise when moving | |
1249 | devices from one host to another. | |
1250 | ||
cd29a5c8 | 1251 | .SH BUILD MODE |
52826846 | 1252 | |
cd29a5c8 NB |
1253 | .HP 12 |
1254 | Usage: | |
7e23fc43 | 1255 | .B mdadm \-\-build |
cd29a5c8 | 1256 | .I device |
7e23fc43 PS |
1257 | .BI \-\-chunk= X |
1258 | .BI \-\-level= Y | |
1259 | .BI \-\-raid\-devices= Z | |
cd29a5c8 NB |
1260 | .I devices |
1261 | ||
1262 | .PP | |
2ae555c3 | 1263 | This usage is similar to |
7e23fc43 | 1264 | .BR \-\-create . |
a9d69660 | 1265 | The difference is that it creates an array without a superblock. With |
cd29a5c8 | 1266 | these arrays there is no difference between initially creating the array and |
52826846 NB |
1267 | subsequently assembling the array, except that hopefully there is useful |
1268 | data there in the second case. | |
1269 | ||
a9d69660 NB |
1270 | The level may raid0, linear, multipath, or faulty, or one of their |
1271 | synonyms. All devices must be listed and the array will be started | |
1272 | once complete. | |
cd29a5c8 NB |
1273 | |
1274 | .SH CREATE MODE | |
1275 | ||
1276 | .HP 12 | |
1277 | Usage: | |
7e23fc43 | 1278 | .B mdadm \-\-create |
cd29a5c8 | 1279 | .I device |
7e23fc43 PS |
1280 | .BI \-\-chunk= X |
1281 | .BI \-\-level= Y | |
cd29a5c8 | 1282 | .br |
7e23fc43 | 1283 | .BI \-\-raid\-devices= Z |
cd29a5c8 NB |
1284 | .I devices |
1285 | ||
1286 | .PP | |
1287 | This usage will initialise a new md array, associate some devices with | |
1288 | it, and activate the array. | |
1289 | ||
a9d69660 | 1290 | If the |
7e23fc43 | 1291 | .B \-\-auto |
dd0781e5 NB |
1292 | option is given (as described in more detail in the section on |
1293 | Assemble mode), then the md device will be created with a suitable | |
1294 | device number if necessary. | |
1295 | ||
cd29a5c8 | 1296 | As devices are added, they are checked to see if they contain raid |
2d465520 | 1297 | superblocks or filesystems. They are also checked to see if the variance in |
cd29a5c8 NB |
1298 | device size exceeds 1%. |
1299 | ||
1300 | If any discrepancy is found, the array will not automatically be run, though | |
2ae555c3 | 1301 | the presence of a |
7e23fc43 | 1302 | .B \-\-run |
cd29a5c8 NB |
1303 | can override this caution. |
1304 | ||
2d465520 | 1305 | To create a "degraded" array in which some devices are missing, simply |
d013a55e | 1306 | give the word "\fBmissing\fP" |
2d465520 NB |
1307 | in place of a device name. This will cause |
1308 | .B mdadm | |
1309 | to leave the corresponding slot in the array empty. | |
1310 | For a RAID4 or RAID5 array at most one slot can be | |
98c6faba | 1311 | "\fBmissing\fP"; for a RAID6 array at most two slots. |
2d465520 NB |
1312 | For a RAID1 array, only one real device needs to be given. All of the |
1313 | others can be | |
d013a55e | 1314 | "\fBmissing\fP". |
2d465520 | 1315 | |
feb716e9 NB |
1316 | When creating a RAID5 array, |
1317 | .B mdadm | |
1318 | will automatically create a degraded array with an extra spare drive. | |
1319 | This is because building the spare into a degraded array is in general faster than resyncing | |
1320 | the parity on a non-degraded, but not clean, array. This feature can | |
35cc5be4 | 1321 | be overridden with the |
7e23fc43 | 1322 | .B \-\-force |
feb716e9 NB |
1323 | option. |
1324 | ||
41a3b72a NB |
1325 | When creating an array with version-1 metadata a name for the host is |
1326 | required. | |
1327 | If this is not given with the | |
7e23fc43 | 1328 | .B \-\-name |
41a3b72a NB |
1329 | option, |
1330 | .I mdadm | |
1331 | will chose a name based on the last component of the name of the | |
1332 | device being created. So if | |
1333 | .B /dev/md3 | |
1334 | is being created, then the name | |
1335 | .B 3 | |
1336 | will be chosen. | |
1337 | If | |
1338 | .B /dev/md/home | |
1339 | is being created, then the name | |
1340 | .B home | |
1341 | will be used. | |
1342 | ||
3d3dd91e NB |
1343 | A new array will normally get a randomly assigned 128bit UUID which is |
1344 | very likely to be unique. If you have a specific need, you can choose | |
1345 | a UUID for the array by giving the | |
7e23fc43 | 1346 | .B \-\-uuid= |
3d3dd91e NB |
1347 | option. Be warned that creating two arrays with the same UUID is a |
1348 | recipe for disaster. Also, using | |
7e23fc43 | 1349 | .B \-\-uuid= |
3d3dd91e | 1350 | when creating a v0.90 array will silently override any |
7e23fc43 | 1351 | .B \-\-homehost= |
3d3dd91e | 1352 | setting. |
2ae555c3 | 1353 | '''If the |
7e23fc43 | 1354 | '''.B \-\-size |
e0d19036 | 1355 | '''option is given, it is not necessary to list any component-devices in this command. |
cd29a5c8 | 1356 | '''They can be added later, before a |
7e23fc43 | 1357 | '''.B \-\-run. |
2ae555c3 | 1358 | '''If no |
7e23fc43 | 1359 | '''.B \-\-size |
cd29a5c8 NB |
1360 | '''is given, the apparent size of the smallest drive given is used. |
1361 | ||
53e8b987 | 1362 | The General Management options that are valid with |
7e23fc43 | 1363 | .B \-\-create |
53e8b987 | 1364 | are: |
cd29a5c8 | 1365 | .TP |
7e23fc43 | 1366 | .B \-\-run |
dd0781e5 | 1367 | insist on running the array even if some devices look like they might |
cd29a5c8 NB |
1368 | be in use. |
1369 | ||
1370 | .TP | |
7e23fc43 | 1371 | .B \-\-readonly |
b3f1c093 | 1372 | start the array readonly \(em not supported yet. |
52826846 | 1373 | |
2ae555c3 | 1374 | |
e0d19036 | 1375 | .SH MANAGE MODE |
cd29a5c8 NB |
1376 | .HP 12 |
1377 | Usage: | |
e0d19036 NB |
1378 | .B mdadm |
1379 | .I device | |
1380 | .I options... devices... | |
cd29a5c8 NB |
1381 | .PP |
1382 | ||
e0d19036 NB |
1383 | This usage will allow individual devices in an array to be failed, |
1384 | removed or added. It is possible to perform multiple operations with | |
1385 | on command. For example: | |
1386 | .br | |
7e23fc43 | 1387 | .B " mdadm /dev/md0 \-f /dev/hda1 \-r /dev/hda1 \-a /dev/hda1" |
e0d19036 NB |
1388 | .br |
1389 | will firstly mark | |
1390 | .B /dev/hda1 | |
1391 | as faulty in | |
1392 | .B /dev/md0 | |
1393 | and will then remove it from the array and finally add it back | |
2d465520 | 1394 | in as a spare. However only one md array can be affected by a single |
2ae555c3 | 1395 | command. |
e0d19036 NB |
1396 | |
1397 | .SH MISC MODE | |
1398 | .HP 12 | |
1399 | Usage: | |
9a9dab36 | 1400 | .B mdadm |
e0d19036 NB |
1401 | .I options ... |
1402 | .I devices ... | |
1403 | .PP | |
cd29a5c8 | 1404 | |
b5e64645 | 1405 | MISC mode includes a number of distinct operations that |
e0d19036 NB |
1406 | operate on distinct devices. The operations are: |
1407 | .TP | |
7e23fc43 | 1408 | \-\-query |
e0d19036 NB |
1409 | The device is examined to see if it is |
1410 | (1) an active md array, or | |
1411 | (2) a component of an md array. | |
1412 | The information discovered is reported. | |
1413 | ||
1414 | .TP | |
7e23fc43 | 1415 | \-\-detail |
2d465520 NB |
1416 | The device should be an active md device. |
1417 | .B mdadm | |
1418 | will display a detailed description of the array. | |
7e23fc43 | 1419 | .B \-\-brief |
2d465520 | 1420 | or |
7e23fc43 | 1421 | .B \-\-scan |
2d465520 | 1422 | will cause the output to be less detailed and the format to be |
e0d19036 | 1423 | suitable for inclusion in |
9a9dab36 | 1424 | .BR /etc/mdadm.conf . |
feb716e9 NB |
1425 | The exit status of |
1426 | .I mdadm | |
1427 | will normally be 0 unless | |
1428 | .I mdadm | |
1429 | failed to get useful information about the device(s). However if the | |
7e23fc43 | 1430 | .B \-\-test |
feb716e9 NB |
1431 | option is given, then the exit status will be: |
1432 | .RS | |
1433 | .TP | |
1434 | 0 | |
1435 | The array is functioning normally. | |
1436 | .TP | |
1437 | 1 | |
1438 | The array has at least one failed device. | |
1439 | .TP | |
1440 | 2 | |
1441 | The array has multiple failed devices and hence is unusable (raid4 or | |
1442 | raid5). | |
1443 | .TP | |
1444 | 4 | |
1445 | There was an error while trying to get information about the device. | |
1446 | .RE | |
cd29a5c8 | 1447 | |
e0d19036 | 1448 | .TP |
7e23fc43 | 1449 | \-\-examine |
2d465520 NB |
1450 | The device should be a component of an md array. |
1451 | .B mdadm | |
1452 | will read the md superblock of the device and display the contents. | |
e0d19036 | 1453 | If |
7e23fc43 | 1454 | .B \-\-brief |
e0d19036 | 1455 | is given, or |
7e23fc43 | 1456 | .B \-\-scan |
e0d19036 NB |
1457 | then multiple devices that are components of the one array |
1458 | are grouped together and reported in a single entry suitable | |
1459 | for inclusion in | |
1460 | .BR /etc/mdadm.conf . | |
1461 | ||
2d465520 | 1462 | Having |
7e23fc43 | 1463 | .B \-\-scan |
e0d19036 NB |
1464 | without listing any devices will cause all devices listed in the |
1465 | config file to be examined. | |
1466 | ||
1467 | .TP | |
7e23fc43 | 1468 | \-\-stop |
98c6faba NB |
1469 | The devices should be active md arrays which will be deactivated, as |
1470 | long as they are not currently in use. | |
e0d19036 NB |
1471 | |
1472 | .TP | |
7e23fc43 | 1473 | \-\-run |
e0d19036 NB |
1474 | This will fully activate a partially assembled md array. |
1475 | ||
1476 | .TP | |
7e23fc43 | 1477 | \-\-readonly |
e0d19036 NB |
1478 | This will mark an active array as read-only, providing that it is |
1479 | not currently being used. | |
1480 | ||
1481 | .TP | |
7e23fc43 | 1482 | \-\-readwrite |
e0d19036 NB |
1483 | This will change a |
1484 | .B readonly | |
1485 | array back to being read/write. | |
1486 | ||
2d465520 | 1487 | .TP |
7e23fc43 | 1488 | \-\-scan |
2d465520 | 1489 | For all operations except |
7e23fc43 PS |
1490 | .BR \-\-examine , |
1491 | .B \-\-scan | |
2d465520 NB |
1492 | will cause the operation to be applied to all arrays listed in |
1493 | .BR /proc/mdstat . | |
1494 | For | |
7e23fc43 PS |
1495 | .BR \-\-examine, |
1496 | .B \-\-scan | |
2d465520 NB |
1497 | causes all devices listed in the config file to be examined. |
1498 | ||
1499 | ||
e0d19036 NB |
1500 | .SH MONITOR MODE |
1501 | ||
cd29a5c8 NB |
1502 | .HP 12 |
1503 | Usage: | |
7e23fc43 | 1504 | .B mdadm \-\-monitor |
e0d19036 NB |
1505 | .I options... devices... |
1506 | ||
cd29a5c8 | 1507 | .PP |
e0d19036 NB |
1508 | This usage causes |
1509 | .B mdadm | |
1510 | to periodically poll a number of md arrays and to report on any events | |
1511 | noticed. | |
1512 | .B mdadm | |
1513 | will never exit once it decides that there are arrays to be checked, | |
1514 | so it should normally be run in the background. | |
1515 | ||
2d465520 NB |
1516 | As well as reporting events, |
1517 | .B mdadm | |
1518 | may move a spare drive from one array to another if they are in the | |
1519 | same | |
1520 | .B spare-group | |
a9d69660 | 1521 | and if the destination array has a failed drive but no spares. |
2d465520 | 1522 | |
e0d19036 NB |
1523 | If any devices are listed on the command line, |
1524 | .B mdadm | |
1525 | will only monitor those devices. Otherwise all arrays listed in the | |
1526 | configuration file will be monitored. Further, if | |
7e23fc43 | 1527 | .B \-\-scan |
e0d19036 NB |
1528 | is given, then any other md devices that appear in |
1529 | .B /proc/mdstat | |
1530 | will also be monitored. | |
1531 | ||
1532 | The result of monitoring the arrays is the generation of events. | |
bd526cee | 1533 | These events are passed to a separate program (if specified) and may |
2d465520 | 1534 | be mailed to a given E-mail address. |
e0d19036 | 1535 | |
bd526cee | 1536 | When passing event to program, the program is run once for each event |
2ae555c3 | 1537 | and is given 2 or 3 command-line arguments. The first is the |
bd526cee NB |
1538 | name of the event (see below). The second is the name of the |
1539 | md device which is affected, and the third is the name of a related | |
1540 | device if relevant, such as a component device that has failed. | |
cd29a5c8 NB |
1541 | |
1542 | If | |
7e23fc43 | 1543 | .B \-\-scan |
e0d19036 NB |
1544 | is given, then a program or an E-mail address must be specified on the |
1545 | command line or in the config file. If neither are available, then | |
1546 | .B mdadm | |
1547 | will not monitor anything. | |
1548 | Without | |
7e23fc43 | 1549 | .B \-\-scan |
e0d19036 | 1550 | .B mdadm |
2d465520 | 1551 | will continue monitoring as long as something was found to monitor. If |
e0d19036 NB |
1552 | no program or email is given, then each event is reported to |
1553 | .BR stdout . | |
cd29a5c8 | 1554 | |
e0d19036 NB |
1555 | The different events are: |
1556 | ||
1557 | .RS 4 | |
1558 | .TP | |
1559 | .B DeviceDisappeared | |
2d465520 | 1560 | An md array which previously was configured appears to no longer be |
773135f5 | 1561 | configured. (syslog priority: Critical) |
e0d19036 | 1562 | |
b8f72a62 NB |
1563 | If |
1564 | .I mdadm | |
1565 | was told to monitor an array which is RAID0 or Linear, then it will | |
1566 | report | |
1567 | .B DeviceDisappeared | |
1568 | with the extra information | |
1569 | .BR Wrong-Level . | |
1570 | This is because RAID0 and Linear do not support the device-failed, | |
1571 | hot-spare and resync operations which are monitored. | |
1572 | ||
e0d19036 NB |
1573 | .TP |
1574 | .B RebuildStarted | |
773135f5 | 1575 | An md array started reconstruction. (syslog priority: Warning) |
e0d19036 NB |
1576 | |
1577 | .TP | |
1578 | .BI Rebuild NN | |
1579 | Where | |
1580 | .I NN | |
1581 | is 20, 40, 60, or 80, this indicates that rebuild has passed that many | |
773135f5 | 1582 | percentage of the total. (syslog priority: Warning) |
e0d19036 | 1583 | |
98c6faba NB |
1584 | .TP |
1585 | .B RebuildFinished | |
1586 | An md array that was rebuilding, isn't any more, either because it | |
773135f5 | 1587 | finished normally or was aborted. (syslog priority: Warning) |
98c6faba | 1588 | |
e0d19036 NB |
1589 | .TP |
1590 | .B Fail | |
773135f5 NB |
1591 | An active component device of an array has been marked as |
1592 | faulty. (syslog priority: Critical) | |
e0d19036 NB |
1593 | |
1594 | .TP | |
1595 | .B FailSpare | |
1596 | A spare component device which was being rebuilt to replace a faulty | |
773135f5 | 1597 | device has failed. (syslog priority: Critial) |
e0d19036 NB |
1598 | |
1599 | .TP | |
1600 | .B SpareActive | |
1601 | A spare component device which was being rebuilt to replace a faulty | |
98b24a2a | 1602 | device has been successfully rebuilt and has been made active. |
773135f5 | 1603 | (syslog priority: Info) |
e0d19036 NB |
1604 | |
1605 | .TP | |
1606 | .B NewArray | |
1607 | A new md array has been detected in the | |
1608 | .B /proc/mdstat | |
773135f5 | 1609 | file. (syslog priority: Info) |
e0d19036 | 1610 | |
aa88f531 NB |
1611 | .TP |
1612 | .B DegradedArray | |
1613 | A newly noticed array appears to be degraded. This message is not | |
1614 | generated when | |
1615 | .I mdadm | |
1616 | notices a drive failure which causes degradation, but only when | |
1617 | .I mdadm | |
1618 | notices that an array is degraded when it first sees the array. | |
773135f5 | 1619 | (syslog priority: Critial) |
aa88f531 | 1620 | |
e0d19036 NB |
1621 | .TP |
1622 | .B MoveSpare | |
1623 | A spare drive has been moved from one array in a | |
1624 | .B spare-group | |
1625 | to another to allow a failed drive to be replaced. | |
773135f5 | 1626 | (syslog priority: Info) |
e0d19036 | 1627 | |
b8f72a62 NB |
1628 | .TP |
1629 | .B SparesMissing | |
1630 | If | |
1631 | .I mdadm | |
1632 | has been told, via the config file, that an array should have a certain | |
1633 | number of spare devices, and | |
1634 | .I mdadm | |
1635 | detects that it has fewer that this number when it first sees the | |
1636 | array, it will report a | |
1637 | .B SparesMissing | |
1638 | message. | |
d1732eeb | 1639 | (syslog priority: Warning) |
b8f72a62 | 1640 | |
98c6faba NB |
1641 | .TP |
1642 | .B TestMessage | |
1643 | An array was found at startup, and the | |
7e23fc43 | 1644 | .B \-\-test |
98c6faba | 1645 | flag was given. |
773135f5 | 1646 | (syslog priority: Info) |
e0d19036 NB |
1647 | .RE |
1648 | ||
1649 | Only | |
98c6faba NB |
1650 | .B Fail , |
1651 | .B FailSpare , | |
1652 | .B DegradedArray , | |
d1732eeb | 1653 | .B SparesMissing , |
e0d19036 | 1654 | and |
98c6faba | 1655 | .B TestMessage |
e0d19036 NB |
1656 | cause Email to be sent. All events cause the program to be run. |
1657 | The program is run with two or three arguments, they being the event | |
1658 | name, the array device and possibly a second device. | |
1659 | ||
1660 | Each event has an associated array device (e.g. | |
1661 | .BR /dev/md1 ) | |
1662 | and possibly a second device. For | |
1663 | .BR Fail , | |
1664 | .BR FailSpare , | |
1665 | and | |
1666 | .B SpareActive | |
1667 | the second device is the relevant component device. | |
1668 | For | |
1669 | .B MoveSpare | |
1670 | the second device is the array that the spare was moved from. | |
1671 | ||
1672 | For | |
1673 | .B mdadm | |
1674 | to move spares from one array to another, the different arrays need to | |
1675 | be labelled with the same | |
1676 | .B spare-group | |
1677 | in the configuration file. The | |
1678 | .B spare-group | |
1679 | name can be any string. It is only necessary that different spare | |
2d465520 | 1680 | groups use different names. |
e0d19036 NB |
1681 | |
1682 | When | |
9a9dab36 | 1683 | .B mdadm |
e0d19036 NB |
1684 | detects that an array which is in a spare group has fewer active |
1685 | devices than necessary for the complete array, and has no spare | |
1686 | devices, it will look for another array in the same spare group that | |
1687 | has a full complement of working drive and a spare. It will then | |
1688 | attempt to remove the spare from the second drive and add it to the | |
1689 | first. | |
1690 | If the removal succeeds but the adding fails, then it is added back to | |
1691 | the original array. | |
1692 | ||
dd0781e5 NB |
1693 | .SH GROW MODE |
1694 | The GROW mode is used for changing the size or shape of an active | |
1695 | array. | |
1696 | For this to work, the kernel must support the necessary change. | |
2ae555c3 | 1697 | Various types of growth are being added during 2.6 development, |
dd0781e5 NB |
1698 | including restructuring a raid5 array to have more active devices. |
1699 | ||
dfd4d8ee NB |
1700 | Currently the only support available is to |
1701 | .IP \(bu 4 | |
1702 | change the "size" attribute | |
1703 | for RAID1, RAID5 and RAID6. | |
1704 | .IP \(bu 4 | |
00be0b12 | 1705 | increase the "raid-disks" attribute of RAID1, RAID5, and RAID6. |
dfd4d8ee | 1706 | .IP \(bu 4 |
2ae555c3 NB |
1707 | add a write-intent bitmap to any array which support these bitmaps, or |
1708 | remove a write-intent bitmap from such an array. | |
dfd4d8ee | 1709 | .PP |
dd0781e5 | 1710 | |
2ae555c3 | 1711 | .SS SIZE CHANGES |
fe80f49b | 1712 | Normally when an array is built the "size" it taken from the smallest |
dd0781e5 NB |
1713 | of the drives. If all the small drives in an arrays are, one at a |
1714 | time, removed and replaced with larger drives, then you could have an | |
1715 | array of large drives with only a small amount used. In this | |
1716 | situation, changing the "size" with "GROW" mode will allow the extra | |
1717 | space to start being used. If the size is increased in this way, a | |
1718 | "resync" process will start to make sure the new parts of the array | |
1719 | are synchronised. | |
1720 | ||
1721 | Note that when an array changes size, any filesystem that may be | |
1722 | stored in the array will not automatically grow to use the space. The | |
1723 | filesystem will need to be explicitly told to use the extra space. | |
1724 | ||
2ae555c3 NB |
1725 | .SS RAID-DEVICES CHANGES |
1726 | ||
dd0781e5 NB |
1727 | A RAID1 array can work with any number of devices from 1 upwards |
1728 | (though 1 is not very useful). There may be times which you want to | |
1729 | increase or decrease the number of active devices. Note that this is | |
1730 | different to hot-add or hot-remove which changes the number of | |
1731 | inactive devices. | |
1732 | ||
1733 | When reducing the number of devices in a RAID1 array, the slots which | |
1734 | are to be removed from the array must already be vacant. That is, the | |
1735 | devices that which were in those slots must be failed and removed. | |
1736 | ||
1737 | When the number of devices is increased, any hot spares that are | |
a9d69660 | 1738 | present will be activated immediately. |
dd0781e5 | 1739 | |
2ae555c3 NB |
1740 | Increasing the number of active devices in a RAID5 is much more |
1741 | effort. Every block in the array will need to be read and written | |
1742 | back to a new location. From 2.6.17, the Linux Kernel is able to do | |
1743 | this safely, including restart and interrupted "reshape". | |
1744 | ||
1745 | When relocating the first few stripes on a raid5, it is not possible | |
1746 | to keep the data on disk completely consistent and crash-proof. To | |
1747 | provide the required safety, mdadm disables writes to the array while | |
1748 | this "critical section" is reshaped, and takes a backup of the data | |
1749 | that is in that section. This backup is normally stored in any spare | |
1750 | devices that the array has, however it can also be stored in a | |
1751 | separate file specified with the | |
7e23fc43 | 1752 | .B \-\-backup\-file |
2ae555c3 NB |
1753 | option. If this option is used, and the system does crash during the |
1754 | critical period, the same file must be passed to | |
7e23fc43 | 1755 | .B \-\-assemble |
2ae555c3 NB |
1756 | to restore the backup and reassemble the array. |
1757 | ||
1758 | .SS BITMAP CHANGES | |
1759 | ||
1760 | A write-intent bitmap can be added to, or removed from, an active | |
1761 | array. Either internal bitmaps, or bitmaps stored in a separate file | |
fe80f49b NB |
1762 | can be added. Note that if you add a bitmap stored in a file which is |
1763 | in a filesystem that is on the raid array being affected, the system | |
1764 | will deadlock. The bitmap must be on a separate filesystem. | |
1765 | ||
8382f19b NB |
1766 | .SH INCREMENTAL MODE |
1767 | ||
1768 | .HP 12 | |
1769 | Usage: | |
7e23fc43 PS |
1770 | .B mdadm \-\-incremental |
1771 | .RB [ \-\-run ] | |
1772 | .RB [ \-\-quiet ] | |
8382f19b NB |
1773 | .I component-device |
1774 | .HP 12 | |
1775 | Usage: | |
7e23fc43 | 1776 | .B mdadm \-\-incremental \-\-rebuild |
8382f19b NB |
1777 | .HP 12 |
1778 | Usage: | |
7e23fc43 | 1779 | .B mdadm \-\-incremental \-\-run \-\-scan |
8382f19b NB |
1780 | |
1781 | ||
1782 | .PP | |
1783 | This mode is designed to be used in conjunction with a device | |
1784 | discovery system. As devices are found in a system, they can be | |
1785 | passed to | |
7e23fc43 | 1786 | .B "mdadm \-\-incremental" |
8382f19b NB |
1787 | to be conditionally added to an appropriate array. |
1788 | ||
1789 | .I mdadm | |
1790 | performs a number of tests to determine if the device is part of an | |
1791 | array, and which array is should be part of. If an appropriate array | |
1792 | is found, or can be created, | |
1793 | .I mdadm | |
1794 | adds the device to the array and conditionally starts the array. | |
1795 | ||
1796 | Note that | |
1797 | .I mdadm | |
1798 | will only add devices to an array which were previously working | |
1799 | (active or spare) parts of that array. It does not currently support | |
1800 | automatic inclusion of a new drive as a spare in some array. | |
1801 | ||
7e23fc43 | 1802 | .B "mdadm \-\-incremental" |
8382f19b NB |
1803 | requires a bug present in all kernels through 2.6.19, to be fixed. |
1804 | Hopefully this will be fixed in 2.6.20. Alternately apply the patch | |
1805 | which is included with the mdadm source distribution. If | |
1806 | .I mdadm | |
1807 | detects that this bug is present, it will abort any attempt to use | |
7e23fc43 | 1808 | .BR \-\-incremental . |
8382f19b NB |
1809 | |
1810 | The tests that | |
1811 | .I mdadm | |
1812 | makes are as follow: | |
1813 | .IP + | |
1814 | Is the device permitted by | |
1815 | .BR mdadm.conf ? | |
1816 | That is, is it listed in a | |
1817 | .B DEVICES | |
1818 | line in that file. If | |
1819 | .B DEVICES | |
1820 | is absent then the default it to allow any device. Similar if | |
1821 | .B DEVICES | |
1822 | contains the special word | |
1823 | .B partitions | |
1824 | then any device is allowed. Otherwise the device name given to | |
1825 | .I mdadm | |
1826 | must match one of the names or patterns in a | |
1827 | .B DEVICES | |
1828 | line. | |
1829 | ||
1830 | .IP + | |
1831 | Does the device have a valid md superblock. If a specific metadata | |
1832 | version is request with | |
7e23fc43 | 1833 | .B \-\-metadata |
8382f19b | 1834 | or |
7e23fc43 | 1835 | .B \-e |
8382f19b NB |
1836 | then only that style of metadata is accepted, otherwise |
1837 | .I mdadm | |
1838 | finds any known version of metadata. If no | |
1839 | .I md | |
1840 | metadata is found, the device is rejected. | |
1841 | ||
1842 | .IP + | |
1843 | Does the metadata match an expected array? | |
1844 | The metadata can match in two ways. Either there is an array listed | |
1845 | in | |
1846 | .B mdadm.conf | |
1847 | which identifies the array (either by UUID, by name, by device list, | |
1848 | or by minor-number), the array was created with a | |
1849 | .B homehost | |
1850 | specified, and that | |
1851 | .B homehost | |
1852 | matches that which is given in | |
1853 | .B mdadm.conf | |
1854 | or on the command line. | |
1855 | If | |
1856 | .I mdadm | |
1857 | is not able to positively identify the array as belonging to the | |
1858 | current host, the device will be rejected. | |
1859 | ||
1860 | .IP + | |
1861 | .I mdadm | |
1862 | keeps a list of arrays that is has partly assembled in | |
1863 | .B /var/run/mdadm/map | |
1864 | (or | |
1865 | .B /var/run/mdadm.map | |
1866 | if the directory doesn't exist). If no array exists which matches | |
1867 | the metadata on the new device, | |
1868 | .I mdadm | |
1869 | must choose a device name and unit number. It does this based on any | |
1870 | name given in | |
1871 | .B mdadm.conf | |
1872 | or any name information stored in the metadata. If this name | |
1873 | suggests a unit number, that number will be used, otherwise a free | |
1874 | unit number will be chosen. Normally | |
1875 | .I mdadm | |
1876 | will prefer to create a partitionable array, however if the | |
1877 | .B CREATE | |
1878 | line in | |
1879 | .B mdadm.conf | |
1880 | suggests that a non-partitionable array is preferred, that will be | |
1881 | honoured. | |
1882 | ||
1883 | .IP + | |
1884 | Once an appropriate array is found or created and the device is added, | |
1885 | .I mdadm | |
1886 | must decide if the array is ready to be started. It will | |
1887 | normally compare the number of available (non-spare) devices to the | |
1888 | number of devices that the metadata suggests need to be active. If | |
1889 | there are at least that many, the array will be started. This means | |
1890 | that if any devices are missing the array will not be restarted. | |
1891 | ||
1892 | As an alternative, | |
7e23fc43 | 1893 | .B \-\-run |
8382f19b NB |
1894 | may be passed to |
1895 | .B mdadm | |
1896 | in which case the array will be run as soon as there are enough | |
1897 | devices present for the data to be accessible. For a raid1, that | |
1898 | means one device will start the array. For a clean raid5, the array | |
1899 | will be started as soon as all but one drive is present. | |
1900 | ||
1901 | Note that neither of these approaches is really ideal. If it is can | |
1902 | be known that all device discovery has completed, then | |
1903 | .br | |
7e23fc43 | 1904 | .B " mdadm \-IRs" |
8382f19b NB |
1905 | .br |
1906 | can be run which will try to start all arrays that are being | |
1907 | incrementally assembled. They are started in "read-auto" mode in | |
1908 | which they are read-only until the first write request. This means | |
1909 | that no metadata updates are made and no attempt at resync or recovery | |
1910 | happens. Further devices that are found before the first write can | |
1911 | still be added safely. | |
1912 | ||
2d465520 NB |
1913 | .SH EXAMPLES |
1914 | ||
7e23fc43 | 1915 | .B " mdadm \-\-query /dev/name-of-device" |
2d465520 | 1916 | .br |
5787fa49 NB |
1917 | This will find out if a given device is a raid array, or is part of |
1918 | one, and will provide brief information about the device. | |
2d465520 | 1919 | |
7e23fc43 | 1920 | .B " mdadm \-\-assemble \-\-scan" |
2d465520 | 1921 | .br |
2ae555c3 | 1922 | This will assemble and start all arrays listed in the standard config file |
5787fa49 | 1923 | file. This command will typically go in a system startup file. |
2d465520 | 1924 | |
7e23fc43 | 1925 | .B " mdadm \-\-stop \-\-scan" |
5787fa49 NB |
1926 | .br |
1927 | This will shut down all array that can be shut down (i.e. are not | |
19f8b8fc | 1928 | currently in use). This will typically go in a system shutdown script. |
2d465520 | 1929 | |
7e23fc43 | 1930 | .B " mdadm \-\-follow \-\-scan \-\-delay=120" |
2d465520 | 1931 | .br |
5787fa49 NB |
1932 | If (and only if) there is an Email address or program given in the |
1933 | standard config file, then | |
1934 | monitor the status of all arrays listed in that file by | |
1935 | polling them ever 2 minutes. | |
2d465520 | 1936 | |
7e23fc43 | 1937 | .B " mdadm \-\-create /dev/md0 \-\-level=1 \-\-raid\-devices=2 /dev/hd[ac]1" |
2d465520 | 1938 | .br |
5787fa49 | 1939 | Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1. |
2d465520 | 1940 | |
2d465520 | 1941 | .br |
7e23fc43 | 1942 | .B " echo 'DEVICE /dev/hd*[0\-9] /dev/sd*[0\-9]' > mdadm.conf" |
2d465520 | 1943 | .br |
7e23fc43 | 1944 | .B " mdadm \-\-detail \-\-scan >> mdadm.conf" |
2d465520 | 1945 | .br |
5787fa49 NB |
1946 | This will create a prototype config file that describes currently |
1947 | active arrays that are known to be made from partitions of IDE or SCSI drives. | |
2d465520 NB |
1948 | This file should be reviewed before being used as it may |
1949 | contain unwanted detail. | |
1950 | ||
7e23fc43 | 1951 | .B " echo 'DEVICE /dev/hd[a\-z] /dev/sd*[a\-z]' > mdadm.conf" |
2d465520 | 1952 | .br |
7e23fc43 | 1953 | .B " mdadm \-\-examine \-\-scan \-\-config=mdadm.conf >> mdadm.conf" |
5787fa49 | 1954 | .ber |
2ae555c3 | 1955 | This will find what arrays could be assembled from existing IDE and |
5787fa49 NB |
1956 | SCSI whole drives (not partitions) and store the information is the |
1957 | format of a config file. | |
2d465520 NB |
1958 | This file is very likely to contain unwanted detail, particularly |
1959 | the | |
1960 | .B devices= | |
5787fa49 NB |
1961 | entries. It should be reviewed and edited before being used as an |
1962 | actual config file. | |
2d465520 | 1963 | |
7e23fc43 | 1964 | .B " mdadm \-\-examine \-\-brief \-\-scan \-\-config=partitions" |
2d465520 | 1965 | .br |
7e23fc43 | 1966 | .B " mdadm \-Ebsc partitions" |
5787fa49 NB |
1967 | .br |
1968 | Create a list of devices by reading | |
1969 | .BR /proc/partitions , | |
1970 | scan these for RAID superblocks, and printout a brief listing of all | |
1971 | that was found. | |
2d465520 | 1972 | |
7e23fc43 | 1973 | .B " mdadm \-Ac partitions \-m 0 /dev/md0" |
2d465520 | 1974 | .br |
5787fa49 NB |
1975 | Scan all partitions and devices listed in |
1976 | .BR /proc/partitions | |
1977 | and assemble | |
1978 | .B /dev/md0 | |
1979 | out of all such devices with a RAID superblock with a minor number of 0. | |
2d465520 | 1980 | |
7e23fc43 | 1981 | .B " mdadm \-\-monitor \-\-scan \-\-daemonise > /var/run/mdadm" |
d013a55e NB |
1982 | .br |
1983 | If config file contains a mail address or alert program, run mdadm in | |
1984 | the background in monitor mode monitoring all md devices. Also write | |
1985 | pid of mdadm daemon to | |
1986 | .BR /var/run/mdadm . | |
1987 | ||
7e23fc43 | 1988 | .B " mdadm \-Iq /dev/somedevice" |
8382f19b NB |
1989 | .br |
1990 | Try to incorporate newly discovered device into some array as | |
1991 | appropriate. | |
1992 | ||
7e23fc43 | 1993 | .B " mdadm \-\-incremental \-\-rebuild \-\-run \-\-scan" |
8382f19b NB |
1994 | .br |
1995 | Rebuild the array map from any current arrays, and then start any that | |
1996 | can be started. | |
1997 | ||
b80da661 NB |
1998 | .B " mdadm /dev/md4 --fail detached --remove detached" |
1999 | .br | |
2000 | Any devices which are components of /dev/md4 will be marked as faulty | |
2001 | and then remove from the array. | |
2002 | ||
7e23fc43 | 2003 | .B " mdadm \-\-create \-\-help" |
2d465520 | 2004 | .br |
2ae555c3 | 2005 | Provide help about the Create mode. |
2d465520 | 2006 | |
7e23fc43 | 2007 | .B " mdadm \-\-config \-\-help" |
5787fa49 NB |
2008 | .br |
2009 | Provide help about the format of the config file. | |
2d465520 | 2010 | |
7e23fc43 | 2011 | .B " mdadm \-\-help" |
5787fa49 NB |
2012 | .br |
2013 | Provide general help. | |
cd29a5c8 | 2014 | |
cd29a5c8 NB |
2015 | |
2016 | .SH FILES | |
2017 | ||
2018 | .SS /proc/mdstat | |
2019 | ||
2ae555c3 NB |
2020 | If you're using the |
2021 | .B /proc | |
cd29a5c8 NB |
2022 | filesystem, |
2023 | .B /proc/mdstat | |
2d465520 NB |
2024 | lists all active md devices with information about them. |
2025 | .B mdadm | |
2026 | uses this to find arrays when | |
7e23fc43 | 2027 | .B \-\-scan |
2d465520 NB |
2028 | is given in Misc mode, and to monitor array reconstruction |
2029 | on Monitor mode. | |
2030 | ||
cd29a5c8 | 2031 | |
9a9dab36 | 2032 | .SS /etc/mdadm.conf |
cd29a5c8 | 2033 | |
11a3e71d NB |
2034 | The config file lists which devices may be scanned to see if |
2035 | they contain MD super block, and gives identifying information | |
2036 | (e.g. UUID) about known MD arrays. See | |
2037 | .BR mdadm.conf (5) | |
2038 | for more details. | |
cd29a5c8 | 2039 | |
8382f19b NB |
2040 | .SS /var/run/mdadm/map |
2041 | When | |
7e23fc43 | 2042 | .B \-\-incremental |
8382f19b NB |
2043 | mode is used. this file gets a list of arrays currently being created. |
2044 | If | |
2045 | .B /var/run/mdadm | |
2046 | does not exist as a directory, then | |
2047 | .B /var/run/mdadm.map | |
2048 | is used instead. | |
2049 | ||
48f7b27a NB |
2050 | .SH DEVICE NAMES |
2051 | ||
2052 | While entries in the /dev directory can have any format you like, | |
2053 | .I mdadm | |
2054 | has an understanding of 'standard' formats which it uses to guide its | |
2055 | behaviour when creating device files via the | |
7e23fc43 | 2056 | .B \-\-auto |
48f7b27a NB |
2057 | option. |
2058 | ||
2059 | The standard names for non-partitioned arrays (the only sort of md | |
2060 | array available in 2.4 and earlier) either of | |
2061 | .IP | |
2062 | /dev/mdNN | |
2063 | .br | |
2064 | /dev/md/NN | |
2065 | .PP | |
2066 | where NN is a number. | |
2067 | The standard names for partitionable arrays (as available from 2.6 | |
2068 | onwards) is one of | |
2069 | .IP | |
2070 | /dev/md/dNN | |
2071 | .br | |
2072 | /dev/md_dNN | |
2073 | .PP | |
2074 | Partition numbers should be indicated by added "pMM" to these, thus "/dev/md/d1p2". | |
52826846 | 2075 | |
2d465520 NB |
2076 | .SH NOTE |
2077 | .B mdadm | |
2078 | was previously known as | |
2079 | .BR mdctl . | |
a9d69660 NB |
2080 | .P |
2081 | .B mdadm | |
2082 | is completely separate from the | |
2083 | .B raidtools | |
2084 | package, and does not use the | |
2085 | .I /etc/raidtab | |
2086 | configuration file at all. | |
2087 | ||
52826846 | 2088 | .SH SEE ALSO |
cd29a5c8 NB |
2089 | For information on the various levels of |
2090 | RAID, check out: | |
2091 | ||
2092 | .IP | |
7e23fc43 PS |
2093 | .UR http://ostenfeld.dk/~jakob/Software\-RAID.HOWTO/ |
2094 | http://ostenfeld.dk/~jakob/Software\-RAID.HOWTO/ | |
cd29a5c8 | 2095 | .UE |
a9d69660 NB |
2096 | '''.PP |
2097 | '''for new releases of the RAID driver check out: | |
2098 | ''' | |
2099 | '''.IP | |
2100 | '''.UR ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches | |
2101 | '''ftp://ftp.kernel.org/pub/linux/kernel/people/mingo/raid-patches | |
2102 | '''.UE | |
2103 | '''.PP | |
2104 | '''or | |
2105 | '''.IP | |
2106 | '''.UR http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/ | |
2107 | '''http://www.cse.unsw.edu.au/~neilb/patches/linux-stable/ | |
2108 | '''.UE | |
cd29a5c8 | 2109 | .PP |
2ae555c3 | 2110 | The latest version of |
a9d69660 NB |
2111 | .I mdadm |
2112 | should always be available from | |
cd29a5c8 | 2113 | .IP |
a9d69660 NB |
2114 | .UR http://www.kernel.org/pub/linux/utils/raid/mdadm/ |
2115 | http://www.kernel.org/pub/linux/utils/raid/mdadm/ | |
cd29a5c8 NB |
2116 | .UE |
2117 | .PP | |
a9d69660 NB |
2118 | .IR mdadm.conf (5), |
2119 | .IR md (4). | |
56eb10c0 | 2120 | .PP |
52826846 NB |
2121 | .IR raidtab (5), |
2122 | .IR raid0run (8), | |
2123 | .IR raidstop (8), | |
a9d69660 | 2124 | .IR mkraid (8). |