1FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)
3
7 fence_pve - Fencing agent for the Proxmox Virtual Environment
8
10 The fence_pve agent can be used to fence virtual machines acting as
11 nodes in a virtualized cluster.
12 fence_pve accepts options on the command line as well as from stdin.
14 Fenced sends parameters through stdin when it execs the agent.
15 fence_pve can be run by itself with command line options. This is use‐
16 ful for testing and for turning outlets on or off from scripts.
17 Vendor URL: http://www.proxmox.com/
19
21 -o, --action=[action]
24 Fencing action (Default Value: reboot)
25 -a, --ip=[ip]
27 IP Address or Hostname of a node within the Proxmox cluster.
28 This parameter is always required.
29 -u, --ipport=[port]
31 TCP/UDP port to use for connection with device (Default Value:
32 8006)
33 -m, --method=[method]
35 Method to fence (onoff|cycle) (Default Value: onoff)
36 -p, --password=[password]
39 Login password or passphrase
40 -S, --password-script=[script]
42 Script to run to retrieve password
43 -n, --plug=[id]
45 Id of the virtual machine. This parameter is always required.
46 -l, --username=[name]
49 Login name (Default Value: root@pam)
50 -N, --pve-node=[node_name]
52 Proxmox node name on which machine is located. (Must be speci‐
53 fied if not using --pve-node-auto)
54 -A, --pve-node-auto
56 Automatically select proxmox node. (This option overrides --pve-
57 node)
58 --vmtype
60 Virtual machine type lxc or qemu. (Default: qemu) (Default
61 Value: qemu)
62 --nodename
64 Replaced by --pve-node
65 -q, --quiet
67 Disable logging to stderr. Does not affect --verbose or --debug-
68 file or logging to syslog.
69 -v, --verbose
71 Verbose mode. Multiple -v flags can be stacked on the command
72 line (e.g., -vvv) to increase verbosity.
73 --verbose-level
75 Level of debugging detail in output. Defaults to the number of
76 --verbose flags specified on the command line, or to 1 if ver‐
77 bose=1 in a stonith device configuration (i.e., on stdin).
78 -D, --debug-file=[debugfile]
81 Write debug information to given file
82 -V, --version
84 Display version information and exit
85 -h, --help
87 Display help and exit
88 -C, --separator=[char]
90 Separator for CSV created by 'list' operation (Default Value: ,)
91 --delay=[seconds]
94 Wait X seconds before fencing is started (Default Value: 0)
95 --disable-timeout=[true/false]
98 Disable timeout (true/false) (default: true when run from Pace‐
99 maker 2.0+)
100 --login-timeout=[seconds]
102 Wait X seconds for cmd prompt after login (Default Value: 5)
103 --power-timeout=[seconds]
106 Test X seconds for status change after ON/OFF (Default Value:
107 20)
108 --power-wait=[seconds]
110 Wait X seconds after issuing ON/OFF (Default Value: 0)
111 --shell-timeout=[seconds]
113 Wait X seconds for cmd prompt after issuing command (Default
114 Value: 3)
115 --stonith-status-sleep=[seconds]
117 Sleep X seconds between status calls during a STONITH action
118 (Default Value: 1)
119 --retry-on=[attempts]
121 Count of attempts to retry power on (Default Value: 1)
122
125 on Power on machine.
128 off Power off machine.
130 reboot Reboot machine.
132 status This returns the status of the plug/virtual machine.
134 list List available plugs with aliases/virtual machines if there is
136 support for more then one device. Returns N/A otherwise.
137 list-status
139 List available plugs with aliases/virtual machines and their
140 power state if it can be obtained without additional commands.
141 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: reboot)
160 ip IP Address or Hostname of a node within the Proxmox cluster.
162 This parameter is always required. Obsoletes: ipaddr
163 ipport TCP/UDP port to use for connection with device (Default Value:
165 8006)
166 method Method to fence (onoff|cycle) (Default Value: onoff)
168 password
171 Login password or passphrase Obsoletes: passwd
172 password_script
174 Script to run to retrieve password Obsoletes: passwd_script
175 plug Id of the virtual machine. This parameter is always required.
178 Obsoletes: port
179 username
181 Login name (Default Value: root@pam) Obsoletes: login
182 pve_node
184 Proxmox node name on which machine is located. (Must be speci‐
185 fied if not using --pve-node-auto)
186 pve_node_auto
188 Automatically select proxmox node. (This option overrides --pve-
189 node)
190 vmtype Virtual machine type lxc or qemu. (Default: qemu) (Default
192 Value: qemu)
193 nodename
195 Replaced by --pve-node Obsoletes: node_name
196 quiet Disable logging to stderr. Does not affect --verbose or --debug-
198 file or logging to syslog.
199 verbose
201 Verbose mode. Multiple -v flags can be stacked on the command
202 line (e.g., -vvv) to increase verbosity.
203 verbose_level
205 Level of debugging detail in output. Defaults to the number of
206 --verbose flags specified on the command line, or to 1 if ver‐
207 bose=1 in a stonith device configuration (i.e., on stdin).
208 debug_file
211 Write debug information to given file Obsoletes: debug
212 version
214 Display version information and exit
215 help Display help and exit
217 separator
219 Separator for CSV created by 'list' operation (Default Value: ,)
220 delay Wait X seconds before fencing is started (Default Value: 0)
223 disable_timeout
226 Disable timeout (true/false) (default: true when run from Pace‐
227 maker 2.0+)
228 login_timeout
230 Wait X seconds for cmd prompt after login (Default Value: 5)
231 power_timeout
234 Test X seconds for status change after ON/OFF (Default Value:
235 20)
236 power_wait
238 Wait X seconds after issuing ON/OFF (Default Value: 0)
239 shell_timeout
241 Wait X seconds for cmd prompt after issuing command (Default
242 Value: 3)
243 stonith_status_sleep
245 Sleep X seconds between status calls during a STONITH action
246 (Default Value: 1)
247 retry_on
249 Count of attempts to retry power on (Default Value: 1)
250fence_pve (Fence Agent) 2009-10-20 FENCE_AGENT(8)