FENCE_AGENT(8)

✨ NAME ✨

okay bestie, gather round 💖 this is the fence_apc_snmp page — a Fence agent for APC and Tripplite PDU over SNMP. Also known as fence_tripplite_snmp, which is literally just a symlink to it, no cap. It's filed under the manual for FENCE_AGENT, section 8 (system manager's manual, iykyk) 🎀

🌸 DESCRIPTION 🌸

so fence_tripplite_snmp is a Power Fencing agent you can use with the APC network power switch or Tripplite PDU devices. it logs into a device via SNMP and reboots a specified outlet — like, it just goes in and yanks the plug, respectfully 💅

it supports SNMP v1, v2c, and v3, with all combinations of authenticity/privacy settings. all of them. every combo. she's versatile like that ✨

this fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. and you can also just run the agent by itself with command line options — which is genuinely 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 you want (Default Value: reboot)
• -c, --community=[community] — sets the community string (Default Value: private)
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required. periodt.
• -u, --ipport=[port] — the TCP/UDP port used to connect to the device (Default Value: 161)
• -p, --password=[password] — login password or passphrase 🔐
• -S, --password-script=[script] — a script you 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. fr fr.
• -b, --snmp-auth-prot=[prot] — sets the authentication protocol (MD5|SHA)
• -P, --snmp-priv-passwd=[pass] — sets the privacy protocol password
• -R, --snmp-priv-passwd-script — a script to run to retrieve the privacy password
• -B, --snmp-priv-prot=[prot] — sets the privacy protocol (DES|AES)
• -E, --snmp-sec-level=[level] — sets the security level (noAuthNoPriv|authNoPriv|authPriv)
• -d, --snmp-version=[version] — which SNMP version to use (1|2c|3) (Default Value: 1)
• -l, --username=[name] — login name
• -q, --quiet — disables logging to stderr. doesn't touch --verbose or --debug-file or logging to syslog, so those still do their thing 💅
• -v, --verbose — verbose mode. you can stack multiple -v flags on the command line (like -vvv) to crank up the verbosity 🔥
• --verbose-level — level of debugging detail in the output. 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 info into the given file
• -V, --version — display version information and exit
• -h, --help — display help and exit
• --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: 0)
• --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] — how many 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 💖

• 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 available plugs with aliases/virtual machines, if there's support for more than 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 the fence device 🩺
• metadata — display the XML metadata describing this resource
• manpage — the operational behavior of this is not known 🙈 (we're being honest!)
• validate-all — validate whether all required parameters are entered

🦋 STDIN PARAMETERS 🦋

• action — fencing action (Default Value: reboot)
• community — sets the community string (Default Value: private)
• ip — IP address or hostname of the fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port used for 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 — sets the authentication protocol (MD5|SHA)
• snmp_priv_passwd — sets the privacy protocol password
• snmp_priv_passwd_script — script to run to retrieve the privacy password
• snmp_priv_prot — sets the privacy protocol (DES|AES)
• snmp_sec_level — sets the security level (noAuthNoPriv|authNoPriv|authPriv)
• snmp_version — which SNMP version to use (1|2c|3) (Default Value: 1)
• username — login name. Obsoletes: login
• quiet — disables logging to stderr. doesn't 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 the 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 the cmd prompt after login (Default Value: 5)
• power_timeout — test X seconds for a 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 the cmd prompt after issuing a 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 the snmpget binary (Default Value: /usr/bin/snmpget)
• snmpset_path — path to the snmpset binary (Default Value: /usr/bin/snmpset)
• snmpwalk_path — path to the snmpwalk binary (Default Value: /usr/bin/snmpwalk)

okay that's the whole page bestie, you ate it up 💅🌸 this was the fence_apc_snmp (Fence Agent) page, dated 2009-10-20, from the FENCE_AGENT(8) manual — slay, go reboot an outlet responsibly 🫶✨