1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_pve - Fencing agent for the Proxmox Virtual Environment
8

DESCRIPTION

10       The  fence_pve  agent  can  be used to fence virtual machines acting as
11       nodes in a virtualized cluster.
12
13       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
18       Vendor URL: http://www.proxmox.com/
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -a, --ip=[ip]
27              IP  Address  or  Hostname  of a node within the Proxmox cluster.
28              This parameter is always required.
29
30       -u, --ipport=[port]
31              TCP/UDP port to use for connection with device  (Default  Value:
32              8006)
33
34       -m, --method=[method]
35              Method to fence (onoff|cycle) (Default Value: onoff)
36
37
38       -p, --password=[password]
39              Login password or passphrase
40
41       -S, --password-script=[script]
42              Script to run to retrieve password
43
44       -n, --plug=[id]
45              Id of the virtual machine. This parameter  is  always  required.
46
47
48       -z, --ssl
49              Use SSL connection with verifying certificate (Default Value: 1)
50
51
52       --ssl-insecure
53              Use SSL connection without verifying certificate
54
55       --ssl-secure
56              Use SSL connection with verifying certificate
57
58       -l, --username=[name]
59              Login name (Default Value: root@pam)
60
61       -N, --pve-node=[node_name]
62              Proxmox node name on which machine is located. (Must  be  speci‐
63              fied if not using --pve-node-auto)
64
65       -A, --pve-node-auto
66              Automatically select proxmox node. (This option overrides --pve-
67              node)
68
69       --vmtype
70              Virtual machine type  lxc  or  qemu.  (Default:  qemu)  (Default
71              Value: qemu)
72
73       --nodename
74              Replaced by --pve-node
75
76       -q, --quiet
77              Disable logging to stderr. Does not affect --verbose or --debug-
78              file or logging to syslog.
79
80       -v, --verbose
81              Verbose mode. Multiple -v flags can be stacked  on  the  command
82              line (e.g., -vvv) to increase verbosity.
83
84       --verbose-level
85              Level  of  debugging detail in output. Defaults to the number of
86              --verbose flags specified on the command line, or to 1  if  ver‐
87              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
88
89
90       -D, --debug-file=[debugfile]
91              Write debug information to given file
92
93       -V, --version
94              Display version information and exit
95
96       -h, --help
97              Display help and exit
98
99       --plug-separator=[char]
100              Separator for plug parameter when specifying more  than  1  plug
101              (Default Value: ,)
102
103       -C, --separator=[char]
104              Separator for CSV created by 'list' operation (Default Value: ,)
105
106
107       --delay=[seconds]
108              Wait X seconds before fencing  is  started  (Default  Value:  0)
109
110
111       --disable-timeout=[true/false]
112              Disable  timeout (true/false) (default: true when run from Pace‐
113              maker 2.0+)
114
115       --login-timeout=[seconds]
116              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
117
118
119       --power-timeout=[seconds]
120              Test  X  seconds  for status change after ON/OFF (Default Value:
121              20)
122
123       --power-wait=[seconds]
124              Wait X seconds after issuing ON/OFF (Default Value: 0)
125
126       --shell-timeout=[seconds]
127              Wait X seconds for cmd prompt  after  issuing  command  (Default
128              Value: 3)
129
130       --stonith-status-sleep=[seconds]
131              Sleep  X  seconds  between  status calls during a STONITH action
132              (Default Value: 1)
133
134       --retry-on=[attempts]
135              Count of attempts to retry power on (Default Value: 1)
136
137       --gnutlscli-path=[path]
138              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
139
140

ACTIONS

142
143
144       on     Power on machine.
145
146       off    Power off machine.
147
148       reboot Reboot machine.
149
150       status This returns the status of the plug/virtual machine.
151
152       list   List available plugs with aliases/virtual machines if  there  is
153              support for more then one device. Returns N/A otherwise.
154
155       list-status
156              List  available  plugs  with  aliases/virtual machines and their
157              power state if it can be obtained without  additional  commands.
158
159
160       monitor
161              Check the health of fence device
162
163       metadata
164              Display the XML metadata describing this resource.
165
166       manpage
167               The operational behavior of this is not known.
168
169       validate-all
170              Validate if all required parameters are entered.
171
172

STDIN PARAMETERS

174
175
176       action Fencing action (Default Value: reboot)
177
178       ip     IP  Address  or  Hostname  of a node within the Proxmox cluster.
179              This parameter is always required. Obsoletes: ipaddr
180
181       ipport TCP/UDP port to use for connection with device  (Default  Value:
182              8006)
183
184       method Method to fence (onoff|cycle) (Default Value: onoff)
185
186
187       password
188              Login password or passphrase Obsoletes: passwd
189
190       password_script
191              Script to run  to  retrieve  password  Obsoletes:  passwd_script
192
193
194       plug   Id  of  the  virtual machine. This parameter is always required.
195              Obsoletes: port
196
197       ssl    Use SSL connection with verifying certificate (Default Value: 1)
198
199
200       ssl_insecure
201              Use SSL connection without verifying certificate
202
203       ssl_secure
204              Use SSL connection with verifying certificate
205
206       username
207              Login name (Default Value: root@pam) Obsoletes: login
208
209       pve_node
210              Proxmox  node  name on which machine is located. (Must be speci‐
211              fied if not using --pve-node-auto)
212
213       pve_node_auto
214              Automatically select proxmox node. (This option overrides --pve-
215              node)
216
217       vmtype Virtual  machine  type  lxc  or  qemu.  (Default: qemu) (Default
218              Value: qemu)
219
220       nodename
221              Replaced by --pve-node Obsoletes: node_name
222
223       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
224              file or logging to syslog.
225
226       verbose
227              Verbose  mode.  Multiple  -v flags can be stacked on the command
228              line (e.g., -vvv) to increase verbosity.
229
230       verbose_level
231              Level of debugging detail in output. Defaults to the  number  of
232              --verbose  flags  specified on the command line, or to 1 if ver‐
233              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
234
235
236       debug_file
237              Write debug information to given file Obsoletes: debug
238
239       version
240              Display version information and exit
241
242       help   Display help and exit
243
244       plug_separator
245              Separator  for  plug  parameter when specifying more than 1 plug
246              (Default Value: ,)
247
248       separator
249              Separator for CSV created by 'list' operation (Default Value: ,)
250
251
252       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
253
254
255       disable_timeout
256              Disable timeout (true/false) (default: true when run from  Pace‐
257              maker 2.0+)
258
259       login_timeout
260              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
261
262
263       power_timeout
264              Test X seconds for status change after  ON/OFF  (Default  Value:
265              20)
266
267       power_wait
268              Wait X seconds after issuing ON/OFF (Default Value: 0)
269
270       shell_timeout
271              Wait  X  seconds  for  cmd prompt after issuing command (Default
272              Value: 3)
273
274       stonith_status_sleep
275              Sleep X seconds between status calls  during  a  STONITH  action
276              (Default Value: 1)
277
278       retry_on
279              Count of attempts to retry power on (Default Value: 1)
280
281       gnutlscli_path
282              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
283
284
285
286fence_pve (Fence Agent)           2009-10-20                    FENCE_AGENT(8)