1MPATHCONF(8) Linux Administrator's Manual MPATHCONF(8)
2
3
4
6 mpathconf - A tool for configuring device-mapper-multipath
7
9 mpathconf [commands] [options]
10
12 mpathconf is a utility that creates or modifies /etc/multipath.conf.
13 It can enable or disable multipathing and configure some common op‐
14 tions. mpathconf can also load the dm_multipath module, start and stop
15 the multipathd daemon, and configure the multipathd service to start
16 automatically or not. If mpathconf is called with no commands, it will
17 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 set and find_multipaths set to yes. To disable
29 these, use the --user_friendly_names n and --find_multipaths n options
30
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>. <de‐
45 vice> can be in the form of MAJOR:MINOR, a wwid, or the name of
46 a device-mapper device, either a multipath device, or any device
47 on stacked on top of one or more multipath devices. This command
48 can be used multiple times to allow multiple devices. NOTE:
49 This action will create a configuration file that mpathconf will
50 not be able to revert back to its previous state. Because of
51 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 --recheck_wwid { y | n }
60 If set to y, this adds the line recheck_wwid yes to the
61 /etc/multipath.conf defaults section, or sets an existing line
62 to yes. If set to n, this sets an existing recheck_wwid line to
63 no. This command can be used along with any other command.
64
65 --find_multipaths { yes | no | strict | greedy | smart }
66 If set to <value>, this adds the line find_multipaths <value> to
67 the /etc/multipath.conf defaults section. This command can be
68 used along with any other command. y and n can be used instead
69 of yes and no.
70
71 --property_blacklist { y | n }
72 If set to y, this adds the line property (SCSI_IDENT_|ID_WWN) to
73 the /etc/multipath.conf blacklist_exceptions section. If set to
74 n, this removes the line, if present. This command can be used
75 along with any other command.
76
77 --enable_foreign { y | n }
78 If set to y, this adds the line enable_foreign .* to the
79 /etc/multipath.conf defaults section. if set to n, this removes
80 the line, if present. This command can be used along with any
81 other command.
82
83 --option <option_name>:[<value>]
84 Sets the defaults section option <option_name> to <value>. If
85 the option was not previously set in the defaults section, it is
86 added. If it was set, its value is changed to <value>. If
87 <value> is left blank, then the option is removed from the de‐
88 faults section, if was set there. This command can be used along
89 with any other command.
90
91 --outfile <filename>
92 Write the resulting multipath configuration to <filename> in‐
93 stead of /etc/multipath.conf.
94
96 --with_module { y | n }
97 If set to y, this runs modprobe dm_multipath to install the mul‐
98 tipath modules. This option only works with the --enable com‐
99 mand. This option is set to y by default.
100
101 --with_multipathd { y | n }
102 If set to y, this runs service multipathd start to start the
103 multipathd daemon on --enable, service multipathd stop to stop
104 the multipathd daemon on --disable, and service multipathd
105 reload to reconfigure multipathd on --user_frindly_names and
106 --find_multipaths. This option is set to n by default.
107
109 /etc/multipath.conf
110
112 multipath.conf(5), modprobe(8), multipath(8), multipathd(8), ser‐
113 vice(8),
114
116 Benjamin Marzinski <bmarzins@redhat.com>
117
118
119
120 June 2010 MPATHCONF(8)