Scroll to navigation

FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)

NAME

fence_vbox - Fence agent for VirtualBox

DESCRIPTION

fence_vbox is an I/O Fencing agent which can be used with the virtual machines managed by VirtualBox. It logs via ssh to a dom0 where it runs VBoxManage to do all of the work.

By default, vbox needs to log in as a user that is a member of the vboxusers group. Also, you must allow ssh login in your sshd_config.

fence_vbox accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vbox can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.

Vendor URL: https://www.virtualbox.org/

PARAMETERS

Fencing action (Default Value: reboot)
Force Python regex for command prompt (Default Value: ['\[EXPECT\]#'])
Identity file (private key) for SSH
-4, --inet4-only
Forces agent to use IPv4 addresses only
-6, --inet6-only
Forces agent to use IPv6 addresses only
IP address or hostname of fencing device This parameter is always required.
TCP/UDP port to use for connection with device (Default Value: 22)
Login password or passphrase
Script to run to retrieve password
Physical plug number on device, UUID or identification of machine This parameter is always required.
Use SSH connection (Default Value: 1)
SSH options to use (Default Value: -t '/bin/bash -c "PS1=\[EXPECT\]# HISTFILE=/dev/null /bin/bash --noprofile --norc"')
Login name This parameter is always required.
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
Write debug information to given file
Display version information and exit
Display help and exit
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
Separator for CSV created by 'list' operation (Default Value: ,)
Wait X seconds before fencing is started (Default Value: 0)
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
Operating system of the host (linux|macos|windows) (Default Value: linux)
Wait X seconds for cmd prompt after login (Default Value: 5)
Missing port returns OFF instead of failure
Test X seconds for status change after ON/OFF (Default Value: 20)
Wait X seconds after issuing ON/OFF (Default Value: 0)
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
Path to VBoxManage on the host (Default Value: VBoxManage)
Count of attempts to retry power on (Default Value: 1)
Use sudo (without password) when calling 3rd party software
Path to ssh binary (Default Value: /usr/bin/ssh)
Path to sudo binary (Default Value: /usr/bin/sudo)

ACTIONS

Power on machine.
Power off machine.
Reboot machine.
This returns the status of the plug/virtual machine.
List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
Check the health of fence device
Display the XML metadata describing this resource.

The operational behavior of this is not known.
Validate if all required parameters are entered.

STDIN PARAMETERS

Fencing action (Default Value: reboot)
Force Python regex for command prompt (Default Value: ['\[EXPECT\]#']) Obsoletes: cmd_prompt
Identity file (private key) for SSH
Forces agent to use IPv4 addresses only
Forces agent to use IPv6 addresses only
IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr
TCP/UDP port to use for connection with device (Default Value: 22)
Login password or passphrase Obsoletes: passwd
Script to run to retrieve password Obsoletes: passwd_script
Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port
Use SSH connection (Default Value: 1) Obsoletes: secure
SSH options to use (Default Value: -t '/bin/bash -c "PS1=\[EXPECT\]# HISTFILE=/dev/null /bin/bash --noprofile --norc"')
Login name This parameter is always required. Obsoletes: login
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
Level of debugging detail in output. Defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
Write debug information to given file Obsoletes: debug
Display version information and exit
Display help and exit
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
Separator for CSV created by 'list' operation (Default Value: ,)
Wait X seconds before fencing is started (Default Value: 0)
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
Operating system of the host (linux|macos|windows) (Default Value: linux)
Wait X seconds for cmd prompt after login (Default Value: 5)
Missing port returns OFF instead of failure
Test X seconds for status change after ON/OFF (Default Value: 20)
Wait X seconds after issuing ON/OFF (Default Value: 0)
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
Path to VBoxManage on the host (Default Value: VBoxManage)
Count of attempts to retry power on (Default Value: 1)
Use sudo (without password) when calling 3rd party software Obsoletes: sudo
Path to ssh binary (Default Value: /usr/bin/ssh)
Path to sudo binary (Default Value: /usr/bin/sudo)
2009-10-20 fence_vbox (Fence Agent)