FENCE_AGENT(8)

💖 fence_gce — bestie edition 💖

okay so this is fence_gce(8), a manual page from the System Manager's Manual, and honestly? it's giving "power fencing but make it Google Cloud." sit down, grab a strawberry 🍓, and let's get into it.

---

✨ NAME ✨

fence_gce — the fence agent for GCE (Google Cloud Engine). no cap, that's literally the whole name section.

---

🦋 DESCRIPTION 🦋

so fence_gce is a Power Fencing agent for GCE (Google Cloud Engine). it uses the googleapiclient library to connect to GCE, and like — that library can be configured with the Google SDK CLI, or by running:

gcloud auth application-default login

and if you need instructions, the actual docs live at https://cloud.google.com/compute/docs/tutorials/python-guide. go read them, i'll wait 💅

the fence agent accepts options on the command line as well as from stdin. why stdin, you ask? because Fenced sends parameters through stdin when it execs the agent. and the agent can also be run by itself with command line options — which is lowkey so useful for testing, and for turning outlets on or off from scripts. main character energy fr.

Vendor URL: http://cloud.google.com

---

🌸 PARAMETERS 🌸

here's the whole lineup, every single one, no skips:

• -o, --action=[action] — the 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. periodt.
• --zone=[name] — zone.
• --project=[name] — project ID.
• --stackdriver-logging — stackdriver-logging support.
• --baremetalsolution — if enabled this is a bare metal offering from google.
• --apitimeout=[seconds] — timeout in seconds to use for API calls, default is 60. (Default Value: 60)
• --retries=[retries] — number of retries on failure for API calls, default is 3. (Default Value: 3)
• --retrysleep=[seconds] — time to sleep in seconds between API retries, default is 5. (Default Value: 5)
• --serviceaccount=[filename] — service Account to use for authentication to the google cloud APIs.
• --plugzonemap=[plugzonemap] — comma separated zone map when fencing multiple plugs.
• --proxyhost=[proxy_host] — if a proxy is used for internet access, the proxy host should be specified.
• --proxyport=[proxy_port] — if a proxy is used for internet access, the proxy port should be specified.
• --earlyexit — if an existing reset operation is detected, the fence agent will return before the operation completes with a 0 return code.
• --warntimeout=[warn_timeout] — if the operation is not completed within the timeout, the cluster operations are allowed to continue.
• --errortimeout=[error_timeout] — if the operation is not completed within the timeout, cluster is notified of the operation failure.
• --runonwarn=[run_on_warn] — if a timeout would occur while running the agent, then the supplied command is run.
• --runonfail=[run_on_fail] — if a failure would occur while running the agent, then the supplied command is run.
• -q, --quiet — disable logging to stderr. does not affect --verbose or --debug-file or logging to syslog.
• -v, --verbose — verbose mode. multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
• --verbose-level — level of debugging detail in output. defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
• -D, --debug-file=[debugfile] — write debug information to given file.
• -V, --version — display version information and exit.
• -h, --help — display help and exit.
• --plug-separator=[char] — separator for plug parameter when specifying more than 1 plug. (Default Value: ,)
• -C, --separator=[char] — separator for CSV created by list operation. (Default Value: ,)
• --delay=[seconds] — wait X seconds before fencing is started. (Default Value: 0)
• --disable-timeout=[true/false] — disable timeout (true/false) (default: true when run from Pacemaker 2.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)
• --stonith-status-sleep=[seconds] — sleep X seconds between status calls during a STONITH action. (Default Value: 1)
• --retry-on=[attempts] — count of attempts to retry power on. (Default Value: 1)

---

👑 ACTIONS 👑

the things this agent can do:

• 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 🌈

same energy, but these ones come in through stdin (Fenced does this when it execs the agent). notice a bunch of them are the underscore versions of the flags above 🫶

• 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
• baremetalsolution — if enabled this is a bare metal offering from google.
• apitimeout — timeout in seconds to use for API calls, default is 60. (Default Value: 60)
• retries — number of retries on failure for API calls, default is 3. (Default Value: 3)
• retrysleep — time to sleep in seconds between API retries, default is 5. (Default Value: 5)
• serviceaccount — service Account to use for authentication to the google cloud APIs.
• plugzonemap — comma separated zone map when fencing multiple plugs.
• proxyhost — if a proxy is used for internet access, the proxy host should be specified.
• proxyport — if a proxy is used for internet access, the proxy port should be specified.
• earlyexit — if an existing reset operation is detected, the fence agent will return before the operation completes with a 0 return code.
• warntimeout — if the operation is not completed within the timeout, the cluster operations are allowed to continue.
• errortimeout — if the operation is not completed within the timeout, cluster is notified of the operation failure.
• runonwarn — if a timeout would occur while running the agent, then the supplied command is run.
• runonfail — if a failure would occur while running the agent, then the supplied command is run.
• quiet — disable logging to stderr. does not affect --verbose or --debug-file or logging to syslog.
• verbose — verbose mode. multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
• verbose_level — level of debugging detail in output. defaults to the number of --verbose flags specified on the command line, or to 1 if verbose=1 in a stonith device configuration (i.e., on stdin).
• debug_file — write debug information to given file. Obsoletes: debug
• version — display version information and exit.
• help — display help and exit.
• plug_separator — separator for plug parameter when specifying more than 1 plug. (Default Value: ,)
• separator — separator for CSV created by list operation. (Default Value: ,)
• delay — wait X seconds before fencing is started. (Default Value: 0)
• disable_timeout — disable timeout (true/false) (default: true when run from Pacemaker 2.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)
• stonith_status_sleep — sleep X seconds between status calls during a STONITH action. (Default Value: 1)
• retry_on — count of attempts to retry power on. (Default Value: 1)

---

aaaand that's the whole page, bestie 💖 this one's fence_gce (Fence Agent), dated 2009-10-20, from the FENCE_AGENT(8) manual. slay, go fence something responsibly ✨🎀