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       -p, --password=[password]
41              Login password or passphrase
42
43       -S, --password-script=[script]
44              Script to run to retrieve password
45
46       -n, --plug=[id]
47              Id  of  the  virtual machine. This parameter is always required.
48
49
50       -l, --username=[name]
51              Login name (Default Value: root@pam)
52
53       -N, --nodename
54              Node on which machine is located. (Optional, will  be  automati‐
55              cally determined)
56
57       --vmtype
58              Virtual  machine  type  lxc  or  qemu.  (Default: qemu) (Default
59              Value: qemu)
60
61       -q, --quiet
62              Disable logging to stderr. Does not affect --verbose or --debug-
63              file or logging to syslog.
64
65       -v, --verbose
66              Verbose mode
67
68       -D, --debug-file=[debugfile]
69              Write debug information to given file
70
71       -V, --version
72              Display version information and exit
73
74       -h, --help
75              Display help and exit
76
77       -C, --separator=[char]
78              Separator for CSV created by 'list' operation (Default Value: ,)
79
80
81       --delay=[seconds]
82              Wait X seconds before fencing  is  started  (Default  Value:  0)
83
84
85       --login-timeout=[seconds]
86              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
87
88
89       --power-timeout=[seconds]
90              Test X seconds for status change after  ON/OFF  (Default  Value:
91              20)
92
93       --power-wait=[seconds]
94              Wait X seconds after issuing ON/OFF (Default Value: 0)
95
96       --shell-timeout=[seconds]
97              Wait  X  seconds  for  cmd prompt after issuing command (Default
98              Value: 3)
99
100       --retry-on=[attempts]
101              Count of attempts to retry power on (Default Value: 1)
102
103

ACTIONS

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

STDIN PARAMETERS

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