summaryrefslogtreecommitdiffstats
path: root/mdadm.conf.man
blob: 70ac49aaee941048db5ca91c9ea0b35123c09bc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
MDADM.CONF(5)                                       MDADM.CONF(5)



NNAAMMEE
       mdadm.conf - configuration for management of Software Raid
       with mdadm

SSYYNNOOPPSSIISS
       /etc/mdadm.conf

DDEESSCCRRIIPPTTIIOONN
       mmddaaddmm is a tool for  creating,  managing,  and  monitoring
       RAID devices using the mmdd driver in Linux.

       Some  common  tasks, such as assembling all arrays, can be
       simplified by describing the devices  and  array  in  this
       configuration file.


   SSYYNNTTAAXX
       The file should be seen as a collection of words separated
       by white space (space, tab, or newline).   Any  word  that
       beings with a hash sign (#) starts a comment and that word
       together with the remainder of the line are ignored.

       Any line that start with white space  (space  or  tab)  is
       treated  as  though it were a continuation of the previous
       line.

       Empty lines are ignored, but otherwise each (non continua-
       tion) line must start with a keyword as listed below.  The
       key words are case insensitive and can be abbreviated to 3
       characters.

       The keywords are:

       DDEEVVIICCEE A  ddeevviiccee  line lists the devices (whole devices or
              partitions) that might contain a component of an MD
              array.   When  looking  for  the  components  of an
              array, mmddaaddmm will scan these devices and no others.

              The  ddeevviiccee  line may contain a number of different
              devices (separated by spaces) and each device  name
              can contain wild cards as defined by gglloobb(7).

              Also,  there may be several device lines present in
              the file.

              For example:

              DEVICE /dev/hda* /dev/hdc*
              DEV    /dev/sd*
              DEVICE /dev/discs/disc*/disc


       AARRRRAAYY  The ARRAY lines identify actual arrays.  The second
              word  on  the line should be the name of the device
              where the array  is  normally  assembled,  such  as
              //ddeevv//mmdd11.   Subsequent words identify the array, or
              identify the array as a member of a group. If  mul-
              tiple  identities  are  given,  then the array must
              match ALL identities  to  be  considered  a  match.
              Each  identity word has a tag, and equals sign, and
              some value.  The options are:


           uuuuiidd==  The value should be a 128 bit uuid in hexadeci-
                  mal,  with punctuation interspersed if desired.
                  This  must  match  the  uuid  stored   in   the
                  superblock.

           ssuuppeerr--mmiinnoorr==
                  The  value  is  an  integer which indicates the
                  minor number that was stored in the  superblock
                  when  the  array  was created. When an array is
                  created as /dev/mdX, then the minor number X is
                  stored.

           ddeevviicceess==
                  The  value  is a comma separated list of device
                  names. Precisely these devices will be used  to
                  assemble  the  array.   Note  that  the devices
                  listed there must also be listed  on  a  DEVICE
                  line.

           lleevveell== The  value  is  a raid level.  This is not nor-
                  mally used to identify an array,  but  is  sup-
                  ported so that the output of

                  mmddaaddmm ----eexxaammiinnee ----ssccaann

                  can  be use directly in the configuration file.

           ddiisskkss== The value is the number of disks in a  complete
                  active  array.   As  with lleevveell== this is mainly
                  for compatibility with the output of

                  mmddaaddmm ----eexxaammiinnee ----ssccaann.


           ssppaarree--ggrroouupp==
                  The value is a textual  name  for  a  group  of
                  arrays.   All  arrays with the same ssppaarree--ggrroouupp
                  name are considered to  be  part  of  the  same
                  group.   The  significance of a group of arrays
                  is that mmddaaddmm will, when monitoring the arrays,
                  move a spare drive from one array in a group to
                  another array in that group if the first  array
                  had a failed or missing drive but no spare.


       MMAAIILLAADDDDRR
              The  mmaaiillaaddddrr  line  gives  an  E-mail address that
              alerts should be sent to when is running in ----mmoonnii--
              ttoorr  mode (and was given the ----ssccaann option).  There
              should only be one MMAAIILLAADDDDRR line and it should have
              only one address.



       PPRROOGGRRAAMM
              The  pprrooggrraamm line gives the name of a program to be
              run when mmddaaddmm ----mmoonniittoorr detects potentially inter-
              esting events on any of the arrays that it is moni-
              toring.  This program gets run with  two  or  three
              arguments, they being the Event, the md device, and
              possibly the related component device.

              There should only be one pprrooggrraamm line and it should
              be give only one program.



SSEEEE AALLSSOO
       mmddaaddmm(8), mmdd(4).




                                                    MDADM.CONF(5)