multipath-tools: merge dcssblk in similar blacklist regex
[multipath-tools/.git] / multipath / multipath.conf.5
index 8377d14..367688e 100644 (file)
@@ -3,11 +3,11 @@
 .\" Make sure there are no errors with:
 .\" groff -z -wall -b -e -t multipath/multipath.conf.5
 .\"
-.\" TODO: Look for XXX
+.\" TODO: Look for XXX and ???
 .\"
 .\" ----------------------------------------------------------------------------
 .
-.TH MULTIPATH.CONF 5 2016-08-07 "Linux"
+.TH MULTIPATH.CONF 5 2016-08-12 "Linux"
 .
 .
 .\" ----------------------------------------------------------------------------
@@ -147,10 +147,11 @@ Default value is: \fBno\fR
 .
 .TP
 .B multipath_dir
-Directory where the dynamic shared objects are stored. Defined at compile time.
+Directory where the dynamic shared objects are stored.
 .RS
 .TP
-Default value is: \fB<system dependent>\fR, commonly \fI/lib64/multipath/\fR
+Default value is: \fB<system dependent>\fR. Defined at compile time, commonly
+\fI/lib64/multipath/\fR.
 .RE
 .
 .
@@ -162,14 +163,18 @@ kernel multipath target. There are three selector algorithms:
 .TP 12
 .I "round-robin 0"
 Loop through every path in the path group, sending the same amount of IO to
-each.
+each. Some aspects of behavior can be controlled with the attributes:
+\fIrr_min_io\fR, \fIrr_min_io_rq\fR and \fIrr_weight\fR.
 .TP
+.\" XXX
 .I "queue-length 0"
-Send the next bunch of IO down the path with the least amount of outstanding IO.
+(Since ??? kernel) Choose the path for the next bunch of IO based on the amount
+of outstanding IO to the path.
 .TP
+.\" XXX
 .I "service-time 0"
-Choose the path for the next bunch of IO based on the amount of outstanding IO
-to the path and its relative throughput.
+(Since ??? kernel) Choose the path for the next bunch of IO based on the amount
+of outstanding IO to the path and its relative throughput.
 .TP
 Default value is: \fBservice-time 0\fR
 .RE
@@ -240,7 +245,7 @@ generate the path priority. This prioritizer accepts the optional prio_arg
 .I emc
 (Hardware-dependent)
 Generate the path priority for DGC class arrays as CLARiiON CX/AX and
-EMC VNX families.
+EMC VNX and Unity families.
 .TP
 .I alua
 (Hardware-dependent)
@@ -302,8 +307,9 @@ regex can be of SCSI H:B:T:L format. For example: 1:0:.:. , *:0:0:.
 regex can be of device name format. For example: sda , sd.e
 .TP
 .I serial
-regex can be of serial number format. For example: .*J1FR.*324 . The serial can be looked
-up through sysfs or by running multipathd show paths format "%z". For example: 0395J1FR904324
+regex can be of serial number format. For example: .*J1FR.*324 . The serial can
+be looked up through sysfs or by running multipathd show paths format "%z". For
+example: 0395J1FR904324
 .TP
 .I wwn
 regex can be of the form \fI"host_wwnn:host_wwpn:target_wwnn:target_wwpn"\fR
@@ -330,22 +336,31 @@ Default value is: \fB<unset>\fR
 .TP
 .B features
 Specify any device-mapper features to be used. Syntax is \fInum list\fR
-where \fInum\fR is the number, between 0 and 6, of features in \fIlist\fR.
+where \fInum\fR is the number, between 0 and 8, of features in \fIlist\fR.
 Possible values for the feature list are:
 .RS
 .TP 12
+.\" XXX
 .I queue_if_no_path
-Queue IO if no path is active; identical to the \fIno_path_retry\fR keyword.
-See KNOWN ISSUES.
+(Superseded by \fIno_path_retry\fR) (Since ??? kernel) Queue IO if no path is active.
+Identical to the \fIno_path_retry\fR with \fIqueue\fR value. See KNOWN ISSUES.
 .TP
 .I no_partitions
 Disable automatic partitions generation via kpartx.
 .TP
-.I pg_init_retries
-Number of times to retry pg_init, it must be between 1 and 50.
+.\" XXX
+.I pg_init_retries <times>
+(Since ??? kernel) Number of times to retry pg_init, it must be between 1 and 50.
+.TP
+.\" XXX
+.I pg_init_delay_msecs <msecs>
+(Since ??? kernel) Number of msecs before pg_init retry, it must be between 0 and 60000.
 .TP
-.I pg_init_delay_msecs
-Number of msecs before pg_init retry, it must be between 0 and 60000.
+.\" XXX
+.I queue_mode <mode>
+(Since ??? kernel) Select the the queue_mode per multipath device.
+Where <mode> can be \fIbio\fR, \fIrq\fR or \fImq\fR. Which corresponds to
+bio-based, request_fn rq-based, and blk-mq rq-based respectively.
 .TP
 Default value is: \fB0\fR
 .RE
@@ -367,7 +382,7 @@ Issue a \fITEST UNIT READY\fR command to the device.
 .I emc_clariion
 (Hardware-dependent)
 Query the DGC/EMC specific EVPD page 0xC0 to determine the path state
-for CLARiiON CX/AX and EMC VNX arrays families.
+for CLARiiON CX/AX and EMC VNX and Unity arrays families.
 .TP
 .I hp_sw
 (Hardware-dependent)
@@ -407,6 +422,8 @@ Default value is: \fBmpath\fR
 .TP
 .B failback
 Tell multipathd how to manage path group failback.
+To select \fIimmediate\fR or a \fIvalue\fR, it's mandatory that the device
+has support for a working prioritizer.
 .RS
 .TP 12
 .I immediate
@@ -431,8 +448,9 @@ Default value is: \fBmanual\fR
 .
 .TP
 .B  rr_min_io
-The number of IO to route to a path before switching to the next in
-the same path group. This is only for BIO based multipath.
+Number of IO requests to route to a path before switching to the next in the
+same path group. This is only for \fIBlock I/O\fR(BIO) based multipath and 
+only apply to \fIround-robin\fR path_selector.
 .RS
 .TP
 Default value is: \fB1000\fR
@@ -441,8 +459,9 @@ Default value is: \fB1000\fR
 .
 .TP
 .B rr_min_io_rq
-The number of IO requests to route to a path before switching to the
-next in the same path group. This is only for request based multipath.
+Number of IO requests to route to a path before switching to the next in the
+same path group. This is only for \fIRequest\fR based multipath and
+only apply to \fIround-robin\fR path_selector.
 .RS
 .TP
 Default value is: \fB1\fR
@@ -465,11 +484,12 @@ Default value is: \fBmax\fR
 .
 .TP
 .B rr_weight
-If set to \fIpriorities\fR the multipath configurator will assign
-path weights as "path prio * rr_min_io". Possible values are
+If set to \fIpriorities\fR the multipath configurator will assign path weights
+as "path prio * rr_min_io". Possible values are
 .I priorities
 or
 .I uniform .
+Only apply to \fIround-robin\fR path_selector.
 .RS
 .TP
 Default value is: \fBuniform\fR
@@ -576,7 +596,8 @@ Default value is: \fB600\fR
 .
 .TP
 .B bindings_file
-The full pathname of the binding file to be used when the user_friendly_names option is set.
+The full pathname of the binding file to be used when the user_friendly_names
+option is set.
 .RS
 .TP
 Default value is: \fB/etc/multipath/bindings\fR
@@ -828,6 +849,10 @@ The following keywords are recognized:
 .TP 17
 .B devnode
 Regular expression of the device nodes to be excluded.
+.RS
+.TP
+Default value is: \fB^(ram|raw|loop|fd|md|dm-|sr|scd|st|dcssblk)[0-9]\fR, \fB^(td|hd|vd)[a-z]\fR and \fB^nvme\fR
+.RE
 .TP
 .B wwid
 The \fIWorld Wide Identification\fR of a device.
@@ -867,7 +892,7 @@ The \fIWorld Wide Identification\fR of a device.
 Regular expression of the udev property to be whitelisted.
 .RS
 .TP
-Default value is: \fB(ID_WWN|SCSI_IDENT_.*)\fR
+Default value is: \fB(SCSI_IDENT_|ID_WWN)\fR
 .RE
 .TP
 .B device
@@ -981,7 +1006,8 @@ The following hardware handler are implemented:
 .TP 12
 .I 1 emc
 (Hardware-dependent)
-Hardware handler for DGC class arrays as CLARiiON CX/AX and EMC VNX families.
+Hardware handler for DGC class arrays as CLARiiON CX/AX and EMC VNX and Unity
+families.
 .TP
 .I 1 rdac
 (Hardware-dependent)