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    : polling_interval
  13 #       # scope   : multipathd
  14 #       # desc    : interval between two path checks in seconds. For
  15 #       #           properly functioning paths, the interval between checks
  16 #       #           will gradually increase to (4 * polling_interval).
  17 #       # values  : n > 0
  18 #       # default : 5
  19 #       #
  20 #       polling_interval 10
  21 #
  22 #       #
  23 #       # name    : path_selector
  24 #       # scope   : multipath & multipathd
  25 #       # desc    : the default path selector algorithm to use
  26 #       #           these algorithms are offered by the kernel multipath target
  27 #       # values  : "round-robin 0"  = Loop through every path in the path group,
  28 #       #                              sending the same amount of IO to each.
  29 #       #           "queue-length 0" = Send the next bunch of IO down the path
  30 #       #                              with the least amount of outstanding IO.
  31 #       #           "service-time 0" = Choose the path for the next bunch of IO
  32 #       #                              based on the amount of outstanding IO to
  33 #       #                              the path and its relative throughput.
  34 #       # default : "service-time 0"
  35 #       #
  36 #       path_selector   "service-time 0"
  37 #
  38 #       #
  39 #       # name    : path_grouping_policy
  40 #       # scope   : multipath & multipathd
  41 #       # desc    : the default path grouping policy to apply to unspecified
  42 #       #           multipaths
  43 #       # values  : failover           = 1 path per priority group
  44 #       #           multibus           = all valid paths in 1 priority group
  45 #       #           group_by_serial    = 1 priority group per detected serial
  46 #       #                                number
  47 #       #           group_by_prio      = 1 priority group per path priority
  48 #       #                                value
  49 #       #           group_by_node_name = 1 priority group per target node name
  50 #       # default : failover
  51 #       #
  52 #       path_grouping_policy    multibus
  53 #
  54 #       #
  55 #       # name    : uid_attribute
  56 #       # scope   : multipath & multipathd
  57 #       # desc    : the default udev attribute from which the path
  58 #       #           identifier should be generated.
  59 #       # default : ID_SERIAL
  60 #       #
  61 #       uid_attribute   "ID_SERIAL"
  62 #
  63 #       #
  64 #       # name    : getuid_callout
  65 #       # scope   : multipath & multipathd
  66 #       # desc    : the default program and args to callout to obtain a unique
  67 #       #           path identifier. This parameter is deprecated.
  68 #       #           This parameter is deprecated, superseded by uid_attribute
  69 #       # default : /lib/udev/scsi_id --whitelisted --device=/dev/%n
  70 #       #
  71 #       getuid_callout  "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
  72 #
  73 #       #
  74 #       # name    : prio
  75 #       # scope   : multipath & multipathd
  76 #       # desc    : the default function to call to obtain a path
  77 #       #           priority value. The ALUA bits in SPC-3 provide an
  78 #       #           exploitable prio value for example.
  79 #       # default : const
  80 #       #
  81 #       prio    "alua"
  82 #
  83 #       #
  84 #       # name    : prio_args
  85 #       # scope   : multipath & multipathd
  86 #       # desc    : The arguments string passed to the prio function
  87 #       #           Most prio functions do not need arguments. The
  88 #       #           datacore prioritizer need one.
  89 #       # default : (null)
  90 #       #
  91 #       prio_args       "timeout=1000 preferredsds=foo"
  92 #
  93 #       #
  94 #       # name    : features
  95 #       # scope   : multipath & multipathd
  96 #       # desc    : The default extra features of multipath devices.
  97 #       #           Syntax is "num[ feature_0 feature_1 ...]", where `num' is the
  98 #       #           number of features in the following (possibly empty) list of
  99 #       #           features.
 100 #       # values  : queue_if_no_path = Queue IO if no path is active; consider
 101 #       #                              using the `no_path_retry' keyword instead.
 102 #       #           no_partitions    = Disable automatic partitions generation via
 103 #       #                              kpartx.
 104 #       # default : "0"
 105 #       #
 106 #       features        "0"
 107 #       features        "1 queue_if_no_path"
 108 #       features        "1 no_partitions"
 109 #       features        "2 queue_if_no_path no_partitions"
 110 #
 111 #       #
 112 #       # name    : path_checker, checker
 113 #       # scope   : multipath & multipathd
 114 #       # desc    : the default method used to determine the paths' state
 115 #       # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|cciss_tur
 116 #       # default : directio
 117 #       #
 118 #       path_checker    directio
 119 #
 120 #       #
 121 #       # name    : rr_min_io
 122 #       # scope   : multipath & multipathd
 123 #       # desc    : the number of IO to route to a path before switching
 124 #       #           to the next in the same path group for the bio-based
 125 #       #           multipath implementation. This parameter is used for
 126 #       #           kernels version up to 2.6.31; newer kernel version
 127 #       #           use the parameter rr_min_io_rq
 128 #       # default : 1000
 129 #       #
 130 #       rr_min_io       1000
 131 #
 132 #       #
 133 #       # name    : rr_min_io_rq
 134 #       # scope   : multipath & multipathd
 135 #       # desc    : the number of IO to route to a path before switching
 136 #       #           to the next in the same path group for the request-based
 137 #       #           multipath implementation. This parameter is used for
 138 #       #           kernels versions later than 2.6.31.
 139 #       # default : 1
 140 #       #
 141 #       rr_min_io_rq    1
 142 #
 143 #       #
 144 #       # name    : flush_on_last_del
 145 #       # scope   : multipathd
 146 #       # desc    : If set to "yes", multipathd will disable queueing when the
 147 #       #           last path to a device has been deleted.
 148 #       # values  : yes|no
 149 #       # default : no
 150 #       #
 151 #       flush_on_last_del       yes
 152 #
 153 #       #
 154 #       # name    : max_fds
 155 #       # scope   : multipathd
 156 #       # desc    : Sets the maximum number of open file descriptors for the
 157 #       #           multipathd process.
 158 #       # values  : max|n > 0
 159 #       # default : None
 160 #       #
 161 #       max_fds         8192
 162 #
 163 #       #
 164 #       # name    : rr_weight
 165 #       # scope   : multipath & multipathd
 166 #       # desc    : if set to priorities the multipath configurator will assign
 167 #       #           path weights as "path prio * rr_min_io"
 168 #       # values  : priorities|uniform
 169 #       # default : uniform
 170 #       #
 171 #       rr_weight       priorities
 172 #
 173 #       #
 174 #       # name    : failback
 175 #       # scope   : multipathd
 176 #       # desc    : tell the daemon to manage path group failback, or not to.
 177 #       #           0 means immediate failback, values >0 means deffered
 178 #       #           failback expressed in seconds.
 179 #       # values  : manual|immediate|n > 0
 180 #       # default : manual
 181 #       #
 182 #       failback        immediate
 183 #
 184 #       #
 185 #       # name    : no_path_retry
 186 #       # scope   : multipath & multipathd
 187 #       # desc    : tell the number of retries until disable queueing, or
 188 #       #           "fail" means immediate failure (no queueing),
 189 #       #           "queue" means never stop queueing
 190 #       # values  : queue|fail|n (>0)
 191 #       # default : (null)
 192 #       #
 193 #       no_path_retry  queue
 194 #
 195 #       #
 196 #       # name    : queue_without_daemon
 197 #       # scope   : multipathd
 198 #       # desc    : If set to "no", multipathd will disable queueing for all
 199 #       #           devices when it is shut down.
 200 #       # values  : yes|no
 201 #       # default : yes
 202 #       queue_without_daemon    no
 203 #
 204 #       #
 205 #       # name    : user_friendly_names
 206 #       # scope   : multipath & multipathd
 207 #       # desc    : If set to "yes", using the bindings file
 208 #       #           /etc/multipath/bindings to assign a persistent and
 209 #       #           unique alias to the multipath, in the form of mpath<n>.
 210 #       #           If set to "no" use the WWID as the alias. In either case
 211 #       #           this be will be overriden by any specific aliases in this
 212 #       #           file.
 213 #       # values  : yes|no
 214 #       # default : no
 215 #       user_friendly_names no
 216 #
 217 #       #
 218 #       # name    : mode
 219 #       # scope   : multipath & multipathd
 220 #       # desc    : The mode to use for the multipath device nodes, in octal.
 221 #       # values  : 0000 - 0777
 222 #       # default : determined by the process
 223 #       mode 0644
 224 #
 225 #       #
 226 #       # name    : uid
 227 #       # scope   : multipath & multipathd
 228 #       # desc    : The user id to use for the multipath device nodes. You
 229 #       #           may use either the numeric or symbolic uid
 230 #       # values  : <user_id>
 231 #       # default : determined by the process
 232 #       uid 0
 233 #
 234 #       #
 235 #       # name    : gid
 236 #       # scope   : multipath & multipathd
 237 #       # desc    : The group id to user for the multipath device nodes. You
 238 #       #           may use either the numeric or symbolic gid
 239 #       # values  : <group_id>
 240 #       # default : determined by the process
 241 #       gid disk
 242 #
 243 #       #
 244 #       # name    : checker_timeout
 245 #       # scope   : multipath & multipathd
 246 #       # desc    : The timeout to use for path checkers that issue scsi
 247 #       #           commands with an explicit timeout, in seconds.
 248 #       # values  : n > 0
 249 #       # default : taken from /sys/block/sd<x>/device/timeout
 250 #       checker_timeout 60
 251 #
 252 #       #
 253 #       # name    : fast_io_fail_tmo
 254 #       # scope   : multipath & multipathd
 255 #       # desc    : The number of seconds the scsi layer will wait after a
 256 #       #           problem has been detected on a FC remote port before failing
 257 #       #           IO to devices on that remote port.
 258 #       # values  : off | n >= 0 (smaller than dev_loss_tmo)
 259 #       # default : determined by the OS
 260 #       fast_io_fail_tmo 5
 261 #
 262 #       #
 263 #       # name    : dev_loss_tmo
 264 #       # scope   : multipath & multipathd
 265 #       # desc    : The number of seconds the scsi layer will wait after a
 266 #       #           problem has been detected on a FC remote port before
 267 #       #           removing it from the system.
 268 #       # values  : infinity | n > 0
 269 #       # default : determined by the OS
 270 #       dev_loss_tmo 600
 271 #
 272 #       # name    : bindings_file
 273 #       # scope   : multipath
 274 #       # desc    : The location of the bindings file that is used with
 275 #       #           the user_friendly_names option.
 276 #       # values  : <full_pathname>
 277 #       # default : "/var/lib/multipath/bindings"
 278 #       bindings_file "/etc/multipath_bindings"
 279 #
 280 #}
 281 #
 282 ##
 283 ## name    : blacklist
 284 ## scope   : multipath & multipathd
 285 ## desc    : list of device names to discard as not multipath candidates
 286 ##           Devices can be identified by their device node name "devnode",
 287 ##           their WWID "wwid", or their vender and product strings
 288 ##           "device"
 289 ## default : fd, hd, md, dm, sr, scd, st, ram, raw, loop, dcssblk
 290 ##
 291 #blacklist {
 292 #       wwid 26353900f02796769
 293 #       devnode "^(ram|raw|loop|fd|md|dm-|sr|scd|st)[0-9]*"
 294 #       devnode "^hd[a-z]"
 295 #       devnode "^dcssblk[0-9]*"
 296 #       device {
 297 #               vendor DEC.*
 298 #               product MSA[15]00
 299 #       }
 300 #}
 301 ##
 302 ## name    : blacklist_exceptions
 303 ## scope   : multipath & multipathd
 304 ## desc    : list of device names to be treated as multipath candidates
 305 ##           even if they are on the blacklist.
 306 ##           Note: blacklist exceptions are only valid in the same class.
 307 ##           It is not possible to blacklist devices using the devnode keyword
 308 ##           and to exclude some devices of them using the wwid keyword.
 309 ## default : -
 310 ##
 311 #blacklist_exceptions {
 312 #       devnode "^dasd[c-d]+[0-9]*"
 313 #       wwid    "IBM.75000000092461.4d00.34"
 314 #       wwid    "IBM.75000000092461.4d00.35"
 315 #       wwid    "IBM.75000000092461.4d00.36"
 316 #}
 317 #
 318 ##
 319 ## name    : multipaths
 320 ## scope   : multipath & multipathd
 321 ## desc    : list of multipaths finest-grained settings
 322 ##
 323 #multipaths {
 324 #       #
 325 #       # name  : multipath
 326 #       # scope : multipath & multipathd
 327 #       # desc  : container for settings that apply to one specific multipath
 328 #       #
 329 #       multipath {
 330 #               #
 331 #               # name  : wwid
 332 #               # scope : multipath & multipathd
 333 #               # desc  : index of the container
 334 #               #
 335 #               wwid                    3600508b4000156d700012000000b0000
 336 #
 337 #               #
 338 #               # name    : alias
 339 #               # scope   : multipath & multipathd
 340 #               # desc    : symbolic name for the multipath. If you are using
 341 #               #           user_friendly_names, do not set the alias to
 342 #               #           mpath<n>. This may conflict with an automatically
 343 #               #           assigned user friendly name, and give you
 344 #               #           incorrect device node names.
 345 #               #
 346 #               alias                   yellow
 347 #
 348 #               #
 349 #               # name    : path_grouping_policy
 350 #               # scope   : multipath & multipathd
 351 #               # desc    : path grouping policy to apply to this multipath
 352 #               # values  : failover, multibus, group_by_serial
 353 #               # values  : failover           = 1 path per priority group
 354 #               #           multibus           = all valid paths in 1 priority
 355 #               #                                group
 356 #               #           group_by_serial    = 1 priority group per detected
 357 #               #                                serial number
 358 #               #           group_by_prio      = 1 priority group per path
 359 #               #                                priority value
 360 #               #           group_by_node_name = 1 priority group per target
 361 #               #                                node name
 362 #               #
 363 #               path_grouping_policy    failover
 364 #
 365 #               #
 366 #               # name    : path_selector
 367 #               # scope   : multipath & multipathd
 368 #               # desc    : the path selector algorithm to use for this mpath
 369 #               #           these algo are offered by the kernel mpath target
 370 #               # values  : "round-robin 0"
 371 #               #
 372 #               path_selector           "round-robin 0"
 373 #
 374 #               #
 375 #               # name    : failback
 376 #               # scope   : multipathd
 377 #               # desc    : tell the daemon to manage path group failback, or
 378 #               #           not to. 0 means immediate failback, values >0 means
 379 #               #           deffered failback expressed in seconds.
 380 #               # values  : manual|immediate|n > 0
 381 #               #
 382 #               failback                manual
 383 #
 384 #               #
 385 #               # name    : rr_weight
 386 #               # scope   : multipath & multipathd
 387 #               # desc    : if set to priorities the multipath configurator will
 388 #               #           assign path weights as "path prio * rr_min_io"
 389 #               # values  : priorities|uniform
 390 #               #
 391 #               rr_weight       priorities
 392 #
 393 #               #
 394 #               # name    : no_path_retry
 395 #               # scope   : multipath & multipathd
 396 #               # desc    : tell the number of retries until disable queueing,
 397 #               #           or "fail" means immediate failure (no queueing),
 398 #               #           "queue" means never stop queueing
 399 #               # values  : queue|fail|n (>0)
 400 #               #
 401 #               no_path_retry  queue
 402 #
 403 #               #
 404 #               # name    : rr_min_io
 405 #               # scope   : multipath & multipathd
 406 #               # desc    : the number of IO to route to a path before switching
 407 #               #           to the next in the same path group
 408 #               #
 409 #               rr_min_io       100
 410 #
 411 #               #
 412 #               # name    : flush_on_last_del
 413 #               # scope   : multipathd
 414 #               # desc    : If set to "yes", multipathd will disable queueing
 415 #               #           when the last path to a device has been deleted.
 416 #               # values  : yes|no
 417 #               # default : no
 418 #               #
 419 #               flush_on_last_del       yes
 420 #
 421 #               #
 422 #               # name    : mode
 423 #               # scope   : multipath & multipathd
 424 #               # desc    : The mode to use for the multipath device nodes, in
 425 #               #           octal.
 426 #               # values  : 0000 - 0777
 427 #               # default : determined by the process
 428 #               mode 0644
 429 #
 430 #               #
 431 #               # name    : uid
 432 #               # scope   : multipath & multipathd
 433 #               # desc    : The user id to use for the multipath device nodes.
 434 #               #           You may use either the numeric or symbolic uid
 435 #               # values  : <user_id>
 436 #               # default : determined by the process
 437 #               uid 0
 438 #
 439 #               #
 440 #               # name    : gid
 441 #               # scope   : multipath & multipathd
 442 #               # desc    : The group id to user for the multipath device nodes.
 443 #               #           You may use either the numeric or symbolic gid
 444 #               # values  : <group_id>
 445 #               # default : determined by the process
 446 #               gid 0
 447 #
 448 #       }
 449 #       multipath {
 450 #               wwid    1DEC_____321816758474
 451 #               alias   red
 452 #               rr_weight               priorities
 453 #       }
 454 #}
 455 #
 456 ##
 457 ## name  : devices
 458 ## scope : multipath & multipathd
 459 ## desc  : list of per storage controller settings
 460 ##        overrides default settings (device_maps block)
 461 ##         overriden by per multipath settings (multipaths block)
 462 ##
 463 #devices {
 464 #       #
 465 #       # name  : device
 466 #       # scope : multipath & multipathd
 467 #       # desc  : settings for this specific storage controller
 468 #       #
 469 #       device {
 470 #               #
 471 #               # name  : vendor, product
 472 #               # scope : multipath & multipathd
 473 #               # desc  : index for the block
 474 #               #
 475 #               vendor                  "COMPAQ  "
 476 #               product                 "HSV110 (C)COMPAQ"
 477 #
 478 #               #
 479 #               # name    : path_grouping_policy
 480 #               # scope   : multipath & multipathd
 481 #               # desc    : path grouping policy to apply to this multipath
 482 #               # values  : failover, multibus, group_by_serial
 483 #               # values  : failover           = 1 path per priority group
 484 #               #           multibus           = all valid paths in 1 priority
 485 #               #                                group
 486 #               #           group_by_serial    = 1 priority group per detected
 487 #               #                                serial number
 488 #               #           group_by_prio      = 1 priority group per path
 489 #               #                                priority value
 490 #               #           group_by_node_name = 1 priority group per target
 491 #               #                                node name
 492 #               #
 493 #               path_grouping_policy    failover
 494 #
 495 #               #
 496 #               # name    : getuid_callout
 497 #               # scope   : multipath & multipathd
 498 #               # desc    : the program and args to callout to obtain a unique
 499 #               #           path identifier. Absolute path required
 500 #               #
 501 #               getuid_callout          "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
 502 #
 503 #               #
 504 #               # name    : prio
 505 #               # scope   : multipath & multipathd
 506 #               # desc    : the function to call to obtain a path
 507 #               #           weight. Weights are summed for each path group to
 508 #               #           determine the next PG to use case of failure.
 509 #               # default : no callout, all paths equals
 510 #               #
 511 #               prio          "hp_sw"
 512 #
 513 #               #
 514 #               # name    : prio_args
 515 #               # scope   : multipath & multipathd
 516 #               # desc    : The arguments string passed to the prio function
 517 #               #           Most prio functions do not need arguments. The
 518 #               #           datacore prioritizer need one.
 519 #               # default : (null)
 520 #               #
 521 #               prio_args       "timeout=1000 preferredsds=foo"
 522 #
 523 #               # name    : path_checker, checker
 524 #               # scope   : multipathd & multipathd
 525 #               # desc    : path checking algorithm to use to check path state
 526 #               # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|
 527 #               #           cciss_tur
 528 #               #
 529 #               path_checker            directio
 530 #
 531 #               # as already described
 532 #               path_selector           "service-time 0"
 533 #
 534 #               # as already described
 535 #               features        "0"
 536 #
 537 #               #
 538 #               # name    : hardware_handler
 539 #               # scope   : multipath & multipathd
 540 #               # desc    : If set, it specifies a module that will be used to
 541 #               #           perform hardware specific actions when switching
 542 #               #           path groups or handling IO errors
 543 #               # values  : "0"|"1 emc"
 544 #               # default : "0"
 545 #               #
 546 #               hardware_handler "1 emc"
 547 #
 548 #               #
 549 #               # name    : failback
 550 #               # scope   : multipathd
 551 #               # desc    : tell the daemon to manage path group failback, or
 552 #               #           not to. 0 means immediate failback, values >0 means
 553 #               #           deffered failback expressed in seconds.
 554 #               # values  : manual|immediate|n > 0
 555 #               #
 556 #               failback                30
 557 #
 558 #               #
 559 #               # name    : rr_weight
 560 #               # scope   : multipath & multipathd
 561 #               # desc    : if set to priorities the multipath configurator will
 562 #               #           assign path weights as "path prio * rr_min_io"
 563 #               # values  : priorities|uniform
 564 #               #
 565 #               rr_weight       priorities
 566 #
 567 #               #
 568 #               # name    : no_path_retry
 569 #               # scope   : multipath & multipathd
 570 #               # desc    : tell the number of retries until disable queueing,
 571 #               #           or "fail" means immediate failure (no queueing),
 572 #               #           "queue" means never stop queueing
 573 #               # values  : queue|fail|n (>0)
 574 #               #
 575 #               no_path_retry  queue
 576 #
 577 #               #
 578 #               # name    : rr_min_io
 579 #               # scope   : multipath & multipathd
 580 #               # desc    : the number of IO to route to a path before switching
 581 #               #           to the next in the same path group
 582 #               #
 583 #               rr_min_io       100
 584 #
 585 #               #
 586 #               # name    : flush_on_last_del
 587 #               # scope   : multipathd
 588 #               # desc    : If set to "yes", multipathd will disable queueing
 589 #               #           when the last path to a device has been deleted.
 590 #               # values  : yes|no
 591 #               #
 592 #               flush_on_last_del       yes
 593 #
 594 #               #
 595 #               # name    : product_blacklist
 596 #               # scope   : multipath & multipathd
 597 #               # desc    : product strings to blacklist for this vendor
 598 #               #
 599 #               product_blacklist       LUN_Z
 600 #
 601 #               #
 602 #               # name    : fast_io_fail_tmo
 603 #               # scope   : multipath & multipathd
 604 #               # desc    : The number of seconds the scsi layer will wait after
 605 #               #           a problem has been detected on a FC remote port
 606 #               #           before failing IO to devices on that remote port.
 607 #               # values  : off | n >= 0 (smaller than dev_loss_tmo)
 608 #               fast_io_fail_tmo 5
 609 #
 610 #               #
 611 #               # name    : dev_loss_tmo
 612 #               # scope   : multipath & multipathd
 613 #               # desc    : The number of seconds the scsi layer will wait after
 614 #               #           a problem has been detected on a FC remote port
 615 #               #           before removing it from the system.
 616 #               # values  : n > 0
 617 #               dev_loss_tmo 600
 618 #       }
 619 #       device {
 620 #               vendor                  "COMPAQ  "
 621 #               product                 "MSA1000         "
 622 #               path_grouping_policy    multibus
 623 #               path_checker            tur
 624 #               rr_weight               priorities
 625 #       }
 626 #}