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