FENCE_AGENT(8) FENCE_AGENT(8)

NAME fence_vmware_soap - Fence agent for VMWare over SOAP API

DESCRIPTION fence_vmware_soap is an I/O Fencing agent which can be used with the virtual machines managed by VMWare products that have SOAP API v4.1+.

Name of virtual machine (-n / port) has to be used in inventory path format (e.g. /datacenter/vm/Discovered virtual machine/myMachine). In the cases when name of yours VM is unique you can use it instead. Alternatively you can always use UUID (-U / uuid) to access virtual machine.

fence_vmware_soap accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_vmware_soap 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)

-a, --ip=<ip> IP Address or Hostname This parameter is always required.

-l, --username=<name> Login Name This parameter is always required.

-p, --password=<password> Login password or passphrase

-S, --password-script=<script> Script to retrieve password

-z, --ssl SSL connection

-n, --plug=<id> Physical plug number or name of virtual machine This parameter is always required.

-U, --uuid The UUID of the virtual machine to fence.

-u, --ipport=<port> TCP port to use for connection with device

-v, --verbose Verbose mode

-D, --debug-file=<debugfile> Write debug information to given file

-V, --version Display version information and exit

-h, --help Display help and exit

-C, --separator=<char> Separator for CSV created by operation list (Default Value: ,)

--power-timeout Test X seconds for status change after ON/OFF (Default Value: 20)

--shell-timeout Wait X seconds for cmd prompt after issuing command (Default Value: 3)

--login-timeout Wait X seconds for cmd prompt after login (Default Value: 5)

--power-wait Wait X seconds after issuing ON/OFF (Default Value: 0)

--delay Wait X seconds before fencing is started (Default Value: 0)

--retry-on Count of attempts to retry power on (Default Value: 1)

ACTIONS

on Power on machine.

off Power off machine.

reboot Reboot machine.

status This returns the status of the plug/virtual machine.

list List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.

monitor Check if fencing device is running. List available plugs/virtual machines or get status of machine (if it does not support more).

metadata Display the XML metadata describing this resource.

STDIN PARAMETERS

action Fencing Action (Default Value: reboot)

ipaddr IP Address or Hostname This parameter is always required.

login Login Name This parameter is always required.

passwd Login password or passphrase

passwd_script Script to retrieve password

ssl SSL connection

port Physical plug number or name of virtual machine This parameter is always required.

uuid The UUID of the virtual machine to fence.

ipport TCP port to use for connection with device

verbose Verbose mode

debug Write debug information to given file

version Display version information and exit

help Display help and exit

separator Separator for CSV created by operation list (Default Value: ,)

power_timeout Test X seconds for status change after ON/OFF (Default Value: 20)

shell_timeout Wait X seconds for cmd prompt after issuing command (Default Value: 3)

login_timeout Wait X seconds for cmd prompt after login (Default Value: 5)

power_wait Wait X seconds after issuing ON/OFF (Default Value: 0)

delay Wait X seconds before fencing is started (Default Value: 0)

retry_on Count of attempts to retry power on (Default Value: 1)

fence_vmware_soap (Fence Agent) 2009-10-20 FENCE_AGENT(8)