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       --plug-separator=[char]
95              Separator  for  plug  parameter when specifying more than 1 plug
96              (Default Value: ,)
97
98       -C, --separator=[char]
99              Separator for CSV created by 'list' operation (Default Value: ,)
100
101
102       --delay=[seconds]
103              Wait  X  seconds  before  fencing  is started (Default Value: 0)
104
105
106       --disable-timeout=[true/false]
107              Disable timeout (true/false) (default: true when run from  Pace‐
108              maker 2.0+)
109
110       --host-os=[os]
111              Operating  system  of  the  host  (linux|macos|windows) (Default
112              Value: linux)
113
114       --login-timeout=[seconds]
115              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
116
117
118       --missing-as-off
119              Missing port returns OFF instead of failure
120
121       --power-timeout=[seconds]
122              Test  X  seconds  for status change after ON/OFF (Default Value:
123              20)
124
125       --power-wait=[seconds]
126              Wait X seconds after issuing ON/OFF (Default Value: 0)
127
128       --shell-timeout=[seconds]
129              Wait X seconds for cmd prompt  after  issuing  command  (Default
130              Value: 3)
131
132       --stonith-status-sleep=[seconds]
133              Sleep  X  seconds  between  status calls during a STONITH action
134              (Default Value: 1)
135
136       --vboxmanage-path=[path]
137              Path to VBoxManage on the host (Default Value: VBoxManage)
138
139       --retry-on=[attempts]
140              Count of attempts to retry power on  (Default  Value:  1)
141
142
143       --use-sudo
144              Use  sudo  (without  password)  when  calling 3rd party software
145
146
147       --ssh-path=[path]
148              Path to ssh binary (Default Value: /usr/bin/ssh)
149
150       --sudo-path=[path]
151              Path to sudo binary (Default Value: /usr/bin/sudo)
152
153

ACTIONS

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

STDIN PARAMETERS

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