multipath: update man pages
[multipath-tools/.git] / multipathd / multipathd.8
1 .\" ----------------------------------------------------------------------------
2 .\" Update the date below if you make any significant change.
3 .\" Make sure there are no errors with:
4 .\" groff -z -wall -b -e -t multipathd/multipathd.8
5 .\"
6 .\" ----------------------------------------------------------------------------
7 .
8 .TH MULTIPATHD 8 2016-10-27 Linux
9 .
10 .
11 .\" ----------------------------------------------------------------------------
12 .SH NAME
13 .\" ----------------------------------------------------------------------------
14 .
15 multipathd \- Multipath daemon.
16 .
17 .
18 .\" ----------------------------------------------------------------------------
19 .SH SYNOPSIS
20 .\" ----------------------------------------------------------------------------
21 .
22 .B multipathd
23 .RB [\| \-d | \-k \|]
24 .RB [\| \-s \|]
25 .RB [\| \-v\ \c
26 .IR verbosity \|]
27 .RB [\| \-B \|]
28 .RB [\| \-w \|]
29 .
30 .
31 .\" ----------------------------------------------------------------------------
32 .SH DESCRIPTION
33 .\" ----------------------------------------------------------------------------
34 .
35 The \fBmultipathd\fR daemon is in charge of checking for failed paths. When this
36 happens, it will reconfigure the multipath map the path belongs to, so that this
37 map regains its maximum performance and redundancy.
38
39 This daemon executes the external \fBmultipath\fR tool when events occur.
40 In turn, the multipath tool signals the multipathd daemon when it is done with
41 devmap reconfiguration, so that it can refresh its failed path list.
42 .
43 .
44 .\" ----------------------------------------------------------------------------
45 .SH OPTIONS
46 .\" ----------------------------------------------------------------------------
47 .
48 .TP
49 .B \-d
50 Foreground Mode. Don't daemonize, and print all messages to stdout and stderr.
51 .
52 .TP
53 .B \-s
54 Suppress timestamps. Do not prefix logging messages with a timestamp.
55 .
56 .TP
57 .BI \-v " level"
58 Verbosity level. Print additional information while running multipathd. A  level
59 of 0 means only print errors. A level of 3 or greater prints debugging information
60 as well.
61 .
62 .TP
63 .B \-B
64 Read-only bindings file. multipathd will not write to the \fIuser_friendly_names\fR
65 bindings file. If a \fIuser_friendly_name\fR doesn't already exist for a device, it
66 will use its WWID as its alias.
67 .
68 .TP
69 .B \-k
70 multipathd will enter interactive mode. From this mode, the available commands can
71 be viewed by entering '\fIhelp\fR'. When you are finished entering commands, press
72 \fBCTRL-D\fR to quit.
73 .
74 .TP
75 .B \-n
76 \fBIGNORED\fR. Use the option
77 \fIfind_multipaths\fR to control the treatment of newly detected devices by
78 multipathd. See
79 .BR multipath.conf(5).
80 .
81 .TP
82 .B \-w
83 Since kernel 4.14 a new device-mapper event polling interface is used for updating
84 multipath devices on dmevents. Use this flag to force it to use the old event
85 waiting method, based on creating a seperate thread for each device.
86 .
87 .
88 .
89 .\" ----------------------------------------------------------------------------
90 .SH COMMANDS
91 .\" ----------------------------------------------------------------------------
92 .
93 .TP
94 The following commands can be used in interactive mode:
95 .
96 .TP
97 .B list|show paths
98 Show the paths that multipathd is monitoring, and their state.
99 .
100 .TP
101 .B list|show paths format $format
102 Show the paths that multipathd is monitoring, using a format string with path
103 format wildcards.
104 .
105 .TP
106 .B list|show maps|multipaths
107 Show the multipath devices that the multipathd is monitoring.
108 .
109 .TP
110 .B list|show maps|multipaths format $format
111 Show the status of all multipath devices that the multipathd is monitoring,
112 using a format string with multipath format wildcards.
113 .
114 .TP
115 .B list|show maps|multipaths status
116 Show the status of all multipath devices that the multipathd is monitoring.
117 .
118 .TP
119 .B list|show maps|multipaths stats
120 Show some statistics of all multipath devices that the multipathd is monitoring.
121 .
122 .TP
123 .B list|show maps|multipaths topology
124 Show the current multipath topology. Same as '\fImultipath \-ll\fR'.
125 .
126 .TP
127 .B list|show topology
128 Show the current multipath topology. Same as '\fImultipath \-ll\fR'.
129 .
130 .TP
131 .B list|show map|multipath $map topology
132 Show topology of a single multipath device specified by $map, for example
133 36005076303ffc56200000000000010aa. This map could be obtained from '\fIlist maps\fR'.
134 .
135 .TP
136 .B list|show wildcards
137 Show the format wildcards used in interactive commands taking $format.
138 .
139 .TP
140 .B list|show config
141 Show the currently used configuration, derived from default values and values
142 specified within the configuration file \fI/etc/multipath.conf\fR.
143 .
144 .TP
145 .B list|show config local
146 Show the currently used configuration like \fIshow config\fR, but limiting
147 the devices section to those devices that are actually present in the system.
148 .
149 .TP
150 .B list|show blacklist
151 Show the currently used blacklist rules, derived from default values and values
152 specified within the configuration file \fI/etc/multipath.conf\fR.
153 .
154 .TP
155 .B list|show devices
156 Show all available block devices by name including the information if they are
157 blacklisted or not.
158 .
159 .TP
160 .B list|show status
161 Show the number of path checkers in each possible state, the number of monitored
162 paths, and whether multipathd is currently handling a uevent.
163 .
164 .TP
165 .B list|show daemon
166 Show the current state of the multipathd daemon.
167 .
168 .TP
169 .B add path $path
170 Add a path to the list of monitored paths. $path is as listed in /sys/block (e.g. sda).
171 .
172 .TP
173 .B remove|del path $path
174 Stop monitoring a path. $path is as listed in /sys/block (e.g. sda).
175 .
176 .TP
177 .B add map|multipath $map
178 Add a multipath device to the list of monitored devices. $map can either be a
179 device-mapper device as listed in /sys/block (e.g. dm-0) or it can be the alias
180 for the multipath device (e.g. mpath1) or the uid of the multipath device
181 (e.g. 36005076303ffc56200000000000010aa).
182 .
183 .TP
184 .B remove|del map|multipath $map
185 Stop monitoring a multipath device.
186 .
187 .TP
188 .B resize map|multipath $map
189 Resizes map $map to the given size.
190 .
191 .TP
192 .B switch|switchgroup map|multipath $map group $group
193 Force a multipath device to switch to a specific path group. $group is the path
194 group index, starting with 1.
195 .
196 .TP
197 .B reconfigure
198 Reconfigures the multipaths. This should be triggered automatically after anyi
199 hotplug event.
200 .
201 .TP
202 .B suspend map|multipath $map
203 Sets map $map into suspend state.
204 .
205 .TP
206 .B resume map|multipath $map
207 Resumes map $map from suspend state.
208 .
209 .TP
210 .B reset map|multipath $map
211 Reassign existing device-mapper table(s) use use the multipath device, instead
212 of its path devices.
213 .
214 .TP
215 .B reload map|multipath $map
216 Reload a multipath device.
217 .
218 .TP
219 .B fail path $path
220 Sets path $path into failed state.
221 .
222 .TP
223 .B reinstate path $path
224 Resumes path $path from failed state.
225 .
226 .TP
227 .B disablequeueing maps|multipaths
228 Disable queueing on all multipath devices.
229 .
230 .TP
231 .B restorequeueing maps|multipaths
232 Restore queueing on all multipath devices.
233 .
234 .TP
235 .B disablequeueing map|multipath $map
236 Disable queuing on multipathed map $map.
237 .
238 .TP
239 .B restorequeueing map|multipath $map
240 Restore queuing on multipahted map $map.
241 .
242 .TP
243 .B forcequeueing daemon
244 Forces multipathd into queue_without_daemon mode, so that no_path_retry queueing
245 will not be disabled when the daemon stops.
246 .
247 .TP
248 .B restorequeueing daemon
249 Restores configured queue_without_daemon mode.
250 .
251 .TP
252 .B map|multipath $map setprstatus
253 Enable persistent reservation management on $map.
254 .
255 .TP
256 .B map|multipath $map unsetprstatus
257 Disable persistent reservation management on $map.
258 .
259 .TP
260 .B map|multipath $map getprstatus
261 Get the current persistent reservation management status of $map.
262 .
263 .TP
264 .B map|multipath $map getprkey
265 Get the current persistent reservation key associated with $map.
266 .
267 .TP
268 .B map|multipath $map setprkey key $key
269 Set the persistent reservation key associated with $map to $key in the
270 \fIprkeys_file\fR. This key will only be used by multipathd if
271 \fIreservation_key\fR is set to \fBfile\fR in \fI/etc/multipath.conf\fR.
272 .
273 .TP
274 .B map|multipath $map unsetprkey
275 Remove the persistent reservation key associated with $map from the
276 \fIprkeys_file\fR. This will only unset the key used by multipathd if
277 \fIreservation_key\fR is set to \fBfile\fR in \fI/etc/multipath.conf\fR.
278 .
279 .TP
280 .B path $path setmarginal
281 move $path to a marginal pathgroup. The path will remain in the marginal
282 path group until \fIunsetmarginal\fR is called. This command will only
283 work if \fImarginal_pathgroups\fR is enabled and there is no Shaky paths
284 detection method configured (see the multipath.conf man page for details).
285 .
286 .TP
287 .B path $path unsetmarginal
288 return marginal path $path to its normal pathgroup. This command will only
289 work if \fImarginal_pathgroups\fR is enabled and there is no Shaky paths
290 detection method configured (see the multipath.conf man page for details).
291 .
292 .TP
293 .B map $map unsetmarginal
294 return all marginal paths in $map to their normal pathgroups. This command
295 will only work if \fImarginal_pathgroups\fR is enabled and there is no Shaky
296 paths detection method configured (see the multipath.conf man page for details).
297 .
298 .TP
299 .B quit|exit
300 End interactive session.
301 .
302 .TP
303 .B shutdown
304 Stop multipathd.
305 .
306 .
307 .\" ----------------------------------------------------------------------------
308 .SH "SYSTEMD INTEGRATION"
309 .\" ----------------------------------------------------------------------------
310 .
311 When compiled with systemd support two systemd service files are installed,
312 \fImultipathd.service\fR and \fImultipathd.socket\fR The \fImultipathd.socket\fR
313 service instructs systemd to intercept the CLI command socket, so that any call
314 to the CLI interface will start-up the daemon if required.
315 The \fImultipathd.service\fR file carries the definitions for controlling the
316 multipath daemon. The daemon itself uses the \fBsd_notify\fR(3) interface to
317 communicate with systemd. The following unit keywords are recognized:
318 .
319 .TP
320 .B WatchdogSec=
321 Enables the internal watchdog from systemd. multipath will send a
322 notification via \fBsd_notify\fR(3) to systemd to reset the watchdog. If
323 specified the \fIpolling_interval\fR and \fImax_polling_interval\fR settings
324 will be overridden by the watchdog settings.
325 Please note that systemd prior to version 207 has issues which prevent
326 the systemd-provided watchdog from working correctly. So the watchdog
327 is not enabled per default, but has to be enabled manually by updating
328 the \fImultipathd.service\fR file.
329 .
330 .TP
331 .B OOMScoreAdjust=
332 Overrides the internal OOM adjust mechanism.
333 .
334 .TP
335 .B LimitNOFILE=
336 Overrides the \fImax_fds\fR configuration setting.
337 .
338 .
339 .\" ----------------------------------------------------------------------------
340 .SH "SEE ALSO"
341 .\" ----------------------------------------------------------------------------
342 .
343 .BR multipath (8),
344 .BR kpartx (8),
345 .BR sd_notify (3),
346 .BR system.service (5).
347 .
348 .
349 .\" ----------------------------------------------------------------------------
350 .SH AUTHORS
351 .\" ----------------------------------------------------------------------------
352 .
353 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
354 and others.
355 .\" EOF