multipathd: issue systemd READY after initial configuration
[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 [\| \-n \|]
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 Ignore new devices. multipathd will not create a multipath device unless the
77 WWID for the device is already listed in the WWIDs file.
78 .
79 .
80 .\" ----------------------------------------------------------------------------
81 .SH COMMANDS
82 .\" ----------------------------------------------------------------------------
83 .
84 .TP
85 The following commands can be used in interactive mode:
86 .
87 .TP
88 .B list|show paths
89 Show the paths that multipathd is monitoring, and their state.
90 .
91 .TP
92 .B list|show paths format $format
93 Show the paths that multipathd is monitoring, using a format string with path
94 format wildcards.
95 .
96 .TP
97 .B list|show maps|multipaths
98 Show the multipath devices that the multipathd is monitoring.
99 .
100 .TP
101 .B list|show maps|multipaths format $format
102 Show the status of all multipath devices that the multipathd is monitoring,
103 using a format string with multipath format wildcards.
104 .
105 .TP
106 .B list|show maps|multipaths status
107 Show the status of all multipath devices that the multipathd is monitoring.
108 .
109 .TP
110 .B list|show maps|multipaths stats
111 Show some statistics of all multipath devices that the multipathd is monitoring.
112 .
113 .TP
114 .B list|show maps|multipaths topology
115 Show the current multipath topology. Same as '\fImultipath \-ll\fR'.
116 .
117 .TP
118 .B list|show topology
119 Show the current multipath topology. Same as '\fImultipath \-ll\fR'.
120 .
121 .TP
122 .B list|show map|multipath $map topology
123 Show topology of a single multipath device specified by $map, for example
124 36005076303ffc56200000000000010aa. This map could be obtained from
125 '\fIlist maps\fR'.
126 .
127 .TP
128 .B list|show wildcards
129 Show the format wildcards used in interactive commands taking $format.
130 .
131 .TP
132 .B list|show config
133 Show the currently used configuration, derived from default values and values
134 specified within the configuration file \fI/etc/multipath.conf\fR.
135 .
136 .TP
137 .B list|show blacklist
138 Show the currently used blacklist rules, derived from default values and values
139 specified within the configuration file \fI/etc/multipath.conf\fR.
140 .
141 .TP
142 .B list|show devices
143 Show all available block devices by name including the information if they are
144 blacklisted or not.
145 .
146 .TP
147 .B list|show status
148 Show the number of path checkers in each possible state, the number of monitored
149 paths, and whether multipathd is currently handling a uevent.
150 .
151 .TP
152 .B list|show daemon
153 Show the current state of the multipathd daemon.
154 .
155 .TP
156 .B add path $path
157 Add a path to the list of monitored paths. $path is as listed in /sys/block (e.g. sda).
158 .
159 .TP
160 .B remove|del path $path
161 Stop monitoring a path. $path is as listed in /sys/block (e.g. sda).
162 .
163 .TP
164 .B add map|multipath $map
165 Add a multipath device to the list of monitored devices. $map can either be a
166 device-mapper device as listed in /sys/block (e.g. dm-0) or it can be the alias
167 for the multipath device (e.g. mpath1) or the uid of the multipath device
168 (e.g. 36005076303ffc56200000000000010aa).
169 .
170 .TP
171 .B remove|del map|multipath $map
172 Stop monitoring a multipath device.
173 .
174 .TP
175 .B resize map|multipath $map
176 Resizes map $map to the given size.
177 .
178 .TP
179 .B switch|switchgroup map|multipath $map group $group
180 Force a multipath device to switch to a specific path group. $group is the path
181 group index, starting with 1.
182 .
183 .TP
184 .B reconfigure
185 Reconfigures the multipaths. This should be triggered automatically after anyi
186 hotplug event.
187 .
188 .TP
189 .B suspend map|multipath $map
190 Sets map $map into suspend state.
191 .
192 .TP
193 .B resume map|multipath $map
194 Resumes map $map from suspend state.
195 .
196 .TP
197 .B reset map|multipath $map
198 Reassign existing device-mapper table(s) use use the multipath device, instead
199 of its path devices.
200 .
201 .TP
202 .B reload map|multipath $map
203 Reload a multipath device.
204 .
205 .TP
206 .B fail path $path
207 Sets path $path into failed state.
208 .
209 .TP
210 .B reinstate path $path
211 Resumes path $path from failed state.
212 .
213 .TP
214 .B disablequeueing maps|multipaths
215 Disable queueing on all multipath devices.
216 .
217 .TP
218 .B restorequeueing maps|multipaths
219 Restore queueing on all multipath devices.
220 .
221 .TP
222 .B disablequeueing map|multipath $map
223 Disable queuing on multipathed map $map.
224 .
225 .TP
226 .B restorequeueing map|multipath $map
227 Restore queuing on multipahted map $map.
228 .
229 .TP
230 .B forcequeueing daemon
231 Forces multipathd into queue_without_daemon mode, so that no_path_retry queueing
232 will not be disabled when the daemon stops.
233 .
234 .TP
235 .B restorequeueing daemon
236 Restores configured queue_without_daemon mode.
237 .
238 .TP
239 .B map|multipath $map setprstatus
240 Enable persistent reservation management on $map.
241 .
242 .TP
243 .B map|multipath $map unsetprstatus
244 Disable persistent reservation management on $map.
245 .
246 .TP
247 .B map|multipath $map getprstatus
248 Get the current persistent reservation management status of $map.
249 .
250 .TP
251 .B quit|exit
252 End interactive session.
253 .
254 .TP
255 .B shutdown
256 Stop multipathd.
257 .
258 .
259 .\" ----------------------------------------------------------------------------
260 .SH "SYSTEMD INTEGRATION"
261 .\" ----------------------------------------------------------------------------
262 .
263 When compiled with systemd support two systemd service files are installed,
264 \fImultipathd.service\fR and \fImultipathd.socket\fR The \fImultipathd.socket\fR
265 service instructs systemd to intercept the CLI command socket, so that any call
266 to the CLI interface will start-up the daemon if required.
267 The \fImultipathd.service\fR file carries the definitions for controlling the
268 multipath daemon. The daemon itself uses the \fBsd_notify\fR(3) interface to
269 communicate with systemd. The following unit keywords are recognized:
270 .
271 .TP
272 .B WatchdogSec=
273 Enables the internal watchdog from systemd. multipath will send a
274 notification via \fBsd_notify\fR(3) to systemd to reset the watchdog. If
275 specified the \fIpolling_interval\fR and \fImax_polling_interval\fR settings
276 will be overridden by the watchdog settings.
277 Please note that systemd prior to version 207 has issues which prevent
278 the systemd-provided watchdog from working correctly. So the watchdog
279 is not enabled per default, but has to be enabled manually by updating
280 the \fImultipathd.service\fR file.
281 .
282 .TP
283 .B OOMScoreAdjust=
284 Overrides the internal OOM adjust mechanism.
285 .
286 .TP
287 .B LimitNOFILE=
288 Overrides the \fImax_fds\fR configuration setting.
289 .
290 .
291 .\" ----------------------------------------------------------------------------
292 .SH "SEE ALSO"
293 .\" ----------------------------------------------------------------------------
294 .
295 .BR multipath (8),
296 .BR kpartx (8),
297 .BR sd_notify (3),
298 .BR system.service (5).
299 .
300 .
301 .\" ----------------------------------------------------------------------------
302 .SH AUTHORS
303 .\" ----------------------------------------------------------------------------
304 .
305 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
306 and others.
307 .\" EOF