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       -4, --inet4-only
27              Forces agent to use IPv4 addresses only
28
29       -6, --inet6-only
30              Forces agent to use IPv6 addresses only
31
32       -a, --ip=[ip]
33              IP  Address  or  Hostname  of a node within the Proxmox cluster.
34              This parameter is always required.
35
36       -u, --ipport=[port]
37              TCP/UDP port to use for connection with device  (Default  Value:
38              8006)
39
40       -m, --method=[method]
41              Method to fence (onoff|cycle) (Default Value: onoff)
42
43
44       -p, --password=[password]
45              Login password or passphrase
46
47       -S, --password-script=[script]
48              Script to run to retrieve password
49
50       -n, --plug=[id]
51              Id of the virtual machine. This parameter  is  always  required.
52
53
54       -l, --username=[name]
55              Login name (Default Value: root@pam)
56
57       -N, --nodename
58              Node  on  which machine is located. (Optional, will be automati‐
59              cally determined)
60
61       --vmtype
62              Virtual machine type  lxc  or  qemu.  (Default:  qemu)  (Default
63              Value: qemu)
64
65       -q, --quiet
66              Disable logging to stderr. Does not affect --verbose or --debug-
67              file or logging to syslog.
68
69       -v, --verbose
70              Verbose mode
71
72       -D, --debug-file=[debugfile]
73              Write debug information to given file
74
75       -V, --version
76              Display version information and exit
77
78       -h, --help
79              Display help and exit
80
81       -C, --separator=[char]
82              Separator for CSV created by 'list' operation (Default Value: ,)
83
84
85       --delay=[seconds]
86              Wait  X  seconds  before  fencing  is started (Default Value: 0)
87
88
89       --login-timeout=[seconds]
90              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
91
92
93       --power-timeout=[seconds]
94              Test  X  seconds  for status change after ON/OFF (Default Value:
95              20)
96
97       --power-wait=[seconds]
98              Wait X seconds after issuing ON/OFF (Default Value: 0)
99
100       --shell-timeout=[seconds]
101              Wait X seconds for cmd prompt  after  issuing  command  (Default
102              Value: 3)
103
104       --retry-on=[attempts]
105              Count of attempts to retry power on (Default Value: 1)
106
107

ACTIONS

109
110
111       on     Power on machine.
112
113       off    Power off machine.
114
115       reboot Reboot machine.
116
117       status This returns the status of the plug/virtual machine.
118
119       list   List  available  plugs with aliases/virtual machines if there is
120              support for more then one device. Returns N/A otherwise.
121
122       list-status
123              List available plugs with  aliases/virtual  machines  and  their
124              power  state  if it can be obtained without additional commands.
125
126
127       monitor
128              Check the health of fence device
129
130       metadata
131              Display the XML metadata describing this resource.
132
133       manpage
134               The operational behavior of this is not known.
135
136       validate-all
137              Validate if all required parameters are entered.
138
139

STDIN PARAMETERS

141
142
143       action Fencing action (Default Value: reboot)
144
145       inet4_only
146              Forces agent to use IPv4 addresses only
147
148       inet6_only
149              Forces agent to use IPv6 addresses only
150
151       ip     IP Address or Hostname of a node  within  the  Proxmox  cluster.
152              This parameter is always required. Obsoletes: ipaddr
153
154       ipport TCP/UDP  port  to use for connection with device (Default Value:
155              8006)
156
157       method Method to fence (onoff|cycle) (Default Value: onoff)
158
159
160       password
161              Login password or passphrase Obsoletes: passwd
162
163       password_script
164              Script  to  run  to  retrieve  password Obsoletes: passwd_script
165
166
167       plug   Id of the virtual machine. This parameter  is  always  required.
168              Obsoletes: port
169
170       username
171              Login  name  (Default  Value:  root@pam)  Obsoletes: login
172
173
174       nodename
175              Node on which machine is located. (Optional, will  be  automati‐
176              cally determined) Obsoletes: node_name
177
178       vmtype Virtual  machine  type  lxc  or  qemu.  (Default: qemu) (Default
179              Value: qemu)
180
181       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
182              file or logging to syslog.
183
184       verbose
185              Verbose mode
186
187       debug_file
188              Write debug information to given file Obsoletes: debug
189
190       version
191              Display version information and exit
192
193       help   Display help and exit
194
195       separator
196              Separator for CSV created by 'list' operation (Default Value: ,)
197
198
199       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
200
201
202       login_timeout
203              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
204
205
206       power_timeout
207              Test X seconds for status change after  ON/OFF  (Default  Value:
208              20)
209
210       power_wait
211              Wait X seconds after issuing ON/OFF (Default Value: 0)
212
213       shell_timeout
214              Wait  X  seconds  for  cmd prompt after issuing command (Default
215              Value: 3)
216
217       retry_on
218              Count of attempts to retry power on (Default Value: 1)
219
220
221
222fence_pve (Fence Agent)           2009-10-20                    FENCE_AGENT(8)