FENCE_AGENT(8)

πŸ“¦
version 4.17.0 Β· 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– FENCE_AGENT(8) β€” the fence_lindypdu girlies' manual πŸ’–

okay so bestie, welcome to the System Manager's Manual, section 8, and today's main character is fence_lindypdu. yes she's a fence agent. yes she eats. let's go 🫢


✨ NAME ✨

fence_lindypdu β€” the Fence agent for Lindy over SNMP. that's it, that's the name, she's iconic πŸ’…


🌸 DESCRIPTION 🌸

okay so fence_lindypdu is a Power Fencing agent and she's the one you call when you've got a Lindy PDU network power switch in the house. the vibe? she logs into the device via SNMP and reboots a specified outlet. that's her whole thing and she does it flawlessly, no cap. she supports SNMP v1 with all combinations of authenticity/privacy settings β€” all of them, every single combo, she's not picky πŸ’–

and here's the tea: the fence agent takes options on the command line and from stdin. fenced sends parameters through stdin when it execs the agent. but you can also run her all by herself with command line options β€” which is lowkey so useful for testing and for turning outlets on or off from scripts. main character energy fr fr ✨

Vendor URL: http://www.lindy.co.uk 🌈


πŸŽ€ PARAMETERS πŸŽ€

okay bestie, here's the whole roster. every single one. no skipping, we don't do that here πŸ’…

  • -o, --action=[action] β€” the fencing action, obvi. (Default Value: reboot)
  • -c, --community=[community] β€” set the community string. (Default Value: public)
  • -a, --ip=[ip] β€” IP address or hostname of the fencing device. 🚨 This parameter is always required.
  • -u, --ipport=[port] β€” TCP/UDP port to use for 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 device, UUID, or identification of the machine. 🚨 This parameter is always 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 the 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 the SNMP version to use (1|2c|3). (Default Value: 1)
  • -s, --switch=[id] β€” physical switch number on device. (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 not that quiet)
  • -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 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 specifying more than 1 plug. (Default Value: ,)
  • -C, --separator=[char] β€” separator for 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 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 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 πŸ’…

here's what she can actually do, bestie. pick your fighter:

  • on β€” power on the machine. ⚑
  • off β€” power off the machine. πŸ’€
  • reboot β€” reboot the machine. πŸ”„
  • status β€” this 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. πŸ™ˆ (yes really, that's what it says, we're keeping it, don't come for us)
  • validate-all β€” validate if all required parameters are entered. βœ…

πŸ¦‹ STDIN PARAMETERS πŸ¦‹

same squad, different entrance β€” when fenced pipes stuff in through stdin, these are the names it uses:

  • action β€” fencing action (Default Value: reboot)
  • community β€” set the community string (Default Value: public)
  • ip β€” IP address or hostname of the fencing device. This parameter is always required. Obsoletes: ipaddr
  • ipport β€” TCP/UDP port to use 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 device, UUID, or identification of the 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 the privacy password
  • snmp_priv_prot β€” set privacy protocol (DES|AES)
  • snmp_sec_level β€” set security level (noAuthNoPriv|authNoPriv|authPriv)
  • snmp_version β€” specifies the SNMP version to use (1|2c|3) (Default Value: 1)
  • switch β€” physical switch number on device (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 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 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: 0)
  • shell_timeout β€” wait X seconds for 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)

🫢 quick reminder bestie: --ip/ip and --plug/plug are always required. no plug, no ip, no fencing. she will simply not know what to do with herself. 😭

and that's the whole page, babes. this was fence_lindypdu (Fence Agent), dated 2009-10-20, living her truth inside FENCE_AGENT(8) in the System Manager's Manual. go forth and fence responsibly βœ¨πŸ’–πŸŽ€