FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

okay bestie, this is a page from the System Manager's Manual and it's literally all about fence_ecloud, the fence agent. grab a snack, we're doing this 💅

---

✨ NAME ✨

fence_ecloud — the Fence Agent for ANS eCloud. that's the whole name, iconic, no notes 🎀

---

🌸 DESCRIPTION 🌸

fence_ecloud is a Power Fencing agent for use with the ANS eCloud platform, and the way that it's compatible with eCloud VPC and eCloud v1?? we love range 🦋

so here's the vibe: the fence agent takes options on the command line, and it also takes them 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 so useful for testing and for turning outlets on or off from scripts 🔥

Vendor URL: https://www.ans.co.uk — go say hi 💖

---

💅 PARAMETERS 💅

okay this is the big one, every single flag, no skipping, periodt ✨

• --apikey=[key] — API Key. this one is always required, like always always, don't forget it bestie 😭
• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -n, --plug=[instance] — Instance ID (VPC) or server ID (v1). this one is always required too 🫶
• -q, --quiet — Disable logging to stderr. note: it does not affect --verbose or --debug-file or logging to syslog. okayyy 💜
• -v, --verbose — Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. stack 'em like bracelets ✨
• --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: 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 it can actually do, and honestly? each one ate 💅

• 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. no cap, nobody knows what this one does 😭
• validate-all — Validate if all required parameters are entered. ✅

---

🦋 STDIN PARAMETERS 🦋

same energy, different delivery method — these are the ones that come in through stdin (hi Fenced 🫶). heads up: the names use underscores here instead of dashes, so keep that in mind bestie ✨

• apikey — API Key. always required 💖
• action — Fencing action. (Default Value: reboot)
• plug — Instance ID (VPC) or server ID (v1). 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: 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)

---

and that's the whole page, bestie!! 🎀 this one's from fence_ecloud (Fence Agent), dated 2009-10-20, living under FENCE_AGENT(8) — she's been around a minute and she's still serving 💖✨