FENCE_AGENT(8)

💅 FENCE_AGENT — the fence_aws era ✨

okay bestie, welcome to the manual page for fence_aws, and yes it lives in section 8 of the System Manager's Manual, we love a numbered section, very demure 🎀

---

🌸 NAME 🌸

fence_aws — the Fence agent for AWS (Amazon Web Services). no cap, that's literally its whole job 💖

---

✨ DESCRIPTION ✨

fence_aws is a Power Fencing agent for AWS (Amazon WebServices) 🦋 it uses the boto3 library to connect to AWS, that's the whole vibe.

so like, you can configure boto3 with the AWS CLI, or by making a ~/.aws/credentials file, whichever feels more main character to you 💅 the instructions live here:

https://boto3.readthedocs.io/en/latest/guide/quickstart.html#configuration

✨ and here's the tea: the fence agent takes options on the command line and from stdin, it's giving versatile. Fenced sends parameters through stdin when it execs the agent. but you can also run the agent all by itself with command line options — which is lowkey perfect for testing and for turning outlets on or off from scripts 🫶

Vendor URL: http://www.amazon.com

---

🎀 PARAMETERS 🎀

one bullet per flag, no skipping, we're thorough in this house 💖

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -n, --plug=[id] — physical plug number on device, UUID or identification of machine. This parameter is always required. like, always. 🙈
• -r, --region=[region] — region.
• -a, --access-key=[key] — Access Key.
• -s, --secret-key=[key] — Secret Key. 🤫
• --filter=[key=value] — filter for list-action.
• -b, --boto3_debug=[option] — Boto Lib debug. (Default Value: False)
• --skip-race-check — skip race condition check. 🏃♀️
• --skip-os-shutdown=[true|false] — use the SkipOsShutdown flag to stop the EC2 instance. (Default Value: true)
• -q, --quiet — disable logging to stderr. does not affect --verbose or --debug-file or logging to syslog, so don't get it twisted 💅
• -v, --verbose — verbose mode. multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. stack 'em like scrunchies ✨
• --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 🔥

• 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. 🙈 genuinely, we don't know, it's giving mystery.
• validate-all — validate if all required parameters are entered. ✅

---

🌈 STDIN PARAMETERS 🌈

same energy, different delivery system — these come in through stdin, bestie 🫶

• action — fencing action. (Default Value: reboot)
• plug — physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
• region — region.
• access_key — Access Key.
• secret_key — Secret Key.
• filter — filter for list-action.
• boto3_debug — Boto Lib debug. (Default Value: False)
• skip_race_check — skip race condition check.
• skip_os_shutdown — use the SkipOsShutdown flag to stop the EC2 instance. (Default Value: true)
• 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)

---

okay that's the whole page, you ate that, periodt. 💖✨

this iconic little number is fence_aws (Fence Agent), and it's been out here since 2009-10-20 🎂 iconic behavior, honestly. now go fence something, bestie 🦋👑