FENCE_AGENT(8)

✨ NAME ✨

ok so this is fence_ibmz, bestie — it's the Fence agent for IBM z LPARs 💖 (and yeah, it lives in section 8 of the manual, iykyk).

---

🦋 DESCRIPTION 🦋

fence_ibmz is a Power Fencing agent that uses the HMC Web Services API to fence IBM z LPARs. no cap, that's literally its whole job 💅

okay so the tea ☕ — this fence agent takes options on the command line and from stdin. When fenced execs the agent, it sends parameters through stdin. but you can also run the agent all by itself with command line options, which is highkey useful for testing and for turning outlets on or off from scripts 🎀

Vendor URL: http://www.ibm.com 🌐

---

🌸 PARAMETERS 🌸

• -o, --action=[action] — the fencing action 💥 (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of the fencing device. this one is always required, like there's no getting around it 🫶
• -u, --ipport=[port] — TCP/UDP port to use for the connection with the device (Default Value: 6794)
• -p, --password=[password] — login password or passphrase 🔐
• -S, --password-script=[script] — script to run to retrieve the password 📜
• -n, --plug=[id] — physical plug id, formatted as cpc-name/partition-name (and yes it's case-sensitive, watch out 👀). this parameter is always required.
• --ssl-secure — use an SSL connection with verifying certificate 🔒✨
• -l, --username=[name] — login name. also always required, we're not letting this one slide either 💁
• --connect-retries=[number] — how many times to retry on connection errors (Default Value: 3)
• --connect-timeout=[seconds] — how long to wait to establish a connection (Default Value: 30)
• --operation-timeout=[seconds] — how long to wait for the power operation to complete (Default Value: 900)
• --read-retries=[number] — how many times to retry on read errors (Default Value: 3)
• --read-timeout=[seconds] — how long to wait for server data (Default Value: 300)
• --load-on-activate — rely on the HMC to perform a load operation on activation ⚡
• -q, --quiet — disable logging to stderr. (it does not affect --verbose or --debug-file or logging to syslog, so don't get it twisted 🤫)
• -v, --verbose — verbose mode. you can stack multiple -v flags 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 status change after ON/OFF (Default Value: 300)
• --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)

---

👑 ACTIONS 👑

• on — power on machine. ⚡
• off — power off machine. 💀
• reboot — reboot 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. that's what it says. we're all just vibing with that one.)
• validate-all — validate if all required parameters are entered. ✅

---

🎀 STDIN PARAMETERS 🎀

• action — fencing action (Default Value: reboot)
• 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: 6794)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• plug — physical plug id in the format cpc-name/partition-name (case-sensitive). this parameter is always required. Obsoletes: port
• ssl_secure — use SSL connection with verifying certificate
• username — login name. this parameter is always required. Obsoletes: login
• connect_retries — how many times to retry on connection errors (Default Value: 3)
• connect_timeout — how long to wait to establish a connection (Default Value: 30)
• operation_timeout — how long to wait for power operation to complete (Default Value: 900)
• read_retries — how many times to retry on read errors (Default Value: 3)
• read_timeout — how long to wait for server data (Default Value: 300)
• load_on_activate — rely on the HMC to perform a load operation on activation
• 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: ,)
• separator — separator for CSV created by 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 cmd prompt after login (Default Value: 5)
• power_timeout — test X seconds for status change after ON/OFF (Default Value: 300)
• 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)

---

okay that's the whole thing, you ate that reading session fr fr 🫶 this was fence_ibmz (Fence Agent) and it's dated 2009-10-20 — the same page as FENCE_AGENT(8), slay, go forth and fence responsibly 💅✨🌈