FENCE_AGENT(8)

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

πŸ’– NAME πŸ’–

okay so bestie, this is fence_cdu β€” the fence agent for a Sentry Switch CDU, and it does all its little tasks over telnet. It lives in the FENCE_AGENT(8) section of the System Manager's Manual, iykyk. πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

So like, fence_cdu is a Power Fencing agent and its whole thing is hanging out with the Sentry Switch CDU. It logs into the device via telnet and powers an outlet on or off. That's it. That's the job. πŸ’…

The fence agent takes options on the command line and from stdin. When Fenced execs the agent, it sends the parameters through stdin, periodt. But you can also just run the agent by itself with command line options, which is genuinely so useful for testing and for turning outlets on or off from scripts. 🌸

Vendor URL: http://www.servertech.com


✨ PARAMETERS ✨

  • -o, --action=[action] β€” the fencing action you want, bestie. (Default Value: reboot)
  • -a, --ip=[ip] β€” IP address or hostname of fencing device. This parameter is always required. no skipping it πŸ™ˆ
  • -u, --ipport=[port] β€” TCP/UDP port to use for connection with device. (Default Value: 23)
  • -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. 🫢
  • -s, --switch=[id] β€” physical switch number on device
  • -l, --username=[name] β€” login name. This parameter is always required.
  • -q, --quiet β€” disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog. shhh 🀫
  • -v, --verbose β€” verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. stack 'em like bracelets ✨
  • --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)
  • --telnet-path=[path] β€” path to telnet binary. (Default Value: /usr/bin/telnet)

πŸ”₯ ACTIONS πŸ”₯

  • 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. πŸ’€ (literally not known, bestie, we're not guessing)
  • validate-all β€” validate if all required parameters are entered.

🌈 STDIN PARAMETERS 🌈

  • action β€” fencing action (Default Value: reboot)
  • 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: 23)
  • 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
  • switch β€” physical switch number on device
  • username β€” login name. This parameter is always required. 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)
  • telnet_path β€” path to telnet binary (Default Value: /usr/bin/telnet)

okay that's literally the whole page, go forth and fence responsibly 🫢

and that's a wrap, bestie!! this was fence_cdu (Fence Agent) from way back on 2009-10-20, filed under FENCE_AGENT(8) in the System Manager's Manual. slay, stay fenced πŸ’…βœ¨