FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

okay bestie, welcome to the fence_agent(8) corner of the system manager's manual, and today's main character is fence_kubevirt — a fence agent for KubeVirt, fr fr. grab a boba, we're doing this ✨

---

🎀 NAME 🎀

fence_kubevirt — it's a fence agent for KubeVirt, and yes it eats. 💅

---

🌸 DESCRIPTION 🌸

So. fence_kubevirt is a Power Fencing agent for KubeVirt. that's the whole vibe. 🔥

Here's the tea: the fence agent accepts options on the command line as well as from stdin. When fenced execs the agent, it sends parameters through stdin. But also — plot twist — the agent can be run by itself with command line options. Which is lowkey iconic, because it means you can use it for testing and for turning outlets on or off from scripts. 💖

Vendor URL: https://kubevirt.io/ — go say hi 🦋

---

✨ PARAMETERS ✨

• -o, --action=[action] — the fencing action you want. (Default Value: reboot)
• -n, --plug=[id] — physical plug number on the device, or the UUID, or the identification of the machine. this parameter is always required, no skipping, periodt. 😤
• --ssl-insecure — use SSL connection without verifying certificate. yep, that's the whole thing. 🙈
• --namespace=[namespace] — namespace of the KubeVirt machine.
• --kubeconfig=[kubeconfig] — kubeconfig file path.
• --apiversion=[apiversion] — version of the KubeVirt API. (Default Value: kubevirt.io/v1)
• -q, --quiet — disable logging to stderr. does not affect --verbose or --debug-file or logging to syslog, bestie, so don't get it twisted. 💀
• -v, --verbose — verbose mode. multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. stack 'em like bracelets 🫶
• --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 given file.
• -V, --version — display version information and exit.
• -h, --help — display help and exit.
• --plug-separator=[char] — separator for plug parameter when specifying more than 1 plug. (Default Value: ,)
• -C, --separator=[char] — separator for CSV created by 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 cmd prompt after login. (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for status change after ON/OFF. (Default Value: 40)
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF. (Default Value: 0)
• --shell-timeout=[seconds] — wait X seconds for cmd prompt after issuing 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 is 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 fence device. 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. not me being mysterious ✨
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same energy, different delivery system. here's everything that can come in through stdin:

• action — fencing action (Default Value: reboot)
• plug — physical plug number on device, UUID or identification of machine. this parameter is always required. Obsoletes: port
• ssl_insecure — use SSL connection without verifying certificate
• namespace — namespace of the KubeVirt machine.
• kubeconfig — kubeconfig file path
• apiversion — version of the KubeVirt API. (Default Value: kubevirt.io/v1)
• 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: 40)
• 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)

---

ok and if you ever need the synopsis in one breath, it's basically this: run it with command line options, or let fenced feed it parameters over stdin — either way, same agent, same slay. 💅

---

and that's the whole page, bestie! this lil masterpiece is fence_kubevirt (Fence Agent), dated 2009-10-20, from FENCE_AGENT(8) — aka the system manager's manual section 8. she's been serving since 2009 and honestly? still ate. 🎀✨👑