Provided by: fence-agents-extra_4.7.1-1ubuntu8.1_amd64 
NAME
fence_vmware - Fence agent for VMWare
DESCRIPTION
fence_vmware is an I/O Fencing agent which can be used with the VMware ESX, VMware ESXi or
VMware Server to fence virtual machines.
Before you can use this agent, it must be installed VI Perl Toolkit or vmrun command on
every node you want to make fencing.
VI Perl Toolkit is preferred for VMware ESX/ESXi and Virtual Center. Vmrun command is only
solution for VMware Server 1/2 (this command will works against ESX/ESXi 3.5 up2 and VC
up2 too, but not cluster aware!) and is available as part of VMware VIX API SDK package.
VI Perl and VIX API SDK are both available from VMware web pages (not int RHEL
repository!).
You can specify type of VMware you are connecting to with -d switch (or vmware_type for
stdin). Possible values are esx, server2 and server1.Default value is esx, which will use
VI Perl. With server1 and server2, vmrun command is used.
After you have successfully installed VI Perl Toolkit or VIX API, you should be able to
run fence_vmware_helper (part of this agent) or vmrun command. This agent supports only
vmrun from version 2.0.0 (VIX API 1.6.0).
fence_vmware accepts options on the command line as well as from stdin. Fenced sends
parameters through stdin when it execs the agent. fence_vmware 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: http://www.vmware.com
PARAMETERS
-o, --action=[action]
Fencing action (Default Value: reboot)
-e, --exec=[command]
Command to execute
-k, --identity-file=[filename]
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
-a, --ip=[ip]
IP address or hostname of fencing device
-u, --ipport=[port]
TCP/UDP port to use for connection with device (Default Value: 22)
-p, --password=[password]
Login password or passphrase
-S, --password-script=[script]
Script to run to retrieve password
-n, --plug=[ip]
IP address or hostname of fencing device (together with --port-as-ip)
-x, --ssh
Use SSH connection (Default Value: 1)
--ssh-options=[options]
SSH options to use
-l, --username=[name]
Login name This parameter is always required.
-d, --vmware_type=[type]
Type of VMware to connect (Default Value: esx)
-s, --vmware-datacenter=[dc]
VMWare datacenter filter
-q, --quiet
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to
syslog.
-v, --verbose
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to
increase verbosity.
--verbose-level
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).
-D, --debug-file=[debugfile]
Write debug information to given file
-V, --version
Display version information and exit
-h, --help
Display help and exit
--delay=[seconds]
Wait X seconds before fencing is started (Default Value: 0)
--disable-timeout=[true/false]
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
--login-timeout=[seconds]
Wait X seconds for cmd prompt after login (Default Value: 5)
--port-as-ip
Make "port/plug" to be an alias to IP address
--power-timeout=[seconds]
Test X seconds for status change after ON/OFF (Default Value: 20)
--power-wait=[seconds]
Wait X seconds after issuing ON/OFF (Default Value: 0)
--shell-timeout=[seconds]
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
--retry-on=[attempts]
Count of attempts to retry power on (Default Value: 1)
--ssh-path=[path]
Path to ssh binary (Default Value: /usr/bin/ssh)
ACTIONS
on Power on machine.
off Power off machine.
reboot Reboot machine.
status This returns the status of the plug/virtual machine.
monitor
Check the health of fence device
metadata
Display the XML metadata describing this resource.
manpage
The operational behavior of this is not known.
validate-all
Validate if all required parameters are entered.
STDIN PARAMETERS
action Fencing action (Default Value: reboot)
exec Command to execute
identity_file
Identity file (private key) for SSH
inet4_only
Forces agent to use IPv4 addresses only
inet6_only
Forces agent to use IPv6 addresses only
ip IP address or hostname of fencing device Obsoletes: ipaddr
ipport TCP/UDP port to use for connection with device (Default Value: 22)
password
Login password or passphrase Obsoletes: passwd
password_script
Script to run to retrieve password Obsoletes: passwd_script
plug IP address or hostname of fencing device (together with --port-as-ip) Obsoletes:
port
ssh Use SSH connection (Default Value: 1) Obsoletes: secure
ssh_options
SSH options to use
username
Login name This parameter is always required. Obsoletes: login
vmware_type
Type of VMware to connect (Default Value: esx)
vmware_datacenter
VMWare datacenter filter
quiet Disable logging to stderr. Does not affect --verbose or --debug-file or logging to
syslog.
verbose
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to
increase verbosity.
verbose_level
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).
debug_file
Write debug information to given file Obsoletes: debug
version
Display version information and exit
help Display help and exit
delay Wait X seconds before fencing is started (Default Value: 0)
disable_timeout
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
login_timeout
Wait X seconds for cmd prompt after login (Default Value: 5)
port_as_ip
Make "port/plug" to be an alias to IP address
power_timeout
Test X seconds for status change after ON/OFF (Default Value: 20)
power_wait
Wait X seconds after issuing ON/OFF (Default Value: 0)
shell_timeout
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
retry_on
Count of attempts to retry power on (Default Value: 1)
ssh_path
Path to ssh binary (Default Value: /usr/bin/ssh)