FENCE_AGENT(8)

✨ NAME ✨

okay bestie, meet fence_apc_snmp — the fence agent for APC and Tripplite PDU over SNMP 💅

and also fence_tripplite_snmp — the fence agent for Tripplife over SNMP (it's a symlink, it's giving twin energy 🫶)

---

🌸 DESCRIPTION 🌸

so fence_apc_snmp is a Power Fencing agent, and she is that girl for the APC network power switch or Tripplite PDU devices. She logs into a device via SNMP and reboots a specified outlet. periodt. 🔥

She supports SNMP v1, v2c, v3 with all combinations of authenticity/privacy settings — yes, every single one, she's flexible like that 💖

The fence agent accepts options on the command line and from stdin, because she contains multitudes. Fenced sends parameters through stdin when it execs the agent. But you can also run the agent by itself with command line options — super useful for testing and for turning outlets on or off from scripts ✨

Vendor URL: http://www.apc.com 👑

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action, bestie (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 skips, no exceptions 💅
• -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 too 🫶
• -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. she's quiet but she still hears everything 🙈
• -v, --verbose — verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. stack her like a charm bracelet 💅
• --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)
• --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 💖

• on — power on machine. wake up bestie ☀️
• off — power off machine. nap time 😴
• reboot — reboot machine. the classic glow-up cycle 🔄
• 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. efficiency icon ✨
• 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, that's just what it says)
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

• 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: 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)
• 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 a whole vibe, highkey a whole reference page 🫶

and that's the whole thing, bestie!! this is the fence_apc_snmp (Fence Agent) page, dated 2009-10-20, part of the System Manager's Manual — aka FENCE_AGENT(8) 🎀 slay, go fence something responsibly 💅✨