multipathd: function return value tweaks
[multipath-tools/.git] / multipath / multipath.conf.5
1 .\" ----------------------------------------------------------------------------
2 .\" Update the date below if you make any significant change.
3 .\" Make sure there are no errors with:
4 .\" groff -z -wall -b -e -t multipath/multipath.conf.5
5 .\" man --warnings -E UTF-8 -l -Tutf8 -Z multipath/multipath.conf.5 >/dev/null
6 .\"
7 .\" TODO: Look for XXX and ???
8 .\"
9 .\" ----------------------------------------------------------------------------
10 .
11 .TH MULTIPATH.CONF 5 2018-05-21 Linux
12 .
13 .
14 .\" ----------------------------------------------------------------------------
15 .SH NAME
16 .\" ----------------------------------------------------------------------------
17 .
18 multipath.conf \- multipath daemon configuration file.
19 .
20 .
21 .\" ----------------------------------------------------------------------------
22 .SH DESCRIPTION
23 .\" ----------------------------------------------------------------------------
24 .
25 .B "/etc/multipath.conf"
26 is the configuration file for the multipath daemon. It is used to
27 overwrite the built-in configuration table of \fBmultipathd\fP.
28 Any line whose first non-white-space character is a '#' is considered
29 a comment line. Empty lines are ignored.
30 .PP
31 Currently used multipathd configuration can be displayed with the \fBmultipath -t\fR
32 or \fBmultipathd show config\fR command.
33 .
34 .
35 .\" ----------------------------------------------------------------------------
36 .SH SYNTAX
37 .\" ----------------------------------------------------------------------------
38 .
39 The configuration file contains entries of the form:
40 .RS
41 .nf
42 .ft B
43 .sp
44 <section> {
45 .RS
46 .ft B
47 <attribute> <value>
48 .I "..."
49 .ft B
50 <subsection> {
51 .RS
52 .ft B
53 <attribute> <value>
54 .I "..."
55 .RE
56 .ft B
57 }
58 .RE
59 .ft B
60 }
61 .ft R
62 .fi
63 .RE
64 .LP
65 Each \fIsection\fP contains one or more attributes or subsections. The
66 recognized keywords for attributes or subsections depend on the
67 section in which they occur.
68 .LP
69 .
70 \fB<attribute>\fR and \fB<value>\fR must be on a single line.
71 \fB<attribute>\fR is one of the keywords listed in this man page.
72 \fB<value>\fR is either a simple word (containing no whitespace and none of the
73 characters '\(dq', '#', and '!') or \fIone\fR string enclosed in double
74 quotes ("..."). Outside a quoted string, text starting with '#', and '!' is
75 regarded as a comment and ignored until the end of the line. Inside a quoted
76 string, '#' and '!' are normal characters, and whitespace is preserved.
77 To represent a double quote character inside a double quoted string, use two
78 consecutive double quotes ('""'). Thus '2.5\(dq SSD' can be written as "2.5"" SSD".
79 .LP
80 .
81 Opening braces ('{') must follow the (sub)section name on the same line. Closing
82 braces ('}') that mark the end of a (sub)section must be the only non-whitespace
83 character on the line. Whitespace is ignored except inside double quotes, thus
84 the indentation shown in the above example is helpful for human readers but
85 not mandatory.
86 .LP
87 .
88 .LP
89 .B Note on regular expressions:
90 The \fImultipath.conf\fR syntax allows many attribute values to be specified as POSIX
91 Extended Regular Expressions (see \fBregex\fR(7)). These regular expressions
92 are \fBcase sensitive\fR and \fBnot anchored\fR, thus the expression "bar" matches "barbie",
93 "rhabarber", and "wunderbar", but not "Barbie". To avoid unwanted substring
94 matches, standard regular expression syntax using the special characters "^" and "$" can be used.
95 .
96 .LP
97 .
98 The following \fIsection\fP keywords are recognized:
99 .TP 17
100 .B defaults
101 This section defines default values for attributes which are used
102 whenever no values are given in the appropriate device or multipath
103 sections.
104 .TP
105 .B blacklist
106 This section defines which devices should be excluded from the
107 multipath topology discovery.
108 .TP
109 .B blacklist_exceptions
110 This section defines which devices should be included in the
111 multipath topology discovery, despite being listed in the
112 \fIblacklist\fR section.
113 .TP
114 .B multipaths
115 This section defines the multipath topologies. They are indexed by a
116 \fIWorld Wide Identifier\fR(WWID). For details on the WWID generation
117 see section \fIWWID generation\fR below. Attributes set in this section take
118 precedence over all others.
119 .TP
120 .B devices
121 This section defines the device-specific settings. Devices are identified by
122 vendor, product, and revision.
123 .TP
124 .B overrides
125 This section defines values for attributes that should override the
126 device-specific settings for all devices.
127 .RE
128 .LP
129 .
130 .
131 .\" ----------------------------------------------------------------------------
132 .SH "defaults section"
133 .\" ----------------------------------------------------------------------------
134 .
135 The \fIdefaults\fR section recognizes the following keywords:
136 .
137 .
138 .TP 17
139 .B verbosity
140 Default verbosity. Higher values increase the verbosity level. Valid
141 levels are between 0 and 6.
142 .RS
143 .TP
144 The default is: \fB2\fR
145 .RE
146 .
147 .
148 .TP
149 .B polling_interval
150 Interval between two path checks in seconds. For properly functioning paths,
151 the interval between checks will gradually increase to \fImax_polling_interval\fR.
152 This value will be overridden by the \fIWatchdogSec\fR
153 setting in the multipathd.service definition if systemd is used.
154 .RS
155 .TP
156 The default is: \fB5\fR
157 .RE
158 .
159 .
160 .TP
161 .B max_polling_interval
162 Maximal interval between two path checks in seconds.
163 .RS
164 .TP
165 The default is: \fB4 * polling_interval\fR
166 .RE
167 .
168 .
169 .TP
170 .B reassign_maps
171 Enable reassigning of device-mapper maps. With this option multipathd
172 will remap existing device-mapper maps to always point to multipath
173 device, not the underlying block devices. Possible values are
174 \fIyes\fR and \fIno\fR.
175 .RS
176 .TP
177 The default is: \fBno\fR
178 .RE
179 .
180 .
181 .TP
182 .B multipath_dir
183 Directory where the dynamic shared objects are stored. Defined at compile time,
184 commonly \fI/lib64/multipath/\fR or \fI/lib/multipath/\fR.
185 .RS
186 .TP
187 The default is: \fB<system dependent>\fR
188 .RE
189 .
190 .
191 .TP
192 .B path_selector
193 The default path selector algorithm to use; they are offered by the
194 kernel multipath target. There are three selector algorithms:
195 .RS
196 .TP 12
197 .I "round-robin 0"
198 Loop through every path in the path group, sending the same amount of I/O to
199 each. Some aspects of behavior can be controlled with the attributes:
200 \fIrr_min_io\fR, \fIrr_min_io_rq\fR and \fIrr_weight\fR.
201 .TP
202 .I "queue-length 0"
203 (Since 2.6.31 kernel) Choose the path for the next bunch of I/O based on the amount
204 of outstanding I/O to the path.
205 .TP
206 .I "service-time 0"
207 (Since 2.6.31 kernel) Choose the path for the next bunch of I/O based on the amount
208 of outstanding I/O to the path and its relative throughput.
209 .TP
210 The default is: \fBservice-time 0\fR
211 .RE
212 .
213 .
214 .TP
215 .B path_grouping_policy
216 The default path grouping policy to apply to unspecified
217 multipaths. Possible values are:
218 .RS
219 .TP 12
220 .I failover
221 One path per priority group.
222 .TP
223 .I multibus
224 All paths in one priority group.
225 .TP
226 .I group_by_serial
227 One priority group per serial number.
228 .TP
229 .I group_by_prio
230 One priority group per priority value. Priorities are determined by
231 callout programs specified as a global, per-controller or
232 per-multipath option in the configuration file.
233 .TP
234 .I group_by_node_name
235 One priority group per target node name. Target node names are fetched
236 in \fI/sys/class/fc_transport/target*/node_name\fR.
237 .TP
238 The default is: \fBfailover\fR
239 .RE
240 .
241 .
242 .TP
243 .B uid_attrs
244 The udev attribute providing a unique path identifier for corresponding
245 type of path devices. If this field is configured and matched with type
246 of device, it would override any other methods providing for device
247 unique identifier in config file, and it would activate merging uevents
248 according to the identifier to promote effiecncy in processing uevents.
249 It has no default value, if you want to identify path by udev attribute
250 and to activate merging uevents for SCSI and DASD devices, you can set
251 its value as: \fIuid_attrs "sd:ID_SERIAL dasd:ID_UID"\fR.
252 .RS
253 .TP
254 The default is: \fB<unset>\fR
255 .RE
256 .
257 .
258 .TP
259 .B uid_attribute
260 The udev attribute providing a unique path identifier.
261 .RS
262 .TP
263 The default is: for SCSI devices \fBID_SERIAL\fR
264 .TP
265 The default is: for DASD devices \fBID_UID\fR
266 .TP
267 The default is: for NVME devices \fBID_WWN\fR
268 .RE
269 .
270 .
271 .TP
272 .B getuid_callout
273 (Superseded by \fIuid_attribute\fR) The default program and args to callout
274 to obtain a unique path identifier. Should be specified with an absolute path.
275 .RS
276 .TP
277 The default is: \fB<unset>\fR
278 .RE
279 .
280 .
281 .TP
282 .B prio
283 The name of the path priority routine. The specified routine
284 should return a numeric value specifying the relative priority
285 of this path. Higher number have a higher priority.
286 \fI"none"\fR is a valid value. Currently the following path priority routines
287 are implemented:
288 .RS
289 .TP 12
290 .I const
291 Return a constant priority of \fI1\fR.
292 .TP
293 .I sysfs
294 Use the sysfs attributes \fIaccess_state\fR and \fIpreferred_path\fR to
295 generate the path priority. This prioritizer accepts the optional prio_arg
296 \fIexclusive_pref_bit\fR.
297 .TP
298 .I emc
299 (Hardware-dependent)
300 Generate the path priority for DGC class arrays as CLARiiON CX/AX and
301 EMC VNX and Unity families.
302 .TP
303 .I alua
304 (Hardware-dependent)
305 Generate the path priority based on the SCSI-3 ALUA settings. This prioritizer
306 accepts the optional prio_arg \fIexclusive_pref_bit\fR.
307 .TP
308 .I ontap
309 (Hardware-dependent)
310 Generate the path priority for NetApp ONTAP class and OEM arrays as IBM NSeries.
311 .TP
312 .I rdac
313 (Hardware-dependent)
314 Generate the path priority for LSI/Engenio/NetApp RDAC class as NetApp SANtricity
315 E/EF Series, and OEM arrays from IBM DELL SGI STK and SUN.
316 .TP
317 .I hp_sw
318 (Hardware-dependent)
319 Generate the path priority for HP/COMPAQ/DEC HSG80 and MSA/HSV arrays with
320 Active/Standby mode exclusively.
321 .TP
322 .I hds
323 (Hardware-dependent)
324 Generate the path priority for Hitachi AMS families of arrays other than AMS 2000.
325 .TP
326 .I random
327 Generate a random priority between 1 and 10.
328 .TP
329 .I weightedpath
330 Generate the path priority based on the regular expression and the
331 priority provided as argument. Requires prio_args keyword.
332 .TP
333 .I path_latency
334 Generate the path priority based on a latency algorithm.
335 Requires prio_args keyword.
336 .TP
337 .I datacore
338 (Hardware-dependent)
339 Generate the path priority for some DataCore storage arrays. Requires prio_args
340 keyword.
341 .TP
342 .I iet
343 (iSCSI only)
344 Generate path priority for iSCSI targets based on IP address. Requires
345 prio_args keyword.
346 .PP
347 The default depends on the \fBdetect_prio\fR setting: If \fBdetect_prio\fR is
348 \fByes\fR (default), the default priority algorithm is \fBsysfs\fR (except for
349 NetAPP E-Series, where it is \fBalua\fR). If \fBdetect_prio\fR is
350 \fBno\fR, the default priority algorithm is \fBconst\fR.
351 .RE
352 .
353 .
354 .TP
355 .B prio_args
356 Arguments to pass to to the prio function. This only applies to certain
357 prioritizers:
358 .RS
359 .TP 12
360 .I weighted
361 Needs a value of the form
362 \fI"<hbtl|devname|serial|wwn> <regex1> <prio1> <regex2> <prio2> ..."\fR
363 .RS
364 .TP 8
365 .I hbtl
366 Regex can be of SCSI H:B:T:L format. For example: 1:0:.:. , *:0:0:.
367 .TP
368 .I devname
369 Regex can be of device name format. For example: sda , sd.e
370 .TP
371 .I serial
372 Regex can be of serial number format. For example: .*J1FR.*324 . The serial can
373 be looked up through sysfs or by running multipathd show paths format "%z". For
374 example: 0395J1FR904324
375 .TP
376 .I wwn
377 Regex can be of the form \fI"host_wwnn:host_wwpn:target_wwnn:target_wwpn"\fR
378 these values can be looked up through sysfs or by running \fImultipathd show paths format
379 "%N:%R:%n:%r"\fR. For example: 0x200100e08ba0aea0:0x210100e08ba0aea0:.*:.* , .*:.*:iqn.2009-10.com.redhat.msp.lab.ask-06:.*
380 .RE
381 .TP 12
382 .I path_latency
383 Needs a value of the form "io_num=\fI<20>\fR base_num=\fI<10>\fR"
384 .RS
385 .TP 8
386 .I io_num
387 The number of read IOs sent to the current path continuously, used to calculate the average path latency.
388 Valid Values: Integer, [2, 200].
389 .TP
390 .I base_num
391 The base number value of logarithmic scale, used to partition different priority ranks. Valid Values: Integer,
392 [2, 10]. And Max average latency value is 100s, min average latency value is 1us.
393 For example: If base_num=10, the paths will be grouped in priority groups with path latency <=1us, (1us, 10us],
394 (10us, 100us], (100us, 1ms], (1ms, 10ms], (10ms, 100ms], (100ms, 1s], (1s, 10s], (10s, 100s], >100s.
395 .RE
396 .TP 12
397 .I alua
398 If \fIexclusive_pref_bit\fR is set, paths with the \fIpreferred path\fR bit
399 set will always be in their own path group.
400 .TP
401 .I sysfs
402 If \fIexclusive_pref_bit\fR is set, paths with the \fIpreferred path\fR bit
403 set will always be in their own path group.
404 .TP
405 .I datacore
406 .RS
407 .TP 8
408 .I preferredsds
409 (Mandatory) The preferred "SDS name".
410 .TP
411 .I timeout
412 (Optional) The timeout for the INQUIRY, in ms.
413 .RE
414 .TP 12
415 .I iet
416 .RS
417 .TP 8
418 .I preferredip=...
419 (Mandatory) Th preferred IP address, in dotted decimal notation, for iSCSI targets.
420 .RE
421 .TP
422 The default is: \fB<unset>\fR
423 .RE
424 .
425 .
426 .TP
427 .B features
428 Specify any device-mapper features to be used. Syntax is \fInum list\fR
429 where \fInum\fR is the number, between 0 and 8, of features in \fIlist\fR.
430 Possible values for the feature list are:
431 .RS
432 .TP 12
433 .I queue_if_no_path
434 (Deprecated, superseded by \fIno_path_retry\fR) Queue I/O if no path is active.
435 Identical to the \fIno_path_retry\fR with \fIqueue\fR value. If both this
436 feature and \fIno_path_retry\fR are set, the latter value takes
437 precedence. See KNOWN ISSUES.
438 .TP
439 .I pg_init_retries <times>
440 (Since kernel 2.6.24) Number of times to retry pg_init, it must be between 1 and 50.
441 .TP
442 .I pg_init_delay_msecs <msecs>
443 (Since kernel 2.6.38) Number of msecs before pg_init retry, it must be between 0 and 60000.
444 .TP
445 .I queue_mode <mode>
446 (Since kernel 4.8) Select the the queueing mode per multipath device.
447 <mode> can be \fIbio\fR, \fIrq\fR or \fImq\fR, which corresponds to
448 bio-based, request-based, and block-multiqueue (blk-mq) request-based,
449 respectively.
450 The default depends on the kernel parameter \fBdm_mod.use_blk_mq\fR. It is
451 \fImq\fR if the latter is set, and \fIrq\fR otherwise.
452 .TP
453 The default is: \fB<unset>\fR
454 .RE
455 .
456 .
457 .TP
458 .B path_checker
459 The default method used to determine the paths state. Possible values
460 are:
461 .RS
462 .TP 12
463 .I readsector0
464 (Deprecated) Read the first sector of the device. This checker is being
465 deprecated, please use \fItur\fR instead.
466 .TP
467 .I tur
468 Issue a \fITEST UNIT READY\fR command to the device.
469 .TP
470 .I emc_clariion
471 (Hardware-dependent)
472 Query the DGC/EMC specific EVPD page 0xC0 to determine the path state
473 for CLARiiON CX/AX and EMC VNX and Unity arrays families.
474 .TP
475 .I hp_sw
476 (Hardware-dependent)
477 Check the path state for HP/COMPAQ/DEC HSG80 and MSA/HSV arrays with
478 Active/Standby mode exclusively.
479 .TP
480 .I rdac
481 (Hardware-dependent)
482 Check the path state for LSI/Engenio/NetApp RDAC class as NetApp SANtricity E/EF
483 Series, and OEM arrays from IBM DELL SGI STK and SUN.
484 .TP
485 .I directio
486 (Deprecated) Read the first sector with direct I/O. This checker is being
487 deprecated, it could cause spurious path failures under high load.
488 Please use \fItur\fR instead.
489 .TP
490 .I cciss_tur
491 (Hardware-dependent)
492 Check the path state for HP/COMPAQ Smart Array(CCISS) controllers.
493 .TP
494 .I none
495 Do not check the device, fallback to use the values retrieved from sysfs
496 .TP
497 The default is: \fBtur\fR
498 .RE
499 .
500 .
501 .TP
502 .B alias_prefix
503 The \fIuser_friendly_names\fR prefix.
504 .RS
505 .TP
506 The default is: \fBmpath\fR
507 .RE
508 .
509 .
510 .TP
511 .B failback
512 Tell multipathd how to manage path group failback.
513 To select \fIimmediate\fR or a \fIvalue\fR, it's mandatory that the device
514 has support for a working prioritizer.
515 .RS
516 .TP 12
517 .I immediate
518 Immediately failback to the highest priority pathgroup that contains
519 active paths.
520 .TP
521 .I manual
522 Do not perform automatic failback.
523 .TP
524 .I followover
525 Used to deal with multiple computers accessing the same Active/Passive storage
526 devices. Only perform automatic failback when the first path of a pathgroup
527 becomes active. This keeps a cluster node from automatically failing back when
528 another node requested the failover.
529 .TP
530 .I values > 0
531 Deferred failback (time to defer in seconds).
532 .TP
533 The default is: \fBmanual\fR
534 .RE
535 .
536 .
537 .TP
538 .B  rr_min_io
539 Number of I/O requests to route to a path before switching to the next in the
540 same path group. This is only for \fIBlock I/O\fR(BIO) based multipath and
541 only apply to \fIround-robin\fR path_selector.
542 .RS
543 .TP
544 The default is: \fB1000\fR
545 .RE
546 .
547 .
548 .TP
549 .B rr_min_io_rq
550 Number of I/O requests to route to a path before switching to the next in the
551 same path group. This is only for \fIRequest\fR based multipath and
552 only apply to \fIround-robin\fR path_selector.
553 .RS
554 .TP
555 The default is: \fB1\fR
556 .RE
557 .
558 .
559 .TP
560 .B max_fds
561 Specify the maximum number of file descriptors that can be opened by multipath
562 and multipathd. This is equivalent to ulimit \-n. A value of \fImax\fR will set
563 this to the system limit from \fI/proc/sys/fs/nr_open\fR. If this is not set, the
564 maximum number of open fds is taken from the calling process. It is usually
565 1024. To be safe, this should be set to the maximum number of paths plus 32,
566 if that number is greated than 1024.
567 .RS
568 .TP
569 The default is: \fBmax\fR
570 .RE
571 .
572 .
573 .TP
574 .B rr_weight
575 If set to \fIpriorities\fR the multipath configurator will assign path weights
576 as "path prio * rr_min_io". Possible values are
577 .I priorities
578 or
579 .I uniform .
580 Only apply to \fIround-robin\fR path_selector.
581 .RS
582 .TP
583 The default is: \fBuniform\fR
584 .RE
585 .
586 .
587 .TP
588 .B no_path_retry
589 Specify what to do when all paths are down. Possible values are:
590 .RS
591 .TP 12
592 .I value > 0
593 Number of retries until disable I/O queueing.
594 .TP
595 .I fail
596 For immediate failure (no I/O queueing).
597 .TP
598 .I queue
599 For never stop I/O queueing, similar to \fIqueue_if_no_path\fR. See KNOWN ISSUES.
600 .TP
601 The default is: \fBfail\fR
602 .RE
603 .
604 .
605 .TP
606 .B queue_without_daemon
607 If set to
608 .I no
609 , when multipathd stops, queueing will be turned off for all devices.
610 This is useful for devices that set no_path_retry. If a machine is
611 shut down while all paths to a device are down, it is possible to hang waiting
612 for I/O to return from the device after multipathd has been stopped. Without
613 multipathd running, access to the paths cannot be restored, and the kernel
614 cannot be told to stop queueing I/O. Setting queue_without_daemon to
615 .I no
616 , avoids this problem.
617 .RS
618 .TP
619 The default is: \fBno\fR
620 .RE
621 .
622 .
623 .TP
624 .B checker_timeout
625 Specify the timeout to use for path checkers and prioritizers that issue SCSI
626 commands with an explicit timeout, in seconds.
627 .RS
628 .TP
629 The default is: in \fB/sys/block/sd<x>/device/timeout\fR
630 .RE
631 .
632 .
633 .TP
634 .B flush_on_last_del
635 If set to
636 .I yes
637 , multipathd will disable queueing when the last path to a device has been
638 deleted.
639 .RS
640 .TP
641 The default is: \fBno\fR
642 .RE
643 .
644 .
645 .TP
646 .B user_friendly_names
647 If set to
648 .I yes
649 , using the bindings file \fI/etc/multipath/bindings\fR to assign a persistent
650 and unique alias to the multipath, in the form of mpath<n>. If set to
651 .I no
652 use the WWID as the alias. In either case this be will
653 be overridden by any specific aliases in the \fImultipaths\fR section.
654 .RS
655 .TP
656 The default is: \fBno\fR
657 .RE
658 .
659 .
660 .TP
661 .B fast_io_fail_tmo
662 Specify the number of seconds the SCSI layer will wait after a problem has been
663 detected on a FC remote port before failing I/O to devices on that remote port.
664 This should be smaller than dev_loss_tmo. Setting this to
665 .I off
666 will disable the timeout.
667 .RS
668 .TP
669 The default is: in \fB5\fR
670 .RE
671 .
672 .
673 .TP
674 .B dev_loss_tmo
675 Specify the number of seconds the SCSI layer will wait after a problem has
676 been detected on a FC remote port before removing it from the system. This
677 can be set to "infinity" which sets it to the max value of 2147483647
678 seconds, or 68 years. It will be automatically adjusted to the overall
679 retry interval \fIno_path_retry\fR * \fIpolling_interval\fR
680 if a number of retries is given with \fIno_path_retry\fR and the
681 overall retry interval is longer than the specified \fIdev_loss_tmo\fR value.
682 The Linux kernel will cap this value to \fI600\fR if \fIfast_io_fail_tmo\fR
683 is not set. See KNOWN ISSUES.
684 .RS
685 .TP
686 The default is: \fB600\fR
687 .RE
688 .
689 .
690 .TP
691 .B bindings_file
692 The full pathname of the binding file to be used when the user_friendly_names
693 option is set.
694 .RS
695 .TP
696 The default is: \fB/etc/multipath/bindings\fR
697 .RE
698 .
699 .
700 .TP
701 .B wwids_file
702 The full pathname of the WWIDs file, which is used by multipath to keep track
703 of the WWIDs for LUNs it has created multipath devices on in the past.
704 .RS
705 .TP
706 The default is: \fB/etc/multipath/wwids\fR
707 .RE
708 .
709 .
710 .TP
711 .B prkeys_file
712 The full pathname of the prkeys file, which is used by multipathd to keep
713 track of the persistent reservation key used for a specific WWID, when
714 \fIreservation_key\fR is set to \fBfile\fR.
715 .RS
716 .TP
717 The default is \fB/etc/multipath/prkeys\fR
718 .RE
719 .
720 .
721 .TP
722 .B log_checker_err
723 If set to
724 .I once
725 , multipathd logs the first path checker error at logging level 2. Any later
726 errors are logged at level 3 until the device is restored. If set to
727 .I always
728 , multipathd always logs the path checker error at logging level 2.
729 .RS
730 .TP
731 The default is: \fBalways\fR
732 .RE
733 .
734 .
735 .TP
736 .B reservation_key
737 This is the service action reservation key used by mpathpersist. It must be
738 set for all multipath devices using persistent reservations, and it must be
739 the same as the RESERVATION KEY field of the PERSISTENT RESERVE OUT parameter
740 list which contains an 8-byte value provided by the application client to the
741 device server to identify the I_T nexus. If the \fI--param-aptpl\fR option is
742 used when registering the key with mpathpersist, \fB:aptpl\fR must be appended
743 to the end of the reservation key.
744 .RS
745 .PP
746 Alternatively, this can be set to \fBfile\fR, which will store the RESERVATION
747 KEY registered by mpathpersist in the \fIprkeys_file\fR. multipathd will then
748 use this key to register additional paths as they appear.  When the
749 registration is removed, the RESERVATION KEY is removed from the
750 \fIprkeys_file\fR. The prkeys file will automatically keep track of whether
751 the key was registered with \fI--param-aptpl\fR.
752 .TP
753 The default is: \fB<unset>\fR
754 .RE
755 .
756 .
757 .TP
758 .B all_tg_pt
759 Set the 'all targets ports' flag when registering keys with mpathpersist. Some
760 arrays automatically set and clear registration keys on all target ports from a
761 host, instead of per target port per host. The ALL_TG_PT flag must be set to
762 successfully use mpathpersist on these arrays. Setting this option is identical
763 to calling mpathpersist with \fI--param-alltgpt\fR
764 .RS
765 .TP
766 The default is: \fBno\fR
767 .RE
768 .
769 .
770 .TP
771 .B retain_attached_hw_handler
772 (Obsolete for kernels >= 4.3) If set to
773 .I yes
774 and the SCSI layer has already attached a hardware_handler to the device,
775 multipath will not force the device to use the hardware_handler specified by
776 mutipath.conf. If the SCSI layer has not attached a hardware handler,
777 multipath will continue to use its configured hardware handler.
778 .RS
779 .PP
780 The default is: \fByes\fR
781 .PP
782 \fBImportant Note:\fR Linux kernel 4.3 or newer always behaves as if
783 \fB"retain_attached_hw_handler yes"\fR was set.
784 .RE
785 .
786 .
787 .TP
788 .B detect_prio
789 If set to
790 .I yes
791 , multipath will try to detect if the device supports SCSI-3 ALUA. If so, the
792 device will automatically use the \fIsysfs\fR prioritizer if the required sysf
793 attributes \fIaccess_state\fR and \fIpreferred_path\fR are supported, or the
794 \fIalua\fR prioritizer if not. If set to
795 .I no
796 , the prioritizer will be selected as usual.
797 .RS
798 .TP
799 The default is: \fByes\fR
800 .RE
801 .
802 .
803 .TP
804 .B detect_checker
805 if set to
806 .I yes
807 , multipath will try to detect if the device supports SCSI-3 ALUA. If so, the
808 device will automatically use the \fItur\fR checker. If set to
809 .I no
810 , the checker will be selected as usual.
811 .RS
812 .TP
813 The default is: \fByes\fR
814 .RE
815 .
816 .
817 .TP
818 .B force_sync
819 If set to
820 .I yes
821 , multipathd will call the path checkers in sync mode only.  This means that
822 only one checker will run at a time.  This is useful in the case where many
823 multipathd checkers running in parallel causes significant CPU pressure.
824 .RS
825 .TP
826 The default is: \fBno\fR
827 .RE
828 .
829 .
830 .TP
831 .B strict_timing
832 If set to
833 .I yes
834 , multipathd will start a new path checker loop after exactly one second,
835 so that each path check will occur at exactly \fIpolling_interval\fR
836 seconds. On busy systems path checks might take longer than one second;
837 here the missing ticks will be accounted for on the next round.
838 A warning will be printed if path checks take longer than \fIpolling_interval\fR
839 seconds.
840 .RS
841 .TP
842 The default is: \fBno\fR
843 .RE
844 .
845 .
846 .TP
847 .B deferred_remove
848 If set to
849 .I yes
850 , multipathd will do a deferred remove instead of a regular remove when the
851 last path device has been deleted.  This means that if the multipath device is
852 still in use, it will be freed when the last user closes it.  If path is added
853 to the multipath device before the last user closes it, the deferred remove
854 will be canceled.
855 .RS
856 .TP
857 The default is: \fBno\fR
858 .RE
859 .
860 .
861 .TP
862 .B partition_delimiter
863 This parameter controls how multipath chooses the names of partition devices
864 of multipath maps if a multipath map is renamed (e.g. if a map alias is added
865 or changed). If this parameter is set to a string other than "/UNSET/" (even
866 the empty string), multipath inserts that string between device name and
867 partition number to construct the partition device name.
868 Otherwise (i.e. if this parameter is unset or has the value "/UNSET/"),
869 the behavior depends on the map name: if it ends in a digit, a \fI"p"\fR is
870 inserted between name and partition number; otherwise, the partition number is
871 simply appended.
872 Distributions may use a non-null default value for this option; in this case,
873 the user must set it to "/UNSET/" to obtain the original \fB<unset>\fR
874 behavior. Use \fImultipath -T\fR to check the current settings.
875 .RS
876 .TP
877 The default is: \fB<unset>\fR
878 .RE
879 .
880 .
881 .TP
882 .B config_dir
883 If set to anything other than "", multipath will search this directory
884 alphabetically for file ending in ".conf" and it will read configuration
885 information from them, just as if it was in \fI/etc/multipath.conf\fR.
886 config_dir must either be "" or a fully qualified directory name.
887 .RS
888 .TP
889 The default is: \fB/etc/multipath/conf.d/\fR
890 .RE
891 .
892 .
893 .TP
894 .B marginal_path_double_failed_time
895 One of the four parameters of supporting path check based on accounting IO
896 error such as intermittent error. When a path failed event occurs twice in
897 \fImarginal_path_double_failed_time\fR seconds due to an IO error and all the
898 other three parameters are set, multipathd will fail the path and enqueue
899 this path into a queue of which members are sent a couple of continuous
900 direct reading asynchronous IOs at a fixed sample rate of 10HZ to start IO
901 error accounting process.
902 .RS
903 .TP
904 The default is: \fBno\fR
905 .RE
906 .
907 .
908 .TP
909 .B marginal_path_err_sample_time
910 One of the four parameters of supporting path check based on accounting IO
911 error such as intermittent error. If it is set to a value no less than 120,
912 when a path fail event occurs twice in \fImarginal_path_double_failed_time\fR
913 second due to an IO error, multipathd will fail the path and enqueue this
914 path into a queue of which members are sent a couple of continuous direct
915 reading asynchronous IOs at a fixed sample rate of 10HZ to start the IO
916 accounting process for the path will last for
917 \fImarginal_path_err_sample_time\fR.
918 If the rate of IO error on a particular path is greater than the
919 \fImarginal_path_err_rate_threshold\fR, then the path will not reinstate for
920 \fImarginal_path_err_recheck_gap_time\fR seconds unless there is only one
921 active path. After \fImarginal_path_err_recheck_gap_time\fR expires, the path
922 will be requeueed for rechecking. If checking result is good enough, the
923 path will be reinstated.
924 .RS
925 .TP
926 The default is: \fBno\fR
927 .RE
928 .
929 .
930 .TP
931 .B marginal_path_err_rate_threshold
932 The error rate threshold as a permillage (1/1000). One of the four parameters
933 of supporting path check based on accounting IO error such as intermittent
934 error. Refer to \fImarginal_path_err_sample_time\fR. If the rate of IO errors
935 on a particular path is greater than this parameter, then the path will not
936 reinstate for \fImarginal_path_err_recheck_gap_time\fR seconds unless there is
937 only one active path.
938 .RS
939 .TP
940 The default is: \fBno\fR
941 .RE
942 .
943 .
944 .TP
945 .B marginal_path_err_recheck_gap_time
946 One of the four parameters of supporting path check based on accounting IO
947 error such as intermittent error. Refer to
948 \fImarginal_path_err_sample_time\fR. If this parameter is set to a positive
949 value, the failed path of  which the IO error rate is larger than
950 \fImarginal_path_err_rate_threshold\fR will be kept in failed state for
951 \fImarginal_path_err_recheck_gap_time\fR seconds. When
952 \fImarginal_path_err_recheck_gap_time\fR seconds expires, the path will be
953 requeueed for checking. If checking result is good enough, the path will be
954 reinstated, or else it will keep failed.
955 .RS
956 .TP
957 The default is: \fBno\fR
958 .RE
959 .
960 .
961 .TP
962 .B delay_watch_checks
963 If set to a value greater than 0, multipathd will watch paths that have
964 recently become valid for this many checks. If they fail again while they are
965 being watched, when they next become valid, they will not be used until they
966 have stayed up for \fIdelay_wait_checks\fR checks.
967 .RS
968 .TP
969 The default is: \fBno\fR
970 .RE
971 .
972 .
973 .TP
974 .B delay_wait_checks
975 If set to a value greater than 0, when a device that has recently come back
976 online fails again within \fIdelay_watch_checks\fR checks, the next time it
977 comes back online, it will marked and delayed, and not used until it has passed
978 \fIdelay_wait_checks\fR checks.
979 .RS
980 .TP
981 The default is: \fBno\fR
982 .RE
983 .
984 .
985 .TP
986 .B find_multipaths
987 This option controls whether multipath and multipathd try to create multipath
988 maps over non-blacklisted devices they encounter. This matters a) when a device is
989 encountered by \fBmultipath -u\fR during udev rule processing (a device is
990 blocked from further processing by higher layers - such as LVM - if and only
991 if it\'s considered a valid multipath device path), and b) when multipathd
992 detects a new device. The following values are possible:
993 .RS
994 .TP 10
995 .I strict
996 Both multipath and multipathd treat only such devices as multipath devices
997 which have been part of a multipath map previously, and which are therefore
998 listed in the \fBwwids_file\fR. Users can manually set up multipath maps using the
999 \fBmultipathd add map\fR command. Once set up manually, the map is
1000 remembered in the wwids file and will be set up automatically in the future.
1001 .TP
1002 .I no
1003 Multipath behaves like \fBstrict\fR. Multipathd behaves like \fBgreedy\fR.
1004 .TP
1005 .I yes
1006 Both multipathd and multipath treat a device as multipath device if the
1007 conditions for \fBstrict\fR are met, or if at least two non-blacklisted paths
1008 with the same WWID have been detected.
1009 .TP
1010 .I greedy
1011 Both multipathd and multipath treat every non-blacklisted device as multipath
1012 device path.
1013 .TP
1014 .I smart
1015 This differs from \fIfind_multipaths yes\fR only in
1016 the way it treats new devices for which only one path has been
1017 detected yet. When such a device is first encounted in udev rules, it is
1018 treated as a multipath device. multipathd waits whether additional paths with
1019 the same WWID appears. If that happens, it sets up a multipath map. If it
1020 doesn\'t happen until a
1021 timeout expires, or if setting up the map fails, a new uevent is triggered for
1022 the device; at second encounter in the udev rules, the device will be treated
1023 as non-multipath and passed on to upper layers.
1024 \fBNote:\fR this may cause delays during device detection if
1025 there are single-path devices which aren\'t blacklisted.
1026 .TP
1027 The default is: \fBstrict\fR
1028 .RE
1029 .
1030 .
1031 .TP
1032 .B find_multipaths_timeout
1033 Timeout, in seconds, to wait for additional paths after detecting the first
1034 one, if \fIfind_multipaths
1035 "smart"\fR (see above) is set. If the value is \fBpositive\fR, this timeout is used for all
1036 unknown, non-blacklisted devices encountered. If the value is \fBnegative\fR
1037 (recommended), it's only
1038 applied to "known" devices that have an entry in multipath's hardware table,
1039 either in the built-in table or in a \fIdevice\fR section; other ("unknown") devices will
1040 use a timeout of only 1 second to avoid booting delays. The value 0 means
1041 "use the built-in default". If \fIfind_multipath\fR has a value
1042 other than \fIsmart\fR, this option has no effect.
1043 .RS
1044 .TP
1045 The default is: \fB-10\fR (10s for known and 1s for unknown hardware)
1046 .RE
1047 .
1048 .
1049 .TP
1050 .B uxsock_timeout
1051 CLI receive timeout in milliseconds. For larger systems CLI commands
1052 might timeout before the multipathd lock is released and the CLI command
1053 can be processed. This will result in errors like
1054 "timeout receiving packet" to be returned from CLI commands.
1055 In these cases it is recommended to increase the CLI timeout to avoid
1056 those issues.
1057 .RS
1058 .TP
1059 The default is: \fB1000\fR
1060 .RE
1061 .
1062 .
1063 .TP
1064 .B retrigger_tries
1065 Sets the number of times multipathd will try to retrigger a uevent to get the
1066 WWID.
1067 .RS
1068 .TP
1069 The default is: \fB3\fR
1070 .RE
1071 .
1072 .
1073 .TP
1074 .B retrigger_delay
1075 Sets the amount of time, in seconds, to wait between retriggers.
1076 .RS
1077 .TP
1078 The default is: \fB10\fR
1079 .RE
1080 .
1081 .
1082 .TP
1083 .B missing_uev_wait_timeout
1084 Controls how many seconds multipathd will wait, after a new multipath device
1085 is created, to receive a change event from udev for the device, before
1086 automatically enabling device reloads. Usually multipathd will delay reloads
1087 on a device until it receives a change uevent from the initial table load.
1088 .RS
1089 .TP
1090 The default is: \fB30\fR
1091 .RE
1092 .
1093 .
1094 .TP
1095 .B skip_kpartx
1096 If set to
1097 .I yes
1098 , kpartx will not automatically create partitions on the device.
1099 .RS
1100 .TP
1101 The default is: \fBno\fR
1102 .RE
1103 .
1104 .
1105 .TP
1106 .B disable_changed_wwids
1107 If set to \fIyes\fR, multipathd will check the path wwid on change events, and
1108 if it has changed from the wwid of the multipath device, multipathd will
1109 disable access to the path until the wwid changes back.
1110 .RS
1111 .TP
1112 The default is: \fBno\fR
1113 .RE
1114 .
1115 .
1116 .TP
1117 .B remove_retries
1118 This sets how may times multipath will retry removing a device that is in-use.
1119 Between each attempt, multipath will sleep 1 second.
1120 .RS
1121 .TP
1122 The default is: \fB0\fR
1123 .RE
1124 .
1125 .
1126 .TP
1127 .B max_sectors_kb
1128 Sets the max_sectors_kb device parameter on all path devices and the multipath
1129 device to the specified value.
1130 .RS
1131 .TP
1132 The default is: \fB<device dependent>\fR
1133 .RE
1134 .
1135 .
1136 .TP
1137 .B ghost_delay
1138 Sets the number of seconds that multipath will wait after creating a device
1139 with only ghost paths before marking it ready for use in systemd. This gives
1140 the active paths time to appear before the multipath runs the hardware handler
1141 to switch the ghost paths to active ones. Setting this to \fI0\fR or \fIon\fR
1142 makes multipath immediately mark a device with only ghost paths as ready.
1143 .RS
1144 .TP
1145 The default is \fBno\fR
1146 .RE
1147 .
1148 .
1149 .\" ----------------------------------------------------------------------------
1150 .SH "blacklist and blacklist_exceptions sections"
1151 .\" ----------------------------------------------------------------------------
1152 .
1153 The \fIblacklist\fR section is used to exclude specific devices from
1154 the multipath topology. It is most commonly used to exclude local disks or
1155 non-disk devices (such as LUNs for the storage array controller) from
1156 being handled by multipath-tools.
1157 .LP
1158 .
1159 .
1160 The \fIblacklist_exceptions\fR section is used to revert the actions of the
1161 \fIblacklist\fR section. This allows one to selectively include ("whitelist") devices which
1162 would normally be excluded via the \fIblacklist\fR section. A common usage is
1163 to blacklist "everything" using a catch-all regular expression, and create
1164 specific blacklist_exceptions entries for those devices that should be handled
1165 by multipath-tools.
1166 .LP
1167 .
1168 .
1169 The following keywords are recognized in both sections. The defaults are empty
1170 unless explicitly stated.
1171 .TP 17
1172 .B devnode
1173 Regular expression matching the device nodes to be excluded/included.
1174 .RS
1175 .PP
1176 The default \fIblacklist\fR consists of the regular expressions
1177 "^(ram|raw|loop|fd|md|dm-|sr|scd|st|dcssblk)[0-9]" and
1178 "^(td|hd|vd)[a-z]". This causes virtual devices, non-disk devices, and some other
1179 device types to be excluded from multipath handling by default.
1180 .RE
1181 .TP
1182 .B wwid
1183 Regular expression for the \fIWorld Wide Identifier\fR of a device to be excluded/included.
1184 .
1185 .TP
1186 .B device
1187 Subsection for the device description. This subsection recognizes the
1188 .B vendor
1189 and
1190 .B product
1191 keywords. Both are regular expressions. For a full description of these keywords please see the
1192 \fIdevices\fR section description.
1193 .TP
1194 .B property
1195 Regular expression for an udev property. All
1196 devices that have matching udev properties will be excluded/included.
1197 The handling of the \fIproperty\fR keyword is special,
1198 because devices \fBmust\fR have at least one whitelisted udev property;
1199 otherwise they're treated as blacklisted, and the message
1200 "\fIblacklisted, udev property missing\fR" is displayed in the logs.
1201 .
1202 .RS
1203 .PP
1204 The default \fIblacklist exception\fR is: \fB(SCSI_IDENT_|ID_WWN)\fR, causing
1205 well-behaved SCSI devices and devices that provide a WWN (World Wide Number)
1206 to be included, and all others to be excluded.
1207 .RE
1208 .TP
1209 .B protocol
1210 Regular expression for the protocol of a device to be excluded/included.
1211 .RS
1212 .PP
1213 The protocol strings that multipath recognizes are \fIscsi:fcp\fR,
1214 \fIscsi:spi\fR, \fIscsi:ssa\fR, \fIscsi:sbp\fR, \fIscsi:srp\fR,
1215 \fIscsi:iscsi\fR, \fIscsi:sas\fR, \fIscsi:adt\fR, \fIscsi:ata\fR,
1216 \fIscsi:unspec\fR, \fIccw\fR, \fIcciss\fR, \fInvme\fR, and \fIundef\fR.
1217 The protocol that a path is using can be viewed by running
1218 \fBmultipathd show paths format "%d %P"\fR
1219 .RE
1220 .LP
1221 For every device, these 5 blacklist criteria are evaluated in the the order
1222 "property, dev\%node, device, protocol, wwid". If a device turns out to be
1223 blacklisted by any criterion, it's excluded from handling by multipathd, and
1224 the later criteria aren't evaluated any more. For each
1225 criterion, the whitelist takes precedence over the blacklist if a device
1226 matches both.
1227 .LP
1228 .B
1229 Note:
1230 Besides the blacklist and whitelist, other configuration options such as
1231 \fIfind_multipaths\fR have an impact on
1232 whether or not a given device is handled by multipath-tools.
1233 .
1234 .
1235 .\" ----------------------------------------------------------------------------
1236 .SH "multipaths section"
1237 .\" ----------------------------------------------------------------------------
1238 .
1239 The \fImultipaths\fR section allows setting attributes of multipath maps. The
1240 attributes that are set via the multipaths section (see list below) take
1241 precedence over all other configuration settings, including those from the
1242 \fIoverrides\fR section.
1243 .LP
1244 The only recognized attribute for the \fImultipaths\fR section is the
1245 \fImultipath\fR subsection. If there are multiple \fImultipath\fR subsections
1246 matching a given WWID, the contents of these sections are merged, and settings
1247 from later entries take precedence.
1248 .LP
1249 .
1250 .
1251 The \fImultipath\fR subsection recognizes the following attributes:
1252 .TP 17
1253 .B wwid
1254 (Mandatory) World Wide Identifier. Detected multipath maps are matched agains this attribute.
1255 Note that, unlike the \fIwwid\fR attribute in the \fIblacklist\fR section,
1256 this is \fBnot\fR a regular expression or a substring; WWIDs must match
1257 exactly inside the multipaths section.
1258 .TP
1259 .B alias
1260 Symbolic name for the multipath map. This takes precedence over a an entry for
1261 the same WWID in the \fIbindings_file\fR.
1262 .LP
1263 .
1264 .
1265 The following attributes are optional; if not set the default values
1266 are taken from the \fIoverrides\fR, \fIdevices\fR, or \fIdefaults\fR
1267 section:
1268 .sp 1
1269 .PD .1v
1270 .RS
1271 .TP 18
1272 .B path_grouping_policy
1273 .TP
1274 .B path_selector
1275 .TP
1276 .B prio
1277 .TP
1278 .B prio_args
1279 .TP
1280 .B failback
1281 .TP
1282 .B rr_weight
1283 .TP
1284 .B no_path_retry
1285 .TP
1286 .B rr_min_io
1287 .TP
1288 .B rr_min_io_rq
1289 .TP
1290 .B flush_on_last_del
1291 .TP
1292 .B features
1293 .TP
1294 .B reservation_key
1295 .TP
1296 .B user_friendly_names
1297 .TP
1298 .B deferred_remove
1299 .TP
1300 .B marginal_path_err_sample_time
1301 .TP
1302 .B marginal_path_err_rate_threshold
1303 .TP
1304 .B marginal_path_err_recheck_gap_time
1305 .TP
1306 .B marginal_path_double_failed_time
1307 .TP
1308 .B delay_watch_checks
1309 .TP
1310 .B delay_wait_checks
1311 .TP
1312 .B skip_kpartx
1313 .TP
1314 .B max_sectors_kb
1315 .TP
1316 .B ghost_delay
1317 .RE
1318 .PD
1319 .LP
1320 .
1321 .
1322 .\" ----------------------------------------------------------------------------
1323 .SH "devices section"
1324 .\" ----------------------------------------------------------------------------
1325 .
1326 \fImultipath-tools\fR have a built-in device table with reasonable defaults
1327 for more than 100 known multipath-capable storage devices. The devices section
1328 can be used to override these settings. If there are multiple matches for a
1329 given device, the attributes of all matching entries are applied to it.
1330 If an attribute is specified in several matching device subsections,
1331 later entries take precedence. Thus, entries in files under \fIconfig_dir\fR (in
1332 reverse alphabetical order) have the highest precedence, followed by entries
1333 in \fImultipath.conf\fR; the built-in hardware table has the lowest
1334 precedence. Inside a configuration file, later entries have higher precedence
1335 than earlier ones.
1336 .LP
1337 The only recognized attribute for the \fIdevices\fR section is the \fIdevice\fR
1338 subsection. Devices detected in the system are matched against the device entries
1339 using the \fBvendor\fR, \fBproduct\fR, and \fBrevision\fR fields, which are
1340 all POSIX Extended regular expressions (see \fBregex\fR(7)).
1341 .LP
1342 The vendor, product, and revision fields that multipath or multipathd detect for
1343 devices in a system depend on the device type. For SCSI devices, they correspond to the
1344 respective fields of the SCSI INQUIRY page. In general, the command '\fImultipathd show
1345 paths format "%d %s"\fR' command can be used to see the detected properties
1346 for all devices in the system.
1347 .LP
1348 .
1349 The \fIdevice\fR subsection recognizes the following attributes:
1350 .TP 17
1351 .B vendor
1352 (Mandatory) Regular expression to match the vendor name.
1353 .TP
1354 .B product
1355 (Mandatory) Regular expression to match the product name.
1356 .TP
1357 .B revision
1358 Regular expression to match the product revision. If not specified, any
1359 revision matches.
1360 .TP
1361 .B product_blacklist
1362 Products with the given \fBvendor\fR matching this string are
1363 blacklisted. This is equivalent to a \fBdevice\fR entry in the \fIblacklist\fR
1364 section with the \fIvendor\fR attribute set to this entry's \fIvendor\fR, and
1365 the \fIproduct\fR attribute set to the value of \fIproduct_blacklist\fR.
1366 .TP
1367 .B alias_prefix
1368 The user_friendly_names prefix to use for this
1369 device type, instead of the default "mpath".
1370 .TP
1371 .B hardware_handler
1372 The hardware handler to use for this device type.
1373 The following hardware handler are implemented:
1374 .RS
1375 .TP 12
1376 .I 1 emc
1377 (Hardware-dependent)
1378 Hardware handler for DGC class arrays as CLARiiON CX/AX and EMC VNX and Unity
1379 families.
1380 .TP
1381 .I 1 rdac
1382 (Hardware-dependent)
1383 Hardware handler for LSI/Engenio/NetApp RDAC class as NetApp SANtricity E/EF
1384 Series, and OEM arrays from IBM DELL SGI STK and SUN.
1385 .TP
1386 .I 1 hp_sw
1387 (Hardware-dependent)
1388 Hardware handler for HP/COMPAQ/DEC HSG80 and MSA/HSV arrays with
1389 Active/Standby mode exclusively.
1390 .TP
1391 .I 1 alua
1392 (Hardware-dependent)
1393 Hardware handler for SCSI-3 ALUA compatible arrays.
1394 .PP
1395 The default is: \fB<unset>\fR
1396 .PP
1397 \fBImportant Note:\fR Linux kernels 4.3 and newer automatically attach a device
1398 handler to known devices (which includes all devices supporting SCSI-3 ALUA)
1399 and disallow changing the handler
1400 afterwards. Setting \fBhardware_handler\fR for such devices on these kernels
1401 has no effect.
1402 .RE
1403 .
1404 .
1405 .LP
1406 The following attributes are optional; if not set the default values
1407 are taken from the \fIdefaults\fR
1408 section:
1409 .sp 1
1410 .PD .1v
1411 .RS
1412 .TP 18
1413 .B path_grouping_policy
1414 .TP
1415 .B uid_attribute
1416 .TP
1417 .B path_selector
1418 .TP
1419 .B path_checker
1420 .TP
1421 .B prio
1422 .TP
1423 .B prio_args
1424 .TP
1425 .B features
1426 .TP
1427 .B failback
1428 .TP
1429 .B rr_weight
1430 .TP
1431 .B no_path_retry
1432 .TP
1433 .B rr_min_io
1434 .TP
1435 .B rr_min_io_rq
1436 .TP
1437 .B fast_io_fail_tmo
1438 .TP
1439 .B dev_loss_tmo
1440 .TP
1441 .B flush_on_last_del
1442 .TP
1443 .B retain_attached_hw_handler
1444 .TP
1445 .B detect_prio
1446 .TP
1447 .B detect_checker
1448 .TP
1449 .B deferred_remove
1450 .TP
1451 .B marginal_path_err_sample_time
1452 .TP
1453 .B marginal_path_err_rate_threshold
1454 .TP
1455 .B marginal_path_err_recheck_gap_time
1456 .TP
1457 .B marginal_path_double_failed_time
1458 .TP
1459 .B delay_watch_checks
1460 .TP
1461 .B delay_wait_checks
1462 .TP
1463 .B skip_kpartx
1464 .TP
1465 .B max_sectors_kb
1466 .TP
1467 .B ghost_delay
1468 .RE
1469 .PD
1470 .LP
1471 .
1472 .
1473 .\" ----------------------------------------------------------------------------
1474 .SH "overrides section"
1475 .\" ----------------------------------------------------------------------------
1476 .
1477 The overrides section recognizes the following optional attributes; if not set
1478 the values are taken from the \fIdevices\fR or \fIdefaults\fR sections:
1479 .sp 1
1480 .PD .1v
1481 .RS
1482 .TP 18
1483 .B path_grouping_policy
1484 .TP
1485 .B uid_attribute
1486 .TP
1487 .B getuid_callout
1488 .TP
1489 .B path_selector
1490 .TP
1491 .B path_checker
1492 .TP
1493 .B alias_prefix
1494 .TP
1495 .B features
1496 .TP
1497 .B prio
1498 .TP
1499 .B prio_args
1500 .TP
1501 .B failback
1502 .TP
1503 .B rr_weight
1504 .TP
1505 .B no_path_retry
1506 .TP
1507 .B rr_min_io
1508 .TP
1509 .B rr_min_io_rq
1510 .TP
1511 .B flush_on_last_del
1512 .TP
1513 .B fast_io_fail_tmo
1514 .TP
1515 .B dev_loss_tmo
1516 .TP
1517 .B user_friendly_names
1518 .TP
1519 .B retain_attached_hw_handler
1520 .TP
1521 .B detect_prio
1522 .TP
1523 .B detect_checker
1524 .TP
1525 .B deferred_remove
1526 .TP
1527 .B marginal_path_err_sample_time
1528 .TP
1529 .B marginal_path_err_rate_threshold
1530 .TP
1531 .B marginal_path_err_recheck_gap_time
1532 .TP
1533 .B marginal_path_double_failed_time
1534 .TP
1535 .B delay_watch_checks
1536 .TP
1537 .B delay_wait_checks
1538 .TP
1539 .B skip_kpartx
1540 .TP
1541 .B ghost_delay
1542 .RE
1543 .PD
1544 .LP
1545 .
1546 .
1547 .\" ----------------------------------------------------------------------------
1548 .SH "WWID generation"
1549 .\" ----------------------------------------------------------------------------
1550 .
1551 Multipath uses a \fIWorld Wide Identification\fR (WWID) to determine
1552 which paths belong to the same device. Each path presenting the same
1553 WWID is assumed to point to the same device.
1554 .LP
1555 The WWID is generated by four methods (in the order of preference):
1556 .TP 17
1557 .B uid_attrs
1558 The WWID is derived from udev attributes by matching the device node name. See
1559 description of \fIuid_attrs\fR in the defaults section above.
1560 .TP
1561 .B getuid_callout
1562 Use the specified external program; cf \fIgetuid_callout\fR above.
1563 Care should be taken when using this method; the external program
1564 needs to be loaded from disk for execution, which might lead to
1565 deadlock situations in an all-paths-down scenario.
1566 .TP
1567 .B uid_attribute
1568 Use the value of the specified udev attribute; cf \fIuid_attribute\fR
1569 above. This method is preferred to \fIgetuid_callout\fR as multipath
1570 does not need to call any external programs here. However, under
1571 certain circumstances udev might not be able to generate the requested
1572 variable.
1573 .TP
1574 .B vpd_pg83
1575 If none of the \fIgetuid_callout\fR or \fIuid_attribute\fR parameters
1576 are present multipath will try to use the sysfs attribute
1577 \fIvpd_pg83\fR to generate the WWID.
1578 .
1579 .
1580 .\" ----------------------------------------------------------------------------
1581 .SH "KNOWN ISSUES"
1582 .\" ----------------------------------------------------------------------------
1583 .
1584 The usage of \fIqueue_if_no_path\fR option can lead to \fID state\fR
1585 processes being hung and not killable in situations where all the paths to the
1586 LUN go offline. It is advisable to use the \fIno_path_retry\fR option instead.
1587 .P
1588 The use of \fIqueue_if_no_path\fR or \fIno_path_retry\fR might lead to a
1589 deadlock if the \fIdev_loss_tmo\fR setting results in a device being removed
1590 while I/O is still queued. The multipath daemon will update the \fIdev_loss_tmo\fR
1591 setting accordingly to avoid this deadlock. Hence if both values are
1592 specified the order of precedence is \fIno_path_retry, queue_if_no_path, dev_loss_tmo\fR.
1593 .
1594 .
1595 .\" ----------------------------------------------------------------------------
1596 .SH "SEE ALSO"
1597 .\" ----------------------------------------------------------------------------
1598 .
1599 .BR udev (8),
1600 .BR dmsetup (8),
1601 .BR multipath (8),
1602 .BR multipathd (8).
1603 .
1604 .
1605 .\" ----------------------------------------------------------------------------
1606 .SH AUTHORS
1607 .\" ----------------------------------------------------------------------------
1608 .
1609 \fImultipath-tools\fR was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com>
1610 and others.
1611 .\" EOF