.TH FENCE_AGENT 8 2009-10-20 "fence_gce (Fence Agent)"
.SH NAME
fence_gce - Fence agent for GCE (Google Cloud Engine)
.SH DESCRIPTION
.P
fence_gce is an I/O Fencing agent for GCE (Google Cloud Engine). It uses the googleapiclient library to connect to GCE.
googleapiclient can be configured with Google SDK CLI or by executing 'gcloud auth application-default login'.
For instructions see: https://cloud.google.com/compute/docs/tutorials/python-guide
.P
fence_gce accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_gce 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://cloud.google.com
.SH PARAMETERS

	
.TP
.B -o, --action=[action]
. 
Fencing action (Default Value: reboot)
	
.TP
.B -m, --method=[method]
. 
Method to fence (onoff|cycle) (Default Value: cycle)
	
.TP
.B -n, --plug=[id]
. 
Physical plug number on device, UUID or identification of machine This parameter is always required.
	
	
.TP
.B --zone=[name]
. 
Zone.
	
.TP
.B --project=[name]
. 
Project ID.
	
	
.TP
.B --stackdriver-logging
. 
Stackdriver-logging support.
	
.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: 60)
	
.TP
.B --power-wait=[seconds]
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B --shell-timeout=[seconds]
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B --retry-on=[attempts]
. 
Count of attempts to retry power on (Default Value: 1)

.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 method
. 
Method to fence (onoff|cycle) (Default Value: cycle)
	
.TP
.B plug
. 
Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port
	
	
.TP
.B zone
. 
Zone.
	
.TP
.B project
. 
Project ID.
	
	
.TP
.B stackdriver_logging
. 
Stackdriver-logging support. Obsoletes: stackdriver-logging
	
.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: 60)
	
.TP
.B power_wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)