FENCE_AGENT(8)

💖 NAME 💖

okay bestie, meet fence_ibm_vpc — the fence agent for IBM Cloud VPC. that's the whole name, that's the whole vibe. 🫶

---

✨ DESCRIPTION ✨

so like, fence_ibm_vpc</p> is a Power Fencing agent that you use with IBM Cloud VPC to fence virtual machines. that's its whole job and it does it. 💅

here's the tea about how you talk to it: the fence agent takes options on the command line AND from stdin. both. it's flexible like that. 🌈

when fenced execs the agent, it sends parameters through stdin. but the agent can also be run all by itself with command line options — which is lowkey iconic for testing and for turning outlets on or off from scripts. 🎀

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

---

🎀 PARAMETERS 🎀

• --apikey=[key] — the API Key. this parameter is always required. like, no apikey no fencing, periodt. 🔑
• --limit=[number] — how many nodes the API hands back. (Default Value: 50)
• --proxy=[http://<URL>:<PORT>] — network proxy. (Default Value: empty, like, nothing, nada)
• --region=[region] — the Region. this parameter is always required. 🌍
• --token-file=[path] — path to the token cache file. (Default Value: /run/fence-agents/fence_ibm_vpc/[hash].token) 🗂️
• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -n, --plug=[id] — physical plug number on device, UUID, or identification of the machine. this parameter is always required. 🔌
• -q, --quiet — disable logging to stderr. heads up bestie, this does not affect --verbose or --debug-file or logging to syslog. 🤫
• -v, --verbose — verbose mode. you can stack multiple -v flags on the command line (e.g. -vvv) to crank the verbosity up. 📢
• --verbose-level — level of debugging detail in the output. defaults to the number of --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] — 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: 30) ⚡
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF. (Default Value: 1)
• --shell-timeout=[seconds] — wait X seconds for the cmd prompt after issuing a command. (Default Value: 15)
• --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 bestie, we don't know either 🙈)
• validate-all — validate if all required parameters are entered. ✅

---

🦋 STDIN PARAMETERS 🦋

• apikey — API Key. this parameter is always required. 🔑
• limit — number of nodes returned by API. (Default Value: 50)
• proxy — network proxy. (Default Value: empty)
• region — Region. this parameter is always required. 🌍
• token_file — path to the token cache file. (Default Value: /run/fence-agents/fence_ibm_vpc/[hash].token) 🗂️
• action — fencing action. (Default Value: reboot)
• plug — physical plug number on device, UUID, or identification of the 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: 30) ⚡
• power_wait — wait X seconds after issuing ON/OFF. (Default Value: 1)
• shell_timeout — wait X seconds for cmd prompt after issuing command. (Default Value: 15)
• 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) 🔁

---

and that's the whole page bestie!! 💖✨🌸

this was the FENCE_AGENT(8) manual — system manager's manual energy — and the page itself is fence_ibm_vpc (Fence Agent), dated 2009-10-20. yes she's been around a minute and she still ate. 👑🎀🫶