multipathd: Implement systemd watchdog integration
[multipath-tools/.git] / multipathd / multipathd.8
1 .TH MULTIPATHD 8 "November 2009" "Linux Administrator's Manual"
2 .SH NAME
3 multipathd \- multipath daemon
4
5 .SH SYNOPSIS
6 .B multipathd
7 .RB [\| options \|]
8
9 .SH DESCRIPTION
10 The 
11 .B multipathd 
12 daemon is in charge of checking for failed paths. When this happens,
13 it will reconfigure the multipath map the path belongs to, so that this map 
14 regains its maximum performance and redundancy.
15
16 This daemon executes the external multipath config tool when events occur. 
17 In turn, the multipath tool signals the multipathd daemon when it is done with 
18 devmap reconfiguration, so that it can refresh its failed path list.
19
20 .SH OPTIONS
21 .TP
22 .B \-d
23 Foreground Mode. Don't daemonize, and print all messages to stdout and stderr.
24 .TP
25 .B \-s
26 Suppress timestamps. Do not prefix logging messages with a timestamp.
27 .TP
28 .B -v "level"
29 Verbosity level. Print additional information while running multipathd. A  level of 0 means only print errors. A level of 3 or greater prints debugging information as well. 
30 .TP
31 .B -k 
32 multipathd will enter interactive mode. From this mode, the available commands can be viewed by entering "help". When you are finished entering commands, press CTRL-D to quit.
33
34 .SH COMMANDS
35 .TP
36 The following commands can be used in interactive mode:
37 .TP
38 .B list|show paths
39 Show the paths that multipathd is monitoring, and their state. 
40 .TP
41 .B list|show paths format $format
42 Show the paths that multipathd is monitoring, using a format string with path
43 format wildcards.
44 .TP
45 .B list|show maps|multipaths
46 Show the multipath devices that the multipathd is monitoring. 
47 .TP
48 .B list|show maps|multipaths format $format
49 Show the status of all multipath devices that the multipathd is monitoring,
50 using a format string with multipath format wildcards.
51 .TP
52 .B list|show maps|multipaths status
53 Show the status of all multipath devices that the multipathd is monitoring.
54 .TP
55 .B list|show maps|multipaths stats
56 Show some statistics of all multipath devices that the multipathd is monitoring.
57 .TP
58 .B list|show maps|multipaths topology
59 Show the current multipath topology. Same as "multipath \-ll".
60 .TP
61 .B list|show topology
62 Show the current multipath topology. Same as "multipath \-ll".
63 .TP
64 .B list|show map|multipath $map topology
65 Show topology of a single multipath device specified by $map, e.g. 36005076303ffc56200000000000010aa.
66 This map could be obtained from "list maps".
67 .TP
68 .B list|show wildcards
69 Show the format wildcards used in interactive commands taking $format
70 .TP
71 .B list|show config
72 Show the currently used configuration, derived from default values and values specified within the configuration file /etc/multipath.conf.
73 .TP
74 .B list|show blacklist
75 Show the currently used blacklist rules, derived from default values and values specified within the configuration file /etc/multipath.conf.
76 .TP
77 .B list|show devices
78 Show all available block devices by name including the information if they are blacklisted or not.
79 .TP
80 .B list|show status
81 Show the number of path checkers in each possible state, the number of monitored paths, and whether multipathd is currently handling a uevent.
82 .TP
83 .B add path $path
84 Add a path to the list of monitored paths. $path is as listed in /sys/block (e.g. sda).
85 .TP 
86 .B remove|del path $path
87 Stop monitoring a path. $path is as listed in /sys/block (e.g. sda).
88 .TP
89 .B add map $map
90 Add a multipath device to the list of monitored devices. $map can either be a device-mapper device as listed in /sys/block (e.g. dm-0) or it can be the alias for the multipath device (e.g. mpath1) or the uid of the multipath device (e.g. 36005076303ffc56200000000000010aa). 
91 .TP
92 .B remove|del map $map
93 Stop monitoring a multipath device.
94 .TP
95 .B resize map|multipath $map
96 Resizes map $map to the given size
97 .TP 
98 .B switch|switchgroup map $map group $group
99 Force a multipath device to switch to a specific path group. $group is the path group index, starting with 1.
100 .TP
101 .B reconfigure
102 Reconfigures the multipaths. This should be triggered automatically after any hotplug event.
103 .TP
104 .B suspend map|multipath $map
105 Sets map $map into suspend state.
106 .TP
107 .B resume map|multipath $map
108 Resumes map $map from suspend state.
109 .TP
110 .B fail path $path
111 Sets path $path into failed state.
112 .TP
113 .B reinstate path $path
114 Resumes path $path from failed state.
115 .TP
116 .B disablequeueing maps|multipaths
117 Disable queueing on all multipath devices.
118 .TP
119 .B restorequeueing maps|multipaths
120 Restore queueing on all multipath devices.
121 .TP
122 .B disablequeueing map|multipath $map
123 Disable queuing on multipathed map $map
124 .TP
125 .B restorequeueing map|multipath $map
126 Restore queuing on multipahted map $map
127 .TP
128 .B quit|exit
129 End interactive session.
130
131 .SH "SYSTEMD INTEGRATION"
132 When compiled with systemd support two systemd service files are
133 installed,
134 .I multipathd.service
135 and
136 .I multipathd.socket
137 The
138 .I multipathd.socket
139 service instructs systemd to intercept the CLI command socket, so
140 that any call to the CLI interface will start-up the daemon if
141 required.
142 The
143 .I multipathd.service
144 file carries the definitions for controlling the multipath daemon.
145 The daemon itself uses the
146 .B sd_notify(3)
147 interface to communicate with systemd. The following unit keywords are
148 recognized:
149 .TP
150 .I WatchdogSec=
151 Enables the internal watchdog from systemd. multipath will send a
152 notification via
153 .B sd_notify(3)
154 to systemd to reset the watchdog. If specified the
155 .I polling_interval
156 and
157 .I max_polling_interval
158 settings will be overridden by the watchdog settings.
159
160 Please note that systemd prior to version 207 has issues which prevent
161 the systemd-provided watchdog from working correctly. So the watchdog
162 is not enabled per default, but has to be enabled manually by updating
163 the multipathd.service file.
164 .TP
165 .I OOMScoreAdjust=
166 Overrides the internal OOM adjust mechanism
167 .TP
168 .I LimitNOFILE=
169 Overrides the
170 .I max_fds
171 configuration setting.
172
173 .SH "SEE ALSO"
174 .BR multipath (8)
175 .BR kpartx (8)
176 .BR sd_notify (3)
177 .BR system.service (5)
178 .SH "AUTHORS"
179 .B multipathd
180 was developed by Christophe Varoqui, <christophe.varoqui@opensvc.com> and others.