]>
Commit | Line | Data |
---|---|---|
773135f5 | 1 | |
64c4757e | 2 | /* |
9a9dab36 | 3 | * mdadm - manage Linux "md" devices aka RAID arrays. |
64c4757e | 4 | * |
a92f6acc | 5 | * Copyright (C) 2001-2006 Neil Brown <neilb@cse.unsw.edu.au> |
64c4757e NB |
6 | * |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program; if not, write to the Free Software | |
20 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 | * | |
22 | * Author: Neil Brown | |
23 | * Email: <neilb@cse.unsw.edu.au> | |
24 | * Paper: Neil Brown | |
25 | * School of Computer Science and Engineering | |
26 | * The University of New South Wales | |
27 | * Sydney, 2052 | |
28 | * Australia | |
29 | */ | |
30 | ||
9a9dab36 | 31 | #include "mdadm.h" |
64c4757e | 32 | |
39c5a909 | 33 | char Version[] = Name " - v2.4-pre1 - Not For Production Use - 20 March 2006\n"; |
4b1ac34b | 34 | |
64c4757e NB |
35 | /* |
36 | * File: ReadMe.c | |
37 | * | |
38 | * This file contains general comments about the implementation | |
9a9dab36 | 39 | * and the various usage messages that can be displayed by mdadm |
64c4757e | 40 | * |
9a9dab36 | 41 | * mdadm is a single program that can be used to control Linux md devices. |
64c4757e NB |
42 | * It is intended to provide all the functionality of the mdtools and |
43 | * raidtools but with a very different interface. | |
9a9dab36 | 44 | * mdadm can perform all functions without a configuration file. |
64c4757e NB |
45 | * There is the option of using a configuration file, but not in the same |
46 | * way that raidtools uses one | |
47 | * raidtools uses a configuration file to describe how to create a RAID | |
48 | * array, and also uses this file partially to start a previously | |
49 | * created RAID array. Further, raidtools requires the configuration | |
50 | * file for such things as stopping a raid array which needs to know | |
51 | * nothing about the array. | |
52 | * | |
9a9dab36 | 53 | * The configuration file that can be used by mdadm lists two |
64c4757e NB |
54 | * different things: |
55 | * 1/ a mapping from uuid to md device to identify which arrays are | |
56 | * expect and what names (numbers) they should be given | |
57 | * 2/ a list of devices that should be scanned for md sub-devices | |
58 | * | |
59 | * | |
60 | */ | |
61 | ||
62 | /* | |
dd0781e5 | 63 | * mdadm has 7 major modes of operation: |
64c4757e | 64 | * 1/ Create |
5787fa49 | 65 | * This mode is used to create a new array with a superblock |
64c4757e NB |
66 | * It can progress in several step create-add-add-run |
67 | * or it can all happen with one command | |
68 | * 2/ Assemble | |
69 | * This mode is used to assemble the parts of a previously created | |
70 | * array into an active array. Components can be explicitly given | |
9a9dab36 | 71 | * or can be searched for. mdadm (optionally) check that the components |
5787fa49 | 72 | * do form a bona-fide array, and can, on request, fiddle superblock |
64c4757e NB |
73 | * version numbers so as to assemble a faulty array. |
74 | * 3/ Build | |
75 | * This is for building legacy arrays without superblocks | |
76 | * 4/ Manage | |
e0d19036 NB |
77 | * This is for doing something to one or more devices |
78 | * in an array, such as add,remove,fail. | |
79 | * run/stop/readonly/readwrite are also available | |
80 | * 5/ Misc | |
81 | * This is for doing things to individual devices. | |
82 | * They might be parts of an array so | |
83 | * zero-superblock, examine might be appropriate | |
84 | * They might be md arrays so | |
85 | * run,stop,rw,ro,detail might be appropriate | |
86 | * Also query will treat it as either | |
87 | * 6/ Monitor | |
88 | * This mode never exits but just monitors arrays and reports changes. | |
dd0781e5 NB |
89 | * 7/ Grow |
90 | * This mode allows for changing of key attributes of a raid array, such | |
91 | * as size, number of devices, and possibly even layout. | |
92 | * At the time if writing, there is only minimal support. | |
64c4757e NB |
93 | */ |
94 | ||
773135f5 NB |
95 | char short_options[]="-ABCDEFGQhVXvqbc:i:l:p:m:n:x:u:c:d:z:U:sarfRSow1tye:"; |
96 | char short_bitmap_auto_options[]="-ABCDEFGQhVXvqb:c:i:l:p:m:n:x:u:c:d:z:U:sa:rfRSow1tye:"; | |
97 | ||
64c4757e NB |
98 | struct option long_options[] = { |
99 | {"manage", 0, 0, '@'}, | |
e0d19036 | 100 | {"misc", 0, 0, '#'}, |
64c4757e NB |
101 | {"assemble", 0, 0, 'A'}, |
102 | {"build", 0, 0, 'B'}, | |
103 | {"create", 0, 0, 'C'}, | |
104 | {"detail", 0, 0, 'D'}, | |
105 | {"examine", 0, 0, 'E'}, | |
52826846 | 106 | {"follow", 0, 0, 'F'}, |
dd0781e5 | 107 | {"grow", 0, 0, 'G'}, |
e0d19036 NB |
108 | {"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */ |
109 | {"query", 0, 0, 'Q'}, | |
c82f047c | 110 | {"examine-bitmap", 0, 0, 'X'}, |
52826846 NB |
111 | |
112 | /* synonyms */ | |
113 | {"monitor", 0, 0, 'F'}, | |
114 | ||
64c4757e NB |
115 | /* after those will normally come the name of the md device */ |
116 | {"help", 0, 0, 'h'}, | |
56eedc1a | 117 | {"help-options",0,0,'h'}, |
64c4757e NB |
118 | {"version", 0, 0, 'V'}, |
119 | {"verbose", 0, 0, 'v'}, | |
dab6685f | 120 | {"quiet", 0, 0, 'q'}, |
64c4757e NB |
121 | |
122 | /* For create or build: */ | |
123 | {"chunk", 1, 0, 'c'}, | |
124 | {"rounding", 1, 0, 'c'}, /* for linear, chunk is really a rounding number */ | |
98c6faba | 125 | {"level", 1, 0, 'l'}, /* 0,1,4,5,6,linear */ |
5787fa49 | 126 | {"parity", 1, 0, 'p'}, /* {left,right}-{a,}symmetric */ |
64c4757e NB |
127 | {"layout", 1, 0, 'p'}, |
128 | {"raid-disks",1, 0, 'n'}, | |
b83d95f3 | 129 | {"raid-devices",1, 0, 'n'}, |
64c4757e | 130 | {"spare-disks",1,0, 'x'}, |
b83d95f3 | 131 | {"spare-devices",1,0, 'x'}, |
dd0781e5 | 132 | {"size", 1, 0, 'z'}, |
c82f047c | 133 | {"auto", 1, 0, 'a'}, /* also for --assemble */ |
dd0781e5 | 134 | {"assume-clean",0,0, 3 }, |
f9ce90ba | 135 | {"metadata", 1, 0, 'e'}, /* superblock format */ |
c82f047c NB |
136 | {"bitmap", 1, 0, 'b'}, |
137 | {"bitmap-chunk", 1, 0, 4}, | |
dfd4d8ee NB |
138 | {"write-behind", 2, 0, 5}, |
139 | {"write-mostly",0, 0, 'W'}, | |
fe80f49b | 140 | {"re-add", 0, 0, 6}, |
64c4757e NB |
141 | |
142 | /* For assemble */ | |
143 | {"uuid", 1, 0, 'u'}, | |
52826846 | 144 | {"super-minor",1,0, 'm'}, |
947fd4dd | 145 | {"name", 1, 0, 'N'}, |
64c4757e NB |
146 | {"config", 1, 0, 'c'}, |
147 | {"scan", 0, 0, 's'}, | |
148 | {"force", 0, 0, 'f'}, | |
5787fa49 | 149 | {"update", 1, 0, 'U'}, |
dfd4d8ee | 150 | |
64c4757e NB |
151 | /* Management */ |
152 | {"add", 0, 0, 'a'}, | |
153 | {"remove", 0, 0, 'r'}, | |
154 | {"fail", 0, 0, 'f'}, | |
155 | {"set-faulty",0, 0, 'f'}, | |
156 | {"run", 0, 0, 'R'}, | |
157 | {"stop", 0, 0, 'S'}, | |
158 | {"readonly", 0, 0, 'o'}, | |
159 | {"readwrite", 0, 0, 'w'}, | |
52826846 | 160 | |
cd29a5c8 NB |
161 | /* For Detail/Examine */ |
162 | {"brief", 0, 0, 'b'}, | |
bd526cee | 163 | {"sparc2.2", 0, 0, 22}, |
feb716e9 | 164 | {"test", 0, 0, 't'}, |
cd29a5c8 | 165 | |
52826846 NB |
166 | /* For Follow/monitor */ |
167 | {"mail", 1, 0, 'm'}, | |
168 | {"program", 1, 0, 'p'}, | |
169 | {"alert", 1, 0, 'p'}, | |
170 | {"delay", 1, 0, 'd'}, | |
56eedc1a NB |
171 | {"daemonise", 0, 0, 'f'}, |
172 | {"daemonize", 0, 0, 'f'}, | |
aa88f531 | 173 | {"oneshot", 0, 0, '1'}, |
b5e64645 | 174 | {"pid-file", 1, 0, 'i'}, |
64c4757e NB |
175 | |
176 | {0, 0, 0, 0} | |
177 | }; | |
178 | ||
179 | char Usage[] = | |
9a9dab36 | 180 | "Usage: mdadm --help\n" |
64c4757e NB |
181 | " for help\n" |
182 | ; | |
183 | ||
184 | char Help[] = | |
e5a5d81e NB |
185 | "mdadm is used for building, managing, and monitoring\n" |
186 | "Linux md devices (aka RAID arrays)\n" | |
9a9dab36 | 187 | "Usage: mdadm --create device options...\n" |
e5a5d81e | 188 | " Create a new array from unused devices.\n" |
9a9dab36 | 189 | " mdadm --assemble device options...\n" |
e968ba60 | 190 | " Assemble a previously created array.\n" |
9a9dab36 | 191 | " mdadm --build device options...\n" |
e5a5d81e | 192 | " Create or assemble an array without metadata.\n" |
e0d19036 | 193 | " mdadm --manage device options...\n" |
e968ba60 | 194 | " make changes to an existing array.\n" |
e0d19036 | 195 | " mdadm --misc options... devices\n" |
e968ba60 | 196 | " report on or modify various md related devices.\n" |
e0d19036 | 197 | " mdadm --monitor options...\n" |
e968ba60 | 198 | " Monitor one or more array for significant changes.\n" |
9a9dab36 | 199 | " mdadm device options...\n" |
e968ba60 | 200 | " Shorthand for --manage.\n" |
e5a5d81e NB |
201 | "Any parameter that does not start with '-' is treated as a device name\n" |
202 | "or, for --examine-bitmap, a file name.\n" | |
203 | "The first such name is often the name of an md device. Subsequent\n" | |
204 | "names are often names of component devices.\n" | |
205 | "\n" | |
56eedc1a | 206 | " For detailed help on the above major modes use --help after the mode\n" |
e0d19036 | 207 | " e.g.\n" |
9a9dab36 | 208 | " mdadm --assemble --help\n" |
56eedc1a NB |
209 | " For general help on options use\n" |
210 | " mdadm --help-options\n" | |
211 | ; | |
212 | ||
213 | char OptionHelp[] = | |
64c4757e | 214 | "Any parameter that does not start with '-' is treated as a device name\n" |
c82f047c | 215 | "or, for --examine-bitmap, a file name.\n" |
e0d19036 | 216 | "The first such name is often the name of an md device. Subsequent\n" |
e5a5d81e | 217 | "names are often names of component devices.\n" |
52826846 | 218 | "\n" |
e0d19036 | 219 | "Some common options are:\n" |
56eedc1a | 220 | " --help -h : General help message or, after above option,\n" |
64c4757e | 221 | " mode specific help message\n" |
56eedc1a | 222 | " --help-options : This help message\n" |
9a9dab36 | 223 | " --version -V : Print version information for mdadm\n" |
64c4757e | 224 | " --verbose -v : Be more verbose about what is happening\n" |
dab6685f | 225 | " --quiet -q : Don't print un-necessary messages\n" |
e0d19036 NB |
226 | " --brief -b : Be less verbose, more brief\n" |
227 | " --force -f : Override normal checks and be more forceful\n" | |
228 | "\n" | |
229 | " --assemble -A : Assemble an array\n" | |
e5a5d81e | 230 | " --build -B : Build an array without metadata\n" |
e0d19036 NB |
231 | " --create -C : Create a new array\n" |
232 | " --detail -D : Display details of an array\n" | |
5787fa49 | 233 | " --examine -E : Examine superblock on an array component\n" |
c82f047c | 234 | " --examine-bitmap -X: Display the detail of a bitmap file\n" |
e0d19036 NB |
235 | " --monitor -F : monitor (follow) some arrays\n" |
236 | " --query -Q : Display general information about how a\n" | |
237 | " device relates to the md driver\n" | |
238 | ; | |
239 | /* | |
64c4757e NB |
240 | "\n" |
241 | " For create or build:\n" | |
c82f047c | 242 | " --bitmap= -b : File to store bitmap in - may pre-exist for --build\n" |
64c4757e | 243 | " --chunk= -c : chunk size of kibibytes\n" |
5787fa49 | 244 | " --rounding= : rounding factor for linear array (==chunk size)\n" |
98c6faba NB |
245 | " --level= -l : raid level: 0,1,4,5,6,linear,mp. 0 or linear for build\n" |
246 | " --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n" | |
64c4757e | 247 | " --layout= : same as --parity\n" |
b83d95f3 NB |
248 | " --raid-devices= -n : number of active devices in array\n" |
249 | " --spare-devices= -x: number of spares (eXtras) devices in initial array\n" | |
e5329c37 | 250 | " --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n" |
52826846 NB |
251 | " --force -f : Honour devices as listed on command line. Don't\n" |
252 | " : insert a missing drive for RAID5.\n" | |
dd0781e5 NB |
253 | " --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n" |
254 | " --assume-clean : Assume the array is already in-sync. This is dangerous.\n" | |
c82f047c NB |
255 | " --bitmap-chunk= : chunksize of bitmap in bitmap file (Kilobytes)\n" |
256 | " --delay= -d : seconds between bitmap updates\n" | |
dfd4d8ee | 257 | " --write-behind= : number of simultaneous write-behind requests to allow (requires bitmap)\n" |
947fd4dd | 258 | " --name= -N : Textual name for array - max 32 characters\n" |
64c4757e NB |
259 | "\n" |
260 | " For assemble:\n" | |
c82f047c | 261 | " --bitmap= -b : File to find bitmap information in\n" |
64c4757e NB |
262 | " --uuid= -u : uuid of array to assemble. Devices which don't\n" |
263 | " have this uuid are excluded\n" | |
52826846 NB |
264 | " --super-minor= -m : minor number to look for in super-block when\n" |
265 | " choosing devices to use.\n" | |
947fd4dd | 266 | " --name= -N : Array name to look for in super-block.\n" |
64c4757e NB |
267 | " --config= -c : config file\n" |
268 | " --scan -s : scan config file for missing information\n" | |
269 | " --force -f : Assemble the array even if some superblocks appear out-of-date\n" | |
feb716e9 | 270 | " --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n" |
dd0781e5 | 271 | " --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n" |
64c4757e | 272 | "\n" |
cd29a5c8 NB |
273 | " For detail or examine:\n" |
274 | " --brief -b : Just print device name and UUID\n" | |
275 | "\n" | |
52826846 NB |
276 | " For follow/monitor:\n" |
277 | " --mail= -m : Address to mail alerts of failure to\n" | |
278 | " --program= -p : Program to run when an event is detected\n" | |
279 | " --alert= : same as --program\n" | |
280 | " --delay= -d : seconds of delay between polling state. default=60\n" | |
281 | "\n" | |
64c4757e NB |
282 | " General management:\n" |
283 | " --add -a : add, or hotadd subsequent devices\n" | |
284 | " --remove -r : remove subsequent devices\n" | |
285 | " --fail -f : mark subsequent devices a faulty\n" | |
286 | " --set-faulty : same as --fail\n" | |
287 | " --run -R : start a partially built array\n" | |
5787fa49 | 288 | " --stop -S : deactivate array, releasing all resources\n" |
64c4757e NB |
289 | " --readonly -o : mark array as readonly\n" |
290 | " --readwrite -w : mark array as readwrite\n" | |
9a9dab36 | 291 | " --zero-superblock : erase the MD superblock from a device.\n" |
64c4757e | 292 | ; |
e0d19036 | 293 | */ |
64c4757e NB |
294 | |
295 | char Help_create[] = | |
b83d95f3 | 296 | "Usage: mdadm --create device -chunk=X --level=Y --raid-devices=Z devices\n" |
64c4757e | 297 | "\n" |
aa88f531 NB |
298 | " This usage will initialise a new md array, associate some\n" |
299 | " devices with it, and activate the array. In order to create an\n" | |
300 | " array with some devices missing, use the special word 'missing' in\n" | |
301 | " place of the relevant device name.\n" | |
64c4757e | 302 | "\n" |
aa88f531 | 303 | " Before devices are added, they are checked to see if they already contain\n" |
e0d19036 | 304 | " raid superblocks or filesystems. They are also checked to see if\n" |
64c4757e | 305 | " the variance in device size exceeds 1%.\n" |
aa88f531 NB |
306 | " If any discrepancy is found, the user will be prompted for confirmation\n" |
307 | " before the array is created. The presence of a '--run' can override this\n" | |
64c4757e NB |
308 | " caution.\n" |
309 | "\n" | |
e0d19036 NB |
310 | " If the --size option is given then only that many kilobytes of each\n" |
311 | " device is used, no matter how big each device is.\n" | |
682c7051 | 312 | " If no --size is given, the apparent size of the smallest drive given\n" |
e0d19036 NB |
313 | " is used for raid level 1 and greater, and the full device is used for\n" |
314 | " other levels.\n" | |
682c7051 | 315 | "\n" |
e0d19036 | 316 | " Options that are valid with --create (-C) are:\n" |
c82f047c | 317 | " --bitmap= : Create a bitmap for the array with the given filename\n" |
e0d19036 | 318 | " --chunk= -c : chunk size of kibibytes\n" |
5787fa49 | 319 | " --rounding= : rounding factor for linear array (==chunk size)\n" |
98c6faba NB |
320 | " --level= -l : raid level: 0,1,4,5,6,linear,multipath and synonyms\n" |
321 | " --parity= -p : raid5/6 parity algorithm: {left,right}-{,a}symmetric\n" | |
e0d19036 | 322 | " --layout= : same as --parity\n" |
b83d95f3 NB |
323 | " --raid-devices= -n : number of active devices in array\n" |
324 | " --spare-devices= -x: number of spares (eXtras) devices in initial array\n" | |
e5329c37 | 325 | " --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n" |
e0d19036 NB |
326 | " --force -f : Honour devices as listed on command line. Don't\n" |
327 | " : insert a missing drive for RAID5.\n" | |
aa88f531 | 328 | " --run -R : insist of running the array even if not all\n" |
e0d19036 | 329 | " : devices are present or some look odd.\n" |
aa88f531 | 330 | " --readonly -o : start the array readonly - not supported yet.\n" |
947fd4dd | 331 | " --name= -N : Textual name for array - max 32 characters\n" |
c82f047c NB |
332 | " --bitmap-chunk= : bitmap chunksize in Kilobytes.\n" |
333 | " --delay= -d : bitmap update delay in seconds.\n" | |
64c4757e NB |
334 | "\n" |
335 | ; | |
336 | ||
337 | char Help_build[] = | |
b83d95f3 | 338 | "Usage: mdadm --build device -chunk=X --level=Y --raid-devices=Z devices\n" |
64c4757e NB |
339 | "\n" |
340 | " This usage is similar to --create. The difference is that it creates\n" | |
e0d19036 | 341 | " a legacy array without a superblock. With these arrays there is no\n" |
64c4757e NB |
342 | " different between initially creating the array and subsequently\n" |
343 | " assembling the array, except that hopefully there is useful data\n" | |
344 | " there in the second case.\n" | |
345 | "\n" | |
e0d19036 | 346 | " The level may only be 0, raid0, or linear.\n" |
64c4757e | 347 | " All devices must be listed and the array will be started once complete.\n" |
e0d19036 | 348 | " Options that are valid with --build (-B) are:\n" |
c82f047c | 349 | " --bitmap= : file to store/find bitmap information in.\n" |
e0d19036 | 350 | " --chunk= -c : chunk size of kibibytes\n" |
5787fa49 | 351 | " --rounding= : rounding factor for linear array (==chunk size)\n" |
e0d19036 | 352 | " --level= -l : 0, raid0, or linear\n" |
c82f047c NB |
353 | " --raid-devices= -n : number of active devices in array\n" |
354 | " --bitmap-chunk= : bitmap chunksize in Kilobytes.\n" | |
355 | " --delay= -d : bitmap update delay in seconds.\n" | |
64c4757e NB |
356 | ; |
357 | ||
358 | char Help_assemble[] = | |
9a9dab36 NB |
359 | "Usage: mdadm --assemble device options...\n" |
360 | " mdadm --assemble --scan options...\n" | |
64c4757e NB |
361 | "\n" |
362 | "This usage assembles one or more raid arrays from pre-existing\n" | |
363 | "components.\n" | |
e0d19036 | 364 | "For each array, mdadm needs to know the md device, the identity of\n" |
52826846 NB |
365 | "the array, and a number of sub devices. These can be found in a number\n" |
366 | "of ways.\n" | |
367 | "\n" | |
368 | "The md device is either given on the command line or is found listed\n" | |
369 | "in the config file. The array identity is determined either from the\n" | |
e0d19036 | 370 | "--uuid or --super-minor commandline arguments, from the config file,\n" |
52826846 | 371 | "or from the first component device on the command line.\n" |
64c4757e | 372 | "\n" |
52826846 NB |
373 | "The different combinations of these are as follows:\n" |
374 | " If the --scan option is not given, then only devices and identities\n" | |
375 | " listed on the command line are considered.\n" | |
e0d19036 | 376 | " The first device will be the array device, and the remainder will be\n" |
52826846 NB |
377 | " examined when looking for components.\n" |
378 | " If an explicit identity is given with --uuid or --super-minor, then\n" | |
e0d19036 | 379 | " only devices with a superblock which matches that identity is considered,\n" |
52826846 | 380 | " otherwise every device listed is considered.\n" |
64c4757e | 381 | "\n" |
52826846 NB |
382 | " If the --scan option is given, and no devices are listed, then\n" |
383 | " every array listed in the config file is considered for assembly.\n" | |
e0d19036 | 384 | " The identity of candidate devices are determined from the config file.\n" |
64c4757e | 385 | "\n" |
52826846 NB |
386 | " If the --scan option is given as well as one or more devices, then\n" |
387 | " Those devices are md devices that are to be assembled. Their identity\n" | |
388 | " and components are determined from the config file.\n" | |
64c4757e | 389 | "\n" |
e0d19036 | 390 | "Options that are valid with --assemble (-A) are:\n" |
c82f047c | 391 | " --bitmap= : bitmap file to use wit the array\n" |
e0d19036 NB |
392 | " --uuid= -u : uuid of array to assemble. Devices which don't\n" |
393 | " have this uuid are excluded\n" | |
394 | " --super-minor= -m : minor number to look for in super-block when\n" | |
395 | " choosing devices to use.\n" | |
947fd4dd | 396 | " --name= -N : Array name to look for in super-block.\n" |
e0d19036 NB |
397 | " --config= -c : config file\n" |
398 | " --scan -s : scan config file for missing information\n" | |
399 | " --run -R : Try to start the array even if not enough devices\n" | |
400 | " for a full array are present\n" | |
401 | " --force -f : Assemble the array even if some superblocks appear\n" | |
402 | " : out-of-date. This involves modifying the superblocks.\n" | |
feb716e9 | 403 | " --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n" |
e0d19036 NB |
404 | ; |
405 | ||
406 | char Help_manage[] = | |
407 | "Usage: mdadm arraydevice options component devices...\n" | |
408 | "\n" | |
409 | "This usage is for managing the component devices within an array.\n" | |
410 | "The --manage option is not needed and is assumed if the first argument\n" | |
411 | "is a device name or a management option.\n" | |
412 | "The first device listed will be taken to be an md array device, and\n" | |
413 | "subsequent devices are (potential) components of that array.\n" | |
414 | "\n" | |
415 | "Options that are valid with management mode are:\n" | |
416 | " --add -a : hotadd subsequent devices to the array\n" | |
417 | " --remove -r : remove subsequent devices, which must not be active\n" | |
418 | " --fail -f : mark subsequent devices a faulty\n" | |
419 | " --set-faulty : same as --fail\n" | |
420 | " --run -R : start a partially built array\n" | |
5787fa49 | 421 | " --stop -S : deactivate array, releasing all resources\n" |
e0d19036 NB |
422 | " --readonly -o : mark array as readonly\n" |
423 | " --readwrite -w : mark array as readwrite\n" | |
424 | ; | |
425 | ||
426 | char Help_misc[] = | |
427 | "Usage: mdadm misc_option devices...\n" | |
428 | "\n" | |
429 | "This usage is for performing some task on one or more devices, which\n" | |
430 | "may be arrays or components, depending on the task.\n" | |
431 | "The --misc option is not needed (though it is allowed) and is assumed\n" | |
432 | "if the first argument in a misc option.\n" | |
433 | "\n" | |
434 | "Options that are valid with the miscellaneous mode are:\n" | |
435 | " --query -Q : Display general information about how a\n" | |
436 | " device relates to the md driver\n" | |
437 | " --detail -D : Display details of an array\n" | |
5787fa49 | 438 | " --examine -E : Examine superblock on an array component\n" |
c82f047c | 439 | " --examine-bitmap -X: Display contents of a bitmap file\n" |
e0d19036 NB |
440 | " --zero-superblock : erase the MD superblock from a device.\n" |
441 | " --run -R : start a partially built array\n" | |
5787fa49 | 442 | " --stop -S : deactivate array, releasing all resources\n" |
e0d19036 NB |
443 | " --readonly -o : mark array as readonly\n" |
444 | " --readwrite -w : mark array as readwrite\n" | |
feb716e9 | 445 | " --test -t : exit status 0 if ok, 1 if degrade, 2 if dead, 4 if missing\n" |
e0d19036 NB |
446 | ; |
447 | ||
448 | char Help_monitor[] = | |
449 | "Usage: mdadm --monitor options devices\n" | |
450 | "\n" | |
451 | "This usage causes mdadm to monitor a number of md arrays by periodically\n" | |
452 | "polling their status and acting on any changes.\n" | |
453 | "If any devices are listed then those devices are monitored, otherwise\n" | |
454 | "all devices listed in the config file are monitored.\n" | |
455 | "The address for mailing advisories to, and the program to handle\n" | |
456 | "each change can be specified in the config file or on the command line.\n" | |
457 | "If no mail address or program are specified, then mdadm reports all\n" | |
458 | "state changes to stdout.\n" | |
459 | "\n" | |
dd0781e5 | 460 | "Options that are valid with the monitor (-F --follow) mode are:\n" |
e0d19036 NB |
461 | " --mail= -m : Address to mail alerts of failure to\n" |
462 | " --program= -p : Program to run when an event is detected\n" | |
463 | " --alert= : same as --program\n" | |
464 | " --delay= -d : seconds of delay between polling state. default=60\n" | |
465 | " --config= -c : specify a different config file\n" | |
466 | " --scan -s : find mail-address/program in config file\n" | |
d013a55e | 467 | " --daemonise -f : Fork and continue in child, parent exits\n" |
b5e64645 | 468 | " --pid-file= -i : In daemon mode write pid to specified file instead of stdout\n" |
aa88f531 | 469 | " --oneshot -1 : Check for degraded arrays, then exit\n" |
98c6faba | 470 | " --test -t : Generate a TestMessage event against each array at startup\n" |
e0d19036 NB |
471 | ; |
472 | ||
dd0781e5 NB |
473 | char Help_grow[] = |
474 | "Usage: mdadm --grow device options\n" | |
475 | "\n" | |
476 | "This usage causes mdadm to attempt to reconfigure a running array.\n" | |
477 | "This is only possibly if the kernel being used supports a particular\n" | |
478 | "reconfiguration. This version only supports changing the number of\n" | |
479 | "devices in a RAID1, and changing the active size of all devices in\n" | |
480 | "a RAID1/4/5/6.\n" | |
481 | "\n" | |
891d2994 | 482 | "Options that are valid with the grow (-G --grow) mode are:\n" |
dd0781e5 NB |
483 | " --size= -z : Change the active size of devices in an array.\n" |
484 | " : This is useful if all devices have been replaced\n" | |
485 | " : with larger devices.\n" | |
486 | " --raid-disks= -n : Change the number of active devices in a RAID1\n" | |
487 | " : array.\n" | |
488 | ; | |
e0d19036 NB |
489 | |
490 | ||
491 | ||
492 | char Help_config[] = | |
493 | "The /etc/mdadm.conf config file:\n\n" | |
494 | " The config file contains, apart from blank lines and comment lines that\n" | |
495 | " start with a hash(#), four sorts of configuration lines: array lines, \n" | |
496 | " device lines, mailaddr lines and program lines.\n" | |
497 | " Each configuration line is constructed of a number of space separated\n" | |
498 | " words, and can be continued on subsequent physical lines by indenting\n" | |
499 | " those lines.\n" | |
500 | "\n" | |
501 | " A device line starts with the word 'device' and then has a number of words\n" | |
502 | " which identify devices. These words should be names of devices in the\n" | |
503 | " filesystem, and can contain wildcards. There can be multiple words or each\n" | |
504 | " device line, and multiple device lines. All devices so listed are checked\n" | |
505 | " for relevant super blocks when assembling arrays.\n" | |
506 | "\n" | |
507 | " An array line start with the word 'array'. This is followed by the name of\n" | |
508 | " the array device in the filesystem, e.g. '/dev/md2'. Subsequent words\n" | |
509 | " describe the identity of the array, used to recognise devices to include in the\n" | |
510 | " array. The identity can be given as a UUID with a word starting 'uuid=', or\n" | |
511 | " as a minor-number stored in the superblock using 'super-minor=', or as a list\n" | |
512 | " of devices. This is given as a comma separated list of names, possibly\n" | |
5787fa49 | 513 | " containing wildcards, preceded by 'devices='. If multiple critea are given,\n" |
e0d19036 NB |
514 | " than a device must match all of them to be considered.\n" |
515 | "\n" | |
516 | " A mailaddr line starts with the word 'mailaddr' and should contain exactly\n" | |
517 | " one Email address. 'mdadm --monitor --scan' will send alerts of failed drives\n" | |
518 | " to this Email address." | |
519 | "\n" | |
520 | " A program line starts with the word 'program' and should contain exactly\n" | |
521 | " one program name. 'mdadm --monitor --scan' will run this program when any\n" | |
522 | " event is detected.\n" | |
64c4757e NB |
523 | "\n" |
524 | ; | |
682c7051 NB |
525 | |
526 | ||
527 | /* name/number mappings */ | |
528 | ||
529 | mapping_t r5layout[] = { | |
cd29a5c8 NB |
530 | { "left-asymmetric", 0}, |
531 | { "right-asymmetric", 1}, | |
532 | { "left-symmetric", 2}, | |
533 | { "right-symmetric", 3}, | |
682c7051 NB |
534 | |
535 | { "default", 2}, | |
536 | { "la", 0}, | |
537 | { "ra", 1}, | |
538 | { "ls", 2}, | |
539 | { "rs", 3}, | |
540 | { NULL, 0} | |
541 | }; | |
542 | ||
543 | mapping_t pers[] = { | |
544 | { "linear", -1}, | |
545 | { "raid0", 0}, | |
546 | { "0", 0}, | |
547 | { "stripe", 0}, | |
548 | { "raid1", 1}, | |
549 | { "1", 1}, | |
550 | { "mirror", 1}, | |
551 | { "raid4", 4}, | |
552 | { "4", 4}, | |
553 | { "raid5", 5}, | |
554 | { "5", 5}, | |
e0d19036 NB |
555 | { "multipath", -4}, |
556 | { "mp", -4}, | |
98c6faba NB |
557 | { "raid6", 6}, |
558 | { "6", 6}, | |
e5329c37 NB |
559 | { "raid10", 10}, |
560 | { "10", 10}, | |
b5e64645 | 561 | { "faulty", -5}, |
682c7051 NB |
562 | { NULL, 0} |
563 | }; | |
e0d19036 NB |
564 | |
565 | ||
566 | mapping_t modes[] = { | |
567 | { "assemble", ASSEMBLE}, | |
568 | { "build", BUILD}, | |
569 | { "create", CREATE}, | |
570 | { "manage", MANAGE}, | |
571 | { "misc", MISC}, | |
572 | { "monitor", MONITOR}, | |
dd0781e5 | 573 | { "grow", GROW}, |
e0d19036 | 574 | }; |
b5e64645 NB |
575 | |
576 | mapping_t faultylayout[] = { | |
577 | { "write-transient", WriteTransient }, | |
578 | { "wt", WriteTransient }, | |
579 | { "read-transient", ReadTransient }, | |
580 | { "rt", ReadTransient }, | |
581 | { "write-persistent", WritePersistent }, | |
582 | { "wp", WritePersistent }, | |
583 | { "read-persistent", ReadPersistent }, | |
584 | { "rp", ReadPersistent }, | |
585 | { "write-all", WriteAll }, | |
586 | { "wa", WriteAll }, | |
587 | { "read-fixable", ReadFixable }, | |
588 | { "rf", ReadFixable }, | |
589 | ||
590 | { "clear", ClearErrors}, | |
591 | { "flush", ClearFaults}, | |
592 | { "none", ClearErrors}, | |
593 | { "default", ClearErrors}, | |
594 | { NULL, 0} | |
595 | }; |