NAME
fence_vmware - I/O Fencing agent for VMware virtual machines
SYNOPSIS
fence_vmware [OPTION]...
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.
HOST NAME/IP ADDRESS SPECIFICATION
Host name can include port in standard notation host_name:port.
Specifying port isn’t mandatory, but you must use it, if you try use
this agent against VMware server 2.0.0 with default options, where
https console runs on port 8333. In case of ESX/ESXi, you don’t need to
specify port, because default configuration runs https on standard
(443) port.
OPTIONS
-a IPaddress
IP address or hostname of ESX/ESXi host machine. See (see HOST
NAME/IP ADDRESS SPECIFICATION above).
-h Print out a help message describing available options, then
exit.
-l login
Login name to VMware administration console.
-o action
The action required. This can be reboot (default), status, off,
on, list or monitor.
-p password
Password for login for VMware administration console.
-S script
Script to run to retrieve password for VMware administration
console.
-n name
Name of virtual machine to fence (ie. "test" for ESX with VI
Perl or "[datastore1] test/test.vmx" for Server 2) which is
returned by list command.
-e command
Location of fence_vmware_helper or vmrun command. Default is
fence_vmware_helper or /usr/bin/vmrun, but if you are using
nonstandard location, you may find this switch useful.
-d type
Type of VMware product you are trying to connect. This can be
esx, server1 or server2.
-s datacenter
VMware datacenter to use. This can be used to filter guests to
operate. Without specifying, guests from all datacenters will be
used. Parameter can be used only with VI Perl helper (type is
esx).
-v Verbose. Record session to stdout, or debug file if specified
(see -D).
-D Specifies file, where will be written debug messages from
session.
-V Print out a version message, then exit.
STDIN PARAMETERS
agent = < param >
This option is used by fence_node(8) and is ignored by
fence_vmware.
ipaddr = < hostname | ip >
IP address or hostname of ESX/ESXi host machine. See (see HOST
NAME/IP ADDRESS SPECIFICATION above).
login = < param >
Login name to VMware administration console.
option = < param >
The action required. This can be reboot (default), status, off,
on, list or monitor.
passwd = < param >
Password for login for VMware administration console.
passwd_script = < param >
Script to run to retrieve password for VMware administration
console.
port = < param >
Name of virtual machine to fence (ie. "test" for ESX with VI
Perl or "[datastore1] test/test.vmx" for Server 2) which is
returned by list command.
exec = < param >
Location of fence_vmware_helper or vmrun command. Default is
fence_vmware_helper or /usr/bin/vmrun, but if you are using
nonstandard location, you may find this switch useful.
vmware_type = < param >
Type of VMware product you are trying to connect. This can be
esx, server1 or server2.
vmware_datacenter = < param >
VMware datacenter to use. This can be used to filter guests to
operate. Without specifying, guests from all datacenters will be
used. Parameter can be used only with VI Perl helper (type is
esx).
verbose = < param >
Verbose. Record session to stdout, or debug file if specified
(see debug).
debug = < param >
Specifies file, where will be written debug messages from
session.
SEE ALSO
fence(8), fence_node(8)
fence_vmware(8)