FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

okay bestie, sit down, grab a boba, because we're about to read a whole System Manager's Manual page together and honestly? it's giving iconic. this is the FENCE_AGENT(8) page, section 8, and it's all about the HP iLO SSH fence agents. let's get into it ✨

---

🌸 NAME 🌸

• fence_ilo_ssh — Fence agent for HP iLO over SSH
• fence_ilo3_ssh — Fence agent for HP iLO3 over SSH (symlink)
• fence_ilo4_ssh — Fence agent for HP iLO4 over SSH (symlink)
• fence_ilo5_ssh — Fence agent for HP iLO5 over SSH (symlink)

so like, one real agent and three little symlink besties tagging along 💅

---

✨ DESCRIPTION ✨

fence_ilo_ssh is a Power Fencing agent that connects to an iLO device. it logs into the device via ssh and reboots a specified outlet. that's the whole vibe, fr fr.

⚠️ WARNING: the monitor action is prone to timeouts. use the fence_ilo-equivalent to avoid this issue. no cap, this one matters 😭

the fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. but here's the cute part — the agent can also be run by itself with command line options. super useful for testing and for turning outlets on or off from scripts 🫶

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

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action you want to happen (Default Value: reboot)
• -c, --command-prompt=[prompt] — force a Python regex for the command prompt (Default Value: ['MP>', 'hpiLO->'])
• -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
• -u, --ipport=[port] — TCP/UDP port to use for connection with the device (Default Value: 23)
• -m, --method=[method] — method to fence, onoff|cycle (Default Value: onoff)
• -p, --password=[password] — login password or passphrase
• -S, --password-script=[script] — script to run to retrieve the password
• -n, --plug=[ip] — IP address or hostname of the fencing device (together with --port-as-ip)
• -x, --ssh — use SSH connection
• --ssh-options=[options] — SSH options to use
• -l, --username=[name] — login name. This parameter is always required. (yes, always. don't forget it 💀)
• -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. stacking flags is the moment ✨
• --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: ,)
• --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)
• --port-as-ip — make "port/plug" be an alias to IP address
• --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: 5)
• --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)
• --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 machine. ⚡
• off — power off machine.
• reboot — reboot machine. 🔄
• status — this returns the status of the plug/virtual machine.
• 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, i'm not gonna pretend otherwise 🙈)
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

these are the same vibes but with underscore names, because stdin said "i don't do dashes" 💅

• action — fencing action (Default Value: reboot)
• command_prompt — force Python regex for command prompt (Default Value: ['MP>', 'hpiLO->']). 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. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 23)
• method — method to fence (onoff|cycle) (Default Value: onoff)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• plug — IP address or hostname of fencing device (together with --port-as-ip). 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: ,)
• 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)
• port_as_ip — make "port/plug" to be an alias to IP address
• 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)

---

and that's the whole page, bestie. you ate that. 👑

this was fence_ilo_ssh (Fence Agent), dated 2009-10-20, and it lives at the very bottom of FENCE_AGENT(8). periodt 💅✨🦋