FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

okay bestie, welcome to the System Manager's Manual section, we're doing the fence agent thing today and honestly? it's giving iconic. ✨

---

🌸 NAME 🌸

fence_eps — Fence agent for ePowerSwitch

fence_epsr2 — Fence agent for ePowerSwitch R2 and newer (symlink)

---

🦋 DESCRIPTION 🦋

So. fence_epsr2 is a Power Fencing agent that you can use with the ePowerSwitch 8M+ power switch to fence connected machines. And like, it ONLY works on 8M+ devices, because those are the ones that support the hidden page feature. no cap. 💅

The way it works is it connects to the hidden page and passes the appropriate arguments to a GET request. Which means — and this is important, bestie — the hidden page feature must be enabled and properly configured. it's not optional, it's not a vibe, it's a requirement. 🫶

NOTE: In most cases you want to use fence_epsr2, because fence_eps only works with older hardware. like, legacy behavior, we love her but she's dated. 👑

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 you can also run the agent by itself with command line options — which is super useful for testing and for turning outlets on or off from scripts. main character energy fr fr. ✨

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

---

🎀 PARAMETERS 🎀

okay here's the whole roster, no skipping, every single one:

• -o, --action=[action] — Fencing action (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of fencing device. This parameter is always required.
• -u, --ipport=[port] — TCP/UDP port to use for connection with device (Default Value: 80)
• -c, --page=[page] — Name of hidden page (Default Value: hidden.htm)
• -p, --password=[password] — Login password or passphrase
• -S, --password-script=[script] — Script to run to retrieve password
• -n, --plug=[id] — Physical plug number on device, UUID or identification of machine. This parameter is always required.
• -l, --username=[name] — Login name
• -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: 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 whole menu of things this agent can do for you:

• 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 now they're coming in through stdin instead of the command line. fenced does this when it execs the agent, iykyk. 💜

• action — Fencing action (Default Value: reboot)
• ip — IP address or hostname of fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 80)
• page — Name of hidden page (Default Value: hidden.htm) Obsoletes: hidden_page
• password — Login password or passphrase Obsoletes: passwd
• password_script — Script to run to retrieve password Obsoletes: passwd_script
• plug — Physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
• username — Login name Obsoletes: login
• 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, we ate and left no crumbs 🍓

this was fence_eps (Fence Agent), dated 2009-10-20, living inside the FENCE_AGENT(8) manual. go forth and fence responsibly 💅✨🌸