1MULTIPATHD(8) System Manager's Manual MULTIPATHD(8)
2
6 multipathd - Multipath daemon.
7
9 multipathd [-d] [-s] [-v verbosity] [-B] [-w]
10 multipathd [-v verbosity] -kcommand
12 multipathd [-v verbosity] -k
14
17 The multipathd daemon is in charge of checking for failed paths. When
18 this happens, it will reconfigure the multipath map the path belongs
19 to, so that this map regains its maximum performance and redundancy.
20 With the -k option, multipathd acts as a client utility that sends com‐
22 mands to a running instance of the multipathd daemon (see COMMANDS be‐
23 low).
24 In this Linux distribution, multipathd does not run unless a /etc/mul‐
26 tipath.conf file exists.
27
29 -d Foreground Mode. Don't daemonize, and print all messages to std‐
30 out and stderr.
31 -s Suppress timestamps. Do not prefix logging messages with a time‐
33 stamp.
34 -v level
36 Verbosity level. Print additional information while running mul‐
37 tipathd. A level of 0 means only print errors. A level of 3 or
38 greater prints debugging information as well.
39 -B Read-only bindings file. multipathd will not write to the
41 user_friendly_names bindings file. If a user_friendly_name
42 doesn't already exist for a device, it will use its WWID as its
43 alias.
44 -kcommand
46 multipathd executes the given command (see COMMANDS below). If
47 the command contains whitespace or shell special characters, it
48 needs to be quoted like in multipathd -k'show topology'. No
49 whitespace is allowed between the -k and the command string.
50 -k multipathd executes the multipathc interactive shell for enter‐
52 ing commands (see COMMANDS below).
53 -n IGNORED. Use the option find_multipaths to control the treatment
55 of newly detected devices by multipathd. See multipath.conf(5).
56 -w Since kernel 4.14 a new device-mapper event polling interface is
58 used for updating multipath devices on dmevents. Use this flag
59 to force it to use the old event waiting method, based on creat‐
60 ing a separate thread for each device.
61
63 The following commands can be used in interactive mode:
64 list|show paths
66 Show the paths that multipathd is monitoring, and their state.
67 list|show paths format $format
69 Show the paths that multipathd is monitoring, using a format
70 string with path format wildcards.
71 list|show maps|multipaths
73 Show the multipath devices that the multipathd is monitoring.
74 list|show maps|multipaths format $format
76 Show the status of all multipath devices that the multipathd is
77 monitoring, using a format string with multipath format wild‐
78 cards.
79 list|show maps|multipaths status
81 Show the status of all multipath devices that the multipathd is
82 monitoring.
83 list|show maps|multipaths stats
85 Show some statistics of all multipath devices that the multi‐
86 pathd is monitoring.
87 list|show maps|multipaths topology
89 Show the current multipath topology. Same as 'multipath -ll'.
90 list|show topology
92 Show the current multipath topology. Same as 'multipath -ll'.
93 list|show map|multipath $map topology
95 Show topology of a single multipath device specified by $map,
96 for example 36005076303ffc56200000000000010aa. This map could be
97 obtained from 'list maps'.
98 list|show wildcards
100 Show the format wildcards used in interactive commands taking
101 $format.
102 list|show config
104 Show the currently used configuration, derived from default val‐
105 ues and values specified within the configuration file /etc/mul‐
106 tipath.conf.
107 list|show config local
109 Show the currently used configuration like show config, but lim‐
110 iting the devices section to those devices that are actually
111 present in the system.
112 list|show blacklist
114 Show the currently used blacklist rules, derived from default
115 values and values specified within the configuration file
116 /etc/multipath.conf.
117 list|show devices
119 Show all available block devices by name including the informa‐
120 tion if they are blacklisted or not.
121 list|show status
123 Show the number of path checkers in each possible state, the
124 number of monitored paths, and whether multipathd is currently
125 handling a uevent.
126 list|show daemon
128 Show the current state of the multipathd daemon.
129 add path $path
131 Add a path to the list of monitored paths. $path is as listed in
132 /sys/block (e.g. sda).
133 remove|del path $path
135 Stop monitoring a path. $path is as listed in /sys/block (e.g.
136 sda).
137 add map|multipath $map
139 Add a multipath device to the list of monitored devices. $map
140 can either be a device-mapper device as listed in /sys/block
141 (e.g. dm-0) or it can be the alias for the multipath device
142 (e.g. mpath1) or the uid of the multipath device (e.g.
143 36005076303ffc56200000000000010aa).
144 remove|del map|multipath $map
146 Stop monitoring a multipath device.
147 resize map|multipath $map
149 Resizes map $map to the given size.
150 switch|switchgroup map|multipath $map group $group
152 Force a multipath device to switch to a specific path group.
153 $group is the path group index, starting with 1.
154 reconfigure
156 Rereads the configuration, and reloads all changed multipath de‐
157 vices. This also happens at startup, when the service is reload,
158 or when a SIGHUP is received.
159 reconfigure all
161 Rereads the configuration, and reloads all multipath devices re‐
162 gardless of whether or not they have changed. This also happens
163 when multipath -r is run.
164 suspend map|multipath $map
166 Sets map $map into suspend state.
167 resume map|multipath $map
169 Resumes map $map from suspend state.
170 reset map|multipath $map
172 Reassign existing device-mapper table(s) use the multipath de‐
173 vice, instead of its path devices.
174 reload map|multipath $map
176 Reload a multipath device.
177 fail path $path
179 Sets path $path into failed state.
180 reinstate path $path
182 Resumes path $path from failed state.
183 disablequeueing maps|multipaths
185 Disable queueing on all multipath devices.
186 restorequeueing maps|multipaths
188 Restore queueing on all multipath devices.
189 disablequeueing map|multipath $map
191 Disable queuing on multipathed map $map.
192 restorequeueing map|multipath $map
194 Restore queuing on multipahted map $map.
195 forcequeueing daemon
197 Forces multipathd into queue_without_daemon mode, so that
198 no_path_retry queueing will not be disabled when the daemon
199 stops.
200 restorequeueing daemon
202 Restores configured queue_without_daemon mode.
203 map|multipath $map setprstatus
205 Enable persistent reservation management on $map.
206 map|multipath $map unsetprstatus
208 Disable persistent reservation management on $map.
209 map|multipath $map getprstatus
211 Get the current persistent reservation management status of
212 $map.
213 map|multipath $map getprkey
215 Get the current persistent reservation key associated with $map.
216 map|multipath $map setprkey key $key
218 Set the persistent reservation key associated with $map to $key
219 in the prkeys_file. This key will only be used by multipathd if
220 reservation_key is set to file in /etc/multipath.conf.
221 map|multipath $map unsetprkey
223 Remove the persistent reservation key associated with $map from
224 the prkeys_file. This will only unset the key used by multipathd
225 if reservation_key is set to file in /etc/multipath.conf.
226 path $path setmarginal
228 move $path to a marginal pathgroup. The path will remain in the
229 marginal path group until unsetmarginal is called. This command
230 will only work if marginal_pathgroups is enabled and there is no
231 Shaky paths detection method configured (see the multipath.conf
232 man page for details).
233 path $path unsetmarginal
235 return marginal path $path to its normal pathgroup. This command
236 will only work if marginal_pathgroups is enabled and there is no
237 Shaky paths detection method configured (see the multipath.conf
238 man page for details).
239 map $map unsetmarginal
241 return all marginal paths in $map to their normal pathgroups.
242 This command will only work if marginal_pathgroups is enabled
243 and there is no Shaky paths detection method configured (see the
244 multipath.conf man page for details).
245 quit|exit
247 End interactive session.
248 shutdown
250 Stop multipathd.
251
253 When compiled with systemd support two systemd service files are in‐
254 stalled, multipathd.service and multipathd.socket The multipathd.socket
255 service instructs systemd to intercept the CLI command socket, so that
256 any call to the CLI interface will start-up the daemon if required.
257 The multipathd.service file carries the definitions for controlling the
258 multipath daemon. The daemon itself uses the sd_notify(3) interface to
259 communicate with systemd. The following unit keywords are recognized:
260 WatchdogSec=
262 Enables the internal watchdog from systemd. multipath will send
263 a notification via sd_notify(3) to systemd to reset the watch‐
264 dog. If specified the polling_interval and max_polling_interval
265 settings will be overridden by the watchdog settings. Please
266 note that systemd prior to version 207 has issues which prevent
267 the systemd-provided watchdog from working correctly. So the
268 watchdog is not enabled per default, but has to be enabled manu‐
269 ally by updating the multipathd.service file.
270 OOMScoreAdjust=
272 Overrides the internal OOM adjust mechanism.
273 LimitNOFILE=
275 Overrides the max_fds configuration setting.
276
278 multipathc(8), multipath(8), kpartx(8)
279 sd_notify(3), systemd.service(5).
280
282 multipath-tools was developed by Christophe Varoqui <christophe.varo‐
283 qui@opensvc.com> and others.
284Linux 2022-09-03 MULTIPATHD(8)