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 --retry-on=[attempts]
110 Count of attempts to retry power on (Default Value: 1)
111
114 on Power on machine.
117 off Power off machine.
119 reboot Reboot machine.
121 status This returns the status of the plug/virtual machine.
123 list List available plugs with aliases/virtual machines if there is
125 support for more then one device. Returns N/A otherwise.
126 list-status
128 List available plugs with aliases/virtual machines and their
129 power state if it can be obtained without additional commands.
130 monitor
133 Check the health of fence device
134 metadata
136 Display the XML metadata describing this resource.
137 manpage
139 The operational behavior of this is not known.
140 validate-all
142 Validate if all required parameters are entered.
143
146 action Fencing action (Default Value: reboot)
149 ip IP Address or Hostname of a node within the Proxmox cluster.
151 This parameter is always required. Obsoletes: ipaddr
152 ipport TCP/UDP port to use for connection with device (Default Value:
154 8006)
155 method Method to fence (onoff|cycle) (Default Value: onoff)
157 password
160 Login password or passphrase Obsoletes: passwd
161 password_script
163 Script to run to retrieve password Obsoletes: passwd_script
164 plug Id of the virtual machine. This parameter is always required.
167 Obsoletes: port
168 username
170 Login name (Default Value: root@pam) Obsoletes: login
171 nodename
174 Node on which machine is located. (Optional, will be automati‐
175 cally determined) Obsoletes: node_name
176 vmtype Virtual machine type lxc or qemu. (Default: qemu) (Default
178 Value: qemu)
179 quiet Disable logging to stderr. Does not affect --verbose or --debug-
181 file or logging to syslog.
182 verbose
184 Verbose mode. Multiple -v flags can be stacked on the command
185 line (e.g., -vvv) to increase verbosity.
186 verbose_level
188 Level of debugging detail in output. Defaults to the number of
189 --verbose flags specified on the command line, or to 1 if ver‐
190 bose=1 in a stonith device configuration (i.e., on stdin).
191 debug_file
194 Write debug information to given file Obsoletes: debug
195 version
197 Display version information and exit
198 help Display help and exit
200 separator
202 Separator for CSV created by 'list' operation (Default Value: ,)
203 delay Wait X seconds before fencing is started (Default Value: 0)
206 disable_timeout
209 Disable timeout (true/false) (default: true when run from Pace‐
210 maker 2.0+)
211 login_timeout
213 Wait X seconds for cmd prompt after login (Default Value: 5)
214 power_timeout
217 Test X seconds for status change after ON/OFF (Default Value:
218 20)
219 power_wait
221 Wait X seconds after issuing ON/OFF (Default Value: 0)
222 shell_timeout
224 Wait X seconds for cmd prompt after issuing command (Default
225 Value: 3)
226 retry_on
228 Count of attempts to retry power on (Default Value: 1)
229fence_pve (Fence Agent) 2009-10-20 FENCE_AGENT(8)