1FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)
3
7 fence_mpath - Fence agent for multipath persistent reservation
8
10 fence_mpath is an I/O fencing agent that uses SCSI-3 persistent reser‐
11 vations to control access multipath devices. Underlying devices must
12 support SCSI-3 persistent reservations (SPC-3 or greater) as well as
13 the "preempt-and-abort" subcommand. The fence_mpath agent works by
14 having a unique key for each node that has to be set in /etc/multi‐
15 path.conf. Once registered, a single node will become the reservation
16 holder by creating a "write exclusive, registrants only" reservation on
17 the device(s). The result is that only registered nodes may write to
18 the device(s). When a node failure occurs, the fence_mpath agent will
19 remove the key belonging to the failed node from the device(s). The
20 failed node will no longer be able to write to the device(s). A manual
21 reboot is required.
22 When used as a watchdog device you can define e.g. retry=1, retry-
24 sleep=2 and verbose=yes parameters in /etc/sysconfig/stonith if you
25 have issues with it failing.
26 fence_mpath accepts options on the command line as well as from stdin.
28 Fenced sends parameters through stdin when it execs the agent.
29 fence_mpath can be run by itself with command line options. This is
30 useful for testing and for turning outlets on or off from scripts.
31 Vendor URL: https://www.sourceware.org/dm/
33
35 -o, --action=[action]
38 Fencing action (Default Value: off)
39 -d, --devices=[devices]
41 List of devices to use for current operation. Devices can be
42 comma or space separated list of device-mapper multipath devices
43 (eg. /dev/mapper/3600508b400105df70000e00000ac0000 or /dev/map‐
44 per/mpath1). Each device must support SCSI-3 persistent reserva‐
45 tions.
46 -k, --key=[key]
48 Replaced by port/-n/--plug
49 -n, --plug=[key]
51 Key to use for the current operation. This key should be unique
52 to a node and have to be written in /etc/multipath.conf. For the
53 "on" action, the key specifies the key use to register the local
54 node. For the "off" action, this key specifies the key to be re‐
55 moved from the device(s).
56 --suppress-errors
58 Error log suppression.
59 -q, --quiet
61 Disable logging to stderr. Does not affect --verbose or --debug-
62 file or logging to syslog.
63 -v, --verbose
65 Verbose mode. Multiple -v flags can be stacked on the command
66 line (e.g., -vvv) to increase verbosity.
67 --verbose-level
69 Level of debugging detail in output. Defaults to the number of
70 --verbose flags specified on the command line, or to 1 if ver‐
71 bose=1 in a stonith device configuration (i.e., on stdin).
72 -D, --debug-file=[debugfile]
75 Write debug information to given file
76 -V, --version
78 Display version information and exit
79 -h, --help
81 Display help and exit
82 --plug-separator=[char]
84 Separator for plug parameter when specifying more than 1 plug
85 (Default Value: ,)
86 --delay=[seconds]
88 Wait X seconds before fencing is started (Default Value: 0)
89 --disable-timeout=[true/false]
92 Disable timeout (true/false) (default: true when run from Pace‐
93 maker 2.0+)
94 --login-timeout=[seconds]
96 Wait X seconds for cmd prompt after login (Default Value: 5)
97 --mpathpersist-path=[path]
100 Path to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
101 sist)
102 --power-timeout=[seconds]
104 Test X seconds for status change after ON/OFF (Default Value:
105 20)
106 --power-wait=[seconds]
108 Wait X seconds after issuing ON/OFF (Default Value: 0)
109 --shell-timeout=[seconds]
111 Wait X seconds for cmd prompt after issuing command (Default
112 Value: 3)
113 --stonith-status-sleep=[seconds]
115 Sleep X seconds between status calls during a STONITH action
116 (Default Value: 1)
117 --store-path=[path]
119 Path to directory where fence agent can store information (De‐
120 fault Value: /var/run/cluster)
121 --retry-on=[attempts]
123 Count of attempts to retry power on (Default Value: 1)
124 --use-sudo
127 Use sudo (without password) when calling 3rd party software
128 --sudo-path=[path]
131 Path to sudo binary (Default Value: /usr/bin/sudo)
132
135 on Power on machine.
138 off Power off machine.
140 status This returns the status of the plug/virtual machine.
142 monitor
144 Check the health of fence device
145 metadata
147 Display the XML metadata describing this resource.
148 manpage
150 The operational behavior of this is not known.
151 validate-all
153 Validate if all required parameters are entered.
154
157 action Fencing action (Default Value: off)
160 devices
162 List of devices to use for current operation. Devices can be
163 comma or space separated list of device-mapper multipath devices
164 (eg. /dev/mapper/3600508b400105df70000e00000ac0000 or /dev/map‐
165 per/mpath1). Each device must support SCSI-3 persistent reserva‐
166 tions.
167 key Replaced by port/-n/--plug
169 plug Key to use for the current operation. This key should be unique
171 to a node and have to be written in /etc/multipath.conf. For the
172 "on" action, the key specifies the key use to register the local
173 node. For the "off" action, this key specifies the key to be re‐
174 moved from the device(s). Obsoletes: port
175 suppress_errors
177 Error log suppression. Obsoletes: suppress-errors
178 quiet Disable logging to stderr. Does not affect --verbose or --debug-
180 file or logging to syslog.
181 verbose
183 Verbose mode. Multiple -v flags can be stacked on the command
184 line (e.g., -vvv) to increase verbosity.
185 verbose_level
187 Level of debugging detail in output. Defaults to the number of
188 --verbose flags specified on the command line, or to 1 if ver‐
189 bose=1 in a stonith device configuration (i.e., on stdin).
190 debug_file
193 Write debug information to given file Obsoletes: debug
194 version
196 Display version information and exit
197 help Display help and exit
199 plug_separator
201 Separator for plug parameter when specifying more than 1 plug
202 (Default Value: ,)
203 delay Wait X seconds before fencing is started (Default Value: 0)
205 disable_timeout
208 Disable timeout (true/false) (default: true when run from Pace‐
209 maker 2.0+)
210 login_timeout
212 Wait X seconds for cmd prompt after login (Default Value: 5)
213 mpathpersist_path
216 Path to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
217 sist)
218 power_timeout
220 Test X seconds for status change after ON/OFF (Default Value:
221 20)
222 power_wait
224 Wait X seconds after issuing ON/OFF (Default Value: 0)
225 shell_timeout
227 Wait X seconds for cmd prompt after issuing command (Default
228 Value: 3)
229 stonith_status_sleep
231 Sleep X seconds between status calls during a STONITH action
232 (Default Value: 1)
233 store_path
235 Path to directory where fence agent can store information (De‐
236 fault Value: /var/run/cluster)
237 retry_on
239 Count of attempts to retry power on (Default Value: 1)
240 use_sudo
243 Use sudo (without password) when calling 3rd party software Ob‐
244 soletes: sudo
245 sudo_path
247 Path to sudo binary (Default Value: /usr/bin/sudo)
248fence_mpath (Fence Agent) 2009-10-20 FENCE_AGENT(8)