FENCE_AGENT(8)

💖 fence_emerson(8) — the FENCE_AGENT manual, but make it make sense 💖

okay bestie, sit down, hydrate, and let me tell you about fence_emerson, a page from the System Manager's Manual (yes, section 8, the big-kid section 🫶).

---

✨ NAME ✨

fence_emerson — the fence agent for Emerson, over SNMP. that's the whole vibe. 💅

---

🌸 DESCRIPTION 🌸

fence_emerson is a Power Fencing agent and it works with MPX and MPH2 managed rack PDU. that's it, that's the job. 🔥

here's the part that's actually important though, so listen up: the fence agent takes options on the command line and from stdin. when fenced execs the agent, it sends the parameters through stdin, no cap. but you can also just run the agent by itself with command line options — which is genuinely so useful, because it means you can test stuff and turn outlets on or off from scripts. icon status fr. ⭐

vendor URL: http://www.emersonnetworkpower.com — go say hi, they're the ones who made the thing. 🌈

---

🎀 PARAMETERS 🎀

okay this is the big list, don't panic, we're going through every single one together, bestie. 💜

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -c, --community=[community] — sets the community string.
• -a, --ip=[ip] — IP address or hostname of the fencing device. this parameter is always required. like, always always. 😤
• -u, --ipport=[port] — TCP/UDP port to use for the connection with the device. (Default Value: 161)
• -p, --password=[password] — login password or passphrase.
• -S, --password-script=[script] — script to run to retrieve the password.
• -n, --plug=[id] — physical plug number on the device, UUID, or identification of the machine. this parameter is always required too. both of them. required. periodt. 👑
• -b, --snmp-auth-prot=[prot] — set the authentication protocol (MD5|SHA).
• -P, --snmp-priv-passwd=[pass] — set the privacy protocol password.
• -R, --snmp-priv-passwd-script — script to run to retrieve the privacy password.
• -B, --snmp-priv-prot=[prot] — set the privacy protocol (DES|AES).
• -E, --snmp-sec-level=[level] — set the security level (noAuthNoPriv|authNoPriv|authPriv).
• -d, --snmp-version=[version] — specifies which SNMP version to use (1|2c|3).
• -l, --username=[name] — login name.
• -q, --quiet — disable logging to stderr. and no, it does not affect --verbose or --debug-file or logging to syslog. read it again. it doesn't. 🙈
• -v, --verbose — verbose mode. you can stack multiple -v flags on the command line (like, -vvv) to crank the verbosity up. the way that just keeps going. 📈
• --verbose-level — level of debugging detail in the output. it defaults to however many --verbose flags you put 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 the given file.
• -V, --version — display version information and exit.
• -h, --help — display help and exit. we love a helpful queen. 🫶
• --plug-separator=[char] — separator for the plug parameter when you're specifying more than 1 plug. (Default Value: ,)
• -C, --separator=[char] — separator for the CSV created by the 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 the cmd prompt after login. (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for a 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 the cmd prompt after issuing a 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)
• --snmpget-path=[path] — path to the snmpget binary. (Default Value: /usr/bin/snmpget)
• --snmpset-path=[path] — path to the snmpset binary. (Default Value: /usr/bin/snmpset)
• --snmpwalk-path=[path] — path to the snmpwalk binary. (Default Value: /usr/bin/snmpwalk)

---

💅 ACTIONS 💅

the moves you can pull. each one, explained, no gatekeeping:

• on — power on the machine. ✨
• off — power off the machine. 💀
• reboot — reboot the machine. 🔄
• status — returns the status of the plug / virtual machine.
• list — list the available plugs with aliases / virtual machines, if there's support for more than one device. otherwise it returns N/A. not sorry about it.
• list-status — list the available plugs with aliases / virtual machines and their power state, if it can be obtained without additional commands. two for one, we love efficiency. 🍓
• monitor — check the health of the fence device. wellness check, but for hardware. 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. yeah. that's genuinely what it says. we don't know. mystery icon. 🧚
• validate-all — validate if all the required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same crew as above, but the names go full snake_case because that's how stdin likes it. also some of these have obsoletes, so heads up:

• action — fencing action (Default Value: reboot)
• community — set the community string
• ip — IP address or hostname of the fencing device. this parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for the connection with the device (Default Value: 161)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve the password. Obsoletes: passwd_script
• plug — physical plug number on the device, UUID, or identification of the machine. this parameter is always required. Obsoletes: port
• snmp_auth_prot — set the authentication protocol (MD5|SHA)
• snmp_priv_passwd — set the privacy protocol password
• snmp_priv_passwd_script — script to run to retrieve the privacy password
• snmp_priv_prot — set the privacy protocol (DES|AES)
• snmp_sec_level — set the security level (noAuthNoPriv|authNoPriv|authPriv)
• snmp_version — specifies which SNMP version to use (1|2c|3)
• 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 the given file. Obsoletes: debug
• version — display version information and exit
• help — display help and exit
• plug_separator — separator for the plug parameter when specifying more than 1 plug (Default Value: ,)
• separator — separator for the CSV created by the 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: 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)
• snmpget_path — path to snmpget binary (Default Value: /usr/bin/snmpget)
• snmpset_path — path to snmpset binary (Default Value: /usr/bin/snmpset)
• snmpwalk_path — path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)

lowkey if you're scripting any of this, double-check you're using the stdin names and not the CLI flags — they're the same settings, different spelling, and the obsoletes list above is your cheat sheet. 🫡

---

and that's the whole page, bestie, you ate it. 💖 this was the fence_emerson Fence Agent manual, dated 2009-10-20, served up from the FENCE_AGENT(8) corner of the System Manager's Manual. go fence something responsibly. mwah. 💅✨🌸