FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

okay bestie, welcome to the fence_ibm_powervs page — that's the agent name, and the whole thing lives in section 8 of the System Manager's Manual (yes, FENCE_AGENT(8), that's the manual name, we're folding it in right here at the top like a lil bow 🎀). This is the page that tells you how to fence IBM Power Virtual Server instances. Let's get into it ✨

---

🌸 NAME 🌸

fence_ibm_powervs — the fence agent for IBM PowerVS, no cap 💅

---

🦋 DESCRIPTION 🦋

So like, fence_ibm_powervs is a power fencing agent for IBM Power Virtual Server (aka IBM PowerVS) and its whole job is fencing virtual server instances. That's it, that's the gig. She's a specialist 💖

Here's the tea: the fence agent takes options on the command line and from stdin. When fenced execs the agent, it sends the parameters through stdin. But you can also just run the agent by itself with command line options — which is genuinely so useful for testing and for turning outlets on or off from scripts. Little DIY queen 🫶

Vendor URL: https://www.ibm.com — go say hi 🌈

---

✨ PARAMETERS ✨

Every single flag, bestie, we're not skipping a one 👑

• --api-type=[private|public] — the API type, and your choices are literally private or public. Default value? private. 🍓
• --crn=[crn] — the CRN. And heads up, this parameter is always required. Always. Periodt.
• --instance=[instance] — the PowerVS Instance. Also always required, no exceptions 💀
• --proxy=[http://<URL>:<PORT>] — the network proxy. Default value is empty, so like, nothing.
• --region=[region] — the Region. You guessed it: always required 🌸
• --token=[token] — the API Token. And yep, always required. You're seeing a pattern, right?
• -o, --action=[action] — the fencing action. Default value: reboot. 💅
• -m, --method=[method] — the method to fence, either onoff or cycle. Default value: onoff.
• -n, --plug=[id] — the physical plug number on the device, or a UUID, or some identification of the machine. This parameter is always required. (Also it obsoletes port on the stdin side, keep reading bestie.)
• -q, --quiet — disables logging to stderr. And before you ask: no, it does not affect --verbose, or --debug-file, or logging to syslog. She's specific about her boundaries 💖
• -v, --verbose — verbose mode! And you can stack multiple -v flags on the command line (like -vvv) to crank the verbosity up. Go off 📈
• --verbose-level — the 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. Bye! 👋
• -h, --help — display help and exit. Also bye! 👋
• --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 style. 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: 120 ⚡
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF. Default value: 15 ⏱️
• --shell-timeout=[seconds] — wait X seconds for the cmd prompt after issuing a command. Default value: 500 🐚
• --stonith-status-sleep=[seconds] — sleep X seconds between status calls during a STONITH action. Default value: 10 😴
• --retry-on=[attempts] — how many attempts to retry power on. Default value: 1 🔁

---

🔥 ACTIONS 🔥

These are the moves she can make, bestie. Vibe check each one 👑

• on — power on the machine. ✨
• off — power off the machine. 💀
• reboot — reboot the machine. 🔄
• status — 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. Otherwise it returns N/A. 🤷
• 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 living with that 🙈)
• validate-all — validate if all required parameters are entered. ✅

---

💜 STDIN PARAMETERS 💜

Same energy, different door — these are the parameter names as they come in over stdin. Note the underscores, bestie, they matter 🌸

• api_type — API-type (private|public). Default value: private. Obsoletes: api-type 🍓
• crn — the CRN. This parameter is always required.
• instance — PowerVS Instance. This parameter is always required.
• proxy — network proxy. Default value is empty.
• region — Region. This parameter is always required.
• token — API Token. This parameter is always required.
• action — fencing action. Default value: reboot.
• method — method to fence (onoff|cycle). Default value: onoff.
• plug — physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port 💅
• 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: 120
• power_wait — wait X seconds after issuing ON/OFF. Default value: 15
• shell_timeout — wait X seconds for cmd prompt after issuing command. Default value: 500
• stonith_status_sleep — sleep X seconds between status calls during a STONITH action. Default value: 10
• retry_on — count of attempts to retry power on. Default value: 1

---

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

This was fence_ibm_powervs (Fence Agent), dated 2009-10-20, from FENCE_AGENT(8). Love her, she's iconic 👑🦋💖