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

NAME

7       fence_vbox - Fence agent for VirtualBox
8

DESCRIPTION

10       fence_vbox  is  an I/O Fencing agent which can be used with the virtual
11       machines managed by VirtualBox. It logs via ssh to a dom0 where it runs
12       VBoxManage to do all of the work.
13
14       By  default,  vbox  needs  to  log in as a user that is a member of the
15       vboxusers group. Also, you must allow ssh login in your sshd_config.
16
17       fence_vbox accepts options on the command line as well as  from  stdin.
18       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
19       fence_vbox can be run by itself with command  line  options.   This  is
20       useful for testing and for turning outlets on or off from scripts.
21
22       Vendor URL: https://www.virtualbox.org/
23

PARAMETERS

25
26
27       -o, --action=[action]
28              Fencing action (Default Value: reboot)
29
30       -c, --command-prompt=[prompt]
31              Force  Python  regex  for command prompt (Default Value: ['\[EX‐
32              PECT\]#'])
33
34       -k, --identity-file=[filename]
35              Identity file (private key) for SSH
36
37       -4, --inet4-only
38              Forces agent to use IPv4 addresses only
39
40       -6, --inet6-only
41              Forces agent to use IPv6 addresses only
42
43       -a, --ip=[ip]
44              IP address or hostname of fencing device This parameter  is  al‐
45              ways required.
46
47       -u, --ipport=[port]
48              TCP/UDP  port  to use for connection with device (Default Value:
49              22)
50
51       -p, --password=[password]
52              Login password or passphrase
53
54       -S, --password-script=[script]
55              Script to run to retrieve password
56
57       -n, --plug=[id]
58              Physical plug number on device, UUID or  identification  of  ma‐
59              chine This parameter is always required.
60
61       -x, --ssh
62              Use SSH connection (Default Value: 1)
63
64       --ssh-options=[options]
65              SSH  options  to use (Default Value: -t '/bin/bash -c "PS1=\[EX‐
66              PECT\]# HISTFILE=/dev/null /bin/bash --noprofile --norc"')
67
68       -l, --username=[name]
69              Login name This parameter is always required.
70
71       -q, --quiet
72              Disable logging to stderr. Does not affect --verbose or --debug-
73              file or logging to syslog.
74
75       -v, --verbose
76              Verbose  mode.  Multiple  -v flags can be stacked on the command
77              line (e.g., -vvv) to increase verbosity.
78
79       --verbose-level
80              Level of debugging detail in output. Defaults to the  number  of
81              --verbose  flags  specified on the command line, or to 1 if ver‐
82              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
83
84
85       -D, --debug-file=[debugfile]
86              Write debug information to given file
87
88       -V, --version
89              Display version information and exit
90
91       -h, --help
92              Display help and exit
93
94       -C, --separator=[char]
95              Separator for CSV created by 'list' operation (Default Value: ,)
96
97
98       --delay=[seconds]
99              Wait X seconds before fencing  is  started  (Default  Value:  0)
100
101
102       --disable-timeout=[true/false]
103              Disable  timeout (true/false) (default: true when run from Pace‐
104              maker 2.0+)
105
106       --host-os=[os]
107              Operating system  of  the  host  (linux|macos|windows)  (Default
108              Value: linux)
109
110       --login-timeout=[seconds]
111              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
112
113
114       --missing-as-off
115              Missing port returns OFF instead of failure
116
117       --power-timeout=[seconds]
118              Test X seconds for status change after  ON/OFF  (Default  Value:
119              20)
120
121       --power-wait=[seconds]
122              Wait X seconds after issuing ON/OFF (Default Value: 0)
123
124       --shell-timeout=[seconds]
125              Wait  X  seconds  for  cmd prompt after issuing command (Default
126              Value: 3)
127
128       --stonith-status-sleep=[seconds]
129              Sleep X seconds between status calls  during  a  STONITH  action
130              (Default Value: 1)
131
132       --vboxmanage-path=[path]
133              Path to VBoxManage on the host (Default Value: VBoxManage)
134
135       --retry-on=[attempts]
136              Count  of  attempts  to  retry power on (Default Value: 1)
137
138
139       --use-sudo
140              Use sudo (without password)  when  calling  3rd  party  software
141
142
143       --ssh-path=[path]
144              Path to ssh binary (Default Value: /usr/bin/ssh)
145
146       --sudo-path=[path]
147              Path to sudo binary (Default Value: /usr/bin/sudo)
148
149

ACTIONS

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

STDIN PARAMETERS

183
184
185       action Fencing action (Default Value: reboot)
186
187       command_prompt
188              Force Python regex for command prompt  (Default  Value:  ['\[EX‐
189              PECT\]#']) Obsoletes: cmd_prompt
190
191       identity_file
192              Identity file (private key) for SSH
193
194       inet4_only
195              Forces agent to use IPv4 addresses only
196
197       inet6_only
198              Forces agent to use IPv6 addresses only
199
200       ip     IP  address  or hostname of fencing device This parameter is al‐
201              ways required. Obsoletes: ipaddr
202
203       ipport TCP/UDP port to use for connection with device  (Default  Value:
204              22)
205
206       password
207              Login password or passphrase Obsoletes: passwd
208
209       password_script
210              Script  to  run  to  retrieve  password Obsoletes: passwd_script
211
212
213       plug   Physical plug number on device, UUID or  identification  of  ma‐
214              chine  This  parameter is always required. Obsoletes: port
215
216
217       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
218
219       ssh_options
220              SSH options to use (Default Value: -t '/bin/bash  -c  "PS1=\[EX‐
221              PECT\]# HISTFILE=/dev/null /bin/bash --noprofile --norc"')
222
223       username
224              Login  name  This parameter is always required. Obsoletes: login
225
226
227       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
228              file or logging to syslog.
229
230       verbose
231              Verbose  mode.  Multiple  -v flags can be stacked on the command
232              line (e.g., -vvv) to increase verbosity.
233
234       verbose_level
235              Level of debugging detail in output. Defaults to the  number  of
236              --verbose  flags  specified on the command line, or to 1 if ver‐
237              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
238
239
240       debug_file
241              Write debug information to given file Obsoletes: debug
242
243       version
244              Display version information and exit
245
246       help   Display help and exit
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       host_os
260              Operating system  of  the  host  (linux|macos|windows)  (Default
261              Value: linux)
262
263       login_timeout
264              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
265
266
267       missing_as_off
268              Missing port returns OFF instead of failure
269
270       power_timeout
271              Test X seconds for status change after  ON/OFF  (Default  Value:
272              20)
273
274       power_wait
275              Wait X seconds after issuing ON/OFF (Default Value: 0)
276
277       shell_timeout
278              Wait  X  seconds  for  cmd prompt after issuing command (Default
279              Value: 3)
280
281       stonith_status_sleep
282              Sleep X seconds between status calls  during  a  STONITH  action
283              (Default Value: 1)
284
285       vboxmanage_path
286              Path to VBoxManage on the host (Default Value: VBoxManage)
287
288       retry_on
289              Count  of  attempts  to  retry power on (Default Value: 1)
290
291
292       use_sudo
293              Use sudo (without password) when calling 3rd party software  Ob‐
294              soletes: sudo
295
296       ssh_path
297              Path to ssh binary (Default Value: /usr/bin/ssh)
298
299       sudo_path
300              Path to sudo binary (Default Value: /usr/bin/sudo)
301
302
303
304fence_vbox (Fence Agent)          2009-10-20                    FENCE_AGENT(8)