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