FENCE_AGENT(8)

💖 fence_pve — the FENCE_AGENT(8) glow-up 💖

okay bestie, welcome to the manual page for fence_pve, from the FENCE_AGENT(8) family, living in the System Manager's Manual section. grab a strawberry 🍓 and let's get into it.

---

✨ NAME ✨

fence_pve — a fencing agent for the Proxmox Virtual Environment 🫶

---

🌸 DESCRIPTION 🌸

fence_pve is a Power Fencing agent for virtual machines acting as nodes in a virtualized cluster. it's giving "i decide who's on and who's off" energy, and honestly? iconic. 👑

here's the vibe: 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 — and this is the fun part — the agent can be run by itself with command line options. that's lowkey so useful for testing and for turning outlets on or off from scripts. no cap. 🔥

Vendor URL: http://www.proxmox.com/

---

🎀 PARAMETERS 🎀

every single one, bestie. no skipping. that's the rule. 💅

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -a, --ip=[ip] — IP Address or Hostname of a node within the Proxmox cluster. this parameter is always required. like, always always. 🙈
• -u, --ipport=[port] — TCP/UDP port to use for connection with device. (Default Value: 8006)
• -m, --method=[method] — method to fence (onoff|cycle). (Default Value: onoff)
• -p, --password=[password] — login password or passphrase 🔐
• -S, --password-script=[script] — script to run to retrieve password
• -n, --plug=[id] — Id of the virtual machine. this parameter is always required. yeah, again. required required. 💀
• -z, --ssl — use SSL connection with verifying certificate. (Default Value: 1)
• --ssl-insecure — use SSL connection without verifying certificate 🚨
• --ssl-secure — use SSL connection with verifying certificate
• -l, --username=[name] — login name. (Default Value: root@pam)
• -N, --pve-node=[node_name] — Proxmox node name on which machine is located. (Must be specified if not using --pve-node-auto)
• -A, --pve-node-auto — automatically select proxmox node. (this option overrides --pve-node)
• --vmtype — virtual machine type lxc or qemu. (Default: qemu) (Default Value: qemu)
• --nodename — replaced by --pve-node
• -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. go off, stack them. ✨
• --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: 20)
• --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)
• --gnutlscli-path=[path] — path to gnutls-cli binary. (Default Value: /usr/bin/gnutls-cli)

---

🦋 ACTIONS 🦋

the things it can do. main character behavior, fr fr. ✨

• 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 then 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. (bestie. nobody knows. it's a mystery. 🫠)
• validate-all — validate if all required parameters are entered.

---

🌈 STDIN PARAMETERS 🌈

same energy, snake_case edition. everything arrives through stdin when fenced execs the agent. 🧚

• action — fencing action. (Default Value: reboot)
• ip — IP Address or Hostname of a node within the Proxmox cluster. this parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device. (Default Value: 8006)
• method — method to fence (onoff|cycle). (Default Value: onoff)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• plug — Id of the virtual machine. this parameter is always required. Obsoletes: port
• ssl — use SSL connection with verifying certificate. (Default Value: 1)
• ssl_insecure — use SSL connection without verifying certificate 🚨
• ssl_secure — use SSL connection with verifying certificate
• username — login name. (Default Value: root@pam) Obsoletes: login
• pve_node — Proxmox node name on which machine is located. (Must be specified if not using --pve-node-auto)
• pve_node_auto — automatically select proxmox node. (this option overrides --pve-node)
• vmtype — virtual machine type lxc or qemu. (Default: qemu) (Default Value: qemu)
• nodename — replaced by --pve-node. Obsoletes: node_name
• 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: 20)
• 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)
• gnutlscli_path — path to gnutls-cli binary. (Default Value: /usr/bin/gnutls-cli)

---

⚠️ real talk: --ssl-insecure and ssl_insecure mean no certificate verification. that's the vibes, and they are risky vibes. also --nodename / nodename are replaced by --pve-node, so use the new one, bestie. 🫶

---

and that's the whole page!! this one is fence_pve (Fence Agent), dated 2009-10-20, and it lives at the bottom of FENCE_AGENT(8). 💜 thanks for reading, you ate this up, periodt. 🎀✨💅