FENCE_AGENT(8)

💖 NAME 💖

okay so bestie, this is fence_alom — the Fence agent for Sun ALOM. that's the whole vibe. 🦋

---

✨ DESCRIPTION ✨

fence_alom is a Power Fencing agent, and you'd use it with machines that are hooked up through ALOM. no cap, that's its whole job. 💅

Here's the tea: this fence agent takes its options on the command line or from stdin. When fenced execs the agent, it sends the parameters through stdin. But you can also just run the agent all by yourself with command line options — which is lowkey so useful for testing, and for turning outlets on or off from scripts. main character energy fr fr. 🔥

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

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -c, --command-prompt=[prompt] — force a Python regex for the command prompt. (Default Value: ['sc\\>\\ '])
• -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: 22)
• -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 an SSH connection. (Default Value: 1)
• --ssh-options=[options] — SSH options to use.
• -l, --username=[name] — login name. This parameter is always required. like, always bestie, don't skip 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.
• --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 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 — make "port/plug" be an alias to the 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: 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 👑

• 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. 🩺
• 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 don't know either.)
• validate-all — validate if all required parameters are entered.

---

🌸 STDIN PARAMETERS 🌸

• action — fencing action (Default Value: reboot)
• command_prompt — force a Python regex for the command prompt (Default Value: ['sc\\>\\ ']). 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 fencing device. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 22)
• 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 (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. 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: 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)

---

okay that's the whole page bestie, you're so welcome 🫶

this lil number is fence_alom (Fence Agent), dated 2009-10-20, living in section FENCE_AGENT(8) of the System Manager's Manual. it's giving vintage but it still slays. ✨🧚💜