FENCE_AGENT(8)

🌸 FENCE_AGENT(8) 🌸

okay bestie, pull up a chair, we're reading a man page together and honestly? it's giving useful. This one's from the System Manager's Manual section (section 8, iykyk — that's the sysadmin stuff 💅), and it's all about fence_ilo_moonshot — the fence agent for HP Moonshot iLO.

---

✨ NAME ✨

fence_ilo_moonshot — the fence agent for HP Moonshot iLO, bestie. That's it, that's the name, it's iconic 🎀

---

🦋 DESCRIPTION 🦋

So here's the vibe: this fence agent takes its options from the command line or from stdin. Both. She's flexible like that 💅

When fenced execs the agent, it sends the parameters through stdin. But you can also run the agent all by itself with command line options — which is lowkey so handy for testing, and for turning outlets on or off from scripts. Main character energy fr fr ✨

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

---

💖 PARAMETERS 💖

Every single one, no skips, we don't do that here:

• -o, --action=[action] — the fencing action you want to happen (Default Value: reboot)
• -c, --command-prompt=[prompt] — forces 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. This parameter is always required. no skipping it, bestie
• -u, --ipport=[port] — TCP/UDP port to use for the connection with the device (Default Value: 22)
• -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 (Default Value: 1)
• --ssh-options=[options] — SSH options to use
• -l, --username=[name] — login name. This parameter is always required.
• -q, --quiet — disables logging to stderr. Doesn't affect --verbose or --debug-file, and doesn't affect logging to syslog either 🫶
• -v, --verbose — verbose mode. You can stack multiple -v flags on the command line (like -vvv) to crank the verbosity up 🔥
• --verbose-level — level of debugging detail in the output. Defaults to however many --verbose flags you put 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: ,)
• -C, --separator=[char] — the 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 a 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 👑

These are the things she can actually do, and they ate:

• 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'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. 💀 yeah, we don't know either bestie
• validate-all — validate if all required parameters are entered.

---

🌈 STDIN PARAMETERS 🌈

Same energy, different spelling — underscores instead of dashes because stdin said so 💅

• 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. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for the connection with the device (Default Value: 22)
• 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 an SSH connection (Default Value: 1). Obsoletes: secure
• ssh_options — SSH options to use
• username — login name. This parameter is always required. Obsoletes: login
• quiet — disable logging to stderr. Doesn't affect --verbose or --debug-file, and doesn't affect logging to syslog either.
• 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 a 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)

---

okay that's the whole page bestie, you read all of it, I'm so proud 🥹

sign-off time ✨ This one's fence_ilo_moonshot (Fence Agent), dated 2009-10-20 — an absolute elder of a page and still serving. Periodt 💅🦋💖