76635673f237cbacca5f3aad2b80ad7603dfd204
[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 #       # default : 5
23 #       #
24 #       polling_interval 10
25 #
26 #       #
27 #       # name    : selector
28 #       # scope   : multipath
29 #       # desc    : the default path selector algorithm to use
30 #       #           these algorithms are offered by the kernel multipath target
31 #       # values  : "round-robin 0"
32 #       # default : "round-robin 0"
33 #       #
34 #       selector        "round-robin 0"
35 #
36 #       #
37 #       # name    : path_grouping_policy
38 #       # scope   : multipath
39 #       # desc    : the default path grouping policy to apply to unspecified
40 #       #           multipaths
41 #       # default : failover
42 #       #
43 #       path_grouping_policy    multibus
44 #
45 #       #
46 #       # name    : getuid_callout
47 #       # scope   : multipath
48 #       # desc    : the default program and args to callout to obtain a unique 
49 #       #           path identifier. Absolute path required
50 #       # default : /lib/udev/scsi_id -g -u -s
51 #       #
52 #       getuid_callout  "/lib/udev/scsi_id -g -u -d /dev/%n"
53 #
54 #       #
55 #       # name    : prio
56 #       # scope   : multipath
57 #       # desc    : the default function to call to obtain a path 
58 #       #           priority value. The ALUA bits in SPC-3 provide an
59 #       #           exploitable prio value for example.
60 #       # default : (null)
61 #       #
62 #       #prio   "alua"
63 #
64 #       #
65 #       # name    : path_checker
66 #       # scope   : multipath & multipathd
67 #       # desc    : the default method used to determine the paths' state
68 #       # values  : readsector0|tur|emc_clariion|hp_sw|directio
69 #       # default : directio
70 #       #
71 #       #path_checker   directio
72 #
73 #       #
74 #       # name    : rr_min_io
75 #       # scope   : multipath
76 #       # desc    : the number of IO to route to a path before switching
77 #       #           to the next in the same path group
78 #       # default : 1000
79 #       #
80 #       rr_min_io       100
81 #
82 #       #
83 #       # name    : max_fds
84 #       # scope   : multipathd
85 #       # desc    : Sets the maximum number of open file descriptors for the
86 #       #           multipathd process.
87 #       # values  : unlimited|n > 0
88 #       # default : None
89 #       #
90 #       max_fds         8192
91 #
92 #       #
93 #       # name    : rr_weight
94 #       # scope   : multipath
95 #       # desc    : if set to priorities the multipath configurator will assign
96 #       #           path weights as "path prio * rr_min_io"
97 #       # values  : priorities|uniform
98 #       # default : uniform
99 #       #
100 #       rr_weight       priorities
101 #
102 #       #
103 #       # name    : failback
104 #       # scope   : multipathd
105 #       # desc    : tell the daemon to manage path group failback, or not to.
106 #       #           0 means immediate failback, values >0 means deffered failback
107 #       #           expressed in seconds.
108 #       # values  : manual|immediate|n > 0
109 #       # default : manual
110 #       #
111 #       failback        immediate
112 #
113 #       #
114 #       # name    : no_path_retry
115 #       # scope   : multipath & multipathd
116 #       # desc    : tell the number of retries until disable queueing, or
117 #       #           "fail" means immediate failure (no queueing),
118 #       #           "queue" means never stop queueing
119 #       # values  : queue|fail|n (>0)
120 #       # default : (null)
121 #       #
122 #       #no_path_retry  queue
123 #
124 #       #
125 #       # name    : user_friendly_names
126 #       # scope   : multipath
127 #       # desc    : If set to "yes", using the bindings file
128 #       #           /var/lib/multipath/bindings to assign a persistent and
129 #       #           unique alias to the multipath, in the form of mpath<n>.
130 #       #           If set to "no" use the WWID as the alias. In either case
131 #       #           this be will be overriden by any specific aliases in this
132 #       #           file.
133 #       # values  : yes|no
134 #       # default : no
135 #       user_friendly_names no
136 #
137 #}
138 #       
139 ##
140 ## name    : blacklist
141 ## scope   : multipath & multipathd
142 ## desc    : list of device names to discard as not multipath candidates
143 ## default : cciss, fd, hd, md, dm, sr, scd, st, ram, raw, loop
144 ##
145 #blacklist {
146 #       wwid 26353900f02796769
147 #       devnode "^(ram|raw|loop|fd|md|dm-|sr|scd|st)[0-9]*"
148 #       devnode "^hd[a-z][[0-9]*]"
149 #       devnode "^cciss!c[0-9]d[0-9]*[p[0-9]*]"
150 #       device {
151 #               vendor DEC.*
152 #               product MSA[15]00
153 #       }
154 #}
155 ##
156 ## name    : blacklist_exceptions
157 ## scope   : multipath & multipathd
158 ## desc    : list of device names to be treated as multipath candidates
159 ##           even if they are on the blacklist.
160 ##           Note: blacklist exceptions are only valid in the same class.
161 ##           It is not possible to blacklist devices using the devnode keyword
162 ##           and to exclude some devices of them using the wwid keyword.
163 ## default : -
164 ##
165 #blacklist_exceptions {
166 #       devnode "^dasd[c-d]+[0-9]*"
167 #       wwid    "IBM.75000000092461.4d00.34"
168 #       wwid    "IBM.75000000092461.4d00.35"
169 #       wwid    "IBM.75000000092461.4d00.36"
170 #}
171 #
172 ##
173 ## name    : multipaths
174 ## scope   : multipath & multipathd
175 ## desc    : list of multipaths finest-grained settings
176 ##
177 #multipaths {
178 #       #
179 #       # name  : multipath
180 #       # scope : multipath & multipathd
181 #       # desc  : container for settings that apply to one specific multipath
182 #       #
183 #       multipath {
184 #               #
185 #               # name  : wwid
186 #               # scope : multipath & multipathd
187 #               # desc  : index of the container
188 #               #
189 #               wwid                    3600508b4000156d700012000000b0000
190 #
191 #               #
192 #               # name    : alias
193 #               # scope   : multipath
194 #               # desc    : symbolic name for the multipath
195 #               #
196 #               alias                   yellow
197 #
198 #               #
199 #               # name    : path_grouping_policy
200 #               # scope   : multipath
201 #               # desc    : path grouping policy to apply to this multipath
202 #               # values  : failover, multibus, group_by_serial
203 #               # default : failover
204 #               #
205 #               path_grouping_policy    multibus
206 #
207 #               #
208 #               # name    : path_selector
209 #               # desc    : the path selector algorithm to use for this mpath
210 #               #           these algo are offered by the kernel mpath target
211 #               # values  : "round-robin 0"
212 #               # default : "round-robin 0"
213 #               #
214 #               path_selector           "round-robin 0"
215 #
216 #               #
217 #               # name    : failback
218 #               # scope   : multipathd
219 #               # desc    : tell the daemon to manage path group failback, or not to.
220 #               #           0 means immediate failback, values >0 means deffered failback
221 #               #           expressed in seconds.
222 #               # values  : manual|immediate|n > 0
223 #               # default : manual
224 #               #
225 #               failback                immediate
226 #
227 #               #
228 #               # name    : no_path_retry
229 #               # scope   : multipath & multipathd
230 #               # desc    : tell the number of retries until disable queueing, or
231 #               #           "fail" means immediate failure (no queueing),
232 #               #           "queue" means never stop queueing
233 #               # values  : queue|fail|n (>0)
234 #               # default : (null)
235 #               #
236 #               #no_path_retry  queue
237 #
238 #               #
239 #               # name    : rr_min_io
240 #               # scope   : multipath
241 #               # desc    : the number of IO to route to a path before switching
242 #               #           to the next in the same path group
243 #               # default : 1000
244 #               #
245 #               rr_min_io       100
246 #       }
247 #       multipath {
248 #               wwid    1DEC_____321816758474
249 #               alias   red
250 #               rr_weight               priorities
251 #       }
252 #}
253 #
254 ##
255 ## name  : devices
256 ## scope : multipath & multipathd
257 ## desc  : list of per storage controller settings
258 ##        overrides default settings (device_maps block)
259 ##         overriden by per multipath settings (multipaths block)
260 ##
261 #devices {
262 #       #
263 #       # name  : device
264 #       # scope : multipath & multipathd
265 #       # desc  : settings for this specific storage controller
266 #       #
267 #       device {
268 #               #
269 #               # name  : vendor, product
270 #               # scope : multipath & multipathd
271 #               # desc  : index for the block
272 #               #
273 #               vendor                  "COMPAQ  "
274 #               product                 "HSV110 (C)COMPAQ"
275 #
276 #               #
277 #               # name    : path_grouping_policy
278 #               # scope   : multipath
279 #               # desc    : path grouping policy to apply to multipath hosted
280 #               #           by this storage controller
281 #               # values  : failover        = 1 path per priority group
282 #               #           multibus        = all valid paths in 1 priority
283 #               #                             group
284 #               #           group_by_serial = 1 priority group per detected
285 #               #                             serial number
286 #               # default : failover
287 #               #
288 #               path_grouping_policy    multibus
289 #
290 #               #
291 #               # name    : getuid_callout
292 #               # scope   : multipath
293 #               # desc    : the program and args to callout to obtain a unique 
294 #               #           path identifier. Absolute path required
295 #               # default : /lib/udev/scsi_id -g -u -s
296 #               #
297 #               getuid_callout          "/lib/udev/scsi_id -g -u -d /dev/%n"
298 #
299 #               #
300 #               # name    : prio
301 #               # scope   : multipath
302 #               # desc    : the function to call to obtain a path 
303 #               #           weight. Weights are summed for each path group to
304 #               #           determine the next PG to use case of failure.
305 #               # default : no callout, all paths equals
306 #               #
307 #               prio          "hp_sw"
308 #
309 #               #
310 #               # name    : path_checker
311 #               # scope   : multipathd
312 #               # desc    : path checking alorithm to use to check path state
313 #               # values  : readsector0|tur|emc_clariion|hp_sw|directio
314 #               # default : directio
315 #               #
316 #               path_checker            directio
317 #
318 #               #
319 #               # name    : path_selector
320 #               # desc    : the path selector algorithm to use for this mpath
321 #               #           these algo are offered by the kernel mpath target
322 #               # values  : "round-robin 0"
323 #               # default : "round-robin 0"
324 #               #
325 #               path_selector           "round-robin 0"
326 #
327 #               #
328 #               # name    : failback
329 #               # scope   : multipathd
330 #               # desc    : tell the daemon to manage path group failback, or not to.
331 #               #           0 means immediate failback, values >0 means deffered failback
332 #               #           expressed in seconds.
333 #               # values  : manual|immediate|n > 0
334 #               # default : manual
335 #               #
336 #               failback                30
337 #
338 #               #
339 #               # name    : rr_min_io
340 #               # scope   : multipath
341 #               # desc    : the number of IO to route to a path before switching
342 #               #           to the next in the same path group
343 #               # default : 1000
344 #               #
345 #               rr_min_io       100
346 #
347 #               #
348 #               # name    : product_blacklist
349 #               # scope   : multipath & multipathd
350 #               # desc    : product strings to blacklist for this vendor
351 #               # default : none
352 #               #
353 #               product_blacklist       LUN_Z
354 #       }
355 #       device {
356 #               vendor                  "COMPAQ  "
357 #               product                 "MSA1000         "
358 #               path_grouping_policy    multibus
359 #               path_checker            tur
360 #               rr_weight               priorities
361 #       }
362 #}