[kpartx] remove bashisms from kpartx_id
[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 : /udev
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 : multibus
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 : /sbin/scsi_id -g -u -s
51 #       #
52 #       getuid_callout  "/sbin/scsi_id -g -u -s /block/%n"
53 #
54 #       #
55 #       # name    : prio_callout
56 #       # scope   : multipath
57 #       # desc    : the default program and args to callout to obtain a path 
58 #       #           priority value. The ALUA bits in SPC-3 provide an
59 #       #           exploitable prio value for example. "none" is a valid value
60 #       # default : (null)
61 #       #
62 #       #prio_callout   "/bin/true"
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 : readsector0
70 #       #
71 #       #path_checker   readsector0
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    : rr_weight
84 #       # scope   : multipath
85 #       # desc    : if set to priorities the multipath configurator will assign
86 #       #           path weights as "path prio * rr_min_io"
87 #       # values  : priorities|uniform
88 #       # default : uniform
89 #       #
90 #       rr_weight       priorities
91 #
92 #       #
93 #       # name    : failback
94 #       # scope   : multipathd
95 #       # desc    : tell the daemon to manage path group failback, or not to.
96 #       #           0 means immediate failback, values >0 means deffered failback
97 #       #           expressed in seconds.
98 #       # values  : manual|immediate|n > 0
99 #       # default : immediate
100 #       #
101 #       failback        manual
102 #
103 #       #
104 #       # name    : no_path_retry
105 #       # scope   : multipath & multipathd
106 #       # desc    : tell the number of retries until disable queueing, or
107 #       #           "fail" means immediate failure (no queueing),
108 #       #           "queue" means never stop queueing
109 #       # values  : queue|fail|n (>0)
110 #       # default : (null)
111 #       #
112 #       #no_path_retry  queue
113 #
114 #       #
115 #       # name    : user_friendly_names
116 #       # scope   : multipath
117 #       # desc    : If set to "yes", using the bindings file
118 #       #           /var/lib/multipath/bindings to assign a persistent and
119 #       #           unique alias to the multipath, in the form of mpath<n>.
120 #       #           If set to "no" use the WWID as the alias. In either case
121 #       #           this be will be overriden by any specific aliases in this
122 #       #           file.
123 #       # values  : yes|no
124 #       # default : no
125 #       user_friendly_names no
126 #
127 #}
128 #       
129 ##
130 ## name    : blacklist
131 ## scope   : multipath & multipathd
132 ## desc    : list of device names to discard as not multipath candidates
133 ## default : cciss, fd, hd, md, dm, sr, scd, st, ram, raw, loop
134 ##
135 #blacklist {
136 #       wwid 26353900f02796769
137 #       devnode "^(ram|raw|loop|fd|md|dm-|sr|scd|st)[0-9]*"
138 #       devnode "^hd[a-z][[0-9]*]"
139 #       devnode "^cciss!c[0-9]d[0-9]*[p[0-9]*]"
140 #       device {
141 #               vendor DEC.*
142 #               product MSA[15]00
143 #       }
144 #}
145 ##
146 ## name    : blacklist_exceptions
147 ## scope   : multipath & multipathd
148 ## desc    : list of device names to be treated as multipath candidates
149 ##           even if they are on the blacklist.
150 ##           Note: blacklist exceptions are only valid in the same class.
151 ##           It is not possible to blacklist devices using the devnode keyword
152 ##           and to exclude some devices of them using the wwid keyword.
153 ## default : -
154 ##
155 #blacklist_exceptions {
156 #       devnode "^dasd[c-d]+[0-9]*"
157 #       wwid    "IBM.75000000092461.4d00.34"
158 #       wwid    "IBM.75000000092461.4d00.35"
159 #       wwid    "IBM.75000000092461.4d00.36"
160 #}
161 #
162 ##
163 ## name    : multipaths
164 ## scope   : multipath & multipathd
165 ## desc    : list of multipaths finest-grained settings
166 ##
167 #multipaths {
168 #       #
169 #       # name  : multipath
170 #       # scope : multipath & multipathd
171 #       # desc  : container for settings that apply to one specific multipath
172 #       #
173 #       multipath {
174 #               #
175 #               # name  : wwid
176 #               # scope : multipath & multipathd
177 #               # desc  : index of the container
178 #               #
179 #               wwid                    3600508b4000156d700012000000b0000
180 #
181 #               #
182 #               # name    : alias
183 #               # scope   : multipath
184 #               # desc    : symbolic name for the multipath
185 #               #
186 #               alias                   yellow
187 #
188 #               #
189 #               # name    : path_grouping_policy
190 #               # scope   : multipath
191 #               # desc    : path grouping policy to apply to this multipath
192 #               # values  : failover, multibus, group_by_serial
193 #               # default : failover
194 #               #
195 #               path_grouping_policy    multibus
196 #
197 #               #
198 #               # name    : path_checker
199 #               # scope   : multipathd
200 #               # desc    : path checking alorithm to use to check path state
201 #               # values  : readsector0, tur
202 #               # default : readsector0
203 #               #
204 #               # path_checker          readsector0
205 #               
206 #               #
207 #               # name    : path_selector
208 #               # desc    : the path selector algorithm to use for this mpath
209 #               #           these algo are offered by the kernel mpath target
210 #               # values  : "round-robin 0"
211 #               # default : "round-robin 0"
212 #               #
213 #               path_selector           "round-robin 0"
214 #
215 #               #
216 #               # name    : failback
217 #               # scope   : multipathd
218 #               # desc    : tell the daemon to manage path group failback, or not to.
219 #               #           0 means immediate failback, values >0 means deffered failback
220 #               #           expressed in seconds.
221 #               # values  : manual|immediate|n > 0
222 #               # default : immediate
223 #               #
224 #               failback                manual
225 #
226 #               #
227 #               # name    : no_path_retry
228 #               # scope   : multipath & multipathd
229 #               # desc    : tell the number of retries until disable queueing, or
230 #               #           "fail" means immediate failure (no queueing),
231 #               #           "queue" means never stop queueing
232 #               # values  : queue|fail|n (>0)
233 #               # default : (null)
234 #               #
235 #               #no_path_retry  queue
236 #
237 #               #
238 #               # name    : rr_min_io
239 #               # scope   : multipath
240 #               # desc    : the number of IO to route to a path before switching
241 #               #           to the next in the same path group
242 #               # default : 1000
243 #               #
244 #               rr_min_io       100
245 #       }
246 #       multipath {
247 #               wwid    1DEC_____321816758474
248 #               alias   red
249 #               rr_weight               priorities
250 #       }
251 #}
252 #
253 ##
254 ## name  : devices
255 ## scope : multipath & multipathd
256 ## desc  : list of per storage controller settings
257 ##        overrides default settings (device_maps block)
258 ##         overriden by per multipath settings (multipaths block)
259 ##
260 #devices {
261 #       #
262 #       # name  : device
263 #       # scope : multipath & multipathd
264 #       # desc  : settings for this specific storage controller
265 #       #
266 #       device {
267 #               #
268 #               # name  : vendor, product
269 #               # scope : multipath & multipathd
270 #               # desc  : index for the block
271 #               #
272 #               vendor                  "COMPAQ  "
273 #               product                 "HSV110 (C)COMPAQ"
274 #
275 #               #
276 #               # name    : path_grouping_policy
277 #               # scope   : multipath
278 #               # desc    : path grouping policy to apply to multipath hosted
279 #               #           by this storage controller
280 #               # values  : failover        = 1 path per priority group
281 #               #           multibus        = all valid paths in 1 priority
282 #               #                             group
283 #               #           group_by_serial = 1 priority group per detected
284 #               #                             serial number
285 #               # default : failover
286 #               #
287 #               path_grouping_policy    multibus
288 #
289 #               #
290 #               # name    : getuid_callout
291 #               # scope   : multipath
292 #               # desc    : the program and args to callout to obtain a unique 
293 #               #           path identifier. Absolute path required
294 #               # default : /sbin/scsi_id -g -u -s
295 #               #
296 #               getuid_callout          "/sbin/scsi_id -g -u -s /block/%n"
297 #
298 #               #
299 #               # name    : prio_callout
300 #               # scope   : multipath
301 #               # desc    : the program and args to callout to obtain a path 
302 #               #           weight. Weights are summed for each path group to
303 #               #           determine the next PG to use case of failure.
304 #               #           "none" is a valid value.
305 #               # default : no callout, all paths equals
306 #               #
307 #               prio_callout          "/sbin/mpath_prio_balance_units %d"
308 #
309 #               #
310 #               # name    : path_checker
311 #               # scope   : multipathd
312 #               # desc    : path checking alorithm to use to check path state
313 #               # values  : readsector0, tur
314 #               # default : readsector0
315 #               #
316 #               path_checker            readsector0
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 : immediate
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 #}