1MPATHCONF(8)             Linux Administrator's Manual             MPATHCONF(8)
2
3
4

NAME

6       mpathconf - A tool for configuring device-mapper-multipath
7

SYNOPSIS

9       mpathconf [commands] [options]
10

DESCRIPTION

12       mpathconf  is  a  utility that creates or modifies /etc/multipath.conf.
13       It can  enable  or  disable  multipathing  and  configure  some  common
14       options.   mpathconf  can  also load the dm_multipath module, start and
15       stop the multipathd daemon, and configure  the  multipathd  service  to
16       start automatically or not. If mpathconf is called with no commands, it
17       will display the current configuration, but will not create  or  modify
18       /etc/multipath.conf
19
20       The  default  options for mpathconf are --with_module The --with_multi‐
21       pathd option is not set by default.  Enabling  multipathing  will  load
22       the  dm_multipath  module but it will not immediately start it. This is
23       so that users can manually edit their config file if necessary,  before
24       starting multipathd.
25
26       If  /etc/multipath.conf  already  exists, mpathconf will edit it. If it
27       does not exist, mpathconf will use  /usr/share/doc/device-mapper-multi‐
28       path-0.4.9/multipath.conf   as   the   starting  file.  This  file  has
29       user_friendly_names set. If this file does not  exist,  mpathconf  will
30       create  /etc/multipath.conf  from  scratch.  For most users, this means
31       that user_friendly_names will be set by default, unless  they  use  the
32       --user_friendly_names n command.
33

COMMANDS

35       --enable
36              Removes  any  line  that  blacklists  all  device nodes from the
37              /etc/multipath.conf blacklist section. Also, creates /etc/multi‐
38              path.conf if it doesn't exist.
39
40       --disable
41              Adds  a line that blacklists all device nodes to the /etc/multi‐
42              path.conf blacklist section. If no blacklist section exists,  it
43              will create one.
44
45       --allow <device>
46              Modifies  the  /etc/multipath/conf  blacklist  to  blacklist all
47              wwids  and  the  blacklist_exceptions  to  whitelist   <device>.
48              <device>  can be in the form of MAJOR:MINOR, a wwid, or the name
49              of a device-mapper device, either a  multipath  device,  or  any
50              device  on stacked on top of one or more multipath devices. This
51              command can be used multiple times to  allow  multiple  devices.
52              NOTE:  This  action will create a configuration file that mpath‐
53              conf will not be able to revert  back  to  its  previous  state.
54              Because of this, --outfile is required when using --allow.
55
56       --user_friendly_name  { y | n }
57              If  set  to y, this adds the line user_friendly_names yes to the
58              /etc/multipath.conf defaults section. If set to n, this  removes
59              the  line,  if  present. This command can be used along with any
60              other command.
61
62       --find_multipaths { y | n }
63              If set to y, this adds  the  line  find_multipaths  yes  to  the
64              /etc/multipath.conf  defaults section. If set to n, this removes
65              the line, if present. This command can be used aldong  with  any
66              other command.
67
68       --outfile <filename>
69              Write   the  resulting  multipath  configuration  to  <filename>
70              instead of /etc/multipath.conf.
71

OPTIONS

73       --with_module { y | n }
74              If set to y, this runs modprobe dm_multipath to install the mul‐
75              tipath  modules.  This  option only works with the --enable com‐
76              mand. This option is set to y by default.
77
78       --with_multipathd { y | n }
79              If set to y, this runs service multipathd  start  to  start  the
80              multipathd  daemon  on --enable, service multipathd stop to stop
81              the multipathd  daemon  on  --disable,  and  service  multipathd
82              reload  to  reconfigure  multipathd  on --user_frindly_names and
83              --find_multipaths.  This option is set to n by default.
84

FILES

86       /etc/multipath.conf
87

SEE ALSO

89       multipath.conf(5),  modprobe(8),  multipath(8),   multipathd(8),   ser‐
90       vice(8),
91

AUTHOR

93       Benjamin Marzinski <bmarzins@redhat.com>
94
95
96
97                                   June 2010                      MPATHCONF(8)
Impressum