FENCE_AGENT(8)

💖 FENCE_AGENT(8) — the fence_hetzner_cloud glow-up 💖

okay bestie, so this is fence_hetzner_cloud, and it lives in section 8 of the System Manager's Manual. Think of it as the group chat for your Hetzner Cloud servers where the only messages are "you're up" and "you're down". Let's get into it 🫶

✨ NAME ✨

fence_hetzner_cloud — the fence agent for Hetzner Cloud, no cap 💅

🌸 DESCRIPTION 🌸

fence_hetzner_cloud is a Power Fencing agent that talks to Hetzner Cloud via its API to fence cloud servers. Like, it's the bouncer at the club door but for your VMs 🔥

The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. But also — plot twist — the agent can be run by itself with command line options. That's lowkey iconic for testing and for turning outlets on or off from scripts ✨

Vendor URL: https://www.hetzner.com

🎀 PARAMETERS 🎀

• --api-token=[token] — API token. This parameter is always required, periodt 🔑
• --api-url=[url] — API URL (Default Value: https://api.hetzner.cloud/v1) 🌐
• -o, --action=[action] — Fencing action (Default Value: reboot) 🎬
• -n, --plug=[id] — Physical plug number on device, UUID or identification of machine. This parameter is always required 🫶
• -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: 20) ⚡
• --power-wait=[seconds] — Wait X seconds after issuing ON/OFF (Default Value: 5) 🕐
• --shell-timeout=[seconds] — Wait X seconds for cmd prompt after issuing command (Default Value: 5) 💻
• --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 🤷
• validate-all — Validate if all required parameters are entered ✅

🦋 STDIN PARAMETERS 🦋

• api_token — API token. This parameter is always required 🔑
• api_url — API URL (Default Value: https://api.hetzner.cloud/v1) 🌐
• action — Fencing action (Default Value: reboot) 🎬
• plug — Physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port 🫶
• 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: 20) ⚡
• power_wait — Wait X seconds after issuing ON/OFF (Default Value: 5) 🕐
• shell_timeout — Wait X seconds for cmd prompt after issuing command (Default Value: 5) 💻
• 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) 🔁

ngl bestie, --api-token and -n/--plug are the two non-negotiables here. Everything else has a default and will simply vibe. 🫶

okay that's the whole page!! this one is fence_hetzner_cloud (Fence Agent) and the page itself is dated 2009-10-20 — yeah it's been serving looks since 2009, and it's still FENCE_AGENT(8) coded. slay, mwah 💅💖✨