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:
32              ['\[EXPECT\]#\ '])
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
45              always 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
59              machine 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
66              "PS1=\[EXPECT\]#  /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
77
78       -D, --debug-file=[debugfile]
79              Write debug information to given file
80
81       -V, --version
82              Display version information and exit
83
84       -h, --help
85              Display help and exit
86
87       -C, --separator=[char]
88              Separator for CSV created by 'list' operation (Default Value: ,)
89
90
91       --delay=[seconds]
92              Wait X seconds before fencing  is  started  (Default  Value:  0)
93
94
95       --host-os=[os]
96              Operating  system  of  the  host  (linux|macos|windows) (Default
97              Value: linux)
98
99       --login-timeout=[seconds]
100              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
101
102
103       --missing-as-off
104              Missing port returns OFF instead of failure
105
106       --power-timeout=[seconds]
107              Test  X  seconds  for status change after ON/OFF (Default Value:
108              20)
109
110       --power-wait=[seconds]
111              Wait X seconds after issuing ON/OFF (Default Value: 0)
112
113       --shell-timeout=[seconds]
114              Wait X seconds for cmd prompt  after  issuing  command  (Default
115              Value: 3)
116
117       --vboxmanage-path=[path]
118              Path to VBoxManage on the host (Default Value: VBoxManage)
119
120       --retry-on=[attempts]
121              Count  of  attempts  to  retry power on (Default Value: 1)
122
123
124       --use-sudo
125              Use sudo (without password)  when  calling  3rd  party  software
126
127
128       --ssh-path=[path]
129              Path to ssh binary (Default Value: /usr/bin/ssh)
130
131       --sudo-path=[path]
132              Path to sudo binary (Default Value: /usr/bin/sudo)
133
134

ACTIONS

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

STDIN PARAMETERS

168
169
170       action Fencing action (Default Value: reboot)
171
172       command_prompt
173              Force  Python  regex  for   command   prompt   (Default   Value:
174              ['\[EXPECT\]#\ ']) Obsoletes: cmd_prompt
175
176       identity_file
177              Identity file (private key) for SSH
178
179       inet4_only
180              Forces agent to use IPv4 addresses only
181
182       inet6_only
183              Forces agent to use IPv6 addresses only
184
185       ip     IP  address  or  hostname  of  fencing  device This parameter is
186              always required. Obsoletes: ipaddr
187
188       ipport TCP/UDP port to use for connection with device  (Default  Value:
189              22)
190
191       password
192              Login password or passphrase Obsoletes: passwd
193
194       password_script
195              Script  to  run  to  retrieve  password Obsoletes: passwd_script
196
197
198       plug   Physical plug  number  on  device,  UUID  or  identification  of
199              machine This parameter is always required. Obsoletes: port
200
201
202       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
203
204       ssh_options
205              SSH  options  to  use   (Default   Value:   -t   '/bin/bash   -c
206              "PS1=\[EXPECT\]#  /bin/bash --noprofile --norc"')
207
208       username
209              Login  name  This parameter is always required. Obsoletes: login
210
211
212       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
213              file or logging to syslog.
214
215       verbose
216              Verbose mode
217
218       debug_file
219              Write debug information to given file Obsoletes: debug
220
221       version
222              Display version information and exit
223
224       help   Display help and exit
225
226       separator
227              Separator for CSV created by 'list' operation (Default Value: ,)
228
229
230       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
231
232
233       host_os
234              Operating  system  of  the  host  (linux|macos|windows) (Default
235              Value: linux)
236
237       login_timeout
238              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
239
240
241       missing_as_off
242              Missing port returns OFF instead of failure
243
244       power_timeout
245              Test  X  seconds  for status change after ON/OFF (Default Value:
246              20)
247
248       power_wait
249              Wait X seconds after issuing ON/OFF (Default Value: 0)
250
251       shell_timeout
252              Wait X seconds for cmd prompt  after  issuing  command  (Default
253              Value: 3)
254
255       vboxmanage_path
256              Path to VBoxManage on the host (Default Value: VBoxManage)
257
258       retry_on
259              Count  of  attempts  to  retry power on (Default Value: 1)
260
261
262       use_sudo
263              Use sudo (without password)  when  calling  3rd  party  software
264              Obsoletes: sudo
265
266       ssh_path
267              Path to ssh binary (Default Value: /usr/bin/ssh)
268
269       sudo_path
270              Path to sudo binary (Default Value: /usr/bin/sudo)
271
272
273
274fence_vbox (Fence Agent)          2009-10-20                    FENCE_AGENT(8)