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  of  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   create   a   default   file   with
28       user_friendly_names  and find_multipaths set. To disable these, use the
29       --user_friendly_names n and --find_multipaths n options
30

COMMANDS

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

OPTIONS

82       --with_module { y | n }
83              If set to y, this runs modprobe dm_multipath to install the mul‐
84              tipath modules. This option only works with  the  --enable  com‐
85              mand. This option is set to y by default.
86
87       --with_multipathd { y | n }
88              If  set  to  y,  this runs service multipathd start to start the
89              multipathd daemon on --enable, service multipathd stop  to  stop
90              the  multipathd  daemon  on  --disable,  and  service multipathd
91              reload to reconfigure  multipathd  on  --user_frindly_names  and
92              --find_multipaths.  This option is set to n by default.
93

FILES

95       /etc/multipath.conf
96

SEE ALSO

98       multipath.conf(5),   modprobe(8),   multipath(8),  multipathd(8),  ser‐
99       vice(8),
100

AUTHOR

102       Benjamin Marzinski <bmarzins@redhat.com>
103
104
105
106                                   June 2010                      MPATHCONF(8)
Impressum