Remove all references to hand-craftes sysfs code
[multipath-tools/.git] / multipath / multipath.conf.5
1 .TH MULTIPATH.CONF 5 "30 November 2006"
2 .SH NAME
3 multipath.conf \- multipath daemon configuration file
4 .SH DESCRIPTION
5 .B "multipath.conf"
6 is the configuration file for the multipath daemon. It is used to
7 overwrite the built-in configuration table of \fBmultipathd\fP.
8 Any line whose first non-white-space character is a '#' is considered
9 a comment line. Empty lines are ignored.
10 .SH SYNTAX
11 The configuration file contains entries of the form:
12 .RS
13 .nf
14 .ft B
15 .sp
16 <section> {
17 .RS
18 .ft B
19 <attribute> <value>
20 .I "..."
21 .ft B
22 <subsection> {
23 .RS
24 .ft B
25 <attribute> <value>
26 .I "..."
27 .RE
28 }
29 .RE
30 }
31 .ft R
32 .fi
33 .RE
34 .LP
35 Each \fIsection\fP contains one or more attributes or subsections. The
36 recognized keywords for attributes or subsections depend on the
37 section in which they occor.
38 .LP
39 The following \fIsection\fP keywords are recognized:
40 .TP 17
41 .B defaults
42 This section defines default values for attributes which are used
43 whenever no values are given in the appropriate device or multipath
44 sections.
45 .TP
46 .B blacklist
47 This section defines which devices should be excluded from the
48 multipath topology discovery.
49 .TP
50 .B blacklist_exceptions
51 This section defines which devices should be included in the
52 multipath topology discovery, despite being listed in the
53 .I blacklist
54 section.
55 .TP
56 .B multipaths
57 This section defines the multipath topologies. They are indexed by a
58 \fIWorld Wide Identifier\fR(wwid), which is taken to be the value of
59 the udev attribute given by the
60 \fIuid_attribute\fR keyword.
61 .TP
62 .B devices
63 This section defines the device-specific settings.
64 .RE
65 .LP
66 .SH "defaults section"
67 The
68 .B defaults
69 section recognizes the following keywords:
70 .TP 17
71 .B polling_interval
72 interval between two path checks in seconds. For properly functioning paths,
73 the interval between checks will gradually increase to
74 .B max_polling_interval;
75 default is
76 .I 5
77 .TP
78 .B max_polling_interval
79 maximal interval between two path checks in seconds; default is
80 .I 4 * polling_interval
81 .TP
82 .B multipath_dir
83 directory where the dynamic shared objects are stored; default is system
84 dependent, commonly
85 .I /lib/multipath
86 .TP
87 .B verbosity
88 default verbosity. Higher values increase the verbosity level. Valid
89 levels are between 0 and 6; default is
90 .I 2
91 .TP
92 .B reassign_maps
93 enable reassigning of device-mapper maps. With this option multipathd
94 will remap existing device-mapper maps to always point to multipath
95 device, not the underlying block devices. Possible values are
96 \fIyes\fR and \fIno\fR. Default is
97 .I yes
98 .TP
99 .B path_selector
100 The default path selector algorithm to use; they are offered by the
101 kernel multipath target. There are three selector algorithms.
102 .RS
103 .TP 12
104 .B "round-robin 0"
105 Loop through every path in the path group, sending the same amount of IO to
106 each.
107 .TP
108 .B "queue-length 0"
109 Send the next bunch of IO down the path with the least amount of outstanding IO.
110 .TP
111 .B "service-time 0"
112 Choose the path for the next bunch of IO based on the amount of outstanding IO
113 to the path and its relative throughput.
114 .RE
115 .TP
116 .B path_grouping_policy
117 The default path grouping policy to apply to unspecified
118 multipaths. Possible values are
119 .RS
120 .TP 12
121 .B failover
122 1 path per priority group
123 .TP
124 .B multibus
125 all paths in 1 priority group
126 .TP
127 .B group_by_serial
128 1 priority group per serial number
129 .TP
130 .B group_by_prio
131 1 priority group per priority value. Priorities are determined by
132 callout programs specified as a global, per-controller or
133 per-multipath option in the configuration file.
134 .TP
135 .B group_by_node_name
136 1 priority group per target node name. Target node names are fetched
137 in /sys/class/fc_transport/target*/node_name.
138 .TP
139 Default value is \fImultibus\fR.
140 .RE
141 .TP
142 .B uid_attribute
143 The udev attribute providing a unique path
144 identifier. Default value is
145 .I ID_SERIAL
146 .TP
147 .B prio
148 The name of the path priority routine. The specified routine
149 should return a numeric value specifying the relative priority
150 of this path. Higher number have a higher priority.
151 .I "none"
152 is a valid value. Currently the following path priority routines
153 are implemented:
154 .RS
155 .TP 12
156 .B const
157 Return a constant priority of \fI1\fR.
158 .TP
159 .B emc
160 Generate the path priority for EMC arrays.
161 .TP
162 .B alua
163 Generate the path priority based on the SCSI-3 ALUA settings.
164 .TP
165 .B ontap
166 Generate the path priority for NetApp arrays.
167 .TP
168 .B rdac
169 Generate the path priority for LSI/Engenio/NetApp E-Series RDAC controller.
170 .TP
171 .B hp_sw
172 Generate the path priority for Compaq/HP controller in
173 active/standby mode.
174 .TP
175 .B hds
176 Generate the path priority for Hitachi HDS Modular storage arrays.
177 .TP
178 .B random
179 Generate a random priority between 1 and 10.
180 .TP 12
181 .B weightedpath
182 Generate the path priority based on the regular expression and the 
183 priority provided as argument. requires prio_args keyword.
184 .TP
185 Default value is \fBnone\fR.
186 .RE
187 .TP
188 .B prio_args
189 Arguments to pass to to the prio function.  Currently only used with
190 .I weighted, which needs a value of the form
191 .I "<hbtl|devname> <regex1> <prio1> <regex2> <prio2> ..."
192 .I hbtl
193 regex can be of SCSI H:B:T:L format  Ex: 1:0:.:. , *:0:0:.
194 .I devname
195 regex can be of device name format  Ex: sda , sd.e
196 .TP
197 .B features
198 Specify any device-mapper features to be used. Syntax is
199 .I num list
200 where
201 .I num
202 is the number of features in
203 .I list.
204 Possible values for the feature list are
205 .RS
206 .TP 12
207 .B queue_if_no_path
208 Queue IO if no path is active; identical to the
209 .I no_path_retry
210 keyword.
211 .TP
212 .B no_partitions
213 Disable automatic partitions generation via kpartx.
214 .RE
215 .TP
216 .B path_checker
217 The default method used to determine the paths state. Possible values
218 are
219 .RS
220 .TP 12
221 .B readsector0
222 (Deprecated) Read the first sector of the device. This checker is being
223 deprecated, please use \fIdirectio\fR instead
224 .TP
225 .B tur
226 Issue a
227 .I TEST UNIT READY
228 command to the device.
229 .TP
230 .B emc_clariion
231 Query the EMC Clariion specific EVPD page 0xC0 to determine the path
232 state.
233 .TP
234 .B hp_sw
235 Check the path state for HP storage arrays with Active/Standby firmware.
236 .TP
237 .B rdac
238 Check the path state for LSI/Engenio/NetApp E-Series RDAC storage controller.
239 .TP
240 .B directio
241 Read the first sector with direct I/O.
242 .TP
243 Default value is \fIdirectio\fR.
244 .RE
245 .TP
246 .B failback
247 Tell multipathd how to manage path group failback.
248 .RS
249 .TP 12
250 .B immediate
251 Immediately failback to the highest priority pathgroup that contains
252 active paths.
253 .TP
254 .B manual
255 Do not perform automatic failback.
256 .TP
257 .B values > 0
258 deferred failback (time to defer in seconds)
259 .TP
260 Default value is \fImanual\fR.
261 .RE
262 .TP
263 .B  rr_min_io
264 The number of IO to route to a path before switching to the next in
265 the same path group. This is only for BIO based multipath. Default is
266 .I 1000
267 .TP
268 .B rr_min_io_q
269 The number of IO requests to route to a path before switching to the
270 next in the same path group. This is only for request based multipath.
271 Default is
272 .I 1
273 .TP
274 .B rr_weight
275 If set to \fIpriorities\fR the multipath configurator will assign
276 path weights as "path prio * rr_min_io". Possible values are
277 .I priorities
278 or
279 .IR uniform .
280 Default is
281 .IR uniform .
282 .TP
283 .B no_path_retry
284 Specify the number of retries until disable queueing, or
285 .I fail
286 for immediate failure (no queueing),
287 .I queue
288 for never stop queueing. Default is 0.
289 .TP
290 .B user_friendly_names
291 If set to 
292 .I yes
293 , using the bindings file
294 .I /etc/multipath/bindings
295 to assign a persistent and unique alias to the multipath, in the form of mpath<n>.
296 If set to 
297 .I no
298 use the WWID as the alias. In either case this be will
299 be overriden by any specific aliases in the \fImultipaths\fR section.
300 Default is
301 .I no
302 .TP
303 .B flush_on_last_del
304 If set to
305 .I yes
306 , multipathd will disable queueing when the last path to a device has been
307 deleted. Default is
308 .I no
309 .TP
310 .B max_fds
311 Specify the maximum number of file descriptors that can be opened by multipath
312 and multipathd.  This is equivalent to ulimit -n. A value of \fImax\fR will set
313 this to the system limit from /proc/sys/fs/nr_open. If this is not set, the
314 maximum number of open fds is taken from the calling process. It is usually
315 1024. To be safe, this should be set to the maximum number of paths plus 32,
316 if that number is greated than 1024.
317 .TP
318 .B checker_timeout
319 Specify the timeout to user for path checkers that issue scsi commands with an
320 explict timeout, in seconds; default taken from
321 .I /sys/block/sd<x>/device/timeout
322 .TP
323 .B fast_io_fail_tmo
324 Specify the number of seconds the scsi layer will wait after a problem has been
325 detected on a FC remote port before failing IO to devices on that remote port.
326 This should be smaller than dev_loss_tmo. Setting this to
327 .I off
328 will disable the timeout.
329 .TP
330 .B dev_loss_tmo
331 Specify the number of seconds the scsi layer will wait after a problem has
332 been detected on a FC remote port before removing it from the system. This
333 can be set to "infinity" which sets it to the max value of 2147483647
334 seconds, or 68 years.
335 .TP
336 .B queue_without_daemon
337 If set to
338 .I no
339 , when multipathd stops, queueing will be turned off for all devices.
340 This is useful for devices that set no_path_retry.  If a machine is
341 shut down while all paths to a device are down, it is possible to hang waiting
342 for IO to return from the device after multipathd has been stopped. Without
343 multipathd running, access to the paths cannot be restored, and the kernel
344 cannot be told to stop queueing IO. Setting queue_without_daemon to
345 .I no
346 , avoids this problem. Default is
347 .I yes
348 .TP
349 .B bindings_file
350 The full pathname of the binding file to be used when the user_friendly_names option is set. Defaults to
351 .I /var/lib/multipath/bindings
352 .TP
353 .B log_checker_err
354 If set to
355 .I once
356 , multipathd logs the first path checker error at logging level 2. Any later
357 errors are logged at level 3 until the device is restored. If set to
358 .I always
359 , multipathd always logs the path checker error at logging level 2. Default is
360 .I always
361 .
362 .SH "blacklist section"
363 The
364 .I blacklist
365 section is used to exclude specific device from inclusion in the
366 multipath topology. It is most commonly used to exclude local disks or
367 LUNs for the array controller.
368 .LP
369 The following keywords are recognized:
370 .TP 17
371 .B wwid
372 The \fIWorld Wide Identification\fR of a device.
373 .TP
374 .B devnode
375 Regular expression of the device nodes to be excluded.
376 .TP
377 .B device
378 Subsection for the device description. This subsection recognizes the
379 .I vendor
380 and
381 .I product
382 keywords. For a full description of these keywords please see the
383 .I devices
384 section description.
385 .SH "blacklist_exceptions section"
386 The
387 .I blacklist_exceptions
388 section is used to revert the actions of the
389 .I blacklist
390 section, ie to include specific device in the
391 multipath topology. This allows to selectively include devices which
392 would normally be excluded via the
393 .I blacklist
394 section.
395 .LP
396 The following keywords are recognized:
397 .TP 17
398 .B wwid
399 The \fIWorld Wide Identification\fR of a device.
400 .TP
401 .B devnode
402 Regular expression of the device nodes to be excluded.
403 .TP
404 .B device
405 Subsection for the device description. This subsection recognizes the
406 .I vendor
407 and
408 .I product
409 keywords. For a full description of these keywords please see the
410 .I devices
411 section description.
412 .SH "multipaths section"
413 The only recognized attribute for the
414 .B multipaths
415 section is the
416 .I multipath
417 subsection.
418 .LP
419 The
420 .B multipath
421 subsection recognizes the following attributes:
422 .TP 17
423 .B wwid
424 Index of the container. Mandatory for this subsection.
425 .TP
426 .B alias
427 (Optional) symbolic name for the multipath map.
428 .LP
429 The following attributes are optional; if not set the default values
430 are taken from the
431 .I defaults
432 or
433 .I devices
434 section:
435 .sp 1
436 .PD .1v
437 .RS
438 .TP 18
439 .B path_grouping_policy
440 .TP
441 .B path_selector
442 .TP
443 .B prio
444 .TP
445 .B prio_args
446 .TP
447 .B failback
448 .TP
449 .B rr_weight
450 .TP
451 .B flush_on_last_del
452 .TP
453 .B no_path_retry
454 .TP
455 .B rr_min_io
456 .TP
457 .B rr_min_io_q
458 .TP
459 .B features
460 .RE
461 .PD
462 .LP
463 .SH "devices section"
464 The only recognized attribute for the
465 .B devices
466 section is the
467 .I device
468 subsection.
469 .LP
470 The
471 .I device
472 subsection recognizes the following attributes:
473 .TP 17
474 .B vendor
475 (Mandatory) Vendor identifier
476 .TP
477 .B product
478 (Mandatory) Product identifier
479 .TP
480 .B revision
481 (Optional) Revision identfier
482 .TP
483 .B product_blacklist
484 (Optional) Product strings to blacklist for this vendor
485 .TP
486 .B alias_prefix
487 (Optional) The user_friendly_names prefix to use for this
488 device type, instead of the default "mpath"
489 .TP
490 .B hardware_handler
491 (Optional) The hardware handler to use for this device type.
492 The following hardware handler are implemented:
493 .RS
494 .TP 12
495 .B 1 emc
496 Hardware handler for EMC storage arrays.
497 .TP
498 .B 1 rdac
499 Hardware handler for LSI/Engenio/NetApp E-Series RDAC storage controller.
500 .TP
501 .B 1 hp_sw
502 Hardware handler for Compaq/HP storage arrays in active/standby
503 mode.
504 .TP
505 .B 1 alua
506 Hardware handler for SCSI-3 ALUA compatible arrays.
507 .RE
508 .LP
509 The following attributes are optional; if not set the default values
510 are taken from the
511 .I defaults
512 section:
513 .sp 1
514 .PD .1v
515 .RS
516 .TP 18
517 .B path_grouping_policy
518 .TP
519 .B uid_attribute
520 .TP
521 .B path_selector
522 .TP
523 .B path_checker
524 .TP
525 .B prio
526 .TP
527 .B prio_args
528 .TP
529 .B features
530 .TP
531 .B failback
532 .TP
533 .B rr_weight
534 .TP
535 .B no_path_retry
536 .TP
537 .B rr_min_io
538 .TP
539 .B rr_min_io_rq
540 .TP
541 .B fast_io_fail_tmo
542 .TP
543 .B dev_loss_tmo
544 .TP
545 .B flush_on_last_del
546 .RE
547 .PD
548 .LP
549 .SH "KNOWN ISSUES"
550 The usage of
551 .B queue_if_no_path
552 option can lead to
553 .B D state
554 processes being hung and not killable in situations where all the paths to the LUN go offline.
555 It is advisable to use the
556 .B no_path_retry
557 option instead.
558 .P
559 The use of
560 .B queue_if_no_path
561 or
562 .B no_path_retry
563 might lead to a deadlock if the
564 .B dev_loss_tmo
565 setting results in a device being removed while I/O is still queued.
566 The multipath daemon will update the
567 .B dev_loss_tmo
568 setting accordingly to avoid this deadlock. Hence if both values are
569 specified the order of precedence is
570 .I no_path_retry, queue_if_no_path, dev_loss_tmo
571
572 .SH "SEE ALSO"
573 .BR udev (8),
574 .BR dmsetup (8)
575 .BR multipath (8)
576 .BR multipathd (8)
577 .SH AUTHORS
578 .B multipath
579 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.