multipath/multipath.conf.5

   1 .TH MULTIPATH.CONF 5 "30 November 2006"
   2 .SH NAME
   3 multipath.conf \- multipath daemon configuration file
   4 .SH DESCRIPTION
   5 .B "multipath.conf"
   6 is the configuration file for the multipath daemon. It is used to
   7 overwrite the built-in configuration table of \fBmultipathd\fP.
   8 Any line whose first non-white-space character is a '#' is considered
   9 a comment line. Empty lines are ignored.
  10 .SH SYNTAX
  11 The configuration file contains entries of the form:
  12 .RS
  13 .nf
  14 .ft B
  15 .sp
  16 <section> {
  17 .RS
  18 .ft B
  19 <attribute> <value>
  20 .I "..."
  21 .ft B
  22 <subsection> {
  23 .RS
  24 .ft B
  25 <attribute> <value>
  26 .I "..."
  27 .RE
  28 }
  29 .RE
  30 }
  31 .ft R
  32 .fi
  33 .RE
  34 .LP
  35 Each \fIsection\fP contains one or more attributes or subsections. The
  36 recognized keywords for attributes or subsections depend on the
  37 section in which they occur.
  38 .LP
  39 The following \fIsection\fP keywords are recognized:
  40 .TP 17
  41 .B defaults
  42 This section defines default values for attributes which are used
  43 whenever no values are given in the appropriate device or multipath
  44 sections.
  45 .TP
  46 .B blacklist
  47 This section defines which devices should be excluded from the
  48 multipath topology discovery.
  49 .TP
  50 .B blacklist_exceptions
  51 This section defines which devices should be included in the
  52 multipath topology discovery, despite being listed in the
  53 .I blacklist
  54 section.
  55 .TP
  56 .B multipaths
  57 This section defines the multipath topologies. They are indexed by a
  58 \fIWorld Wide Identifier\fR(wwid), which is taken to be the value of
  59 the udev attribute given by the
  60 \fIuid_attribute\fR keyword.
  61 .TP
  62 .B devices
  63 This section defines the device-specific settings.
  64 .RE
  65 .LP
  66 .SH "defaults section"
  67 The
  68 .B defaults
  69 section recognizes the following keywords:
  70 .TP 17
  71 .B polling_interval
  72 interval between two path checks in seconds. For properly functioning paths,
  73 the interval between checks will gradually increase to
  74 .B max_polling_interval;
  75 default is
  76 .I 5
  77 .TP
  78 .B max_polling_interval
  79 maximal interval between two path checks in seconds; default is
  80 .I 4 * polling_interval
  81 .TP
  82 .B multipath_dir
  83 directory where the dynamic shared objects are stored; default is system
  84 dependent, commonly
  85 .I /lib/multipath
  86 .TP
  87 .B verbosity
  88 default verbosity. Higher values increase the verbosity level. Valid
  89 levels are between 0 and 6; default is
  90 .I 2
  91 .TP
  92 .B reassign_maps
  93 enable reassigning of device-mapper maps. With this option multipathd
  94 will remap existing device-mapper maps to always point to multipath
  95 device, not the underlying block devices. Possible values are
  96 \fIyes\fR and \fIno\fR. Default is
  97 .I yes
  98 .TP
  99 .B path_selector
 100 The default path selector algorithm to use; they are offered by the
 101 kernel multipath target. There are three selector algorithms.
 102 .RS
 103 .TP 12
 104 .B "round-robin 0"
 105 Loop through every path in the path group, sending the same amount of IO to
 106 each.
 107 .TP
 108 .B "queue-length 0"
 109 Send the next bunch of IO down the path with the least amount of outstanding IO.
 110 .TP
 111 .B "service-time 0"
 112 Choose the path for the next bunch of IO based on the amount of outstanding IO
 113 to the path and its relative throughput.
 114 .RE
 115 .TP
 116 .B path_grouping_policy
 117 The default path grouping policy to apply to unspecified
 118 multipaths. Possible values are
 119 .RS
 120 .TP 12
 121 .B failover
 122 1 path per priority group
 123 .TP
 124 .B multibus
 125 all paths in 1 priority group
 126 .TP
 127 .B group_by_serial
 128 1 priority group per serial number
 129 .TP
 130 .B group_by_prio
 131 1 priority group per priority value. Priorities are determined by
 132 callout programs specified as a global, per-controller or
 133 per-multipath option in the configuration file.
 134 .TP
 135 .B group_by_node_name
 136 1 priority group per target node name. Target node names are fetched
 137 in /sys/class/fc_transport/target*/node_name.
 138 .TP
 139 Default value is \fIfailover\fR.
 140 .RE
 141 .TP
 142 .B uid_attribute
 143 The udev attribute providing a unique path
 144 identifier. Default value is
 145 .I ID_SERIAL
 146 .TP
 147 .B getuid_callout
 148 The default program and args to callout to obtain a unique path
 149 identifier. Should be specified with an absolute path.
 150 This parameter is deprecated; \fIuid_attribute\fR should be used instead.
 151 .TP
 152 .B prio
 153 The name of the path priority routine. The specified routine
 154 should return a numeric value specifying the relative priority
 155 of this path. Higher number have a higher priority.
 156 .I "none"
 157 is a valid value. Currently the following path priority routines
 158 are implemented:
 159 .RS
 160 .TP 12
 161 .B const
 162 Return a constant priority of \fI1\fR.
 163 .TP
 164 .B emc
 165 Generate the path priority for EMC arrays.
 166 .TP
 167 .B alua
 168 Generate the path priority based on the SCSI-3 ALUA settings.
 169 .TP
 170 .B ontap
 171 Generate the path priority for NetApp arrays.
 172 .TP
 173 .B rdac
 174 Generate the path priority for LSI/Engenio/NetApp E-Series RDAC controller.
 175 .TP
 176 .B hp_sw
 177 Generate the path priority for Compaq/HP controller in
 178 active/standby mode.
 179 .TP
 180 .B hds
 181 Generate the path priority for Hitachi HDS Modular storage arrays.
 182 .TP
 183 .B random
 184 Generate a random priority between 1 and 10.
 185 .TP 12
 186 .B weightedpath
 187 Generate the path priority based on the regular expression and the
 188 priority provided as argument. requires prio_args keyword.
 189 .TP
 190 Default value is \fBnone\fR.
 191 .RE
 192 .TP
 193 .B prio_args
 194 Arguments to pass to to the prio function.  Currently only used with
 195 .I weighted, which needs a value of the form
 196 .I "<hbtl|devname> <regex1> <prio1> <regex2> <prio2> ..."
 197 .I hbtl
 198 regex can be of SCSI H:B:T:L format  Ex: 1:0:.:. , *:0:0:.
 199 .I devname
 200 regex can be of device name format  Ex: sda , sd.e
 201 .TP
 202 .B features
 203 Specify any device-mapper features to be used. Syntax is
 204 .I num list
 205 where
 206 .I num
 207 is the number of features in
 208 .I list.
 209 Possible values for the feature list are
 210 .RS
 211 .TP 12
 212 .B queue_if_no_path
 213 Queue IO if no path is active; identical to the
 214 .I no_path_retry
 215 keyword.
 216 .TP
 217 .B no_partitions
 218 Disable automatic partitions generation via kpartx.
 219 .RE
 220 .TP
 221 .B path_checker
 222 The default method used to determine the paths state. Possible values
 223 are
 224 .RS
 225 .TP 12
 226 .B readsector0
 227 (Deprecated) Read the first sector of the device. This checker is being
 228 deprecated, please use \fIdirectio\fR instead
 229 .TP
 230 .B tur
 231 Issue a
 232 .I TEST UNIT READY
 233 command to the device.
 234 .TP
 235 .B emc_clariion
 236 Query the EMC Clariion specific EVPD page 0xC0 to determine the path
 237 state.
 238 .TP
 239 .B hp_sw
 240 Check the path state for HP storage arrays with Active/Standby firmware.
 241 .TP
 242 .B rdac
 243 Check the path state for LSI/Engenio/NetApp E-Series RDAC storage controller.
 244 .TP
 245 .B directio
 246 Read the first sector with direct I/O.
 247 .TP
 248 Default value is \fIdirectio\fR.
 249 .RE
 250 .TP
 251 .B failback
 252 Tell multipathd how to manage path group failback.
 253 .RS
 254 .TP 12
 255 .B immediate
 256 Immediately failback to the highest priority pathgroup that contains
 257 active paths.
 258 .TP
 259 .B manual
 260 Do not perform automatic failback.
 261 .TP
 262 .B followover
 263 Only perform automatic failback when the first path of a pathgroup
 264 becomes active. This keeps a node from automatically failing back when
 265 another node requested the failover.
 266 .TP
 267 .B values > 0
 268 deferred failback (time to defer in seconds)
 269 .TP
 270 Default value is \fImanual\fR.
 271 .RE
 272 .TP
 273 .B  rr_min_io
 274 The number of IO to route to a path before switching to the next in
 275 the same path group. This is only for BIO based multipath. Default is
 276 .I 1000
 277 .TP
 278 .B rr_min_io_rq
 279 The number of IO requests to route to a path before switching to the
 280 next in the same path group. This is only for request based multipath.
 281 Default is
 282 .I 1
 283 .TP
 284 .B rr_weight
 285 If set to \fIpriorities\fR the multipath configurator will assign
 286 path weights as "path prio * rr_min_io". Possible values are
 287 .I priorities
 288 or
 289 .IR uniform .
 290 Default is
 291 .IR uniform .
 292 .TP
 293 .B no_path_retry
 294 Specify the number of retries until disable queueing, or
 295 .I fail
 296 for immediate failure (no queueing),
 297 .I queue
 298 for never stop queueing. Default is 0.
 299 .TP
 300 .B user_friendly_names
 301 If set to
 302 .I yes
 303 , using the bindings file
 304 .I /etc/multipath/bindings
 305 to assign a persistent and unique alias to the multipath, in the form of mpath<n>.
 306 If set to
 307 .I no
 308 use the WWID as the alias. In either case this be will
 309 be overridden by any specific aliases in the \fImultipaths\fR section.
 310 Default is
 311 .I no
 312 .TP
 313 .B flush_on_last_del
 314 If set to
 315 .I yes
 316 , multipathd will disable queueing when the last path to a device has been
 317 deleted. Default is
 318 .I no
 319 .TP
 320 .B max_fds
 321 Specify the maximum number of file descriptors that can be opened by multipath
 322 and multipathd.  This is equivalent to ulimit \-n. A value of \fImax\fR will set
 323 this to the system limit from /proc/sys/fs/nr_open. If this is not set, the
 324 maximum number of open fds is taken from the calling process. It is usually
 325 1024. To be safe, this should be set to the maximum number of paths plus 32,
 326 if that number is greated than 1024.
 327 .TP
 328 .B checker_timeout
 329 Specify the timeout to user for path checkers that issue scsi commands with an
 330 explicit timeout, in seconds; default taken from
 331 .I /sys/block/sd<x>/device/timeout
 332 .TP
 333 .B fast_io_fail_tmo
 334 Specify the number of seconds the scsi layer will wait after a problem has been
 335 detected on a FC remote port before failing IO to devices on that remote port.
 336 This should be smaller than dev_loss_tmo. Setting this to
 337 .I off
 338 will disable the timeout.
 339 .TP
 340 .B dev_loss_tmo
 341 Specify the number of seconds the scsi layer will wait after a problem has
 342 been detected on a FC remote port before removing it from the system. This
 343 can be set to "infinity" which sets it to the max value of 2147483647
 344 seconds, or 68 years. It will be automatically adjusted to the overall
 345 retry interval
 346 \fIno_path_retry\fR * \fIpolling_interval\fR
 347 if a number of retries is given with \fIno_path_retry\fR and the
 348 overall retry interval is longer than the specified \fIdev_loss_tmo\fR value.
 349 The linux kernel will cap this value to \fI300\fR if \fBfast_io_fail_tmo\fR
 350 is not set.
 351 .TP
 352 .B queue_without_daemon
 353 If set to
 354 .I no
 355 , when multipathd stops, queueing will be turned off for all devices.
 356 This is useful for devices that set no_path_retry.  If a machine is
 357 shut down while all paths to a device are down, it is possible to hang waiting
 358 for IO to return from the device after multipathd has been stopped. Without
 359 multipathd running, access to the paths cannot be restored, and the kernel
 360 cannot be told to stop queueing IO. Setting queue_without_daemon to
 361 .I no
 362 , avoids this problem. Default is
 363 .I yes
 364 .TP
 365 .B bindings_file
 366 The full pathname of the binding file to be used when the user_friendly_names option is set. Defaults to
 367 .I /etc/multipath/bindings
 368 .TP
 369 .B wwids_file
 370 The full pathname of the wwids file, which is used by multipath to keep track
 371 of the wwids for LUNs it has created multipath devices on in the past.
 372 Defaults to
 373 .I /etc/multipath/wwids
 374 .TP
 375 .B log_checker_err
 376 If set to
 377 .I once
 378 , multipathd logs the first path checker error at logging level 2. Any later
 379 errors are logged at level 3 until the device is restored. If set to
 380 .I always
 381 , multipathd always logs the path checker error at logging level 2. Default is
 382 .I always
 383 .TP
 384 .B reservation_key
 385 This is the service action reservation key used by mpathpersist.  It must be
 386 set for all multipath devices using persistent reservations, and it must be
 387 the same as the RESERVATION KEY field of the PERSISTENT RESERVE OUT parameter
 388 list which contains an 8-byte value provided by the application client to the
 389 device server to identify the I_T nexus. It is unset by default.
 390 .TP
 391 .B retain_attached_hw_handler
 392 If set to
 393 .I yes
 394 and the scsi layer has already attached a hardware_handler to the device,
 395 multipath will not force the device to use the hardware_handler specified by
 396 mutipath.conf. If the scsi layer has not attached a hardware handler,
 397 multipath will continue to use its configured hardware handler. Default is
 398 .I no
 399 .TP
 400 .B detect_prio
 401 If set to
 402 .I yes
 403 , multipath will try to detect if the device supports ALUA. If so, the device
 404 will automatically use the
 405 .I alua
 406 prioritizer. If not, the prioritizer will be selected as usual. Default is
 407 .I no
 408 .
 409 .SH "blacklist section"
 410 The
 411 .I blacklist
 412 section is used to exclude specific device from inclusion in the
 413 multipath topology. It is most commonly used to exclude local disks or
 414 LUNs for the array controller.
 415 .LP
 416 The following keywords are recognized:
 417 .TP 17
 418 .B wwid
 419 The \fIWorld Wide Identification\fR of a device.
 420 .TP
 421 .B devnode
 422 Regular expression of the device nodes to be excluded.
 423 .TP
 424 .B device
 425 Subsection for the device description. This subsection recognizes the
 426 .I vendor
 427 and
 428 .I product
 429 keywords. For a full description of these keywords please see the
 430 .I devices
 431 section description.
 432 .SH "blacklist_exceptions section"
 433 The
 434 .I blacklist_exceptions
 435 section is used to revert the actions of the
 436 .I blacklist
 437 section, ie to include specific device in the
 438 multipath topology. This allows one to selectively include devices which
 439 would normally be excluded via the
 440 .I blacklist
 441 section.
 442 .LP
 443 The following keywords are recognized:
 444 .TP 17
 445 .B wwid
 446 The \fIWorld Wide Identification\fR of a device.
 447 .TP
 448 .B devnode
 449 Regular expression of the device nodes to be excluded.
 450 .TP
 451 .B device
 452 Subsection for the device description. This subsection recognizes the
 453 .I vendor
 454 and
 455 .I product
 456 keywords. For a full description of these keywords please see the
 457 .I devices
 458 section description.
 459 .SH "multipaths section"
 460 The only recognized attribute for the
 461 .B multipaths
 462 section is the
 463 .I multipath
 464 subsection.
 465 .LP
 466 The
 467 .B multipath
 468 subsection recognizes the following attributes:
 469 .TP 17
 470 .B wwid
 471 Index of the container. Mandatory for this subsection.
 472 .TP
 473 .B alias
 474 (Optional) symbolic name for the multipath map.
 475 .LP
 476 The following attributes are optional; if not set the default values
 477 are taken from the
 478 .I defaults
 479 or
 480 .I devices
 481 section:
 482 .sp 1
 483 .PD .1v
 484 .RS
 485 .TP 18
 486 .B path_grouping_policy
 487 .TP
 488 .B path_selector
 489 .TP
 490 .B prio
 491 .TP
 492 .B prio_args
 493 .TP
 494 .B failback
 495 .TP
 496 .B rr_weight
 497 .TP
 498 .B flush_on_last_del
 499 .TP
 500 .B no_path_retry
 501 .TP
 502 .B rr_min_io
 503 .TP
 504 .B rr_min_io_rq
 505 .TP
 506 .B features
 507 .TP
 508 .B reservation_key
 509 .RE
 510 .PD
 511 .LP
 512 .SH "devices section"
 513 The only recognized attribute for the
 514 .B devices
 515 section is the
 516 .I device
 517 subsection.
 518 .LP
 519 The
 520 .I device
 521 subsection recognizes the following attributes:
 522 .TP 17
 523 .B vendor
 524 (Mandatory) Vendor identifier
 525 .TP
 526 .B product
 527 (Mandatory) Product identifier
 528 .TP
 529 .B revision
 530 (Optional) Revision identfier
 531 .TP
 532 .B product_blacklist
 533 (Optional) Product strings to blacklist for this vendor
 534 .TP
 535 .B alias_prefix
 536 (Optional) The user_friendly_names prefix to use for this
 537 device type, instead of the default "mpath"
 538 .TP
 539 .B hardware_handler
 540 (Optional) The hardware handler to use for this device type.
 541 The following hardware handler are implemented:
 542 .RS
 543 .TP 12
 544 .B 1 emc
 545 Hardware handler for EMC storage arrays.
 546 .TP
 547 .B 1 rdac
 548 Hardware handler for LSI/Engenio/NetApp E-Series RDAC storage controller.
 549 .TP
 550 .B 1 hp_sw
 551 Hardware handler for Compaq/HP storage arrays in active/standby
 552 mode.
 553 .TP
 554 .B 1 alua
 555 Hardware handler for SCSI-3 ALUA compatible arrays.
 556 .RE
 557 .LP
 558 The following attributes are optional; if not set the default values
 559 are taken from the
 560 .I defaults
 561 section:
 562 .sp 1
 563 .PD .1v
 564 .RS
 565 .TP 18
 566 .B path_grouping_policy
 567 .TP
 568 .B uid_attribute
 569 .TP
 570 .B path_selector
 571 .TP
 572 .B path_checker
 573 .TP
 574 .B prio
 575 .TP
 576 .B prio_args
 577 .TP
 578 .B features
 579 .TP
 580 .B failback
 581 .TP
 582 .B rr_weight
 583 .TP
 584 .B no_path_retry
 585 .TP
 586 .B rr_min_io
 587 .TP
 588 .B rr_min_io_rq
 589 .TP
 590 .B fast_io_fail_tmo
 591 .TP
 592 .B dev_loss_tmo
 593 .TP
 594 .B flush_on_last_del
 595 .TP
 596 .B retain_attached_hw_handler
 597 .TP
 598 .B detect_prio
 599 .RE
 600 .PD
 601 .LP
 602 .SH "KNOWN ISSUES"
 603 The usage of
 604 .B queue_if_no_path
 605 option can lead to
 606 .B D state
 607 processes being hung and not killable in situations where all the paths to the LUN go offline.
 608 It is advisable to use the
 609 .B no_path_retry
 610 option instead.
 611 .P
 612 The use of
 613 .B queue_if_no_path
 614 or
 615 .B no_path_retry
 616 might lead to a deadlock if the
 617 .B dev_loss_tmo
 618 setting results in a device being removed while I/O is still queued.
 619 The multipath daemon will update the
 620 .B dev_loss_tmo
 621 setting accordingly to avoid this deadlock. Hence if both values are
 622 specified the order of precedence is
 623 .I no_path_retry, queue_if_no_path, dev_loss_tmo
 624
 625 .SH "SEE ALSO"
 626 .BR udev (8),
 627 .BR dmsetup (8)
 628 .BR multipath (8)
 629 .BR multipathd (8)
 630 .SH AUTHORS
 631 .B multipath
 632 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.