Scroll to navigation

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

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

Fencing Action (Default Value: reboot)
Command to execute
Identity file 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 This parameter is always required.
TCP/UDP port to use for connection with device (Default Value: 22)
Login Name This parameter is always required.
Login password or passphrase
Script to retrieve password
SSH connection (Default Value: 1)
SSH options to use
Type of VMware to connect (Default Value: esx)
Show only machines in specified datacenter
Verbose mode
Write debug information to given file
Display version information and exit
Display help and exit
Wait X seconds before fencing is started (Default Value: 0)
Wait X seconds for cmd prompt after login (Default Value: 5)
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)
Count of attempts to retry power on (Default Value: 1)
Path to ssh binary (Default Value: /usr/bin/ssh)

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.

STDIN PARAMETERS

Fencing Action (Default Value: reboot)
Command to execute
Identity file for ssh
Forces agent to use IPv4 addresses only
Forces agent to use IPv6 addresses only
IP Address or Hostname This parameter is always required.
TCP/UDP port to use for connection with device (Default Value: 22)
Login Name This parameter is always required.
Login password or passphrase
Script to retrieve password
SSH connection (Default Value: 1)
SSH options to use
Type of VMware to connect (Default Value: esx)
Show only machines in specified datacenter
Verbose mode
Write debug information to given file
Display version information and exit
Display help and exit
Wait X seconds before fencing is started (Default Value: 0)
Wait X seconds for cmd prompt after login (Default Value: 5)
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)
Count of attempts to retry power on (Default Value: 1)
Path to ssh binary (Default Value: /usr/bin/ssh)
2009-10-20 fence_vmware (Fence Agent)