multipath-tools: update scsi_id arguments
[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
22 #       # values  : n > 0
23 #       # default : 5
24 #       #
25 #       polling_interval 10
26 #
27 #       #
28 #       # name    : selector
29 #       # scope   : multipath
30 #       # desc    : the default path selector algorithm to use
31 #       #           these algorithms are offered by the kernel multipath target
32 #       # values  : "round-robin 0"
33 #       # default : "round-robin 0"
34 #       #
35 #       selector        "round-robin 0"
36 #
37 #       #
38 #       # name    : path_grouping_policy
39 #       # scope   : multipath
40 #       # desc    : the default path grouping policy to apply to unspecified
41 #       #           multipaths
42 #       # values  : failover           = 1 path per priority group
43 #       #           multibus           = all valid paths in 1 priority group
44 #       #           group_by_serial    = 1 priority group per detected serial
45 #       #                                number
46 #       #           group_by_prio      = 1 priority group per path priority
47 #       #                                value
48 #       #           group_by_node_name = 1 priority group per target node name
49 #       # default : failover
50 #       #
51 #       path_grouping_policy    multibus
52 #
53 #       #
54 #       # name    : getuid_callout
55 #       # scope   : multipath
56 #       # desc    : the default program and args to callout to obtain a unique 
57 #       #           path identifier. Absolute path required
58 #       # default : /lib/udev/scsi_id --whitelisted --device=/dev/%n
59 #       #
60 #       getuid_callout  "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
61 #
62 #       #
63 #       # name    : prio
64 #       # scope   : multipath
65 #       # desc    : the default function to call to obtain a path 
66 #       #           priority value. The ALUA bits in SPC-3 provide an
67 #       #           exploitable prio value for example.
68 #       # default : (null)
69 #       #
70 #       prio    "alua"
71 #
72 #       #
73 #       # name    : features
74 #       # scope   : multipath
75 #       # desc    : The default extra features of multipath devices. The
76 #       #           only existing feature currently is queue_if_no_path, which
77 #       #           is the same as setting no_path_retry to queue.
78 #       # values  : "1 queue_if_no_path"
79 #       # default : (null)
80 #       #
81 #       features        "1 queue_if_no_path"
82 #
83 #       #
84 #       # name    : path_checker, checker
85 #       # scope   : multipath & multipathd
86 #       # desc    : the default method used to determine the paths' state
87 #       # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|cciss_tur
88 #       # default : directio
89 #       #
90 #       path_checker    directio
91 #
92 #       #
93 #       # name    : rr_min_io
94 #       # scope   : multipath
95 #       # desc    : the number of IO to route to a path before switching
96 #       #           to the next in the same path group
97 #       # default : 1000
98 #       #
99 #       rr_min_io       100
100 #
101 #       #
102 #       # name    : flush_on_last_del
103 #       # scope   : multipathd
104 #       # desc    : If set to "yes", multipathd will disable queueing when the
105 #       #           last path to a device has been deleted.
106 #       # values  : yes|no
107 #       # default : no
108 #       #
109 #       flush_on_last_del       yes
110 #
111 #       #
112 #       # name    : max_fds
113 #       # scope   : multipathd
114 #       # desc    : Sets the maximum number of open file descriptors for the
115 #       #           multipathd process.
116 #       # values  : unlimited|n > 0
117 #       # default : None
118 #       #
119 #       max_fds         8192
120 #
121 #       #
122 #       # name    : rr_weight
123 #       # scope   : multipath
124 #       # desc    : if set to priorities the multipath configurator will assign
125 #       #           path weights as "path prio * rr_min_io"
126 #       # values  : priorities|uniform
127 #       # default : uniform
128 #       #
129 #       rr_weight       priorities
130 #
131 #       #
132 #       # name    : failback
133 #       # scope   : multipathd
134 #       # desc    : tell the daemon to manage path group failback, or not to.
135 #       #           0 means immediate failback, values >0 means deffered
136 #       #           failback expressed in seconds.
137 #       # values  : manual|immediate|n > 0
138 #       # default : manual
139 #       #
140 #       failback        immediate
141 #
142 #       #
143 #       # name    : no_path_retry
144 #       # scope   : multipath & multipathd
145 #       # desc    : tell the number of retries until disable queueing, or
146 #       #           "fail" means immediate failure (no queueing),
147 #       #           "queue" means never stop queueing
148 #       # values  : queue|fail|n (>0)
149 #       # default : (null)
150 #       #
151 #       no_path_retry  queue
152 #
153 #       #
154 #       # name    : user_friendly_names
155 #       # scope   : multipath
156 #       # desc    : If set to "yes", using the bindings file
157 #       #           /var/lib/multipath/bindings to assign a persistent and
158 #       #           unique alias to the multipath, in the form of mpath<n>.
159 #       #           If set to "no" use the WWID as the alias. In either case
160 #       #           this be will be overriden by any specific aliases in this
161 #       #           file.
162 #       # values  : yes|no
163 #       # default : no
164 #       user_friendly_names no
165 #
166 #}
167 #       
168 ##
169 ## name    : blacklist
170 ## scope   : multipath & multipathd
171 ## desc    : list of device names to discard as not multipath candidates
172 ##           Devices can be identified by their device node name "devnode",
173 ##           their WWID "wwid", or their vender and product strings
174 ##           "device"
175 ## default : fd, hd, md, dm, sr, scd, st, ram, raw, loop, dcssblk
176 ##
177 #blacklist {
178 #       wwid 26353900f02796769
179 #       devnode "^(ram|raw|loop|fd|md|dm-|sr|scd|st)[0-9]*"
180 #       devnode "^hd[a-z]"
181 #       devnode "^dcssblk[0-9]*"
182 #       device {
183 #               vendor DEC.*
184 #               product MSA[15]00
185 #       }
186 #}
187 ##
188 ## name    : blacklist_exceptions
189 ## scope   : multipath & multipathd
190 ## desc    : list of device names to be treated as multipath candidates
191 ##           even if they are on the blacklist.
192 ##           Note: blacklist exceptions are only valid in the same class.
193 ##           It is not possible to blacklist devices using the devnode keyword
194 ##           and to exclude some devices of them using the wwid keyword.
195 ## default : -
196 ##
197 #blacklist_exceptions {
198 #       devnode "^dasd[c-d]+[0-9]*"
199 #       wwid    "IBM.75000000092461.4d00.34"
200 #       wwid    "IBM.75000000092461.4d00.35"
201 #       wwid    "IBM.75000000092461.4d00.36"
202 #}
203 #
204 ##
205 ## name    : multipaths
206 ## scope   : multipath & multipathd
207 ## desc    : list of multipaths finest-grained settings
208 ##
209 #multipaths {
210 #       #
211 #       # name  : multipath
212 #       # scope : multipath & multipathd
213 #       # desc  : container for settings that apply to one specific multipath
214 #       #
215 #       multipath {
216 #               #
217 #               # name  : wwid
218 #               # scope : multipath & multipathd
219 #               # desc  : index of the container
220 #               #
221 #               wwid                    3600508b4000156d700012000000b0000
222 #
223 #               #
224 #               # name    : alias
225 #               # scope   : multipath
226 #               # desc    : symbolic name for the multipath
227 #               #
228 #               alias                   yellow
229 #
230 #               #
231 #               # name    : path_grouping_policy
232 #               # scope   : multipath
233 #               # desc    : path grouping policy to apply to this multipath
234 #               # values  : failover, multibus, group_by_serial
235 #               # values  : failover           = 1 path per priority group
236 #               #           multibus           = all valid paths in 1 priority
237 #               #                                group
238 #               #           group_by_serial    = 1 priority group per detected
239 #               #                                serial number
240 #               #           group_by_prio      = 1 priority group per path
241 #               #                                priority value
242 #               #           group_by_node_name = 1 priority group per target
243 #               #                                node name
244 #               #
245 #               path_grouping_policy    failover
246 #
247 #               #
248 #               # name    : path_selector
249 #               # desc    : the path selector algorithm to use for this mpath
250 #               #           these algo are offered by the kernel mpath target
251 #               # values  : "round-robin 0"
252 #               #
253 #               path_selector           "round-robin 0"
254 #
255 #               #
256 #               # name    : failback
257 #               # scope   : multipathd
258 #               # desc    : tell the daemon to manage path group failback, or
259 #               #           not to. 0 means immediate failback, values >0 means
260 #               #           deffered failback expressed in seconds.
261 #               # values  : manual|immediate|n > 0
262 #               #
263 #               failback                manual
264 #
265 #               #
266 #               # name    : rr_weight
267 #               # scope   : multipath
268 #               # desc    : if set to priorities the multipath configurator will
269 #               #           assign path weights as "path prio * rr_min_io"
270 #               # values  : priorities|uniform
271 #               #
272 #               rr_weight       priorities
273 #
274 #               #
275 #               # name    : no_path_retry
276 #               # scope   : multipath & multipathd
277 #               # desc    : tell the number of retries until disable queueing,
278 #               #           or "fail" means immediate failure (no queueing),
279 #               #           "queue" means never stop queueing
280 #               # values  : queue|fail|n (>0)
281 #               #
282 #               no_path_retry  queue
283 #
284 #               #
285 #               # name    : rr_min_io
286 #               # scope   : multipath
287 #               # desc    : the number of IO to route to a path before switching
288 #               #           to the next in the same path group
289 #               #
290 #               rr_min_io       100
291 #
292 #               #
293 #               # name    : flush_on_last_del
294 #               # scope   : multipathd
295 #               # desc    : If set to "yes", multipathd will disable queueing
296 #               #           when the last path to a device has been deleted.
297 #               # values  : yes|no
298 #               # default : no
299 #               #
300 #               flush_on_last_del       yes
301 #       }
302 #       multipath {
303 #               wwid    1DEC_____321816758474
304 #               alias   red
305 #               rr_weight               priorities
306 #       }
307 #}
308 #
309 ##
310 ## name  : devices
311 ## scope : multipath & multipathd
312 ## desc  : list of per storage controller settings
313 ##        overrides default settings (device_maps block)
314 ##         overriden by per multipath settings (multipaths block)
315 ##
316 #devices {
317 #       #
318 #       # name  : device
319 #       # scope : multipath & multipathd
320 #       # desc  : settings for this specific storage controller
321 #       #
322 #       device {
323 #               #
324 #               # name  : vendor, product
325 #               # scope : multipath & multipathd
326 #               # desc  : index for the block
327 #               #
328 #               vendor                  "COMPAQ  "
329 #               product                 "HSV110 (C)COMPAQ"
330 #
331 #               #
332 #               # name    : path_grouping_policy
333 #               # scope   : multipath
334 #               # desc    : path grouping policy to apply to this multipath
335 #               # values  : failover, multibus, group_by_serial
336 #               # values  : failover           = 1 path per priority group
337 #               #           multibus           = all valid paths in 1 priority
338 #               #                                group
339 #               #           group_by_serial    = 1 priority group per detected
340 #               #                                serial number
341 #               #           group_by_prio      = 1 priority group per path
342 #               #                                priority value
343 #               #           group_by_node_name = 1 priority group per target
344 #               #                                node name
345 #               #
346 #               path_grouping_policy    failover
347 #
348 #               #
349 #               # name    : getuid_callout
350 #               # scope   : multipath
351 #               # desc    : the program and args to callout to obtain a unique 
352 #               #           path identifier. Absolute path required
353 #               #
354 #               getuid_callout          "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
355 #
356 #               #
357 #               # name    : prio
358 #               # scope   : multipath
359 #               # desc    : the function to call to obtain a path 
360 #               #           weight. Weights are summed for each path group to
361 #               #           determine the next PG to use case of failure.
362 #               # default : no callout, all paths equals
363 #               #
364 #               prio          "hp_sw"
365 #
366 #               #
367 #               # name    : path_checker, checker
368 #               # scope   : multipathd
369 #               # desc    : path checking alorithm to use to check path state
370 #               # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|
371 #               #           cciss_tur
372 #               #
373 #               path_checker            directio
374 #
375 #               #
376 #               # name    : path_selector
377 #               # desc    : the path selector algorithm to use for this mpath
378 #               #           these algo are offered by the kernel mpath target
379 #               # values  : "round-robin 0"
380 #               #
381 #               path_selector           "round-robin 0"
382 #
383 #               #
384 #               # name    : features
385 #               # scope   : multipath
386 #               # desc    : The extra features of multipath devices. The only
387 #               #           existing feature currently is queue_if_no_path,
388 #               #           which is the same as setting no_path_retry to queue.
389 #               # values  : "1 queue_if_no_path"
390 #               #
391 #               features        "1 queue_if_no_path"
392 #
393 #               #
394 #               # name    : hardware_handler
395 #               # scope   : multipath
396 #               # desc    : If set, it specifies a module that will be used to
397 #               #           perform hardware specific actions when switching
398 #               #           path groups or handling IO errors
399 #               # values  : "0"|"1 emc"
400 #               # default : "0"
401 #               #
402 #               hardware_handler "1 emc"
403 #
404 #               #
405 #               # name    : failback
406 #               # scope   : multipathd
407 #               # desc    : tell the daemon to manage path group failback, or
408 #               #           not to. 0 means immediate failback, values >0 means
409 #               #           deffered failback expressed in seconds.
410 #               # values  : manual|immediate|n > 0
411 #               #
412 #               failback                30
413 #
414 #               #
415 #               # name    : rr_weight
416 #               # scope   : multipath
417 #               # desc    : if set to priorities the multipath configurator will
418 #               #           assign path weights as "path prio * rr_min_io"
419 #               # values  : priorities|uniform
420 #               #
421 #               rr_weight       priorities
422 #
423 #               #
424 #               # name    : no_path_retry
425 #               # scope   : multipath & multipathd
426 #               # desc    : tell the number of retries until disable queueing,
427 #               #           or "fail" means immediate failure (no queueing),
428 #               #           "queue" means never stop queueing
429 #               # values  : queue|fail|n (>0)
430 #               #
431 #               no_path_retry  queue
432 #
433 #               #
434 #               # name    : rr_min_io
435 #               # scope   : multipath
436 #               # desc    : the number of IO to route to a path before switching
437 #               #           to the next in the same path group
438 #               #
439 #               rr_min_io       100
440 #
441 #               #
442 #               # name    : flush_on_last_del
443 #               # scope   : multipathd
444 #               # desc    : If set to "yes", multipathd will disable queueing
445 #               #           when the last path to a device has been deleted.
446 #               # values  : yes|no
447 #               # default : no
448 #               #
449 #               flush_on_last_del       yes
450 #
451 #               #
452 #               # name    : product_blacklist
453 #               # scope   : multipath & multipathd
454 #               # desc    : product strings to blacklist for this vendor
455 #               #
456 #               product_blacklist       LUN_Z
457 #       }
458 #       device {
459 #               vendor                  "COMPAQ  "
460 #               product                 "MSA1000         "
461 #               path_grouping_policy    multibus
462 #               path_checker            tur
463 #               rr_weight               priorities
464 #       }
465 #}