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    : 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 #       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    : fast_io_fail_tmo
 215 #       # scope   : multipath & multipathd
 216 #       # desc    : The number of seconds the scsi layer will wait after a
 217 #       #           problem has been detected on a FC remote port before failing
 218 #       #           IO to devices on that remote port.
 219 #       # values  : off | n >= 0 (smaller than dev_loss_tmo)
 220 #       # default : determined by the OS
 221 #       fast_io_fail_tmo 5
 222 #
 223 #       #
 224 #       # name    : dev_loss_tmo
 225 #       # scope   : multipath & multipathd
 226 #       # desc    : The number of seconds the scsi layer will wait after a
 227 #       #           problem has been detected on a FC remote port before
 228 #       #           removing it from the system.
 229 #       # values  : n > 0
 230 #       # default : determined by the OS
 231 #       dev_loss_tmo 600
 232 #}
 233 #
 234 ##
 235 ## name    : blacklist
 236 ## scope   : multipath & multipathd
 237 ## desc    : list of device names to discard as not multipath candidates
 238 ##           Devices can be identified by their device node name "devnode",
 239 ##           their WWID "wwid", or their vender and product strings
 240 ##           "device"
 241 ## default : fd, hd, md, dm, sr, scd, st, ram, raw, loop, dcssblk
 242 ##
 243 #blacklist {
 244 #       wwid 26353900f02796769
 245 #       devnode "^(ram|raw|loop|fd|md|dm-|sr|scd|st)[0-9]*"
 246 #       devnode "^hd[a-z]"
 247 #       devnode "^dcssblk[0-9]*"
 248 #       device {
 249 #               vendor DEC.*
 250 #               product MSA[15]00
 251 #       }
 252 #}
 253 ##
 254 ## name    : blacklist_exceptions
 255 ## scope   : multipath & multipathd
 256 ## desc    : list of device names to be treated as multipath candidates
 257 ##           even if they are on the blacklist.
 258 ##           Note: blacklist exceptions are only valid in the same class.
 259 ##           It is not possible to blacklist devices using the devnode keyword
 260 ##           and to exclude some devices of them using the wwid keyword.
 261 ## default : -
 262 ##
 263 #blacklist_exceptions {
 264 #       devnode "^dasd[c-d]+[0-9]*"
 265 #       wwid    "IBM.75000000092461.4d00.34"
 266 #       wwid    "IBM.75000000092461.4d00.35"
 267 #       wwid    "IBM.75000000092461.4d00.36"
 268 #}
 269 #
 270 ##
 271 ## name    : multipaths
 272 ## scope   : multipath & multipathd
 273 ## desc    : list of multipaths finest-grained settings
 274 ##
 275 #multipaths {
 276 #       #
 277 #       # name  : multipath
 278 #       # scope : multipath & multipathd
 279 #       # desc  : container for settings that apply to one specific multipath
 280 #       #
 281 #       multipath {
 282 #               #
 283 #               # name  : wwid
 284 #               # scope : multipath & multipathd
 285 #               # desc  : index of the container
 286 #               #
 287 #               wwid                    3600508b4000156d700012000000b0000
 288 #
 289 #               #
 290 #               # name    : alias
 291 #               # scope   : multipath & multipathd
 292 #               # desc    : symbolic name for the multipath. If you are using
 293 #               #           user_friendly_names, do not set the alias to
 294 #               #           mpath<n>. This may conflict with an automatically
 295 #               #           assigned user friendly name, and give you
 296 #               #           incorrect device node names.
 297 #               #
 298 #               alias                   yellow
 299 #
 300 #               #
 301 #               # name    : path_grouping_policy
 302 #               # scope   : multipath & multipathd
 303 #               # desc    : path grouping policy to apply to this multipath
 304 #               # values  : failover, multibus, group_by_serial
 305 #               # values  : failover           = 1 path per priority group
 306 #               #           multibus           = all valid paths in 1 priority
 307 #               #                                group
 308 #               #           group_by_serial    = 1 priority group per detected
 309 #               #                                serial number
 310 #               #           group_by_prio      = 1 priority group per path
 311 #               #                                priority value
 312 #               #           group_by_node_name = 1 priority group per target
 313 #               #                                node name
 314 #               #
 315 #               path_grouping_policy    failover
 316 #
 317 #               #
 318 #               # name    : path_selector
 319 #               # scope   : multipath & multipathd
 320 #               # desc    : the path selector algorithm to use for this mpath
 321 #               #           these algo are offered by the kernel mpath target
 322 #               # values  : "round-robin 0"
 323 #               #
 324 #               path_selector           "round-robin 0"
 325 #
 326 #               #
 327 #               # name    : failback
 328 #               # scope   : multipathd
 329 #               # desc    : tell the daemon to manage path group failback, or
 330 #               #           not to. 0 means immediate failback, values >0 means
 331 #               #           deffered failback expressed in seconds.
 332 #               # values  : manual|immediate|n > 0
 333 #               #
 334 #               failback                manual
 335 #
 336 #               #
 337 #               # name    : rr_weight
 338 #               # scope   : multipath & multipathd
 339 #               # desc    : if set to priorities the multipath configurator will
 340 #               #           assign path weights as "path prio * rr_min_io"
 341 #               # values  : priorities|uniform
 342 #               #
 343 #               rr_weight       priorities
 344 #
 345 #               #
 346 #               # name    : no_path_retry
 347 #               # scope   : multipath & multipathd
 348 #               # desc    : tell the number of retries until disable queueing,
 349 #               #           or "fail" means immediate failure (no queueing),
 350 #               #           "queue" means never stop queueing
 351 #               # values  : queue|fail|n (>0)
 352 #               #
 353 #               no_path_retry  queue
 354 #
 355 #               #
 356 #               # name    : rr_min_io
 357 #               # scope   : multipath & multipathd
 358 #               # desc    : the number of IO to route to a path before switching
 359 #               #           to the next in the same path group
 360 #               #
 361 #               rr_min_io       100
 362 #
 363 #               #
 364 #               # name    : flush_on_last_del
 365 #               # scope   : multipathd
 366 #               # desc    : If set to "yes", multipathd will disable queueing
 367 #               #           when the last path to a device has been deleted.
 368 #               # values  : yes|no
 369 #               # default : no
 370 #               #
 371 #               flush_on_last_del       yes
 372 #
 373 #               #
 374 #               # name    : mode
 375 #               # scope   : multipath & multipathd
 376 #               # desc    : The mode to use for the multipath device nodes, in
 377 #               #           octal.
 378 #               # values  : 0000 - 0777
 379 #               # default : determined by the process
 380 #               mode 0644
 381 #
 382 #               #
 383 #               # name    : uid
 384 #               # scope   : multipath & multipathd
 385 #               # desc    : The user id to use for the multipath device nodes.
 386 #               #           You may use either the numeric or symbolic uid
 387 #               # values  : <user_id>
 388 #               # default : determined by the process
 389 #               uid 0
 390 #
 391 #               #
 392 #               # name    : gid
 393 #               # scope   : multipath & multipathd
 394 #               # desc    : The group id to user for the multipath device nodes.
 395 #               #           You may use either the numeric or symbolic gid
 396 #               # values  : <group_id>
 397 #               # default : determined by the process
 398 #               gid 0
 399 #
 400 #       }
 401 #       multipath {
 402 #               wwid    1DEC_____321816758474
 403 #               alias   red
 404 #               rr_weight               priorities
 405 #       }
 406 #}
 407 #
 408 ##
 409 ## name  : devices
 410 ## scope : multipath & multipathd
 411 ## desc  : list of per storage controller settings
 412 ##        overrides default settings (device_maps block)
 413 ##         overriden by per multipath settings (multipaths block)
 414 ##
 415 #devices {
 416 #       #
 417 #       # name  : device
 418 #       # scope : multipath & multipathd
 419 #       # desc  : settings for this specific storage controller
 420 #       #
 421 #       device {
 422 #               #
 423 #               # name  : vendor, product
 424 #               # scope : multipath & multipathd
 425 #               # desc  : index for the block
 426 #               #
 427 #               vendor                  "COMPAQ  "
 428 #               product                 "HSV110 (C)COMPAQ"
 429 #
 430 #               #
 431 #               # name    : path_grouping_policy
 432 #               # scope   : multipath & multipathd
 433 #               # desc    : path grouping policy to apply to this multipath
 434 #               # values  : failover, multibus, group_by_serial
 435 #               # values  : failover           = 1 path per priority group
 436 #               #           multibus           = all valid paths in 1 priority
 437 #               #                                group
 438 #               #           group_by_serial    = 1 priority group per detected
 439 #               #                                serial number
 440 #               #           group_by_prio      = 1 priority group per path
 441 #               #                                priority value
 442 #               #           group_by_node_name = 1 priority group per target
 443 #               #                                node name
 444 #               #
 445 #               path_grouping_policy    failover
 446 #
 447 #               #
 448 #               # name    : getuid_callout
 449 #               # scope   : multipath & multipathd
 450 #               # desc    : the program and args to callout to obtain a unique
 451 #               #           path identifier. Absolute path required
 452 #               #
 453 #               getuid_callout          "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
 454 #
 455 #               #
 456 #               # name    : prio
 457 #               # scope   : multipath & multipathd
 458 #               # desc    : the function to call to obtain a path
 459 #               #           weight. Weights are summed for each path group to
 460 #               #           determine the next PG to use case of failure.
 461 #               # default : no callout, all paths equals
 462 #               #
 463 #               prio          "hp_sw"
 464 #
 465 #               #       #
 466 #               # name    : prio_args
 467 #               # scope   : multipath & multipathd
 468 #               # desc    : The arguments string passed to the prio function
 469 #               #           Most prio functions do not need arguments. The
 470 #               #           datacore prioritizer need one.
 471 #               # default : (null)
 472 #               #
 473 #               prio_args       "timeout=1000 preferredsds=foo"
 474 ##
 475 #               # name    : path_checker, checker
 476 #               # scope   : multipathd & multipathd
 477 #               # desc    : path checking alorithm to use to check path state
 478 #               # values  : readsector0|tur|emc_clariion|hp_sw|directio|rdac|
 479 #               #           cciss_tur
 480 #               #
 481 #               path_checker            directio
 482 #
 483 #               #
 484 #               # name    : path_selector
 485 #               # scope   : multipathd & multipathd
 486 #               # desc    : the path selector algorithm to use for this mpath
 487 #               #           these algo are offered by the kernel mpath target
 488 #               # values  : "round-robin 0"
 489 #               #
 490 #               path_selector           "round-robin 0"
 491 #
 492 #               #
 493 #               # name    : features
 494 #               # scope   : multipath & multipathd
 495 #               # desc    : The extra features of multipath devices. The only
 496 #               #           existing feature currently is queue_if_no_path,
 497 #               #           which is the same as setting no_path_retry to queue.
 498 #               # values  : "1 queue_if_no_path"
 499 #               #
 500 #               features        "1 queue_if_no_path"
 501 #
 502 #               #
 503 #               # name    : hardware_handler
 504 #               # scope   : multipath & multipathd
 505 #               # desc    : If set, it specifies a module that will be used to
 506 #               #           perform hardware specific actions when switching
 507 #               #           path groups or handling IO errors
 508 #               # values  : "0"|"1 emc"
 509 #               # default : "0"
 510 #               #
 511 #               hardware_handler "1 emc"
 512 #
 513 #               #
 514 #               # name    : failback
 515 #               # scope   : multipathd
 516 #               # desc    : tell the daemon to manage path group failback, or
 517 #               #           not to. 0 means immediate failback, values >0 means
 518 #               #           deffered failback expressed in seconds.
 519 #               # values  : manual|immediate|n > 0
 520 #               #
 521 #               failback                30
 522 #
 523 #               #
 524 #               # name    : rr_weight
 525 #               # scope   : multipath & multipathd
 526 #               # desc    : if set to priorities the multipath configurator will
 527 #               #           assign path weights as "path prio * rr_min_io"
 528 #               # values  : priorities|uniform
 529 #               #
 530 #               rr_weight       priorities
 531 #
 532 #               #
 533 #               # name    : no_path_retry
 534 #               # scope   : multipath & multipathd
 535 #               # desc    : tell the number of retries until disable queueing,
 536 #               #           or "fail" means immediate failure (no queueing),
 537 #               #           "queue" means never stop queueing
 538 #               # values  : queue|fail|n (>0)
 539 #               #
 540 #               no_path_retry  queue
 541 #
 542 #               #
 543 #               # name    : rr_min_io
 544 #               # scope   : multipath & multipathd
 545 #               # desc    : the number of IO to route to a path before switching
 546 #               #           to the next in the same path group
 547 #               #
 548 #               rr_min_io       100
 549 #
 550 #               #
 551 #               # name    : flush_on_last_del
 552 #               # scope   : multipathd
 553 #               # desc    : If set to "yes", multipathd will disable queueing
 554 #               #           when the last path to a device has been deleted.
 555 #               # values  : yes|no
 556 #               #
 557 #               flush_on_last_del       yes
 558 #
 559 #               #
 560 #               # name    : product_blacklist
 561 #               # scope   : multipath & multipathd
 562 #               # desc    : product strings to blacklist for this vendor
 563 #               #
 564 #               product_blacklist       LUN_Z
 565 #
 566 #               #
 567 #               # name    : fast_io_fail_tmo
 568 #               # scope   : multipath & multipathd
 569 #               # desc    : The number of seconds the scsi layer will wait after
 570 #               #           a problem has been detected on a FC remote port
 571 #               #           before failing IO to devices on that remote port.
 572 #               # values  : off | n >= 0 (smaller than dev_loss_tmo)
 573 #               fast_io_fail_tmo 5
 574 #
 575 #               #
 576 #               # name    : dev_loss_tmo
 577 #               # scope   : multipath & multipathd
 578 #               # desc    : The number of seconds the scsi layer will wait after
 579 #               #           a problem has been detected on a FC remote port
 580 #               #           before removing it from the system.
 581 #               # values  : n > 0
 582 #               dev_loss_tmo 600
 583 #       }
 584 #       device {
 585 #               vendor                  "COMPAQ  "
 586 #               product                 "MSA1000         "
 587 #               path_grouping_policy    multibus
 588 #               path_checker            tur
 589 #               rr_weight               priorities
 590 #       }
 591 #}