]> git.ipfire.org Git - thirdparty/mdadm.git/blob - mdadm.conf.5
Makefile improvements for static linking.
[thirdparty/mdadm.git] / mdadm.conf.5
1 .TH MDADM.CONF 5
2 .SH NAME
3 mdadm.conf \- configuration for management of Software Raid with mdadm
4 .SH SYNOPSIS
5 /etc/mdadm.conf
6 .SH DESCRIPTION
7 .PP
8 .B mdadm
9 is a tool for creating, managing, and monitoring RAID devices using the
10 .B md
11 driver in Linux.
12 .PP
13 Some common tasks, such as assembling all arrays, can be simplified
14 by describing the devices and arrays in this configuration file.
15
16 .SS SYNTAX
17 The file should be seen as a collection of words separated by white
18 space (space, tab, or newline).
19 Any word that beings with a hash sign (#) starts a comment and that
20 word together with the remainder of the line is ignored.
21
22 Any line that starts with white space (space or tab) is treated as
23 though it were a continuation of the previous line.
24
25 Empty lines are ignored, but otherwise each (non continuation) line
26 must start with a keyword as listed below. The keywords are case
27 insensitive and can be abbreviated to 3 characters.
28
29 The keywords are:
30 .TP
31 .B DEVICE
32 A
33 .B device
34 line lists the devices (whole devices or partitions) that might contain
35 a component of an MD array. When looking for the components of an
36 array,
37 .B mdadm
38 will scan these devices (or any devices listed on the command line).
39
40 The
41 .B device
42 line may contain a number of different devices (separated by spaces)
43 and each device name can contain wild cards as defined by
44 .BR glob (7).
45
46 Also, there may be several device lines present in the file.
47
48 Alternatively, a
49 .B device
50 line can contain the word
51 .BR partitions .
52 This will cause
53 .I mdadm
54 to read
55 .I /proc/partitions
56 and include all devices and partitions found there-in.
57 .I mdadm
58 does not use the names from
59 .I /proc/partitions
60 but only the major and minor device numbers. It scans
61 .I /dev
62 to find the name that matches the numbers.
63
64 If no DEVICE line is present, then "DEVICE partitions" is assumed.
65
66 For example:
67 .IP
68 DEVICE /dev/hda* /dev/hdc*
69 .br
70 DEV /dev/sd*
71 .br
72 DEVICE /dev/discs/disc*/disc
73 .br
74 DEVICE partitions
75
76 .TP
77 .B ARRAY
78 The ARRAY lines identify actual arrays. The second word on the line
79 should be the name of the device where the array is normally
80 assembled, such as
81 .BR /dev/md1 .
82 Subsequent words identify the array, or identify the array as a member
83 of a group. If multiple identities are given,
84 then a component device must match ALL identities to be considered a
85 match. Each identity word has a tag, and equals sign, and some value.
86 The tags are:
87
88 .RS 4
89 .TP
90 .B uuid=
91 The value should be a 128 bit uuid in hexadecimal, with punctuation
92 interspersed if desired. This must match the uuid stored in the
93 superblock.
94 .TP
95 .B name=
96 The value should be a simple textual name as was given to
97 .I mdadm
98 when the array was created. This must match the name stored in the
99 superblock on a device for that device to be included in the array.
100 Not all superblock-formats support names.
101 .TP
102 .B super-minor=
103 The value is an integer which indicates the minor number that was
104 stored in the superblock when the array was created. When an array is
105 created as /dev/mdX, then the minor number X is stored.
106 .TP
107 .B devices=
108 The value is a comma separated list of device names or device name
109 patterns.
110 Only devices with names which match one entry in the list will be used
111 to assemble the array. Note that the devices
112 listed there must also be listed on a DEVICE line.
113 .TP
114 .B level=
115 The value is a raid level. This is not normally used to
116 identify an array, but is supported so that the output of
117
118 .B "mdadm --examine --scan"
119
120 can be use directly in the configuration file.
121 .TP
122 .B num-devices=
123 The value is the number of devices in a complete active array. As with
124 .B level=
125 this is mainly for compatibility with the output of
126
127 .BR "mdadm --examine --scan" .
128
129 .TP
130 .B spare-group=
131 The value is a textual name for a group of arrays. All arrays with
132 the same
133 .B spare-group
134 name are considered to be part of the same group. The significance of
135 a group of arrays is that
136 .B mdadm
137 will, when monitoring the arrays, move a spare drive from one array in
138 a group to another array in that group if the first array had a failed
139 or missing drive but no spare.
140
141 .TP
142 .B auto=
143 This option declares to
144 .B mdadm
145 that it should try to create the device file of the array if it
146 doesn't already exist, or exists but with the wrong device number.
147
148 The value of this option can be "yes" or "md" to indicate that a
149 traditional, non-partitionable md array should be created, or "mdp",
150 "part" or "partition" to indicate that a partitionable md array (only
151 available in linux 2.6 and later) should be used. This later set can
152 also have a number appended to indicate how many partitions to create
153 device files for, e.g.
154 .BR auto=mdp5 .
155 The default is 4.
156
157 .TP
158 .B bitmap=
159 The option specifies a file in which a write-intent bitmap should be
160 found. When assembling the array,
161 .I mdadm
162 will provide this file to the
163 .B md
164 driver as the bitmap file. This has the same function as the
165 .B --bitmap-file
166 option to
167 .BR --assemble .
168 .RE
169
170 .TP
171 .B MAILADDR
172 The
173 .B mailaddr
174 line gives an E-mail address that alerts should be
175 sent to when
176 .M mdadm
177 is running in
178 .B --monitor
179 mode (and was given the
180 .B --scan
181 option). There should only be one
182 .B MAILADDR
183 line and it should have only one address.
184
185
186 .TP
187 .B MAILFROM
188 The
189 .B mailfrom
190 line (which can only be abbreviate at leat 5 characters) gives an
191 address to appear in the "From" address for alert mails. This can be
192 useful if you want to explicitly set a domain, as the default from
193 address is "root" with no domain. All words on this line are
194 catenated with spaces to form the address.
195
196 Note that this value cannot be set via the
197 .I mdadm
198 commandline. It is only settable via the config file.
199
200 .TP
201 .B PROGRAM
202 The
203 .B program
204 line gives the name of a program to be run when
205 .B "mdadm --monitor"
206 detects potentially interesting events on any of the arrays that it
207 is monitoring. This program gets run with two or three arguments, they
208 being the Event, the md device, and possibly the related component
209 device.
210
211 There should only be one
212 .B program
213 line and it should be give only one program.
214
215
216 .TP
217 .B CREATE
218 The
219 .B create
220 line gives default values to be used when creating device entries for
221 arrays.
222 These include:
223
224 .RS 4
225 .TP
226 .B owner=
227 .TP
228 .B group=
229 These can give user/group ids or names to use instead of system
230 defaults (root/wheel or root/disk).
231 .TP
232 .B mode=
233 An octal file mode such as 0660 can be given to override the default
234 of 0600.
235 .TP
236 .B auto=
237 This corresponds to the
238 .B --auto
239 flag to mdadm. Give
240 .BR yes ,
241 .BR md ,
242 .BR mdp ,
243 .B part
244 - possibly followed by a number of partitions - to indicate how
245 missing device entries should be created.
246
247 .RE
248
249
250 .SH EXAMPLE
251 DEVICE /dev/sd[bcdjkl]1
252 .br
253 DEVICE /dev/hda1 /dev/hdb1
254
255 # /dev/md0 is known by it's UID.
256 .br
257 ARRAY /dev/md0 UUID=3aaa0122:29827cfa:5331ad66:ca767371
258 .br
259 # /dev/md1 contains all devices with a minor number of
260 .br
261 # 1 in the superblock.
262 .br
263 ARRAY /dev/md1 superminor=1
264 .br
265 # /dev/md2 is made from precisey these two devices
266 .br
267 ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
268
269 # /dev/md4 and /dev/md5 are a spare-group and spares
270 .br
271 # can be moved between them
272 .br
273 ARRAY /dev/md4 uuid=b23f3c6d:aec43a9f:fd65db85:369432df
274 .br
275 spare-group=group1
276 .br
277 ARRAY /dev/md5 uuid=19464854:03f71b1b:e0df2edd:246cc977
278 .br
279 spare-group=group1
280 .br
281 # /dev/md/home is created if need to be a partitionable md array
282 .br
283 # any spare device number is allocated.
284 .br
285 ARRAY /dev/md/home UUID=9187a482:5dde19d9:eea3cc4a:d646ab8b
286 .br
287 auto=part
288
289 MAILADDR root@mydomain.tld
290 .br
291 PROGRAM /usr/sbin/handle-mdadm-events
292 .br
293 CREATE group=system mode=0640 auto=part-8
294 .br
295 HOMEHOST <system>
296
297 .SH SEE ALSO
298 .BR mdadm (8),
299 .BR md (4).
300