Any word that beings with a hash sign (#) starts a comment and that
word together with the remainder of the line is ignored.
+Spaces can be included in a word using quotation characters. Either
+single quotes
+.RB ( ' )
+or double quotes (\fB"\fP)
+may be used. All the characters from one quotation character to
+next identical character are protected and will not be used to
+separate words to start new quoted strings. To include a single quote
+it must be between double quotes. To include a double quote it must
+be between single quotes.
+
Any line that starts with white space (space or tab) is treated as
though it were a continuation of the previous line.
The value is a comma separated list of device names or device name
patterns.
Only devices with names which match one entry in the list will be used
-to assemble the array. Note that the devices
+to assemble the array. Note that the devices
listed there must also be listed on a DEVICE line.
.TP
.B level=
-The value is a raid level. This is not normally used to
+The value is a RAID level. This is not normally used to
identify an array, but is supported so that the output of
.B "mdadm \-\-examine \-\-scan"
.B \-\-scan
option). There should only be one
.B MAILADDR
-line and it should have only one address.
-
+line and it should have only one address. Any subsequent addresses
+are silently ignored.
.TP
.B MAILFROM
.B CREATE
The
.B create
-line gives default values to be used when creating arrays and device entries for
-arrays.
+line gives default values to be used when creating arrays, new members
+of arrays, and device entries for arrays.
These include:
.RS 4
Give
.B symlinks=no
to suppress this symlink creation.
+
+.TP
+.B names=yes
+Since Linux 2.6.29 it has been possible to create
+.B md
+devices with a name like
+.B md_home
+rather than just a number, like
+.BR md3 .
+.I mdadm
+will use the numeric alternative by default as other tools that interact
+with md arrays may expect only numbers.
+If
+.B names=yes
+is given in
+.I mdadm.conf
+then
+.I mdadm
+will use a name when appropriate.
+If
+.B names=no
+is given, then non-numeric
+.I md
+device names will not be used even if the default changes in a future
+release of
+.IR mdadm .
+
+.TP
+.B bbl=no
+By default,
+.I mdadm
+will reserve space for a bad block list (bbl) on all devices
+included in or added to any array that supports them. Setting
+.B bbl=no
+will prevent this, so newly added devices will not have a bad
+block log.
.RE
.TP
used when creating arrays. This is the only case when there can be
more that one other word on the
.B HOMEHOST
-line.
+line. If there are other words, or other
+.B HOMEHOST
+lines, they are silently ignored.
If
.B <none>
.BR ddf ,
.BR imsm .
+.B AUTO
+should be given at most once. Subsequent lines are silently ignored.
+Thus an earlier config file in a config directory will over-ride
+the setting in a later config file.
+
.TP
.B POLICY
-This is used to specify what automatic behavior is allowed on devices
+This is used to specify what automatic behavior is allowed on devices
newly appearing in the system and provides a way of marking spares that can
be moved to other arrays as well as the migration domains.
.I Domain
of domains of all devices in that array. A spare can be automatically
moved from one array to another if the set of the destination array's
.I domains
-ppcontains all the
+contains all the
.I domains
of the new disk or if both arrays have the same
.IR spare-group .
.B mdadm \-\-udev\-rules
command after changing the config file
-Key words used in the
+Keywords used in the
.I POLICY
line and supported values are:
.B /dev/disk/by-path
.TP
.B type=
-either
+either
.B disk
or
.BR part .
.TP
.B action=
include, re-add, spare, spare-same-slot, or force-spare
+.TP
.B auto=
yes, no, or homehost.
.B include
allows adding a disk to an array if metadata on that disk matches that array
.TP
-.B re-add
+.B re\-add
will include the device in the array if it appears to be a current member
-or a member that was recently removed
+or a member that was recently removed and the array has a
+write-intent-bitmap to allow the
+.B re\-add
+functionality.
.TP
.B spare
as above and additionally: if the device is bare it can
degraded recently and the device plugged in has no metadata then it will
be automatically added to that array (or it's container)
.TP
-.B force-spare
+.B force\-spare
as above and the disk will become a spare in remaining cases
.RE
+.TP
+.B PART-POLICY
+This is similar to
+.B POLICY
+and accepts the same keyword assignments. It allows a consistent set
+of policies to applied to each of the partitions of a device.
+
+A
+.B PART-POLICY
+line should set
+.I type=disk
+and identify the path to one or more disk devices. Each partition on
+these disks will be treated according to the
+.I action=
+setting from this line. If a
+.I domain
+is set in the line, then the domain associated with each patition will
+be based on the domain, but with
+.RB \(dq -part N\(dq
+appended, when N is the partition number for the partition that was
+found.
+
+.TP
+.B SYSFS
+The SYSFS line lists custom values of MD device's sysfs attributes which will be
+stored in sysfs after the array is assembled. Multiple lines are allowed and each
+line has to contain the uuid or the name of the device to which it relates.
+.RS 4
+.TP
+.B uuid=
+hexadecimal identifier of MD device. This has to match the uuid stored in the
+superblock.
+.TP
+.B name=
+name of the MD device as was given to
+.I mdadm
+when the array was created. It will be ignored if
+.B uuid
+is not empty.
+.TP
+.RS 7
+
.SH EXAMPLE
DEVICE /dev/sd[bcdjkl]1
.br
.br
auto=part
.br
+# The name of this array contains a space.
+.br
+ARRAY /dev/md9 name='Data Storage'
+.sp
POLICY domain=domain1 metadata=imsm path=pci-0000:00:1f.2-scsi-*
.br
action=spare
.br
HOMEHOST <system>
.br
-AUTO +1.x homehost -all
+AUTO +1.x homehost \-all
+.br
+SYSFS name=/dev/md/raid5 group_thread_cnt=4 sync_speed_max=1000000
+.br
+SYSFS uuid=bead5eb6:31c17a27:da120ba2:7dfda40d group_thread_cnt=4
+sync_speed_max=1000000
.SH SEE ALSO
.BR mdadm (8),
.BR md (4).
-
projects / thirdparty / mdadm.git / blobdiff