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-separated list of device-mapper multipath devices (eg.
43 /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 -q, --quiet
58 Disable logging to stderr. Does not affect --verbose or --debug-
59 file or logging to syslog.
60 -v, --verbose
62 Verbose mode. Multiple -v flags can be stacked on the command
63 line (e.g., -vvv) to increase verbosity.
64 --verbose-level
66 Level of debugging detail in output. Defaults to the number of
67 --verbose flags specified on the command line, or to 1 if ver‐
68 bose=1 in a stonith device configuration (i.e., on stdin).
69 -D, --debug-file=[debugfile]
72 Write debug information to given file
73 -V, --version
75 Display version information and exit
76 -h, --help
78 Display help and exit
79 --delay=[seconds]
81 Wait X seconds before fencing is started (Default Value: 0)
82 --disable-timeout=[true/false]
85 Disable timeout (true/false) (default: true when run from Pace‐
86 maker 2.0+)
87 --login-timeout=[seconds]
89 Wait X seconds for cmd prompt after login (Default Value: 5)
90 --mpathpersist-path=[path]
93 Path to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
94 sist)
95 --power-timeout=[seconds]
97 Test X seconds for status change after ON/OFF (Default Value:
98 20)
99 --power-wait=[seconds]
101 Wait X seconds after issuing ON/OFF (Default Value: 0)
102 --shell-timeout=[seconds]
104 Wait X seconds for cmd prompt after issuing command (Default
105 Value: 3)
106 --stonith-status-sleep=[seconds]
108 Sleep X seconds between status calls during a STONITH action
109 (Default Value: 1)
110 --store-path=[path]
112 Path to directory where fence agent can store information (De‐
113 fault Value: /var/run/cluster)
114 --retry-on=[attempts]
116 Count of attempts to retry power on (Default Value: 1)
117 --use-sudo
120 Use sudo (without password) when calling 3rd party software
121 --sudo-path=[path]
124 Path to sudo binary (Default Value: /usr/bin/sudo)
125
128 on Power on machine.
131 off Power off machine.
133 status This returns the status of the plug/virtual machine.
135 monitor
137 Check the health of fence device
138 metadata
140 Display the XML metadata describing this resource.
141 manpage
143 The operational behavior of this is not known.
144 validate-all
146 Validate if all required parameters are entered.
147
150 action Fencing action (Default Value: off)
153 devices
155 List of devices to use for current operation. Devices can be
156 comma-separated list of device-mapper multipath devices (eg.
157 /dev/mapper/3600508b400105df70000e00000ac0000 or /dev/map‐
158 per/mpath1). Each device must support SCSI-3 persistent reserva‐
159 tions.
160 key Replaced by port/-n/--plug
162 plug Key to use for the current operation. This key should be unique
164 to a node and have to be written in /etc/multipath.conf. For the
165 "on" action, the key specifies the key use to register the local
166 node. For the "off" action, this key specifies the key to be re‐
167 moved from the device(s). Obsoletes: port
168 quiet Disable logging to stderr. Does not affect --verbose or --debug-
170 file or logging to syslog.
171 verbose
173 Verbose mode. Multiple -v flags can be stacked on the command
174 line (e.g., -vvv) to increase verbosity.
175 verbose_level
177 Level of debugging detail in output. Defaults to the number of
178 --verbose flags specified on the command line, or to 1 if ver‐
179 bose=1 in a stonith device configuration (i.e., on stdin).
180 debug_file
183 Write debug information to given file Obsoletes: debug
184 version
186 Display version information and exit
187 help Display help and exit
189 delay Wait X seconds before fencing is started (Default Value: 0)
191 disable_timeout
194 Disable timeout (true/false) (default: true when run from Pace‐
195 maker 2.0+)
196 login_timeout
198 Wait X seconds for cmd prompt after login (Default Value: 5)
199 mpathpersist_path
202 Path to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
203 sist)
204 power_timeout
206 Test X seconds for status change after ON/OFF (Default Value:
207 20)
208 power_wait
210 Wait X seconds after issuing ON/OFF (Default Value: 0)
211 shell_timeout
213 Wait X seconds for cmd prompt after issuing command (Default
214 Value: 3)
215 stonith_status_sleep
217 Sleep X seconds between status calls during a STONITH action
218 (Default Value: 1)
219 store_path
221 Path to directory where fence agent can store information (De‐
222 fault Value: /var/run/cluster)
223 retry_on
225 Count of attempts to retry power on (Default Value: 1)
226 use_sudo
229 Use sudo (without password) when calling 3rd party software Ob‐
230 soletes: sudo
231 sudo_path
233 Path to sudo binary (Default Value: /usr/bin/sudo)
234fence_mpath (Fence Agent) 2009-10-20 FENCE_AGENT(8)