fence_vbox(8)

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\]#   HISTFILE=/dev/null   /bin/bash    --noprofile
67              --norc"')
68
69       -l, --username=[name]
70              Login name This parameter is always required.
71
72       -q, --quiet
73              Disable logging to stderr. Does not affect --verbose or --debug-
74              file or logging to syslog.
75
76       -v, --verbose
77              Verbose mode. Multiple -v flags can be stacked  on  the  command
78              line (e.g., -vvv) to increase verbosity.
79
80       --verbose-level
81              Level  of  debugging detail in output. Defaults to the number of
82              --verbose flags specified on the command line, or to 1  if  ver‐
83              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
84
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait  X  seconds  before  fencing  is started (Default Value: 0)
101
102
103       --disable-timeout=[true/false]
104              Disable timeout (true/false) (default: true when run from  Pace‐
105              maker 2.0+)
106
107       --host-os=[os]
108              Operating  system  of  the  host  (linux|macos|windows) (Default
109              Value: linux)
110
111       --login-timeout=[seconds]
112              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
113
114
115       --missing-as-off
116              Missing port returns OFF instead of failure
117
118       --power-timeout=[seconds]
119              Test  X  seconds  for status change after ON/OFF (Default Value:
120              20)
121
122       --power-wait=[seconds]
123              Wait X seconds after issuing ON/OFF (Default Value: 0)
124
125       --shell-timeout=[seconds]
126              Wait X seconds for cmd prompt  after  issuing  command  (Default
127              Value: 3)
128
129       --vboxmanage-path=[path]
130              Path to VBoxManage on the host (Default Value: VBoxManage)
131
132       --retry-on=[attempts]
133              Count  of  attempts  to  retry power on (Default Value: 1)
134
135
136       --use-sudo
137              Use sudo (without password)  when  calling  3rd  party  software
138
139
140       --ssh-path=[path]
141              Path to ssh binary (Default Value: /usr/bin/ssh)
142
143       --sudo-path=[path]
144              Path to sudo binary (Default Value: /usr/bin/sudo)
145
146

ACTIONS

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

STDIN PARAMETERS

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