[libmultipath] move the async logger in libmultipath
[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 #}
141 #
142 ##
143 ## name    : multipaths
144 ## scope   : multipath & multipathd
145 ## desc    : list of multipaths finest-grained settings
146 ##
147 #multipaths {
148 #       #
149 #       # name  : multipath
150 #       # scope : multipath & multipathd
151 #       # desc  : container for settings that apply to one specific multipath
152 #       #
153 #       multipath {
154 #               #
155 #               # name  : wwid
156 #               # scope : multipath & multipathd
157 #               # desc  : index of the container
158 #               #
159 #               wwid                    3600508b4000156d700012000000b0000
160 #
161 #               #
162 #               # name    : alias
163 #               # scope   : multipath
164 #               # desc    : symbolic name for the multipath
165 #               #
166 #               alias                   yellow
167 #
168 #               #
169 #               # name    : path_grouping_policy
170 #               # scope   : multipath
171 #               # desc    : path grouping policy to apply to this multipath
172 #               # values  : failover, multibus, group_by_serial
173 #               # default : failover
174 #               #
175 #               path_grouping_policy    multibus
176 #
177 #               #
178 #               # name    : path_checker
179 #               # scope   : multipathd
180 #               # desc    : path checking alorithm to use to check path state
181 #               # values  : readsector0, tur
182 #               # default : readsector0
183 #               #
184 #               # path_checker          readsector0
185 #               
186 #               #
187 #               # name    : path_selector
188 #               # desc    : the path selector algorithm to use for this mpath
189 #               #           these algo are offered by the kernel mpath target
190 #               # values  : "round-robin 0"
191 #               # default : "round-robin 0"
192 #               #
193 #               path_selector           "round-robin 0"
194 #
195 #               #
196 #               # name    : failback
197 #               # scope   : multipathd
198 #               # desc    : tell the daemon to manage path group failback, or not to.
199 #               #           0 means immediate failback, values >0 means deffered failback
200 #               #           expressed in seconds.
201 #               # values  : manual|immediate|n > 0
202 #               # default : immediate
203 #               #
204 #               failback                manual
205 #
206 #               #
207 #               # name    : no_path_retry
208 #               # scope   : multipath & multipathd
209 #               # desc    : tell the number of retries until disable queueing, or
210 #               #           "fail" means immediate failure (no queueing),
211 #               #           "queue" means never stop queueing
212 #               # values  : queue|fail|n (>0)
213 #               # default : (null)
214 #               #
215 #               #no_path_retry  queue
216 #       }
217 #       multipath {
218 #               wwid    1DEC_____321816758474
219 #               alias   red
220 #               rr_weight               priorities
221 #       }
222 #}
223 #
224 ##
225 ## name  : devices
226 ## scope : multipath & multipathd
227 ## desc  : list of per storage controler settings
228 ##        overrides default settings (device_maps block)
229 ##         overriden by per multipath settings (multipaths block)
230 ##
231 #devices {
232 #       #
233 #       # name  : device
234 #       # scope : multipath & multipathd
235 #       # desc  : settings for this specific storage controler
236 #       #
237 #       device {
238 #               #
239 #               # name  : vendor, product
240 #               # scope : multipath & multipathd
241 #               # desc  : index for the block
242 #               #
243 #               vendor                  "COMPAQ  "
244 #               product                 "HSV110 (C)COMPAQ"
245 #
246 #               #
247 #               # name    : path_grouping_policy
248 #               # scope   : multipath
249 #               # desc    : path grouping policy to apply to multipath hosted
250 #               #           by this storage controler
251 #               # values  : failover        = 1 path per priority group
252 #               #           multibus        = all valid paths in 1 priority
253 #               #                             group
254 #               #           group_by_serial = 1 priority group per detected
255 #               #                             serial number
256 #               # default : failover
257 #               #
258 #               path_grouping_policy    multibus
259 #
260 #               #
261 #               # name    : getuid_callout
262 #               # scope   : multipath
263 #               # desc    : the program and args to callout to obtain a unique 
264 #               #           path identifier. Absolute path required
265 #               # default : /sbin/scsi_id -g -u -s
266 #               #
267 #               getuid_callout          "/sbin/scsi_id -g -u -s /block/%n"
268 #
269 #               #
270 #               # name    : prio_callout
271 #               # scope   : multipath
272 #               # desc    : the program and args to callout to obtain a path 
273 #               #           weight. Weights are summed for each path group to
274 #               #           determine the next PG to use case of failure.
275 #               #           "none" is a valid value.
276 #               # default : no callout, all paths equals
277 #               #
278 #               prio_callout          "/sbin/mpath_prio_balance_units %d"
279 #
280 #               #
281 #               # name    : path_checker
282 #               # scope   : multipathd
283 #               # desc    : path checking alorithm to use to check path state
284 #               # values  : readsector0, tur
285 #               # default : readsector0
286 #               #
287 #               path_checker            readsector0
288 #
289 #               #
290 #               # name    : path_selector
291 #               # desc    : the path selector algorithm to use for this mpath
292 #               #           these algo are offered by the kernel mpath target
293 #               # values  : "round-robin 0"
294 #               # default : "round-robin 0"
295 #               #
296 #               path_selector           "round-robin 0"
297 #
298 #               #
299 #               # name    : failback
300 #               # scope   : multipathd
301 #               # desc    : tell the daemon to manage path group failback, or not to.
302 #               #           0 means immediate failback, values >0 means deffered failback
303 #               #           expressed in seconds.
304 #               # values  : manual|immediate|n > 0
305 #               # default : immediate
306 #               #
307 #               failback                30
308 #       }
309 #       device {
310 #               vendor                  "COMPAQ  "
311 #               product                 "MSA1000         "
312 #               path_grouping_policy    multibus
313 #               path_checker            tur
314 #               rr_weight               priorities
315 #       }
316 #}