multipath-tools: document vendor, product, revision and bl_product are POSIX Extended...
[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 .\"
6 .\" TODO: Look for XXX
7 .\"
8 .\" ----------------------------------------------------------------------------
9 .
10 .TH MULTIPATH.CONF 5 2016-08-07 "Linux"
11 .
12 .
13 .\" ----------------------------------------------------------------------------
14 .SH NAME
15 .\" ----------------------------------------------------------------------------
16 .
17 multipath.conf \- multipath daemon configuration file.
18 .
19 .
20 .\" ----------------------------------------------------------------------------
21 .SH DESCRIPTION
22 .\" ----------------------------------------------------------------------------
23 .
24 .B "/etc/multipath.conf"
25 is the configuration file for the multipath daemon. It is used to
26 overwrite the built-in configuration table of \fBmultipathd\fP.
27 Any line whose first non-white-space character is a '#' is considered
28 a comment line. Empty lines are ignored.
29 .
30 .
31 .\" ----------------------------------------------------------------------------
32 .SH SYNTAX
33 .\" ----------------------------------------------------------------------------
34 .
35 The configuration file contains entries of the form:
36 .RS
37 .nf
38 .ft B
39 .sp
40 <section> {
41 .RS
42 .ft B
43 <attribute> <value>
44 .I "..."
45 .ft B
46 <subsection> {
47 .RS
48 .ft B
49 <attribute> <value>
50 .I "..."
51 .RE
52 .ft B
53 }
54 .RE
55 .ft B
56 }
57 .ft R
58 .fi
59 .RE
60 .LP
61 Each \fIsection\fP contains one or more attributes or subsections. The
62 recognized keywords for attributes or subsections depend on the
63 section in which they occur.
64 .LP
65 .
66 .
67 The following \fIsection\fP keywords are recognized:
68 .TP 17
69 .B defaults
70 This section defines default values for attributes which are used
71 whenever no values are given in the appropriate device or multipath
72 sections.
73 .TP
74 .B blacklist
75 This section defines which devices should be excluded from the
76 multipath topology discovery.
77 .TP
78 .B blacklist_exceptions
79 This section defines which devices should be included in the
80 multipath topology discovery, despite being listed in the
81 \fIblacklist\fR section.
82 .TP
83 .B multipaths
84 This section defines the multipath topologies. They are indexed by a
85 \fIWorld Wide Identifier\fR(WWID). For details on the WWID generation
86 see section \fIWWID generation\fR below.
87 .TP
88 .B devices
89 This section defines the device-specific settings.
90 .TP
91 .B overrides
92 This section defines values for attributes that should override the
93 device-specific settings for all devices.
94 .RE
95 .LP
96 .
97 .
98 .\" ----------------------------------------------------------------------------
99 .SH "defaults section"
100 .\" ----------------------------------------------------------------------------
101 .
102 The \fIdefaults\fR section recognizes the following keywords:
103 .
104 .
105 .TP 17
106 .B verbosity
107 Default verbosity. Higher values increase the verbosity level. Valid
108 levels are between 0 and 6.
109 .RS
110 .TP
111 Default value is: \fB2\fR
112 .RE
113 .
114 .
115 .TP
116 .B polling_interval
117 Interval between two path checks in seconds. For properly functioning paths,
118 the interval between checks will gradually increase to \fImax_polling_interval\fR.
119 This value will be overridden by the \fIWatchdogSec\fR
120 setting in the multipathd.service definition if systemd is used.
121 .RS
122 .TP
123 Default value is: \fB5\fR
124 .RE
125 .
126 .
127 .TP
128 .B max_polling_interval
129 Maximal interval between two path checks in seconds.
130 .RS
131 .TP
132 Default value is: \fB4 * polling_interval\fR
133 .RE
134 .
135 .
136 .TP
137 .B reassign_maps
138 Enable reassigning of device-mapper maps. With this option multipathd
139 will remap existing device-mapper maps to always point to multipath
140 device, not the underlying block devices. Possible values are
141 \fIyes\fR and \fIno\fR.
142 .RS
143 .TP
144 Default value is: \fBno\fR
145 .RE
146 .
147 .
148 .TP
149 .B multipath_dir
150 Directory where the dynamic shared objects are stored. Defined at compile time.
151 .RS
152 .TP
153 Default value is: \fB<system dependent>\fR, commonly \fI/lib64/multipath/\fR
154 .RE
155 .
156 .
157 .TP
158 .B path_selector
159 The default path selector algorithm to use; they are offered by the
160 kernel multipath target. There are three selector algorithms:
161 .RS
162 .TP 12
163 .I "round-robin 0"
164 Loop through every path in the path group, sending the same amount of IO to
165 each.
166 .TP
167 .I "queue-length 0"
168 Send the next bunch of IO down the path with the least amount of outstanding IO.
169 .TP
170 .I "service-time 0"
171 Choose the path for the next bunch of IO based on the amount of outstanding IO
172 to the path and its relative throughput.
173 .TP
174 Default value is: \fBservice-time 0\fR
175 .RE
176 .
177 .
178 .TP
179 .B path_grouping_policy
180 The default path grouping policy to apply to unspecified
181 multipaths. Possible values are:
182 .RS
183 .TP 12
184 .I failover
185 One path per priority group.
186 .TP
187 .I multibus
188 All paths in one priority group.
189 .TP
190 .I group_by_serial
191 One priority group per serial number.
192 .TP
193 .I group_by_prio
194 One priority group per priority value. Priorities are determined by
195 callout programs specified as a global, per-controller or
196 per-multipath option in the configuration file.
197 .TP
198 .I group_by_node_name
199 One priority group per target node name. Target node names are fetched
200 in \fI/sys/class/fc_transport/target*/node_name\fR.
201 .TP
202 Default value is: \fBfailover\fR
203 .RE
204 .
205 .
206 .TP
207 .B uid_attribute
208 The udev attribute providing a unique path identifier.
209 .RS
210 .TP
211 Default value is: for SCSI devices \fBID_SERIAL\fR
212 .TP
213 Default value is: for DASD devices \fBID_UID\fR
214 .RE
215 .
216 .
217 .TP
218 .B getuid_callout
219 (Superseded by \fIuid_attribute\fR) The default program and args to callout
220 to obtain a unique path identifier. Should be specified with an absolute path.
221 .TP
222 .
223 .
224 .B prio
225 The name of the path priority routine. The specified routine
226 should return a numeric value specifying the relative priority
227 of this path. Higher number have a higher priority.
228 \fI"none"\fR is a valid value. Currently the following path priority routines
229 are implemented:
230 .RS
231 .TP 12
232 .I const
233 Return a constant priority of \fI1\fR.
234 .TP
235 .I sysfs
236 Use the sysfs attributes \fIaccess_state\fR and \fIpreferred_path\fR to
237 generate the path priority. This prioritizer accepts the optional prio_arg
238 \fIexclusive_pref_bit\fR
239 .TP
240 .I emc
241 (Hardware-dependent)
242 Generate the path priority for DGC class arrays as CLARiiON CX/AX and
243 EMC VNX families.
244 .TP
245 .I alua
246 (Hardware-dependent)
247 Generate the path priority based on the SCSI-3 ALUA settings. This prioritizer
248 accepts the optional prio_arg \fIexclusive_pref_bit\fR.
249 .TP
250 .I ontap
251 (Hardware-dependent)
252 Generate the path priority for NetApp ONTAP class and OEM arrays as IBM NSeries.
253 .TP
254 .I rdac
255 (Hardware-dependent)
256 Generate the path priority for LSI/Engenio/NetApp RDAC class as NetApp SANtricity
257 E/EF Series, and OEM arrays from IBM DELL SGI STK and SUN.
258 .TP
259 .I hp_sw
260 (Hardware-dependent)
261 Generate the path priority for HP/COMPAQ/DEC HSG80 and MSA/HSV arrays with
262 Active/Standby mode exclusively.
263 .TP
264 .I hds
265 (Hardware-dependent)
266 Generate the path priority for Hitachi AMS 2000 and HUS 100 families of arrays.
267 .TP
268 .I random
269 Generate a random priority between 1 and 10.
270 .TP
271 .I weightedpath
272 Generate the path priority based on the regular expression and the
273 priority provided as argument. Requires prio_args keyword.
274 .TP
275 .I datacore
276 .\" XXX
277 ???. Requires prio_args keyword.
278 .TP
279 .I iet
280 .\" XXX
281 ???. Requires prio_args keyword.
282 .TP
283 Default value is: \fBconst\fR
284 .RE
285 .
286 .
287 .TP
288 .B prio_args
289 Arguments to pass to to the prio function. This only applies to certain
290 prioritizers:
291 .RS
292 .TP 12
293 .I weighted
294 Needs a value of the form
295 \fI"<hbtl|devname|serial|wwn> <regex1> <prio1> <regex2> <prio2> ..."\fR
296 .RS
297 .TP 8
298 .I hbtl
299 regex can be of SCSI H:B:T:L format. For example: 1:0:.:. , *:0:0:.
300 .TP
301 .I devname
302 regex can be of device name format. For example: sda , sd.e
303 .TP
304 .I serial
305 regex can be of serial number format. For example: .*J1FR.*324 . The serial can be looked
306 up through sysfs or by running multipathd show paths format "%z". For example: 0395J1FR904324
307 .TP
308 .I wwn
309 regex can be of the form \fI"host_wwnn:host_wwpn:target_wwnn:target_wwpn"\fR
310 these values can be looked up through sysfs or by running \fImultipathd show paths format
311 "%N:%R:%n:%r"\fR. For example: 0x200100e08ba0aea0:0x210100e08ba0aea0:.*:.* , .*:.*:iqn.2009-10.com.redhat.msp.lab.ask-06:.*
312 .RE
313 .TP 12
314 .I alua
315 If \fIexclusive_pref_bit\fR is set, paths with the \fIpreferred path\fR bit
316 set will always be in their own path group.
317 .TP
318 .I datacore
319 .\" XXX
320 \fIpreferredsds\fR ???.
321 .TP
322 .I iet
323 .\" XXX
324 \fIpreferredip\fR ???.
325 .TP
326 Default value is: \fB<unset>\fR
327 .RE
328 .
329 .
330 .TP
331 .B features
332 Specify any device-mapper features to be used. Syntax is \fInum list\fR
333 where \fInum\fR is the number, between 0 and 6, of features in \fIlist\fR.
334 Possible values for the feature list are:
335 .RS
336 .TP 12
337 .I queue_if_no_path
338 Queue IO if no path is active; identical to the \fIno_path_retry\fR keyword.
339 See KNOWN ISSUES.
340 .TP
341 .I no_partitions
342 Disable automatic partitions generation via kpartx.
343 .TP
344 .I pg_init_retries
345 Number of times to retry pg_init, it must be between 1 and 50.
346 .TP
347 .I pg_init_delay_msecs
348 Number of msecs before pg_init retry, it must be between 0 and 60000.
349 .TP
350 Default value is: \fB0\fR
351 .RE
352 .
353 .
354 .TP
355 .B path_checker
356 The default method used to determine the paths state. Possible values
357 are:
358 .RS
359 .TP 12
360 .I readsector0
361 (Deprecated) Read the first sector of the device. This checker is being
362 deprecated, please use \fItur\fR instead.
363 .TP
364 .I tur
365 Issue a \fITEST UNIT READY\fR command to the device.
366 .TP
367 .I emc_clariion
368 (Hardware-dependent)
369 Query the DGC/EMC specific EVPD page 0xC0 to determine the path state
370 for CLARiiON CX/AX and EMC VNX arrays families.
371 .TP
372 .I hp_sw
373 (Hardware-dependent)
374 Check the path state for HP/COMPAQ/DEC HSG80 and MSA/HSV arrays with
375 Active/Standby mode exclusively.
376 .TP
377 .I rdac
378 (Hardware-dependent)
379 Check the path state for LSI/Engenio/NetApp RDAC class as NetApp SANtricity E/EF
380 Series, and OEM arrays from IBM DELL SGI STK and SUN.
381 .TP
382 .I directio
383 (Deprecated) Read the first sector with direct I/O. This checker is being
384 deprecated, it could cause spurious path failures under high load.
385 Please use \fItur\fR instead.
386 .TP
387 .I cciss_tur
388 (Hardware-dependent)
389 Check the path state for HP/COMPAQ Smart Array(CCISS) controllers.
390 .TP
391 .I rbd
392 Check if the path is in the Ceph blacklist and remap the path if it is.
393 .TP
394 Default value is: \fBtur\fR
395 .RE
396 .
397 .
398 .TP
399 .B alias_prefix
400 The \fIuser_friendly_names\fR prefix.
401 .RS
402 .TP
403 Default value is: \fBmpath\fR
404 .RE
405 .
406 .
407 .TP
408 .B failback
409 Tell multipathd how to manage path group failback.
410 .RS
411 .TP 12
412 .I immediate
413 Immediately failback to the highest priority pathgroup that contains
414 active paths.
415 .TP
416 .I manual
417 Do not perform automatic failback.
418 .TP
419 .I followover
420 Used to deal with multiple computers accessing the same Active/Passive storage
421 devices. Only perform automatic failback when the first path of a pathgroup
422 becomes active. This keeps a cluster node from automatically failing back when
423 another node requested the failover.
424 .TP
425 .I values > 0
426 Deferred failback (time to defer in seconds).
427 .TP
428 Default value is: \fBmanual\fR
429 .RE
430 .
431 .
432 .TP
433 .B  rr_min_io
434 The number of IO to route to a path before switching to the next in
435 the same path group. This is only for BIO based multipath.
436 .RS
437 .TP
438 Default value is: \fB1000\fR
439 .RE
440 .
441 .
442 .TP
443 .B rr_min_io_rq
444 The number of IO requests to route to a path before switching to the
445 next in the same path group. This is only for request based multipath.
446 .RS
447 .TP
448 Default value is: \fB1\fR
449 .RE
450 .
451 .
452 .TP
453 .B max_fds
454 Specify the maximum number of file descriptors that can be opened by multipath
455 and multipathd. This is equivalent to ulimit \-n. A value of \fImax\fR will set
456 this to the system limit from \fI/proc/sys/fs/nr_open\fR. If this is not set, the
457 maximum number of open fds is taken from the calling process. It is usually
458 1024. To be safe, this should be set to the maximum number of paths plus 32,
459 if that number is greated than 1024.
460 .RS
461 .TP
462 Default value is: \fBmax\fR
463 .RE
464 .
465 .
466 .TP
467 .B rr_weight
468 If set to \fIpriorities\fR the multipath configurator will assign
469 path weights as "path prio * rr_min_io". Possible values are
470 .I priorities
471 or
472 .I uniform .
473 .RS
474 .TP
475 Default value is: \fBuniform\fR
476 .RE
477 .
478 .
479 .TP
480 .B no_path_retry
481 Specify the number of retries until disable queueing, or
482 .I fail
483 for immediate failure (no queueing),
484 .I queue
485 for never stop queueing. If unset no queueing is attempted. See KNOWN ISSUES.
486 .RS
487 .TP
488 Default value is: \fB<unset>\fR
489 .RE
490 .
491 .
492 .TP
493 .B queue_without_daemon
494 If set to
495 .I no
496 , when multipathd stops, queueing will be turned off for all devices.
497 This is useful for devices that set no_path_retry. If a machine is
498 shut down while all paths to a device are down, it is possible to hang waiting
499 for IO to return from the device after multipathd has been stopped. Without
500 multipathd running, access to the paths cannot be restored, and the kernel
501 cannot be told to stop queueing IO. Setting queue_without_daemon to
502 .I no
503 , avoids this problem.
504 .RS
505 .TP
506 Default value is: \fBno\fR
507 .RE
508 .
509 .
510 .TP
511 .B checker_timeout
512 Specify the timeout to use for path checkers and prioritizers that issue SCSI
513 commands with an explicit timeout, in seconds.
514 .RS
515 .TP
516 Default value is: in \fB/sys/block/sd<x>/device/timeout\fR
517 .RE
518 .
519 .
520 .TP
521 .B flush_on_last_del
522 If set to
523 .I yes
524 , multipathd will disable queueing when the last path to a device has been
525 deleted.
526 .RS
527 .TP
528 Default value is: \fBno\fR
529 .RE
530 .
531 .
532 .TP
533 .B user_friendly_names
534 If set to
535 .I yes
536 , using the bindings file \fI/etc/multipath/bindings\fR to assign a persistent
537 and unique alias to the multipath, in the form of mpath<n>. If set to
538 .I no
539 use the WWID as the alias. In either case this be will
540 be overridden by any specific aliases in the \fImultipaths\fR section.
541 .RS
542 .TP
543 Default value is: \fBno\fR
544 .RE
545 .
546 .
547 .TP
548 .B fast_io_fail_tmo
549 Specify the number of seconds the SCSI layer will wait after a problem has been
550 detected on a FC remote port before failing IO to devices on that remote port.
551 This should be smaller than dev_loss_tmo. Setting this to
552 .I off
553 will disable the timeout.
554 .RS
555 .TP
556 Default value is: in \fB5\fR
557 .RE
558 .
559 .
560 .TP
561 .B dev_loss_tmo
562 Specify the number of seconds the SCSI layer will wait after a problem has
563 been detected on a FC remote port before removing it from the system. This
564 can be set to "infinity" which sets it to the max value of 2147483647
565 seconds, or 68 years. It will be automatically adjusted to the overall
566 retry interval \fIno_path_retry\fR * \fIpolling_interval\fR
567 if a number of retries is given with \fIno_path_retry\fR and the
568 overall retry interval is longer than the specified \fIdev_loss_tmo\fR value.
569 The Linux kernel will cap this value to \fI300\fR if \fIfast_io_fail_tmo\fR
570 is not set. See KNOWN ISSUES.
571 .RS
572 .TP
573 Default value is: \fB600\fR
574 .RE
575 .
576 .
577 .TP
578 .B bindings_file
579 The full pathname of the binding file to be used when the user_friendly_names option is set.
580 .RS
581 .TP
582 Default value is: \fB/etc/multipath/bindings\fR
583 .RE
584 .
585 .
586 .TP
587 .B wwids_file
588 The full pathname of the WWIDs file, which is used by multipath to keep track
589 of the WWIDs for LUNs it has created multipath devices on in the past.
590 .RS
591 .TP
592 Default value is: \fB/etc/multipath/wwids\fR
593 .RE
594 .
595 .
596 .TP
597 .B log_checker_err
598 If set to
599 .I once
600 , multipathd logs the first path checker error at logging level 2. Any later
601 errors are logged at level 3 until the device is restored. If set to
602 .I always
603 , multipathd always logs the path checker error at logging level 2.
604 .RS
605 .TP
606 Default value is: \fBalways\fR
607 .RE
608 .
609 .
610 .TP
611 .B reservation_key
612 This is the service action reservation key used by mpathpersist. It must be
613 set for all multipath devices using persistent reservations, and it must be
614 the same as the RESERVATION KEY field of the PERSISTENT RESERVE OUT parameter
615 list which contains an 8-byte value provided by the application client to the
616 device server to identify the I_T nexus.
617 .RS
618 .TP
619 Default value is: \fB<unset>\fR
620 .RE
621 .
622 .
623 .TP
624 .B retain_attached_hw_handler
625 If set to
626 .I yes
627 and the SCSI layer has already attached a hardware_handler to the device,
628 multipath will not force the device to use the hardware_handler specified by
629 mutipath.conf. If the SCSI layer has not attached a hardware handler,
630 multipath will continue to use its configured hardware handler.
631 .RS
632 .TP
633 Default value is: \fByes\fR
634 .RE
635 .
636 .
637 .TP
638 .B detect_prio
639 If set to
640 .I yes
641 , multipath will try to detect if the device supports SCSI-3 ALUA. If so, the
642 device will automatically use the \fIsysfs\fR prioritizer if the required sysf
643 attributes \fIaccess_state\fR and \fIpreferred_path\fR are supported, or the
644 \fIalua\fR prioritizer if not. If set to
645 .I no
646 , the prioritizer will be selected as usual.
647 .RS
648 .TP
649 Default value is: \fByes\fR
650 .RE
651 .
652 .
653 .TP
654 .B force_sync
655 If set to
656 .I yes
657 , multipathd will call the path checkers in sync mode only.  This means that
658 only one checker will run at a time.  This is useful in the case where many
659 multipathd checkers running in parallel causes significant CPU pressure.
660 .RS
661 .TP
662 Default value is: \fBno\fR
663 .RE
664 .
665 .
666 .TP
667 .B strict_timinig
668 If set to
669 .I yes
670 , multipathd will start a new path checker loop after exactly one second,
671 so that each path check will occur at exactly \fIpolling_interval\fR
672 seconds. On busy systems path checks might take longer than one second;
673 here the missing ticks will be accounted for on the next round.
674 A warning will be printed if path checks take longer than \fIpolling_interval\fR
675 seconds.
676 .RS
677 .TP
678 Default value is: \fBno\fR
679 .RE
680 .
681 .
682 .TP
683 .B deferred_remove
684 If set to
685 .I yes
686 , multipathd will do a deferred remove instead of a regular remove when the
687 last path device has been deleted.  This means that if the multipath device is
688 still in use, it will be freed when the last user closes it.  If path is added
689 to the multipath device before the last user closes it, the deferred remove
690 will be canceled.
691 .RS
692 .TP
693 Default value is: \fBno\fR
694 .RE
695 .
696 .
697 .TP
698 .B partition_delimiter
699 If this value is not set, when multipath renames a device, it will act just
700 like the kpartx default does, only adding a \fI"p"\fR to names ending in a
701 number. If this parameter is set, multipath will act like kpartx does with
702 the \fI-p\fR option is used, and always add delimiter.
703 .RS
704 .TP
705 Default value is: \fB<unset>\fR
706 .RE
707 .
708 .
709 .TP
710 .B config_dir
711 If set to anything other than "", multipath will search this directory
712 alphabetically for file ending in ".conf" and it will read configuration
713 information from them, just as if it was in \fI/etc/multipath.conf\fR.
714 config_dir must either be "" or a fully qualified directory name.
715 .RS
716 .TP
717 Default value is: \fB/etc/multipath/conf.d/\fR
718 .RE
719 .
720 .
721 .TP
722 .B delay_watch_checks
723 If set to a value greater than 0, multipathd will watch paths that have
724 recently become valid for this many checks. If they fail again while they are
725 being watched, when they next become valid, they will not be used until they
726 have stayed up for \fIdelay_wait_checks\fR checks.
727 .RS
728 .TP
729 Default value is: \fBno\fR
730 .RE
731 .
732 .
733 .TP
734 .B delay_wait_checks
735 If set to a value greater than 0, when a device that has recently come back
736 online fails again within \fIdelay_watch_checks\fR checks, the next time it
737 comes back online, it will marked and delayed, and not used until it has passed
738 \fIdelay_wait_checks\fR checks.
739 .RS
740 .TP
741 Default value is: \fBno\fR
742 .RE
743 .
744 .
745 .TP
746 .B find_multipaths
747 If set to
748 .I yes
749 , instead of trying to create a multipath device for every non-blacklisted
750 path, multipath will only create a device if one of three condidions are
751 met.
752 .I 1
753 There are at least two non-blacklisted paths with the same WWID,
754 .I 2
755 the user manually forces the creation, by specifying a device with the multipath
756 command, or
757 .I 3
758 a path has the same WWID as a multipath device that was previously created
759 while find_multipaths was set (even if that multipath device doesn't currently
760 exist).
761 Whenever a multipath device is created with find_multipaths set, multipath will
762 remeber the WWID of the device, so that it will automatically create the
763 device again, as soon as it sees a path with that WWID. This should allow most
764 users to have multipath automatically choose the correct paths to make into
765 multipath devices, without having to edit the blacklist.
766 .RS
767 .TP
768 Default value is: \fBno\fR
769 .RE
770 .
771 .
772 .TP
773 .B uxsock_timeout
774 CLI receive timeout in milliseconds. For larger systems CLI commands
775 might timeout before the multipathd lock is released and the CLI command
776 can be processed. This will result in errors like
777 "timeout receiving packet" to be returned from CLI commands.
778 In these cases it is recommended to increase the CLI timeout to avoid
779 those issues.
780 .RS
781 .TP
782 Default value is: \fB1000\fR
783 .RE
784 .
785 .
786 .TP
787 .B retrigger_tries
788 Sets the number of times multipathd will try to retrigger a uevent to get the
789 WWID.
790 .RS
791 .TP
792 Default value is: \fB3\fR
793 .RE
794 .
795 .
796 .TP
797 .B retrigger_delay
798 Sets the amount of time, in seconds, to wait between retriggers.
799 .RS
800 .TP
801 Default value is: \fB10\fR
802 .RE
803 .
804 .
805 .TP
806 .B missing_uev_wait_timeout
807 Controls how many seconds multipathd will wait, after a new multipath device
808 is created, to receive a change event from udev for the device, before
809 automatically enabling device reloads. Usually multipathd will delay reloads
810 on a device until it receives a change uevent from the initial table load.
811 .RS
812 .TP
813 Default value is: \fB30\fR
814 .RE
815 .
816 .
817 .\" ----------------------------------------------------------------------------
818 .SH "blacklist section"
819 .\" ----------------------------------------------------------------------------
820 .
821 The \fIblacklist\fR section is used to exclude specific device from inclusion in
822 the multipath topology. It is most commonly used to exclude local disks or LUNs
823 for the array controller.
824 .LP
825 .
826 .
827 The following keywords are recognized:
828 .TP 17
829 .B devnode
830 Regular expression of the device nodes to be excluded.
831 .TP
832 .B wwid
833 The \fIWorld Wide Identification\fR of a device.
834 .TP
835 .B property
836 Regular expression of the udev property to be excluded.
837 .TP
838 .B device
839 Subsection for the device description. This subsection recognizes the
840 .B vendor
841 and
842 .B product
843 keywords. For a full description of these keywords please see the
844 \fIdevices\fR section description.
845 .
846 .
847 .\" ----------------------------------------------------------------------------
848 .SH "blacklist_exceptions section"
849 .\" ----------------------------------------------------------------------------
850 .
851 The \fIblacklist_exceptions\fR section is used to revert the actions of the
852 \fIblacklist\fR section. For example to include specific device in the
853 multipath topology. This allows one to selectively include devices which
854 would normally be excluded via the \fIblacklist\fR section.
855 .LP
856 .
857 .
858 The following keywords are recognized:
859 .TP 17
860 .B devnode
861 Regular expression of the device nodes to be whitelisted.
862 .TP
863 .B wwid
864 The \fIWorld Wide Identification\fR of a device.
865 .TP
866 .B property
867 Regular expression of the udev property to be whitelisted.
868 .RS
869 .TP
870 Default value is: \fB(ID_WWN|SCSI_IDENT_.*)\fR
871 .RE
872 .TP
873 .B device
874 Subsection for the device description. This subsection recognizes the
875 .B vendor
876 and
877 .B product
878 keywords. For a full description of these keywords please see the \fIdevices\fR
879 section description.
880 .LP
881 The \fIproperty\fR blacklist and whitelist handling is different from the usual
882 handling in the sense that the whitelist \fIhas\fR to be set, otherwise the
883 device will be blacklisted. In these cases the message \fIblacklisted, udev
884 property missing\fR will be displayed.
885 .
886 .
887 .\" ----------------------------------------------------------------------------
888 .SH "multipaths section"
889 .\" ----------------------------------------------------------------------------
890 .
891 The only recognized attribute for the \fImultipaths\fR section is the
892 \fImultipath\fR subsection.
893 .LP
894 .
895 .
896 The \fImultipath\fR subsection recognizes the following attributes:
897 .TP 17
898 .B wwid
899 (Mandatory) Index of the container.
900 .TP
901 .B alias
902 Symbolic name for the multipath map.
903 .LP
904 .
905 .
906 The following attributes are optional; if not set the default values
907 are taken from the \fIdefaults\fR or \fIdevices\fR section:
908 .sp 1
909 .PD .1v
910 .RS
911 .TP 18
912 .B path_grouping_policy
913 .TP
914 .B path_selector
915 .TP
916 .B prio
917 .TP
918 .B prio_args
919 .TP
920 .B failback
921 .TP
922 .B rr_weight
923 .TP
924 .B no_path_retry
925 .TP
926 .B rr_min_io
927 .TP
928 .B rr_min_io_rq
929 .TP
930 .B flush_on_last_del
931 .TP
932 .B features
933 .TP
934 .B reservation_key
935 .TP
936 .B user_friendly_names
937 .TP
938 .B deferred_remove
939 .TP
940 .B delay_watch_checks
941 .TP
942 .B delay_wait_checks
943 .RE
944 .PD
945 .LP
946 .
947 .
948 .\" ----------------------------------------------------------------------------
949 .SH "devices section"
950 .\" ----------------------------------------------------------------------------
951 .
952 The only recognized attribute for the \fIdevices\fR section is the \fIdevice\fR
953 subsection.
954 .LP
955 .
956 .
957 The \fIdevice\fR subsection recognizes the following attributes:
958 .TP
959 vendor, product, revision and product_blacklist are POSIX Extended regex.
960 .TP 17
961 .B vendor
962 (Mandatory) Vendor identifier.
963 .TP
964 .B product
965 (Mandatory) Product identifier.
966 .TP
967 .B revision
968 Revision identfier.
969 .TP
970 .B product_blacklist
971 Product strings to blacklist for this vendor.
972 .TP
973 .B alias_prefix
974 The user_friendly_names prefix to use for this
975 device type, instead of the default "mpath".
976 .TP
977 .B hardware_handler
978 The hardware handler to use for this device type.
979 The following hardware handler are implemented:
980 .RS
981 .TP 12
982 .I 1 emc
983 (Hardware-dependent)
984 Hardware handler for DGC class arrays as CLARiiON CX/AX and EMC VNX families.
985 .TP
986 .I 1 rdac
987 (Hardware-dependent)
988 Hardware handler for LSI/Engenio/NetApp RDAC class as NetApp SANtricity E/EF
989 Series, and OEM arrays from IBM DELL SGI STK and SUN.
990 .TP
991 .I 1 hp_sw
992 (Hardware-dependent)
993 Hardware handler for HP/COMPAQ/DEC HSG80 and MSA/HSV arrays with
994 Active/Standby mode exclusively.
995 .TP
996 .I 1 alua
997 (Hardware-dependent)
998 Hardware handler for SCSI-3 ALUA compatible arrays.
999 .TP
1000 Default value is: \fB<unset>\fR
1001 .RE
1002 .
1003 .
1004 .LP
1005 The following attributes are optional; if not set the default values
1006 are taken from the \fIdefaults\fR
1007 section:
1008 .sp 1
1009 .PD .1v
1010 .RS
1011 .TP 18
1012 .B path_grouping_policy
1013 .TP
1014 .B uid_attribute
1015 .TP
1016 .B path_selector
1017 .TP
1018 .B path_checker
1019 .TP
1020 .B prio
1021 .TP
1022 .B prio_args
1023 .TP
1024 .B features
1025 .TP
1026 .B failback
1027 .TP
1028 .B rr_weight
1029 .TP
1030 .B no_path_retry
1031 .TP
1032 .B rr_min_io
1033 .TP
1034 .B rr_min_io_rq
1035 .TP
1036 .B fast_io_fail_tmo
1037 .TP
1038 .B dev_loss_tmo
1039 .TP
1040 .B flush_on_last_del
1041 .TP
1042 .B retain_attached_hw_handler
1043 .TP
1044 .B detect_prio
1045 .TP
1046 .B deferred_remove
1047 .TP
1048 .B delay_watch_checks
1049 .TP
1050 .B delay_wait_checks
1051 .RE
1052 .PD
1053 .LP
1054 .
1055 .
1056 .\" ----------------------------------------------------------------------------
1057 .SH "overrides section"
1058 .\" ----------------------------------------------------------------------------
1059 .
1060 The overrides section recognizes the following optional attributes; if not set
1061 the values are taken from the \fIdevices\fR or \fIdefaults\fR sections:
1062 .sp 1
1063 .PD .1v
1064 .RS
1065 .TP 18
1066 .B path_grouping_policy
1067 .TP
1068 .B uid_attribute
1069 .TP
1070 .B getuid_callout
1071 .TP
1072 .B path_selector
1073 .TP
1074 .B path_checker
1075 .TP
1076 .B alias_prefix
1077 .TP
1078 .B features
1079 .TP
1080 .B prio
1081 .TP
1082 .B prio_args
1083 .TP
1084 .B failback
1085 .TP
1086 .B rr_weight
1087 .TP
1088 .B no_path_retry
1089 .TP
1090 .B rr_min_io
1091 .TP
1092 .B rr_min_io_rq
1093 .TP
1094 .B flush_on_last_del
1095 .TP
1096 .B fast_io_fail_tmo
1097 .TP
1098 .B dev_loss_tmo
1099 .TP
1100 .B user_friendly_names
1101 .TP
1102 .B retain_attached_hw_handler
1103 .TP
1104 .B detect_prio
1105 .TP
1106 .B deferred_remove
1107 .TP
1108 .B delay_watch_checks
1109 .TP
1110 .B delay_wait_checks
1111 .RE
1112 .PD
1113 .LP
1114 .
1115 .
1116 .\" ----------------------------------------------------------------------------
1117 .SH "WWID generation"
1118 .\" ----------------------------------------------------------------------------
1119 .
1120 Multipath uses a \fIWorld Wide Identification\fR (WWID) to determine
1121 which paths belong to the same device. Each path presenting the same
1122 WWID is assumed to point to the same device.
1123 .LP
1124 The WWID is generated by three methods (in the order of preference):
1125 .TP 17
1126 .B getuid_callout
1127 Use the specified external program; cf \fIgetuid_callout\fR above.
1128 Care should be taken when using this method; the external program
1129 needs to be loaded from disk for execution, which might lead to
1130 deadlock situations in an all-paths-down scenario.
1131 .TP
1132 .B uid_attribute
1133 Use the value of the specified udev attribute; cf \fIuid_attribute\fR
1134 above. This method is preferred to \fIgetuid_callout\fR as multipath
1135 does not need to call any external programs here. However, under
1136 certain circumstances udev might not be able to generate the requested
1137 variable.
1138 .TP
1139 .B vpd_pg83
1140 If none of the \fIgetuid_callout\fR or \fIuid_attribute\fR parameters
1141 are present multipath will try to use the sysfs attribute
1142 \fIvpd_pg83\fR to generate the WWID.
1143 .
1144 .
1145 .\" ----------------------------------------------------------------------------
1146 .SH "KNOWN ISSUES"
1147 .\" ----------------------------------------------------------------------------
1148 .
1149 The usage of \fIqueue_if_no_path\fR option can lead to \fID state\fR
1150 processes being hung and not killable in situations where all the paths to the
1151 LUN go offline. It is advisable to use the \fIno_path_retry\fR option instead.
1152 .P
1153 The use of \fIqueue_if_no_path\fR or \fIno_path_retry\fR might lead to a
1154 deadlock if the \fIdev_loss_tmo\fR setting results in a device being removed
1155 while I/O is still queued. The multipath daemon will update the \fIdev_loss_tmo\fR
1156 setting accordingly to avoid this deadlock. Hence if both values are
1157 specified the order of precedence is \fIno_path_retry, queue_if_no_path, dev_loss_tmo\fR.
1158 .
1159 .
1160 .\" ----------------------------------------------------------------------------
1161 .SH "SEE ALSO"
1162 .\" ----------------------------------------------------------------------------
1163 .
1164 .BR udev (8),
1165 .BR dmsetup (8),
1166 .BR multipath (8),
1167 .BR multipathd (8).
1168 .
1169 .
1170 .\" ----------------------------------------------------------------------------
1171 .SH AUTHORS
1172 .\" ----------------------------------------------------------------------------
1173 .
1174 \fImultipath-tools\fR was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com>
1175 and others.
1176 .\" EOF