FENCE_AGENT(8)

💖 FENCE_AGENT(8) — the fence_hds_cb glow-up 💖

okay bestie, welcome to the fence_hds_cb page from the System Manager's Manual ✨ yes it's a section 8 man page, yes it's about fencing, no it's not about swords 🫶 buckle up.

---

✨ NAME ✨

fence_hds_cb — fence agent for Hitachi Compute Blade systems 🎀

---

🌸 DESCRIPTION 🌸

fence_hds_cb is a Power Fencing agent that you can use with Hitachi Compute Blades that have recent enough firmware that includes telnet support. like, if your firmware is ancient? not it, bestie 💀

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 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.hds.com 👑

---

💅 PARAMETERS 💅

one bullet per flag, no skipping, we respect the whole list here periodt ✨

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -c, --command-prompt=[prompt] — force a Python regex for the command prompt (Default Value: ['\\) :'])
• -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. no skipping it fr fr
• -u, --ipport=[port] — TCP/UDP port to use for connecting to the device (Default Value: 23)
• -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 an 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. Doesn't touch --verbose, --debug-file, or logging to syslog 🫶
• -v, --verbose — verbose mode. You can stack multiple -v flags on the command line (e.g., -vvv) to increase verbosity, go off bestie 📢
• --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).
• -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 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)
• --missing-as-off — a missing port returns OFF instead of failure
• --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: 5)
• --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)
• --telnet-path=[path] — path to the telnet binary (Default Value: /usr/bin/telnet)

---

🔥 ACTIONS 🔥

• on — power on the machine. wake up king 👑
• off — power off the machine.
• reboot — reboot the machine. the classic.
• 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. literally what it says 💀
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same energy, different delivery method — these are the ones that come in through stdin 💌

• action — fencing action (Default Value: reboot)
• command_prompt — force Python regex for command prompt (Default Value: ['\\) :']) — Obsoletes: cmd_prompt
• identity_file — identity file (private key) for SSH
• inet4_only — forces agent to use IPv4 addresses only
• inet6_only — forces agent to use IPv6 addresses only
• 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
• 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 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)
• missing_as_off — missing port returns OFF instead of failure
• 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: 5)
• 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)
• ssh_path — path to ssh binary (Default Value: /usr/bin/ssh)
• telnet_path — path to telnet binary (Default Value: /usr/bin/telnet)

---

okay that's literally the whole page, every flag, every default, every obsolete alias, all present and accounted for 💖 go fence something responsibly bestie.

---

sign-off time 🎀 this lil masterpiece is fence_hds_cb (Fence Agent), dated 2009-10-20, and it lives in FENCE_AGENT(8). slay, stay fenced, bye bestie 👑✨🦋