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 fence_mpath accepts options on the command line as well as from stdin.
24 Fenced sends parameters through stdin when it execs the agent.
25 fence_mpath can be run by itself with command line options. This is
26 useful for testing and for turning outlets on or off from scripts.
27 Vendor URL: https://www.sourceware.org/dm/
29
31 -o, --action=[action]
34 Fencing action (Default Value: off)
35 -d, --devices=[devices]
37 List of devices to use for current operation. Devices can be
38 comma-separated list of device-mapper multipath devices (eg.
39 /dev/mapper/3600508b400105df70000e00000ac0000 or /dev/map‐
40 per/mpath1). Each device must support SCSI-3 persistent reserva‐
41 tions.
42 -k, --key=[key]
44 Replaced by port/-n/--plug
45 -n, --plug=[key]
47 Key to use for the current operation. This key should be unique
48 to a node and have to be written in /etc/multipath.conf. For the
49 "on" action, the key specifies the key use to register the local
50 node. For the "off" action, this key specifies the key to be
51 removed from the device(s).
52 -q, --quiet
54 Disable logging to stderr. Does not affect --verbose or --debug-
55 file or logging to syslog.
56 -v, --verbose
58 Verbose mode
59 -D, --debug-file=[debugfile]
61 Write debug information to given file
62 -V, --version
64 Display version information and exit
65 -h, --help
67 Display help and exit
68 --delay=[seconds]
70 Wait X seconds before fencing is started (Default Value: 0)
71 --login-timeout=[seconds]
74 Wait X seconds for cmd prompt after login (Default Value: 5)
75 --mpathpersist-path=[path]
78 Path to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
79 sist)
80 --power-timeout=[seconds]
82 Test X seconds for status change after ON/OFF (Default Value:
83 20)
84 --power-wait=[seconds]
86 Wait X seconds after issuing ON/OFF (Default Value: 0)
87 --shell-timeout=[seconds]
89 Wait X seconds for cmd prompt after issuing command (Default
90 Value: 3)
91 --store-path=[path]
93 Path to directory where fence agent can store information
94 (Default Value: /var/run/cluster)
95 --retry-on=[attempts]
97 Count of attempts to retry power on (Default Value: 1)
98 --use-sudo
101 Use sudo (without password) when calling 3rd party software
102 --sudo-path=[path]
105 Path to sudo binary (Default Value: /usr/bin/sudo)
106
109 on Power on machine.
112 off Power off machine.
114 status This returns the status of the plug/virtual machine.
116 monitor
118 Check the health of fence device
119 metadata
121 Display the XML metadata describing this resource.
122 manpage
124 The operational behavior of this is not known.
125 validate-all
127 Validate if all required parameters are entered.
128
131 action Fencing action (Default Value: off)
134 devices
136 List of devices to use for current operation. Devices can be
137 comma-separated list of device-mapper multipath devices (eg.
138 /dev/mapper/3600508b400105df70000e00000ac0000 or /dev/map‐
139 per/mpath1). Each device must support SCSI-3 persistent reserva‐
140 tions.
141 key Replaced by port/-n/--plug
143 plug Key to use for the current operation. This key should be unique
145 to a node and have to be written in /etc/multipath.conf. For the
146 "on" action, the key specifies the key use to register the local
147 node. For the "off" action, this key specifies the key to be
148 removed from the device(s). Obsoletes: port
149 quiet Disable logging to stderr. Does not affect --verbose or --debug-
151 file or logging to syslog.
152 verbose
154 Verbose mode
155 debug_file
157 Write debug information to given file Obsoletes: debug
158 version
160 Display version information and exit
161 help Display help and exit
163 delay Wait X seconds before fencing is started (Default Value: 0)
165 login_timeout
168 Wait X seconds for cmd prompt after login (Default Value: 5)
169 mpathpersist_path
172 Path to mpathpersist binary (Default Value: /usr/sbin/mpathper‐
173 sist)
174 power_timeout
176 Test X seconds for status change after ON/OFF (Default Value:
177 20)
178 power_wait
180 Wait X seconds after issuing ON/OFF (Default Value: 0)
181 shell_timeout
183 Wait X seconds for cmd prompt after issuing command (Default
184 Value: 3)
185 store_path
187 Path to directory where fence agent can store information
188 (Default Value: /var/run/cluster)
189 retry_on
191 Count of attempts to retry power on (Default Value: 1)
192 use_sudo
195 Use sudo (without password) when calling 3rd party software
196 Obsoletes: sudo
197 sudo_path
199 Path to sudo binary (Default Value: /usr/bin/sudo)
200fence_mpath (Fence Agent) 2009-10-20 FENCE_AGENT(8)