FENCE_AGENT(8)

🌸 FENCE_AGENT(8) — the vibe check ✨

okay bestie, welcome to fence_ldom, the fencing agent for Sun LDOM 💅 (yes this is section 8 of the System Manager's Manual, we're fancy now 👑)

---

🎀 NAME 🎀

fence_ldom — fence agent for Sun LDOM 🦋

---

✨ DESCRIPTION ✨

fence_ldom is a Power Fencing agent and it's made for LDoms virtual machines. The way it works is so simple: it runs the ldm command on the host machine. Which means ldm has to be directly runnable, no cap, that's the whole requirement 🙈

A very useful parameter is -c (or cmd_prompt when you're in stdin mode). You have to set it to whatever gets displayed after a successful login to the host machine. The default string is a space on the end of the string (that's the default for root in bash 🫶). But — for example — csh uses ], so in that case you must use parameter -c with argument ]. Super similar situation: if you use bash and login to the host machine with some user that isn't root, then the prompt is $, so again, you must use parameter -c. iykyk 💖

The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. The agent can be run by itself with command line options — which is literally so useful for testing and for turning outlets on or off from scripts 🌈

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: ['\\ $']
• -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. ⚠️
• -u, --ipport=[port] — TCP/UDP port to use for 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 — 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: ,
• -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/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 🌟

• 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 🙈
• 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: ['\\ $']. 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 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. 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: ,
• 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

---

and that's the whole page bestie, you ate it, go fence something 💅✨

this was fence_ldom (Fence Agent), dated 2009-10-20, chillin' at the bottom of FENCE_AGENT(8) like the icon it is 🎀