1MULTIPATHD(8) System Manager's Manual MULTIPATHD(8)
2
6 multipathd - Multipath daemon.
7
9 multipathd [-d|-k] [-s] [-v verbosity] [-B]
10
12 The multipathd daemon is in charge of checking for failed paths. When
13 this happens, it will reconfigure the multipath map the path belongs
14 to, so that this map regains its maximum performance and redundancy.
15 This daemon executes the external multipath tool when events occur. In
17 turn, the multipath tool signals the multipathd daemon when it is done
18 with devmap reconfiguration, so that it can refresh its failed path
19 list.
20 In this Linux distribution, multipathd does not run unless a /etc/mul‐
22 tipath.conf file exists.
23
25 -d Foreground Mode. Don't daemonize, and print all messages to std‐
26 out and stderr.
27 -s Suppress timestamps. Do not prefix logging messages with a time‐
29 stamp.
30 -v level
32 Verbosity level. Print additional information while running mul‐
33 tipathd. A level of 0 means only print errors. A level of 3 or
34 greater prints debugging information as well.
35 -B Read-only bindings file. multipathd will not write to the
37 user_friendly_names bindings file. If a user_friendly_name
38 doesn't already exist for a device, it will use its WWID as its
39 alias.
40 -k multipathd will enter interactive mode. From this mode, the
42 available commands can be viewed by entering 'help'. When you
43 are finished entering commands, press CTRL-D to quit.
44 -n IGNORED. Use the option find_multipaths to control the treatment
46 of newly detected devices by multipathd. See multipath.conf(5).
47
49 The following commands can be used in interactive mode:
50 list|show paths
52 Show the paths that multipathd is monitoring, and their state.
53 list|show paths format $format
55 Show the paths that multipathd is monitoring, using a format
56 string with path format wildcards.
57 list|show maps|multipaths
59 Show the multipath devices that the multipathd is monitoring.
60 list|show maps|multipaths format $format
62 Show the status of all multipath devices that the multipathd is
63 monitoring, using a format string with multipath format wild‐
64 cards.
65 list|show maps|multipaths status
67 Show the status of all multipath devices that the multipathd is
68 monitoring.
69 list|show maps|multipaths stats
71 Show some statistics of all multipath devices that the multi‐
72 pathd is monitoring.
73 list|show maps|multipaths topology
75 Show the current multipath topology. Same as 'multipath -ll'.
76 list|show topology
78 Show the current multipath topology. Same as 'multipath -ll'.
79 list|show map|multipath $map topology
81 Show topology of a single multipath device specified by $map,
82 for example 36005076303ffc56200000000000010aa. This map could be
83 obtained from 'list maps'.
84 list|show wildcards
86 Show the format wildcards used in interactive commands taking
87 $format.
88 list|show config
90 Show the currently used configuration, derived from default val‐
91 ues and values specified within the configuration file /etc/mul‐
92 tipath.conf.
93 list|show config local
95 Show the currently used configuration like show config, but lim‐
96 iting the devices section to those devices that are actually
97 present in the system.
98 list|show blacklist
100 Show the currently used blacklist rules, derived from default
101 values and values specified within the configuration file
102 /etc/multipath.conf.
103 list|show devices
105 Show all available block devices by name including the informa‐
106 tion if they are blacklisted or not.
107 list|show status
109 Show the number of path checkers in each possible state, the
110 number of monitored paths, and whether multipathd is currently
111 handling a uevent.
112 list|show daemon
114 Show the current state of the multipathd daemon.
115 add path $path
117 Add a path to the list of monitored paths. $path is as listed in
118 /sys/block (e.g. sda).
119 remove|del path $path
121 Stop monitoring a path. $path is as listed in /sys/block (e.g.
122 sda).
123 add map|multipath $map
125 Add a multipath device to the list of monitored devices. $map
126 can either be a device-mapper device as listed in /sys/block
127 (e.g. dm-0) or it can be the alias for the multipath device
128 (e.g. mpath1) or the uid of the multipath device (e.g.
129 36005076303ffc56200000000000010aa).
130 remove|del map|multipath $map
132 Stop monitoring a multipath device.
133 resize map|multipath $map
135 Resizes map $map to the given size.
136 switch|switchgroup map|multipath $map group $group
138 Force a multipath device to switch to a specific path group.
139 $group is the path group index, starting with 1.
140 reconfigure
142 Reconfigures the multipaths. This should be triggered automati‐
143 cally after anyi hotplug event.
144 suspend map|multipath $map
146 Sets map $map into suspend state.
147 resume map|multipath $map
149 Resumes map $map from suspend state.
150 reset map|multipath $map
152 Reassign existing device-mapper table(s) use use the multipath
153 device, instead of its path devices.
154 reload map|multipath $map
156 Reload a multipath device.
157 fail path $path
159 Sets path $path into failed state.
160 reinstate path $path
162 Resumes path $path from failed state.
163 disablequeueing maps|multipaths
165 Disable queueing on all multipath devices.
166 restorequeueing maps|multipaths
168 Restore queueing on all multipath devices.
169 disablequeueing map|multipath $map
171 Disable queuing on multipathed map $map.
172 restorequeueing map|multipath $map
174 Restore queuing on multipahted map $map.
175 forcequeueing daemon
177 Forces multipathd into queue_without_daemon mode, so that
178 no_path_retry queueing will not be disabled when the daemon
179 stops.
180 restorequeueing daemon
182 Restores configured queue_without_daemon mode.
183 map|multipath $map setprstatus
185 Enable persistent reservation management on $map.
186 map|multipath $map unsetprstatus
188 Disable persistent reservation management on $map.
189 map|multipath $map getprstatus
191 Get the current persistent reservation management status of
192 $map.
193 map|multipath $map getprkey
195 Get the current persistent reservation key associated with $map.
196 map|multipath $map setprkey key $key
198 Set the persistent reservation key associated with $map to $key
199 in the prkeys_file. This key will only be used by multipathd if
200 reservation_key is set to file in /etc/multipath.conf.
201 map|multipath $map unsetprkey
203 Remove the persistent reservation key associated with $map from
204 the prkeys_file. This will only unset the key used by multipathd
205 if reservation_key is set to file in /etc/multipath.conf.
206 quit|exit
208 End interactive session.
209 shutdown
211 Stop multipathd.
212
214 When compiled with systemd support two systemd service files are
215 installed, multipathd.service and multipathd.socket The multi‐
216 pathd.socket service instructs systemd to intercept the CLI command
217 socket, so that any call to the CLI interface will start-up the daemon
218 if required. The multipathd.service file carries the definitions for
219 controlling the multipath daemon. The daemon itself uses the
220 sd_notify(3) interface to communicate with systemd. The following unit
221 keywords are recognized:
222 WatchdogSec=
224 Enables the internal watchdog from systemd. multipath will send
225 a notification via sd_notify(3) to systemd to reset the watch‐
226 dog. If specified the polling_interval and max_polling_interval
227 settings will be overridden by the watchdog settings. Please
228 note that systemd prior to version 207 has issues which prevent
229 the systemd-provided watchdog from working correctly. So the
230 watchdog is not enabled per default, but has to be enabled manu‐
231 ally by updating the multipathd.service file.
232 OOMScoreAdjust=
234 Overrides the internal OOM adjust mechanism.
235 LimitNOFILE=
237 Overrides the max_fds configuration setting.
238
240 multipath(8), kpartx(8), sd_notify(3), system.service(5).
241
243 multipath-tools was developed by Christophe Varoqui <christophe.varo‐
244 qui@opensvc.com> and others.
245Linux 2016-10-27 MULTIPATHD(8)