FENCE_AGENT(8)

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

okay bestie, welcome to the fence_hpblade section of the system manager's manual and lemme tell you, this one's a whole vibe. it's a fencing agent, it lives in section 8 of the manual, and it is so ready to handle ur HP hardware for u. 🫶

---

🌸 NAME 🌸

fence_hpblade — the fence agent for HP BladeSystem. literally that's her whole thing. 💅

---

✨ DESCRIPTION ✨

fence_hpblade is a Power Fencing agent (yes, capital P capital F, she's official) that u can use with HP BladeSystem and HP Integrity Superdome X. what does she do? she logs into the onboard administrator of an enclosure — via telnet or ssh — and then uses the command line interface to power blades or partitions on or off. that's it. that's the job. iconic behavior honestly. 🔥

and here's the tea: the fence agent takes options on the command line and from stdin. when fenced execs the agent, it sends parameters through stdin. but u can also run the agent all by itself with command line options — which is genuinely so useful for testing and for turning outlets on or off from scripts. no cap, that's the whole point. 🎀

Vendor URL: http://www.hp.com — go say hi to HP, they made the hardware. 🌈

---

🎀 PARAMETERS 🎀

here's the full menu, bestie. every single one. i would never gatekeep. 💜

• -o, --action=[action] — the fencing action, aka what she's gonna do. (Default Value: reboot) ⚡
• -c, --command-prompt=[prompt] — force a Python regex for the command prompt, if u need to be picky about it. (Default Value: ['c7000oa>']) 🦋
• -k, --identity-file=[filename] — the identity file (private key) for SSH. ur lil secret, kept safe. 🔐
• -4, --inet4-only — forces the agent to use IPv4 addresses only. old school, respect. 📼
• -6, --inet6-only — forces the agent to use IPv6 addresses only. futuristic, slay. 🚀
• -a, --ip=[ip] — IP address or hostname of the fencing device. > This parameter is always required. no skipping, bestie.
• -u, --ipport=[port] — TCP/UDP port to use for connection with the device. (Default Value: 23) 🌸
• -p, --password=[password] — login password or passphrase. 🤫
• -S, --password-script=[script] — a script to run to retrieve the password, for when u don't wanna type it. 💫
• -n, --plug=[id] — physical plug number on the device, UUID, or identification of the machine. > This parameter is always required. yes, again. required required.
• -x, --ssh — use an SSH connection. 💻
• --ssh-options=[options] — SSH options to use. ur call. 🎀
• -l, --username=[name] — login name. > This parameter is always required. ok three for three, u get the pattern.
• -q, --quiet — disable logging to stderr. and listen: it does not affect --verbose or --debug-file or logging to syslog. those keep doing their thing. 🤐
• -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 the given file. receipts, but make them a text file. 📝
• -V, --version — display version information and exit. 👋
• -h, --help — display help and exit. the classic. 🆘
• --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 or false. (default: true when run from Pacemaker 2.0+) ⌛
• --login-timeout=[seconds] — wait X seconds for the cmd prompt after login. (Default Value: 10) 🕐
• --missing-as-off — missing port returns OFF instead of failure. choose ur fighter. 💀
• --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) 🛣️
• --telnet-path=[path] — path to the telnet binary. (Default Value: /usr/bin/telnet) 🛣️

---

🦋 ACTIONS 🦋

the moves she can pull. each one is a whole mood:

• on — power on machine. ⚡✨
• off — power off machine. 💤
• reboot — reboot machine. the glow-up-and-restart. 🔄
• 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. two-for-one. 🎁
• monitor — check the health of the fence device. wellness check, bestie. 🩺
• metadata — display the XML metadata describing this resource. 📜
• manpage — the operational behavior of this is not known. 😭 literally nobody knows. it's a mystery. we love her anyway. 🙈
• validate-all — validate if all required parameters are entered. the responsible one in the group chat. ✅

---

💫 STDIN PARAMETERS 💫

same energy, snake_case edition, because fenced sends these through stdin. watch out for the "Obsoletes" notes — those are the old names she's moved on from. 👑

• action — fencing action. (Default Value: reboot)
• command_prompt — force Python regex for command prompt. (Default Value: ['c7000oa>']) 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: 10)
• 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: 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)
• ssh_path — path to ssh binary. (Default Value: /usr/bin/ssh)
• telnet_path — path to telnet binary. (Default Value: /usr/bin/telnet)

---

and that's the whole page, bestie!! 🫶 this lil manpage is brought to u by the fence_hpblade (Fence Agent) herself, dated 2009-10-20 — yeah she's been serving since '09 and she has not lost a single step. periodt. 💅✨