]> git.ipfire.org Git - thirdparty/mdadm.git/blob - mdadm.conf.man
mdadm-0.8
[thirdparty/mdadm.git] / mdadm.conf.man
1 MDADM.CONF(5) MDADM.CONF(5)
2
3
4
5 N\bNA\bAM\bME\bE
6 mdadm.conf - configuration for management of Software Raid
7 with mdadm
8
9 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
10 /etc/mdadm.conf
11
12 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
13 m\bmd\bda\bad\bdm\bm is a tool for creating, managing, and monitoring
14 RAID devices using the m\bmd\bd driver in Linux.
15
16 Some common tasks, such as assembling all arrays, can be
17 simplified by describing the devices and array in this
18 configuration file.
19
20
21 S\bSY\bYN\bNT\bTA\bAX\bX
22 The file should be seen as a collection of words separated
23 by white space (space, tab, or newline). Any word that
24 beings with a hash sign (#) starts a comment and that word
25 together with the remainder of the line are ignored.
26
27 Any line that start with white space (space or tab) is
28 treated as though it were a continuation of the previous
29 line.
30
31 Empty lines are ignored, but otherwise each (non continua-
32 tion) line must start with a keyword as listed below. The
33 key words are case insensitive and can be abbreviated to 3
34 characters.
35
36 The keywords are:
37
38 D\bDE\bEV\bVI\bIC\bCE\bE A d\bde\bev\bvi\bic\bce\be line lists the devices (whole devices or
39 partitions) that might contain a component of an MD
40 array. When looking for the components of an
41 array, m\bmd\bda\bad\bdm\bm will scan these devices and no others.
42
43 The d\bde\bev\bvi\bic\bce\be line may contain a number of different
44 devices (separated by spaces) and each device name
45 can contain wild cards as defined by g\bgl\blo\bob\bb(7).
46
47 Also, there may be several device lines present in
48 the file.
49
50 For example:
51
52 DEVICE /dev/hda* /dev/hdc*
53 DEV /dev/sd*
54 DEVICE /dev/discs/disc*/disc
55
56
57 A\bAR\bRR\bRA\bAY\bY The ARRAY lines identify actual arrays. The second
58 word on the line should be the name of the device
59 where the array is normally assembled, such as
60 /\b/d\bde\bev\bv/\b/m\bmd\bd1\b1. Subsequent words identify the array, or
61 identify the array as a member of a group. If mul-
62 tiple identities are given, then the array must
63 match ALL identities to be considered a match.
64 Each identity word has a tag, and equals sign, and
65 some value. The options are:
66
67
68 u\buu\bui\bid\bd=\b= The value should be a 128 bit uuid in hexadeci-
69 mal, with punctuation interspersed if desired.
70 This must match the uuid stored in the
71 superblock.
72
73 s\bsu\bup\bpe\ber\br-\b-m\bmi\bin\bno\bor\br=\b=
74 The value is an integer which indicates the
75 minor number that was stored in the superblock
76 when the array was created. When an array is
77 created as /dev/mdX, then the minor number X is
78 stored.
79
80 d\bde\bev\bvi\bic\bce\bes\bs=\b=
81 The value is a comma separated list of device
82 names. Precisely these devices will be used to
83 assemble the array. Note that the devices
84 listed there must also be listed on a DEVICE
85 line.
86
87 l\ble\bev\bve\bel\bl=\b= The value is a raid level. This is not nor-
88 mally used to identify an array, but is sup-
89 ported so that the output of
90
91 m\bmd\bda\bad\bdm\bm -\b--\b-e\bex\bxa\bam\bmi\bin\bne\be -\b--\b-s\bsc\bca\ban\bn
92
93 can be use directly in the configuration file.
94
95 d\bdi\bis\bsk\bks\bs=\b= The value is the number of disks in a complete
96 active array. As with l\ble\bev\bve\bel\bl=\b= this is mainly
97 for compatibility with the output of
98
99 m\bmd\bda\bad\bdm\bm -\b--\b-e\bex\bxa\bam\bmi\bin\bne\be -\b--\b-s\bsc\bca\ban\bn.
100
101
102 s\bsp\bpa\bar\bre\be-\b-g\bgr\bro\bou\bup\bp=\b=
103 The value is a textual name for a group of
104 arrays. All arrays with the same s\bsp\bpa\bar\bre\be-\b-g\bgr\bro\bou\bup\bp
105 name are considered to be part of the same
106 group. The significance of a group of arrays
107 is that m\bmd\bda\bad\bdm\bm will, when monitoring the arrays,
108 move a spare drive from one array in a group to
109 another array in that group if the first array
110 had a failed or missing drive but no spare.
111
112
113 M\bMA\bAI\bIL\bLA\bAD\bDD\bDR\bR
114 The m\bma\bai\bil\bla\bad\bdd\bdr\br line gives an E-mail address that
115 alerts should be sent to when is running in -\b--\b-m\bmo\bon\bni\bi-\b-
116 t\bto\bor\br mode (and was given the -\b--\b-s\bsc\bca\ban\bn option). There
117 should only be one M\bMA\bAI\bIL\bLA\bAD\bDD\bDR\bR line and it should have
118 only one address.
119
120
121
122 P\bPR\bRO\bOG\bGR\bRA\bAM\bM
123 The p\bpr\bro\bog\bgr\bra\bam\bm line gives the name of a program to be
124 run when m\bmd\bda\bad\bdm\bm -\b--\b-m\bmo\bon\bni\bit\bto\bor\br detects potentially inter-
125 esting events on any of the arrays that it is moni-
126 toring. This program gets run with two or three
127 arguments, they being the Event, the md device, and
128 possibly the related component device.
129
130 There should only be one p\bpr\bro\bog\bgr\bra\bam\bm line and it should
131 be give only one program.
132
133
134
135 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
136 m\bmd\bda\bad\bdm\bm(8), m\bmd\bd(4).
137
138
139
140
141 MDADM.CONF(5)