table of contents
FENCE_AGENT(8) | System Manager's Manual | FENCE_AGENT(8) |
NAME¶
fence_gce - Fence agent for GCE (Google Cloud Engine)DESCRIPTION¶
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-guidefence_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
PARAMETERS¶
- -o, --action=[action]
- Fencing action (Default Value: reboot)
- -m, --method=[method]
- Method to fence (onoff|cycle) (Default Value: cycle)
- -n, --plug=[id]
- Physical plug number on device, UUID or identification of machine This parameter is always required.
- --zone=[name]
- Zone.
- --project=[name]
- Project ID.
- --stackdriver-logging
- Stackdriver-logging support.
- -q, --quiet
- Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
- -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 'list' operation (Default Value: ,)
- --delay=[seconds]
- Wait X seconds before fencing is started (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: 60)
- --power-wait=[seconds]
- Wait X seconds after issuing ON/OFF (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.
- manpage
- The operational behavior of this is not known.
- validate-all
- Validate if all required parameters are entered.
STDIN PARAMETERS¶
- action
- Fencing action (Default Value: reboot)
- method
- Method to fence (onoff|cycle) (Default Value: cycle)
- plug
- Physical plug number on device, UUID or identification of machine This parameter is always required. Obsoletes: port
- zone
- Zone.
- project
- Project ID.
- stackdriver_logging
- Stackdriver-logging support. Obsoletes: stackdriver-logging
- quiet
- Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
- verbose
- Verbose mode
- debug_file
- Write debug information to given file Obsoletes: debug
- version
- Display version information and exit
- help
- Display help and exit
- separator
- Separator for CSV created by 'list' operation (Default Value: ,)
- delay
- Wait X seconds before fencing is started (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: 60)
- power_wait
- Wait X seconds after issuing ON/OFF (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)
2009-10-20 | fence_gce (Fence Agent) |