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