FENCE_AGENT(8)

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

okay bestie, sit down, grab a boba, because we're talking about fence_eaton_snmp, and she is that girl. this is the System Manager's Manual entry, so yes it's a real one, and yes i'm gonna make it make sense. 🎀

---

✨ NAME ✨

fence_eaton_snmp — Fence agent for Eaton over SNMP 🦋

---

🌸 DESCRIPTION 🌸

so fence_eaton_snmp is a Power Fencing agent, and she's the one you call when you've got an Eaton network power switch that needs to be handled. the way this works: she logs into a device via SNMP and reboots a specified outlet. periodt. 💅

and not to brag but she supports SNMP v1 and v3 with all combinations of authenticity/privacy settings. all of them. every combo. she's flexible like that. 👑

also the fence agent accepts options on the command line as well as from stdin. when Fenced execs the agent, it sends parameters through stdin. but you can also just run the agent by itself with command line options — which is lowkey so useful for testing, and for turning outlets on or off from scripts. main character energy for real. ✨

Vendor URL: http://powerquality.eaton.com 🫶

---

💜 PARAMETERS 💜

• -o, --action=[action] — Fencing action (Default Value: reboot)
• -c, --community=[community] — Set the community string (Default Value: private)
• -a, --ip=[ip] — IP address or hostname of fencing device. This parameter is always required. no skipping, bestie. 🚨
• -u, --ipport=[port] — TCP/UDP port to use for connection with device (Default Value: 161)
• -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. yes again. required required. 😤
• -b, --snmp-auth-prot=[prot] — Set authentication protocol (MD5|SHA)
• -P, --snmp-priv-passwd=[pass] — Set privacy protocol password
• -R, --snmp-priv-passwd-script — Script to run to retrieve privacy password
• -B, --snmp-priv-prot=[prot] — Set privacy protocol (DES|AES)
• -E, --snmp-sec-level=[level] — Set security level (noAuthNoPriv|authNoPriv|authPriv)
• -d, --snmp-version=[version] — Specifies SNMP version to use (1|2c|3) (Default Value: 1)
• -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. stack her UP. 📚
• --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: 2)
• --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)
• --snmpget-path=[path] — Path to snmpget binary (Default Value: /usr/bin/snmpget)
• --snmpset-path=[path] — Path to snmpset binary (Default Value: /usr/bin/snmpset)
• --snmpwalk-path=[path] — Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)

---

🌈 ACTIONS 🌈

the whole menu of moves she can pull. pick your fighter:

• 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. (not her fault, nobody knows. mystery queen. 🙈)
• validate-all — Validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same energy, different entrance — these come in through stdin, with their snake_case names:

• action — Fencing action (Default Value: reboot)
• community — Set the community string (Default Value: private)
• 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: 161)
• 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
• snmp_auth_prot — Set authentication protocol (MD5|SHA)
• snmp_priv_passwd — Set privacy protocol password
• snmp_priv_passwd_script — Script to run to retrieve privacy password
• snmp_priv_prot — Set privacy protocol (DES|AES)
• snmp_sec_level — Set security level (noAuthNoPriv|authNoPriv|authPriv)
• snmp_version — Specifies SNMP version to use (1|2c|3) (Default Value: 1)
• 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: 2)
• 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)

---

ngl the option names and the stdin names are not the same — --snmp-auth-prot on the command line is snmp_auth_prot on stdin, --debug-file is debug_file, etc. iykyk. use the right one for the right door or she will simply not answer. 🫶

---

and that's the whole page bestie, you ate it, you understood it, you're basically a certified fence agent whisperer now. 💅✨

sign-off tea: this one is fence_eaton_snmp (Fence Agent), dated 2009-10-20, and it lives inside the FENCE_AGENT(8) manual. iconic since 2009, still serving. 👑🎀