15ec468a82f47905c64f3eaa89e977a55fb22f46
[multipath-tools/.git] / multipath.conf.annotated
1 ##
2 ## This is a template multipath-tools configuration file
3 ## Uncomment the lines relevent to your environment
4 ##
5 #
6 ##
7 ## name  : defaults
8 ## desc  : multipath-tools default settings
9 ##
10 #defaults {
11 #       #
12 #       # name    : udev_dir
13 #       # desc    : directory where udev creates its device nodes
14 #       # default : /dev
15 #       #
16 #       udev_dir        /dev
17 #
18 #       #
19 #       # name    : polling_interval
20 #       # scope   : multipathd
21 #       # desc    : interval between two path checks in seconds. For
22 #       #           properly functioning paths, the interval between checks
23 #       #           will gradually increase to (4 * polling_interval).
24 #       # values  : n > 0
25 #       # default : 5
26 #       #
27 #       polling_interval 10
28 #
29 #       #
30 #       # name    : path_selector
31 #       # scope   : multipath & multipathd
32 #       # desc    : the default path selector algorithm to use
33 #       #           these algorithms are offered by the kernel multipath target
34 #       # values  : "round-robin 0"  = Loop through every path in the path group,
35 #       #                              sending the same amount of IO to each.
36 #       #           "queue-length 0" = Send the next bunch of IO down the path
37 #       #                              with the least amount of outstanding IO.
38 #       #           "service-time 0" = Choose the path for the next bunch of IO
39 #       #                              based on the amount of outstanding IO to
40 #       #                              the path and its relative throughput.
41 #       # default : "service-time 0"
42 #       #
43 #       path_selector   "service-time 0"
44 #
45 #       #
46 #       # name    : path_grouping_policy
47 #       # scope   : multipath & multipathd
48 #       # desc    : the default path grouping policy to apply to unspecified
49 #       #           multipaths
50 #       # values  : failover           = 1 path per priority group
51 #       #           multibus           = all valid paths in 1 priority group
52 #       #           group_by_serial    = 1 priority group per detected serial
53 #       #                                number
54 #       #           group_by_prio      = 1 priority group per path priority
55 #       #                                value
56 #       #           group_by_node_name = 1 priority group per target node name
57 #       # default : failover
58 #       #
59 #       path_grouping_policy    multibus
60 #
61 #       #
62 #       # name    : uid_attribute
63 #       # scope   : multipath & multipathd
64 #       # desc    : the default udev attribute from which the path
65 #       #           identifier should be generated.
66 #       # default : ID_SERIAL
67 #       #
68 #       uid_attribute   "ID_SERIAL"
69 #
70 #       #
71 #       # name    : getuid_callout
72 #       # scope   : multipath & multipathd
73 #       # desc    : the default program and args to callout to obtain a unique 
74 #       #           path identifier. This parameter is deprecated.
75 #       #           This parameter is deprecated, superseded by uid_attribute
76 #       # default : /lib/udev/scsi_id --whitelisted --device=/dev/%n
77 #       #
78 #       getuid_callout  "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
79 #
80 #       #
81 #       # name    : prio
82 #       # scope   : multipath & multipathd
83 #       # desc    : the default function to call to obtain a path 
84 #       #           priority value. The ALUA bits in SPC-3 provide an
85 #       #           exploitable prio value for example.
86 #       # default : const
87 #       #
88 #       prio    "alua"
89 #
90 #       #
91 #       # name    : prio_args
92 #       # scope   : multipath & multipathd
93 #       # desc    : The arguments string passed to the prio function
94 #       #           Most prio functions do not need arguments. The
95 #       #           datacore prioritizer need one.
96 #       # default : (null)
97 #       #
98 #       prio_args       "timeout=1000 preferredsds=foo"
99 #
100 #       #
101 #       # name    : features
102 #       # scope   : multipath & multipathd
103 #       # desc    : The default extra features of multipath devices.
104 #       #           Syntax is "num[ feature_0 feature_1 ...]", where `num' is the
105 #       #           number of features in the following (possibly empty) list of
106 #       #           features.
107 #       # values  : queue_if_no_path = Queue IO if no path is active; consider
108 #       #                              using the `no_path_retry' keyword instead.
109 #       #           no_partitions    = Disable automatic partitions generation via
110 #       #                              kpartx.
111 #       # default : "0"
112 #       #
113 #       features        "0"
114 #       features        "1 queue_if_no_path"
115 #       features        "1 no_partitions"
116 #       features        "2 queue_if_no_path no_partitions"
117 #
118 #       #
119 #       # name    : path_checker, checker
120 #       # scope   : multipath & multipathd
121 #       # desc    : the default method used to determine the paths' state
122 #       # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|cciss_tur
123 #       # default : directio
124 #       #
125 #       path_checker    directio
126 #
127 #       #
128 #       # name    : rr_min_io
129 #       # scope   : multipath & multipathd
130 #       # desc    : the number of IO to route to a path before switching
131 #       #           to the next in the same path group
132 #       # default : 1000
133 #       #
134 #       rr_min_io       100
135 #
136 #       #
137 #       # name    : flush_on_last_del
138 #       # scope   : multipathd
139 #       # desc    : If set to "yes", multipathd will disable queueing when the
140 #       #           last path to a device has been deleted.
141 #       # values  : yes|no
142 #       # default : no
143 #       #
144 #       flush_on_last_del       yes
145 #
146 #       #
147 #       # name    : max_fds
148 #       # scope   : multipathd
149 #       # desc    : Sets the maximum number of open file descriptors for the
150 #       #           multipathd process.
151 #       # values  : max|n > 0
152 #       # default : None
153 #       #
154 #       max_fds         8192
155 #
156 #       #
157 #       # name    : rr_weight
158 #       # scope   : multipath & multipathd
159 #       # desc    : if set to priorities the multipath configurator will assign
160 #       #           path weights as "path prio * rr_min_io"
161 #       # values  : priorities|uniform
162 #       # default : uniform
163 #       #
164 #       rr_weight       priorities
165 #
166 #       #
167 #       # name    : failback
168 #       # scope   : multipathd
169 #       # desc    : tell the daemon to manage path group failback, or not to.
170 #       #           0 means immediate failback, values >0 means deffered
171 #       #           failback expressed in seconds.
172 #       # values  : manual|immediate|n > 0
173 #       # default : manual
174 #       #
175 #       failback        immediate
176 #
177 #       #
178 #       # name    : no_path_retry
179 #       # scope   : multipath & multipathd
180 #       # desc    : tell the number of retries until disable queueing, or
181 #       #           "fail" means immediate failure (no queueing),
182 #       #           "queue" means never stop queueing
183 #       # values  : queue|fail|n (>0)
184 #       # default : (null)
185 #       #
186 #       no_path_retry  queue
187 #
188 #       #
189 #       # name    : queue_without_daemon
190 #       # scope   : multipathd
191 #       # desc    : If set to "no", multipathd will disable queueing for all
192 #       #           devices when it is shut down.
193 #       # values  : yes|no
194 #       # default : yes
195 #       queue_without_daemon    no
196 #
197 #       #
198 #       # name    : user_friendly_names
199 #       # scope   : multipath & multipathd
200 #       # desc    : If set to "yes", using the bindings file
201 #       #           /etc/multipath/bindings to assign a persistent and
202 #       #           unique alias to the multipath, in the form of mpath<n>.
203 #       #           If set to "no" use the WWID as the alias. In either case
204 #       #           this be will be overriden by any specific aliases in this
205 #       #           file.
206 #       # values  : yes|no
207 #       # default : no
208 #       user_friendly_names no
209 #
210 #       #
211 #       # name    : mode
212 #       # scope   : multipath & multipathd
213 #       # desc    : The mode to use for the multipath device nodes, in octal.
214 #       # values  : 0000 - 0777
215 #       # default : determined by the process
216 #       mode 0644
217 #
218 #       #
219 #       # name    : uid
220 #       # scope   : multipath & multipathd
221 #       # desc    : The user id to use for the multipath device nodes. You
222 #       #           may use either the numeric or symbolic uid
223 #       # values  : <user_id>
224 #       # default : determined by the process
225 #       uid 0
226 #
227 #       #
228 #       # name    : gid
229 #       # scope   : multipath & multipathd
230 #       # desc    : The group id to user for the multipath device nodes. You
231 #       #           may use either the numeric or symbolic gid
232 #       # values  : <group_id>
233 #       # default : determined by the process
234 #       gid disk
235 #
236 #       #
237 #       # name    : checker_timeout
238 #       # scope   : multipath & multipathd
239 #       # desc    : The timeout to use for path checkers that issue scsi
240 #       #           commands with an explicit timeout, in seconds.
241 #       # values  : n > 0
242 #       # default : taken from /sys/block/sd<x>/device/timeout
243 #       checker_timeout 60
244 #
245 #       #
246 #       # name    : fast_io_fail_tmo
247 #       # scope   : multipath & multipathd
248 #       # desc    : The number of seconds the scsi layer will wait after a
249 #       #           problem has been detected on a FC remote port before failing
250 #       #           IO to devices on that remote port.
251 #       # values  : off | n >= 0 (smaller than dev_loss_tmo)
252 #       # default : determined by the OS
253 #       fast_io_fail_tmo 5
254 #
255 #       #
256 #       # name    : dev_loss_tmo
257 #       # scope   : multipath & multipathd
258 #       # desc    : The number of seconds the scsi layer will wait after a
259 #       #           problem has been detected on a FC remote port before
260 #       #           removing it from the system.
261 #       # values  : infinity | n > 0
262 #       # default : determined by the OS
263 #       dev_loss_tmo 600
264 #
265 #       # name    : bindings_file
266 #       # scope   : multipath
267 #       # desc    : The location of the bindings file that is used with
268 #       #           the user_friendly_names option.
269 #       # values  : <full_pathname>
270 #       # default : "/var/lib/multipath/bindings"
271 #       bindings_file "/etc/multipath_bindings"
272 #
273 #}
274 #       
275 ##
276 ## name    : blacklist
277 ## scope   : multipath & multipathd
278 ## desc    : list of device names to discard as not multipath candidates
279 ##           Devices can be identified by their device node name "devnode",
280 ##           their WWID "wwid", or their vender and product strings
281 ##           "device"
282 ## default : fd, hd, md, dm, sr, scd, st, ram, raw, loop, dcssblk
283 ##
284 #blacklist {
285 #       wwid 26353900f02796769
286 #       devnode "^(ram|raw|loop|fd|md|dm-|sr|scd|st)[0-9]*"
287 #       devnode "^hd[a-z]"
288 #       devnode "^dcssblk[0-9]*"
289 #       device {
290 #               vendor DEC.*
291 #               product MSA[15]00
292 #       }
293 #}
294 ##
295 ## name    : blacklist_exceptions
296 ## scope   : multipath & multipathd
297 ## desc    : list of device names to be treated as multipath candidates
298 ##           even if they are on the blacklist.
299 ##           Note: blacklist exceptions are only valid in the same class.
300 ##           It is not possible to blacklist devices using the devnode keyword
301 ##           and to exclude some devices of them using the wwid keyword.
302 ## default : -
303 ##
304 #blacklist_exceptions {
305 #       devnode "^dasd[c-d]+[0-9]*"
306 #       wwid    "IBM.75000000092461.4d00.34"
307 #       wwid    "IBM.75000000092461.4d00.35"
308 #       wwid    "IBM.75000000092461.4d00.36"
309 #}
310 #
311 ##
312 ## name    : multipaths
313 ## scope   : multipath & multipathd
314 ## desc    : list of multipaths finest-grained settings
315 ##
316 #multipaths {
317 #       #
318 #       # name  : multipath
319 #       # scope : multipath & multipathd
320 #       # desc  : container for settings that apply to one specific multipath
321 #       #
322 #       multipath {
323 #               #
324 #               # name  : wwid
325 #               # scope : multipath & multipathd
326 #               # desc  : index of the container
327 #               #
328 #               wwid                    3600508b4000156d700012000000b0000
329 #
330 #               #
331 #               # name    : alias
332 #               # scope   : multipath & multipathd
333 #               # desc    : symbolic name for the multipath. If you are using
334 #               #           user_friendly_names, do not set the alias to
335 #               #           mpath<n>. This may conflict with an automatically
336 #               #           assigned user friendly name, and give you
337 #               #           incorrect device node names.
338 #               #
339 #               alias                   yellow
340 #
341 #               #
342 #               # name    : path_grouping_policy
343 #               # scope   : multipath & multipathd
344 #               # desc    : path grouping policy to apply to this multipath
345 #               # values  : failover, multibus, group_by_serial
346 #               # values  : failover           = 1 path per priority group
347 #               #           multibus           = all valid paths in 1 priority
348 #               #                                group
349 #               #           group_by_serial    = 1 priority group per detected
350 #               #                                serial number
351 #               #           group_by_prio      = 1 priority group per path
352 #               #                                priority value
353 #               #           group_by_node_name = 1 priority group per target
354 #               #                                node name
355 #               #
356 #               path_grouping_policy    failover
357 #
358 #               #
359 #               # name    : path_selector
360 #               # scope   : multipath & multipathd
361 #               # desc    : the path selector algorithm to use for this mpath
362 #               #           these algo are offered by the kernel mpath target
363 #               # values  : "round-robin 0"
364 #               #
365 #               path_selector           "round-robin 0"
366 #
367 #               #
368 #               # name    : failback
369 #               # scope   : multipathd
370 #               # desc    : tell the daemon to manage path group failback, or
371 #               #           not to. 0 means immediate failback, values >0 means
372 #               #           deffered failback expressed in seconds.
373 #               # values  : manual|immediate|n > 0
374 #               #
375 #               failback                manual
376 #
377 #               #
378 #               # name    : rr_weight
379 #               # scope   : multipath & multipathd
380 #               # desc    : if set to priorities the multipath configurator will
381 #               #           assign path weights as "path prio * rr_min_io"
382 #               # values  : priorities|uniform
383 #               #
384 #               rr_weight       priorities
385 #
386 #               #
387 #               # name    : no_path_retry
388 #               # scope   : multipath & multipathd
389 #               # desc    : tell the number of retries until disable queueing,
390 #               #           or "fail" means immediate failure (no queueing),
391 #               #           "queue" means never stop queueing
392 #               # values  : queue|fail|n (>0)
393 #               #
394 #               no_path_retry  queue
395 #
396 #               #
397 #               # name    : rr_min_io
398 #               # scope   : multipath & multipathd
399 #               # desc    : the number of IO to route to a path before switching
400 #               #           to the next in the same path group
401 #               #
402 #               rr_min_io       100
403 #
404 #               #
405 #               # name    : flush_on_last_del
406 #               # scope   : multipathd
407 #               # desc    : If set to "yes", multipathd will disable queueing
408 #               #           when the last path to a device has been deleted.
409 #               # values  : yes|no
410 #               # default : no
411 #               #
412 #               flush_on_last_del       yes
413 #
414 #               #
415 #               # name    : mode
416 #               # scope   : multipath & multipathd
417 #               # desc    : The mode to use for the multipath device nodes, in
418 #               #           octal.
419 #               # values  : 0000 - 0777
420 #               # default : determined by the process
421 #               mode 0644
422 #
423 #               #
424 #               # name    : uid
425 #               # scope   : multipath & multipathd
426 #               # desc    : The user id to use for the multipath device nodes.
427 #               #           You may use either the numeric or symbolic uid
428 #               # values  : <user_id>
429 #               # default : determined by the process
430 #               uid 0
431 #
432 #               #
433 #               # name    : gid
434 #               # scope   : multipath & multipathd
435 #               # desc    : The group id to user for the multipath device nodes.
436 #               #           You may use either the numeric or symbolic gid
437 #               # values  : <group_id>
438 #               # default : determined by the process
439 #               gid 0
440 #
441 #       }
442 #       multipath {
443 #               wwid    1DEC_____321816758474
444 #               alias   red
445 #               rr_weight               priorities
446 #       }
447 #}
448 #
449 ##
450 ## name  : devices
451 ## scope : multipath & multipathd
452 ## desc  : list of per storage controller settings
453 ##        overrides default settings (device_maps block)
454 ##         overriden by per multipath settings (multipaths block)
455 ##
456 #devices {
457 #       #
458 #       # name  : device
459 #       # scope : multipath & multipathd
460 #       # desc  : settings for this specific storage controller
461 #       #
462 #       device {
463 #               #
464 #               # name  : vendor, product
465 #               # scope : multipath & multipathd
466 #               # desc  : index for the block
467 #               #
468 #               vendor                  "COMPAQ  "
469 #               product                 "HSV110 (C)COMPAQ"
470 #
471 #               #
472 #               # name    : path_grouping_policy
473 #               # scope   : multipath & multipathd
474 #               # desc    : path grouping policy to apply to this multipath
475 #               # values  : failover, multibus, group_by_serial
476 #               # values  : failover           = 1 path per priority group
477 #               #           multibus           = all valid paths in 1 priority
478 #               #                                group
479 #               #           group_by_serial    = 1 priority group per detected
480 #               #                                serial number
481 #               #           group_by_prio      = 1 priority group per path
482 #               #                                priority value
483 #               #           group_by_node_name = 1 priority group per target
484 #               #                                node name
485 #               #
486 #               path_grouping_policy    failover
487 #
488 #               #
489 #               # name    : getuid_callout
490 #               # scope   : multipath & multipathd
491 #               # desc    : the program and args to callout to obtain a unique 
492 #               #           path identifier. Absolute path required
493 #               #
494 #               getuid_callout          "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
495 #
496 #               #
497 #               # name    : prio
498 #               # scope   : multipath & multipathd
499 #               # desc    : the function to call to obtain a path 
500 #               #           weight. Weights are summed for each path group to
501 #               #           determine the next PG to use case of failure.
502 #               # default : no callout, all paths equals
503 #               #
504 #               prio          "hp_sw"
505 #
506 #               #
507 #               # name    : prio_args
508 #               # scope   : multipath & multipathd
509 #               # desc    : The arguments string passed to the prio function
510 #               #           Most prio functions do not need arguments. The
511 #               #           datacore prioritizer need one.
512 #               # default : (null)
513 #               #
514 #               prio_args       "timeout=1000 preferredsds=foo"
515 #
516 #               # name    : path_checker, checker
517 #               # scope   : multipathd & multipathd
518 #               # desc    : path checking algorithm to use to check path state
519 #               # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|
520 #               #           cciss_tur
521 #               #
522 #               path_checker            directio
523 #
524 #               # as already described
525 #               path_selector           "service-time 0"
526 #
527 #               # as already described
528 #               features        "0"
529 #
530 #               #
531 #               # name    : hardware_handler
532 #               # scope   : multipath & multipathd
533 #               # desc    : If set, it specifies a module that will be used to
534 #               #           perform hardware specific actions when switching
535 #               #           path groups or handling IO errors
536 #               # values  : "0"|"1 emc"
537 #               # default : "0"
538 #               #
539 #               hardware_handler "1 emc"
540 #
541 #               #
542 #               # name    : failback
543 #               # scope   : multipathd
544 #               # desc    : tell the daemon to manage path group failback, or
545 #               #           not to. 0 means immediate failback, values >0 means
546 #               #           deffered failback expressed in seconds.
547 #               # values  : manual|immediate|n > 0
548 #               #
549 #               failback                30
550 #
551 #               #
552 #               # name    : rr_weight
553 #               # scope   : multipath & multipathd
554 #               # desc    : if set to priorities the multipath configurator will
555 #               #           assign path weights as "path prio * rr_min_io"
556 #               # values  : priorities|uniform
557 #               #
558 #               rr_weight       priorities
559 #
560 #               #
561 #               # name    : no_path_retry
562 #               # scope   : multipath & multipathd
563 #               # desc    : tell the number of retries until disable queueing,
564 #               #           or "fail" means immediate failure (no queueing),
565 #               #           "queue" means never stop queueing
566 #               # values  : queue|fail|n (>0)
567 #               #
568 #               no_path_retry  queue
569 #
570 #               #
571 #               # name    : rr_min_io
572 #               # scope   : multipath & multipathd
573 #               # desc    : the number of IO to route to a path before switching
574 #               #           to the next in the same path group
575 #               #
576 #               rr_min_io       100
577 #
578 #               #
579 #               # name    : flush_on_last_del
580 #               # scope   : multipathd
581 #               # desc    : If set to "yes", multipathd will disable queueing
582 #               #           when the last path to a device has been deleted.
583 #               # values  : yes|no
584 #               #
585 #               flush_on_last_del       yes
586 #
587 #               #
588 #               # name    : product_blacklist
589 #               # scope   : multipath & multipathd
590 #               # desc    : product strings to blacklist for this vendor
591 #               #
592 #               product_blacklist       LUN_Z
593 #
594 #               #
595 #               # name    : fast_io_fail_tmo
596 #               # scope   : multipath & multipathd
597 #               # desc    : The number of seconds the scsi layer will wait after
598 #               #           a problem has been detected on a FC remote port
599 #               #           before failing IO to devices on that remote port.
600 #               # values  : off | n >= 0 (smaller than dev_loss_tmo)
601 #               fast_io_fail_tmo 5
602 #
603 #               #
604 #               # name    : dev_loss_tmo
605 #               # scope   : multipath & multipathd
606 #               # desc    : The number of seconds the scsi layer will wait after
607 #               #           a problem has been detected on a FC remote port
608 #               #           before removing it from the system.
609 #               # values  : n > 0
610 #               dev_loss_tmo 600
611 #       }
612 #       device {
613 #               vendor                  "COMPAQ  "
614 #               product                 "MSA1000         "
615 #               path_grouping_policy    multibus
616 #               path_checker            tur
617 #               rr_weight               priorities
618 #       }
619 #}