config file cleanup and a defaults file
[multipath-tools/.git] / multipath.conf.annotated
index 7663567..bf15dc3 100644 (file)
@@ -19,6 +19,7 @@
 #      # name    : polling_interval
 #      # scope   : multipathd
 #      # desc    : interval between two path checks in seconds
+#      # values  : n > 0
 #      # default : 5
 #      #
 #      polling_interval 10
 #      # scope   : multipath
 #      # desc    : the default path grouping policy to apply to unspecified
 #      #           multipaths
+#      # 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
+#      #           group_by_prio      = 1 priority group per path priority
+#      #                                value
+#      #           group_by_node_name = 1 priority group per target node name
 #      # default : failover
 #      #
 #      path_grouping_policy    multibus
 #      #           exploitable prio value for example.
 #      # default : (null)
 #      #
-#      #prio   "alua"
+#      prio    "alua"
 #
 #      #
-#      # name    : path_checker
+#      # name    : features
+#      # scope   : multipath
+#      # desc    : The default extra features of multipath devices. The
+#      #           only existing feature currently is queue_if_no_path, which
+#      #           is the same as setting no_path_retry to queue.
+#      # values  : "1 queue_if_no_path"
+#      # default : (null)
+#      #
+#      features        "1 queue_if_no_path"
+#
+#      #
+#      # name    : path_checker, checker
 #      # scope   : multipath & multipathd
 #      # desc    : the default method used to determine the paths' state
-#      # values  : readsector0|tur|emc_clariion|hp_sw|directio
+#      # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|cciss_tur
 #      # default : directio
 #      #
-#      #path_checker   directio
+#      path_checker    directio
 #
 #      #
 #      # name    : rr_min_io
 #      # 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.
+#      #           0 means immediate failback, values >0 means deffered
+#      #           failback expressed in seconds.
 #      # values  : manual|immediate|n > 0
 #      # default : manual
 #      #
 #      # values  : queue|fail|n (>0)
 #      # default : (null)
 #      #
-#      #no_path_retry  queue
+#      no_path_retry  queue
 #
 #      #
 #      # name    : user_friendly_names
 ## 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
+##           Devices can be identified by their device node name "devnode",
+##           their WWID "wwid", or their vender and product strings
+##           "device"
+## default : fd, hd, md, dm, sr, scd, st, ram, raw, loop, dcssblk
 ##
 #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]*]"
+#      devnode "^hd[a-z]"
+#      devnode "^dcssblk[0-9]*"
 #       device {
 #               vendor DEC.*
 #               product MSA[15]00
 #              # scope   : multipath
 #              # desc    : path grouping policy to apply to this multipath
 #              # values  : failover, multibus, group_by_serial
-#              # default : failover
-#              #
-#              path_grouping_policy    multibus
+#              # 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
+#              #           group_by_prio      = 1 priority group per path
+#              #                                priority value
+#              #           group_by_node_name = 1 priority group per target
+#              #                                node name
+#              #
+#              path_grouping_policy    failover
 #
 #              #
 #              # 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.
+#              # 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 : manual
 #              #
-#              failback                immediate
+#              failback                manual
+#
+#              #
+#              # 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
+#              #
+#              rr_weight       priorities
 #
 #              #
 #              # name    : no_path_retry
 #              # scope   : multipath & multipathd
-#              # desc    : tell the number of retries until disable queueing, or
-#              #           "fail" means immediate failure (no queueing),
+#              # 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
+#              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
 #      }
 #              #
 #              # 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
+#              # desc    : path grouping policy to apply to this multipath
+#              # values  : failover, multibus, group_by_serial
+#              # 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
+#              #           group_by_prio      = 1 priority group per path
+#              #                                priority value
+#              #           group_by_node_name = 1 priority group per target
+#              #                                node name
+#              #
+#              path_grouping_policy    failover
 #
 #              #
 #              # name    : getuid_callout
 #              # scope   : multipath
 #              # desc    : the program and args to callout to obtain a unique 
 #              #           path identifier. Absolute path required
-#              # default : /lib/udev/scsi_id -g -u -s
 #              #
 #              getuid_callout          "/lib/udev/scsi_id -g -u -d /dev/%n"
 #
 #              prio          "hp_sw"
 #
 #              #
-#              # name    : path_checker
+#              # name    : path_checker, checker
 #              # scope   : multipathd
 #              # desc    : path checking alorithm to use to check path state
-#              # values  : readsector0|tur|emc_clariion|hp_sw|directio
-#              # default : directio
+#              # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|
+#              #           cciss_tur
 #              #
 #              path_checker            directio
 #
 #              # 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    : features
+#              # scope   : multipath
+#              # desc    : The extra features of multipath devices. The only
+#              #           existing feature currently is queue_if_no_path,
+#              #           which is the same as setting no_path_retry to queue.
+#              # values  : "1 queue_if_no_path"
+#              #
+#              features        "1 queue_if_no_path"
+#
+#              #
+#              # name    : hardware_handler
+#              # scope   : multipath
+#              # desc    : If set, it specifies a module that will be used to
+#              #           perform hardware specific actions when switching
+#              #           path groups or handling IO errors
+#              # values  : "0"|"1 emc"
+#              # default : "0"
+#              #
+#              hardware_handler "1 emc"
+#
+#              #
 #              # 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.
+#              # 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 : manual
 #              #
 #              failback                30
 #
 #              #
+#              # 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
+#              #
+#              rr_weight       priorities
+#
+#              #
+#              # 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)
+#              #
+#              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
 #
 #              # name    : product_blacklist
 #              # scope   : multipath & multipathd
 #              # desc    : product strings to blacklist for this vendor
-#              # default : none
 #              #
 #              product_blacklist       LUN_Z
 #      }