multipath.conf.annotated

Linux Multipath Source Code

##
## 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 : /udev
#	#
#	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 : /sbin/scsi_id -g -u -s
#	#
#	getuid_callout	"/sbin/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 : readsector0
#	#
#	#path_checker	readsector0
#
#	#
#	# 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    : 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
#		# default : readsector0
#		#
#		# path_checker		readsector0
#		
#		#
#		# 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 controler 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 controler
#	#
#	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 controler
#		# 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 : /sbin/scsi_id -g -u -s
#		#
#		getuid_callout          "/sbin/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
#		# default : readsector0
#		#
#		path_checker		readsector0
#
#		#
#		# 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
#	}
#}