FENCE_AGENT(8)

✨ NAME ✨

bestie, meet the fence_ilo_ssh family 💖

• fence_ilo_ssh — the fence agent for HP iLO over SSH (this is the main character 👑)
• fence_ilo3_ssh — fence agent for HP iLO3 over SSH (a symlink, she's just pointing at her sister 🫶)
• fence_ilo4_ssh — fence agent for HP iLO4 over SSH (also a symlink ✨)
• fence_ilo5_ssh — fence agent for HP iLO5 over SSH (symlink again, the whole girl gang 🌸)

---

🌈 DESCRIPTION 🌈

So fence_ilo5_ssh is a Power Fencing agent that connects to an iLO device, okay? It logs into the device via ssh and reboots a specified outlet. That's the whole vibe. Slay. 💅

⚠️ WARNING: the monitor-action is prone to timeouts. Use the fence_ilo-equivalent to avoid this issue, no cap. Don't say I didn't warn you 😭

The fence agent takes options on the command line and from stdin, bestie. Fenced sends parameters through stdin when it execs the agent. But like, the agent can also be run all by itself with command line options — which is highkey useful for testing and for turning outlets on or off from scripts. It's giving very versatile ✨

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

---

🎀 PARAMETERS 🎀

okay here come all of them, don't skip a single one, I'm watching 👀

• -o, --action=[action] — the fencing action, obviously (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 the connection with the device (Default Value: 23)
• -m, --method=[method] — method to fence, and it's 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 (this one works together with --port-as-ip)
• -x, --ssh — use an SSH connection 🦋
• --ssh-options=[options] — SSH options to use
• -l, --username=[name] — login name. and listen, this parameter is always required. like, always. periodt.
• -q, --quiet — disable logging to stderr. Heads up: it does not affect --verbose, --debug-file, or logging to syslog.
• -v, --verbose — verbose mode! and you can stack multiple -v flags on the command line (e.g., -vvv) to increase the verbosity 💅
• --verbose-level — level of debugging detail in the output. Defaults to the number of --verbose flags you gave 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] — the separator for the plug parameter when you're 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 the cmd prompt after login (Default Value: 5)
• --port-as-ip — makes "port/plug" be an alias to the IP address 👑
• --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 💅

the things she can actually do, bestie:

• on — power on the machine. ⚡
• off — power off the machine. 💀
• reboot — reboot the machine. 🔥
• status — this returns the status of the plug/virtual machine.
• monitor — check the health of the fence device (remember that timeout warning up top though 👀)
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. (yeah. that's literally what it says. we love a mystery 🕵️♀️)
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same energy, but these come in through stdin instead. note the Obsoletes: notes, those are the old names that got replaced, iykyk:

• action — fencing action (Default Value: reboot)
• command_prompt — force a Python regex for the command prompt (Default Value: ['MP>', 'hpiLO->']) 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 Obsoletes: ipaddr
• ipport — TCP/UDP port to use for the connection with the 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 the password Obsoletes: passwd_script
• plug — IP address or hostname of the fencing device (together with --port-as-ip) Obsoletes: port
• ssh — use an 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: ,)
• 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)
• port_as_ip — make "port/plug" be an alias to the IP address
• power_timeout — test X seconds for a 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 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)
• telnet_path — path to the telnet binary (Default Value: /usr/bin/telnet)

---

and that's the whole page, bestie, you ate that 🫶 fence_ilo_ssh (Fence Agent), dated 2009-10-20, living in the FENCE_AGENT(8) section of the manual. mwah 💋 go fence something responsibly.