fence_vmware_soap (8) Linux Manual Page
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 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
-u, –ipport=[port]- TCP/UDP port to use for connection with device (Default Value: 80)
-t, –notls- Disable TLS negotiation, force SSL 3.0
–ssl-secure- SSL connection with verifying fence device’s certificate
-n, –plug=[id]- Physical plug number, name of virtual machine or UUID This parameter is always required.
-6, –inet6-only- Forces agent to use IPv6 addresses only
-a, –ip=[ip]- IP Address or Hostname This parameter is always required.
-4, –inet4-only- Forces agent to use IPv4 addresses only
-S, –password-script=[script]- Script to retrieve password
-p, –password=[password]- Login password or passphrase
-z, –ssl- SSL connection
–ssl-insecure- SSL connection without verifying fence device’s certificate
-o, –action=[action]- Fencing Action (Default Value: reboot)
-l, –username=[name]- Login Name This parameter is always required.
-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-wait=[seconds]- Wait X seconds after issuing ON/OFF (Default Value: 0)
–login-timeout=[seconds]- Wait X seconds for cmd prompt after login (Default Value: 5)
–power-timeout=[seconds]- Test X seconds for status change after ON/OFF (Default Value: 20)
–delay=[seconds]- Wait X seconds before fencing is started (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)
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.
list-status- List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
monitor- Check the health of fence device
metadata- Display the XML metadata describing this resource.
Stdin Parameters
ipport- TCP/UDP port to use for connection with device (Default Value: 80)
notls- Disable TLS negotiation, force SSL 3.0
ssl_secure- SSL connection with verifying fence device’s certificate
port- Physical plug number, name of virtual machine or UUID This parameter is always required.
inet6_only- Forces agent to use IPv6 addresses only
ipaddr- IP Address or Hostname This parameter is always required.
inet4_only- Forces agent to use IPv4 addresses only
passwd_script- Script to retrieve password
passwd- Login password or passphrase
ssl- SSL connection
ssl_insecure- SSL connection without verifying fence device’s certificate
action- Fencing Action (Default Value: reboot)
login- Login Name This parameter is always required.
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_wait- Wait X seconds after issuing ON/OFF (Default Value: 0)
login_timeout- Wait X seconds for cmd prompt after login (Default Value: 5)
power_timeout- Test X seconds for status change after ON/OFF (Default Value: 20)
delay- Wait X seconds before fencing is started (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)