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, --nodename
52 Node on which machine is located. (Optional, will be automati‐
53 cally determined)
54 --vmtype
56 Virtual machine type lxc or qemu. (Default: qemu) (Default
57 Value: qemu)
58 -q, --quiet
60 Disable logging to stderr. Does not affect --verbose or --debug-
61 file or logging to syslog.
62 -v, --verbose
64 Verbose mode. Multiple -v flags can be stacked on the command
65 line (e.g., -vvv) to increase verbosity.
66 --verbose-level
68 Level of debugging detail in output. Defaults to the number of
69 --verbose flags specified on the command line, or to 1 if ver‐
70 bose=1 in a stonith device configuration (i.e., on stdin).
71 -D, --debug-file=[debugfile]
74 Write debug information to given file
75 -V, --version
77 Display version information and exit
78 -h, --help
80 Display help and exit
81 -C, --separator=[char]
83 Separator for CSV created by 'list' operation (Default Value: ,)
84 --delay=[seconds]
87 Wait X seconds before fencing is started (Default Value: 0)
88 --disable-timeout=[true/false]
91 Disable timeout (true/false) (default: true when run from Pace‐
92 maker 2.0+)
93 --login-timeout=[seconds]
95 Wait X seconds for cmd prompt after login (Default Value: 5)
96 --power-timeout=[seconds]
99 Test X seconds for status change after ON/OFF (Default Value:
100 20)
101 --power-wait=[seconds]
103 Wait X seconds after issuing ON/OFF (Default Value: 0)
104 --shell-timeout=[seconds]
106 Wait X seconds for cmd prompt after issuing command (Default
107 Value: 3)
108 --stonith-status-sleep=[seconds]
110 Sleep X seconds between status calls during a STONITH action
111 (Default Value: 1)
112 --retry-on=[attempts]
114 Count of attempts to retry power on (Default Value: 1)
115
118 on Power on machine.
121 off Power off machine.
123 reboot Reboot machine.
125 status This returns the status of the plug/virtual machine.
127 list List available plugs with aliases/virtual machines if there is
129 support for more then one device. Returns N/A otherwise.
130 list-status
132 List available plugs with aliases/virtual machines and their
133 power state if it can be obtained without additional commands.
134 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: reboot)
153 ip IP Address or Hostname of a node within the Proxmox cluster.
155 This parameter is always required. Obsoletes: ipaddr
156 ipport TCP/UDP port to use for connection with device (Default Value:
158 8006)
159 method Method to fence (onoff|cycle) (Default Value: onoff)
161 password
164 Login password or passphrase Obsoletes: passwd
165 password_script
167 Script to run to retrieve password Obsoletes: passwd_script
168 plug Id of the virtual machine. This parameter is always required.
171 Obsoletes: port
172 username
174 Login name (Default Value: root@pam) Obsoletes: login
175 nodename
178 Node on which machine is located. (Optional, will be automati‐
179 cally determined) Obsoletes: node_name
180 vmtype Virtual machine type lxc or qemu. (Default: qemu) (Default
182 Value: qemu)
183 quiet Disable logging to stderr. Does not affect --verbose or --debug-
185 file or logging to syslog.
186 verbose
188 Verbose mode. Multiple -v flags can be stacked on the command
189 line (e.g., -vvv) to increase verbosity.
190 verbose_level
192 Level of debugging detail in output. Defaults to the number of
193 --verbose flags specified on the command line, or to 1 if ver‐
194 bose=1 in a stonith device configuration (i.e., on stdin).
195 debug_file
198 Write debug information to given file Obsoletes: debug
199 version
201 Display version information and exit
202 help Display help and exit
204 separator
206 Separator for CSV created by 'list' operation (Default Value: ,)
207 delay Wait X seconds before fencing is started (Default Value: 0)
210 disable_timeout
213 Disable timeout (true/false) (default: true when run from Pace‐
214 maker 2.0+)
215 login_timeout
217 Wait X seconds for cmd prompt after login (Default Value: 5)
218 power_timeout
221 Test X seconds for status change after ON/OFF (Default Value:
222 20)
223 power_wait
225 Wait X seconds after issuing ON/OFF (Default Value: 0)
226 shell_timeout
228 Wait X seconds for cmd prompt after issuing command (Default
229 Value: 3)
230 stonith_status_sleep
232 Sleep X seconds between status calls during a STONITH action
233 (Default Value: 1)
234 retry_on
236 Count of attempts to retry power on (Default Value: 1)
237fence_pve (Fence Agent) 2009-10-20 FENCE_AGENT(8)