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