+''' Copyright Neil Brown and others.
+''' This program is free software; you can redistribute it and/or modify
+''' it under the terms of the GNU General Public License as published by
+''' the Free Software Foundation; either version 2 of the License, or
+''' (at your option) any later version.
+''' See file COPYING in distribution for details.
.TH MDADM.CONF 5
.SH NAME
mdadm.conf \- configuration for management of Software Raid with mdadm
.I /dev
to find the name that matches the numbers.
+If no DEVICE line is present, then "DEVICE partitions" is assumed.
+
For example:
.IP
DEVICE /dev/hda* /dev/hdc*
.BR "mdadm --examine --scan" .
+.TP
+.B spares=
+The value is a number of spare devices to expect the array to have.
+.I mdadm --monitor
+will report an array if it is found to have fewer than this number of
+spares when
+.B --monitor
+starts or when
+.B --oneshot
+is used.
+
.TP
.B spare-group=
The value is a textual name for a group of arrays. All arrays with
device files for, e.g.
.BR auto=mdp5 .
The default is 4.
+
+.TP
+.B bitmap=
+The option specifies a file in which a write-intent bitmap should be
+found. When assembling the array,
+.I mdadm
+will provide this file to the
+.B md
+driver as the bitmap file. This has the same function as the
+.B --bitmap-file
+option to
+.BR --assemble .
+
+.TP
+.B metadata=
+Specify the metadata format that the array has. This is mainly
+recognised for comparability with the output of
+.IR "mdadm -Es" .
+
.RE
.TP
line and it should have only one address.
+.TP
+.B MAILFROM
+The
+.B mailfrom
+line (which can only be abbreviate at leat 5 characters) gives an
+address to appear in the "From" address for alert mails. This can be
+useful if you want to explicitly set a domain, as the default from
+address is "root" with no domain. All words on this line are
+catenated with spaces to form the address.
+
+Note that this value cannot be set via the
+.I mdadm
+commandline. It is only settable via the config file.
+
.TP
.B PROGRAM
The
.B program
line and it should be give only one program.
+
+.TP
+.B CREATE
+The
+.B create
+line gives default values to be used when creating arrays and device entries for
+arrays.
+These include:
+
+.RS 4
+.TP
+.B owner=
+.TP
+.B group=
+These can give user/group ids or names to use instead of system
+defaults (root/wheel or root/disk).
+.TP
+.B mode=
+An octal file mode such as 0660 can be given to override the default
+of 0600.
+.TP
+.B auto=
+This corresponds to the
+.B --auto
+flag to mdadm. Give
+.BR yes ,
+.BR md ,
+.BR mdp ,
+.B part
+- possibly followed by a number of partitions - to indicate how
+missing device entries should be created.
+
+.TP
+.B metadata=
+The name of the metadata format to use if none is explicitly given.
+This can be useful to impose a system-wide default of version-1 superblocks.
+
+.TP
+.B symlinks=no
+Normally when creating devices in
+.B /dev/md/
+.I mdadm
+will create a matching symlink from
+.B /dev/
+with a name starting
+.B md
+or
+.BR md_ .
+Give
+.B symlinked=no
+to suppress this symlink creation.
+.RE
+
+
.SH EXAMPLE
DEVICE /dev/sd[bcdjkl]1
.br
.br
# /dev/md2 is made from precisey these two devices
.br
-ARRAY /dev/md2 devices=/dev/hda1,/dev/hda2
+ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
# /dev/md4 and /dev/md5 are a spare-group and spares
.br
MAILADDR root@mydomain.tld
.br
PROGRAM /usr/sbin/handle-mdadm-events
-
+.br
+CREATE group=system mode=0640 auto=part-8
+.br
+HOMEHOST <system>
.SH SEE ALSO
.BR mdadm (8),
projects / thirdparty / mdadm.git / blobdiff