FENCE_AGENT(8)

💖 NAME 💖

ok so bestie, meet fence_cyberpower_ssh — it's a fence agent for CyberPower, and it does all its business over ssh. this page lives in the System Manager's Manual, section 8, and it's literally your whole guide to this little icon. 🫶

---

✨ DESCRIPTION ✨

fence_cyberpower_ssh is a Power Fencing agent that works with the CyberPower network power switch. it logs into the device via ssh and reboots a specified outlet. that's the whole vibe. 💅

⚠️ okay real talk though — lengthy ssh connections should be avoided while a GFS cluster is running, because the connection will block any necessary fencing actions. no cap, this one matters. 😭

the fence agent takes options on the command line and from stdin. when fenced execs the agent, it sends parameters through stdin. but you can also run the agent all 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 fr. ✨

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

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -c, --command-prompt=[prompt] — force a Python regex for the command prompt. (Default Value: ['\n>', '\nCyberPower >'])
• -k, --identity-file=[filename] — identity file (private key) for SSH.
• -4, --inet4-only — forces the agent to use IPv4 addresses only.
• -6, --inet6-only — forces the agent to use IPv6 addresses only.
• -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.
• -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 the device, UUID or identification of the machine. This parameter is always required.
• -x, --ssh — use SSH connection.
• --ssh-options=[options] — SSH options to use.
• -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.
• -v, --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).
• -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 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 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] — count of attempts to retry power on. (Default Value: 1)
• --ssh-path=[path] — path to the ssh binary. (Default Value: /usr/bin/ssh)

---

🔥 ACTIONS 🔥

• 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 is 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. 💀 (yeah bestie, that's literally what it says)
• validate-all — validate if all required parameters are entered.

---

🌸 STDIN PARAMETERS 🌸

• action — fencing action. (Default Value: reboot)
• command_prompt — force Python regex for command prompt. (Default Value: ['\n>', '\nCyberPower >']) Obsoletes: cmd_prompt
• identity_file — identity file (private key) for SSH.
• inet4_only — forces the agent to use IPv4 addresses only.
• inet6_only — forces the agent to use IPv6 addresses only.
• 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.
• 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
• ssh — use SSH connection. Obsoletes: secure
• ssh_options — SSH options to use.
• 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 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 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)
• ssh_path — path to the ssh binary. (Default Value: /usr/bin/ssh)

---

ok that's the whole page bestie, you ate that 🎀✨

this lil masterpiece is fence_cyberpower_ssh (Fence Agent), dated 2009-10-20, and it belongs to the FENCE_AGENT(8) family. go forth and fence responsibly 💖🦋👑