.TH FENCE_AGENT 8 2009-10-20 "fence_vmware_rest (Fence Agent)"
.SH NAME
fence_vmware_rest - Fence agent for VMware REST API
.SH DESCRIPTION
.P
fence_vmware_rest is an I/O Fencing agent which can be used with VMware API to fence virtual machines.
.P
fence_vmware_rest accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_vmware_rest 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: https://www.vmware.com
.SH PARAMETERS

	
.TP
.B -o, --action=[action]
. 
Fencing action (Default Value: reboot)
	
.TP
.B -4, --inet4-only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B -6, --inet6-only
. 
Forces agent to use IPv6 addresses only
	
.TP
.B -a, --ip=[ip]
. 
IP address or hostname of fencing device This parameter is always required.
	
	
.TP
.B -u, --ipport=[port]
. 
TCP/UDP port to use for connection with device (Default Value: 80)
	
	
.TP
.B -t, --notls
. 
Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.
	
	
	
.TP
.B -p, --password=[password]
. 
Login password or passphrase
	
.TP
.B -S, --password-script=[script]
. 
Script to run to retrieve password
	
.TP
.B -n, --plug=[id]
. 
Physical plug number on device, UUID or identification of machine This parameter is always required.
	
	
.TP
.B -z, --ssl
. 
Use SSL connection with verifying certificate
	
.TP
.B --ssl-insecure
. 
Use SSL connection without verifying certificate
	
.TP
.B --ssl-secure
. 
Use SSL connection with verifying certificate
	
.TP
.B -l, --username=[name]
. 
Login name This parameter is always required.
	
.TP
.B --api-path=[path]
. 
The path part of the API URL (Default Value: /rest)
	
.TP
.B -q, --quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B -v, --verbose
. 
Verbose mode
	
	
.TP
.B -D, --debug-file=[debugfile]
. 
Write debug information to given file
	
.TP
.B -V, --version
. 
Display version information and exit
	
.TP
.B -h, --help
. 
Display help and exit
	
.TP
.B -C, --separator=[char]
. 
Separator for CSV created by 'list' operation (Default Value: ,)
	
.TP
.B --delay=[seconds]
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --login-timeout=[seconds]
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B --power-timeout=[seconds]
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B --power-wait=[seconds]
. 
Wait X seconds after issuing ON/OFF (Default Value: 1)
	
.TP
.B --shell-timeout=[seconds]
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 5)
	
.TP
.B --retry-on=[attempts]
. 
Count of attempts to retry power on (Default Value: 1)
	
.TP
.B --gnutlscli-path=[path]
. 
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

.SH ACTIONS

	
.TP
\fBon \fP
Power on machine.
	
.TP
\fBoff \fP
Power off machine.
	
.TP
\fBreboot \fP
Reboot machine.
	
.TP
\fBstatus \fP
This returns the status of the plug/virtual machine.
	
.TP
\fBlist \fP
List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
	
.TP
\fBlist-status \fP
List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
	
.TP
\fBmonitor \fP
Check the health of fence device
	
.TP
\fBmetadata \fP
Display the XML metadata describing this resource.
	
.TP
\fBmanpage \fP
 The operational behavior of this is not known.
	
.TP
\fBvalidate-all \fP
Validate if all required parameters are entered.

.SH STDIN PARAMETERS

	
.TP
.B action
. 
Fencing action (Default Value: reboot)
	
.TP
.B inet4_only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B inet6_only
. 
Forces agent to use IPv6 addresses only
	
.TP
.B ip
. 
IP address or hostname of fencing device This parameter is always required. Obsoletes: ipaddr
	
	
.TP
.B ipport
. 
TCP/UDP port to use for connection with device (Default Value: 80)
	
	
.TP
.B notls
. 
Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.
	
	
	
.TP
.B password
. 
Login password or passphrase Obsoletes: passwd
	
.TP
.B password_script
. 
Script to run to retrieve password Obsoletes: passwd_script
	
.TP
.B plug
. 
Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port
	
	
.TP
.B ssl
. 
Use SSL connection with verifying certificate
	
.TP
.B ssl_insecure
. 
Use SSL connection without verifying certificate
	
.TP
.B ssl_secure
. 
Use SSL connection with verifying certificate
	
.TP
.B username
. 
Login name This parameter is always required. Obsoletes: login
	
.TP
.B api_path
. 
The path part of the API URL (Default Value: /rest)
	
.TP
.B quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B verbose
. 
Verbose mode
	
	
.TP
.B debug_file
. 
Write debug information to given file Obsoletes: debug
	
.TP
.B version
. 
Display version information and exit
	
.TP
.B help
. 
Display help and exit
	
.TP
.B separator
. 
Separator for CSV created by 'list' operation (Default Value: ,)
	
.TP
.B delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B login_timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B power_timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B power_wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 1)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 5)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)
	
.TP
.B gnutlscli_path
. 
Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)