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 an unique key for each pair of node and device that has to be
15 set also in /etc/multipath.conf. Once registered, a single node will
16 become the reservation holder by creating a "write exclusive, regis‐
17 trants only" reservation on the device(s). The result is that only reg‐
18 istered nodes may write to the device(s). When a node failure occurs,
19 the fence_mpath agent will remove the key belonging to the failed node
20 from the device(s). The failed node will no longer be able to write to
21 the device(s). A manual 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/dm-3). Each device must support SCSI-3 persistent reserva‐
40 tions.
41 -k, --key=[key]
43 Key to use for the current operation. This key should be unique
44 to a node and have to be written in /etc/multipath.conf. For the
45 "on" action, the key specifies the key use to register the local
46 node. For the "off" action, this key specifies the key to be
47 removed from the device(s). This parameter is always required.
48 -v, --verbose
51 Verbose mode
52 -D, --debug-file=[debugfile]
54 Write debug information to given file
55 -V, --version
57 Display version information and exit
58 -h, --help
60 Display help and exit
61 --delay=[seconds]
63 Wait X seconds before fencing is started (Default Value: 0)
64 --login-timeout=[seconds]
67 Wait X seconds for cmd prompt after login (Default Value: 5)
68 --mpathpersist-path=[path]
71 Path to mpathpersist binary (Default Value: /sbin/mpathpersist)
72 --power-timeout=[seconds]
75 Test X seconds for status change after ON/OFF (Default Value:
76 20)
77 --power-wait=[seconds]
79 Wait X seconds after issuing ON/OFF (Default Value: 0)
80 --shell-timeout=[seconds]
82 Wait X seconds for cmd prompt after issuing command (Default
83 Value: 3)
84 --store-path=[path]
86 Path to directory where fence agent can store information
87 (Default Value: /var/run/cluster)
88 --retry-on=[attempts]
90 Count of attempts to retry power on (Default Value: 1)
91 --use-sudo
93 Use sudo (without password) when calling 3rd party sotfware.
94 --sudo-path=[path]
97 Path to sudo binary (Default Value: /usr/bin/sudo)
98
101 on Power on machine.
104 off Power off machine.
106 status This returns the status of the plug/virtual machine.
108 list List available plugs with aliases/virtual machines if there is
110 support for more then one device. Returns N/A otherwise.
111 list-status
113 List available plugs with aliases/virtual machines and their
114 power state if it can be obtained without additional commands.
115 monitor
118 Check the health of fence device
119 metadata
121 Display the XML metadata describing this resource.
122
125 action Fencing Action (Default Value: off)
128 devices
130 List of devices to use for current operation. Devices can be
131 comma-separated list of device-mapper multipath devices (eg.
132 /dev/dm-3). Each device must support SCSI-3 persistent reserva‐
133 tions.
134 key Key to use for the current operation. This key should be unique
136 to a node and have to be written in /etc/multipath.conf. For the
137 "on" action, the key specifies the key use to register the local
138 node. For the "off" action, this key specifies the key to be
139 removed from the device(s). This parameter is always required.
140 verbose
143 Verbose mode
144 debug Write debug information to given file
146 version
148 Display version information and exit
149 help Display help and exit
151 delay Wait X seconds before fencing is started (Default Value: 0)
153 login_timeout
156 Wait X seconds for cmd prompt after login (Default Value: 5)
157 mpathpersist_path
160 Path to mpathpersist binary (Default Value: /sbin/mpathpersist)
161 power_timeout
164 Test X seconds for status change after ON/OFF (Default Value:
165 20)
166 power_wait
168 Wait X seconds after issuing ON/OFF (Default Value: 0)
169 shell_timeout
171 Wait X seconds for cmd prompt after issuing command (Default
172 Value: 3)
173 store_path
175 Path to directory where fence agent can store information
176 (Default Value: /var/run/cluster)
177 retry_on
179 Count of attempts to retry power on (Default Value: 1)
180 sudo Use sudo (without password) when calling 3rd party sotfware.
182 sudo_path
185 Path to sudo binary (Default Value: /usr/bin/sudo)
186fence_mpath (Fence Agent) 2009-10-20 FENCE_AGENT(8)