FENCE_AGENT(8)

okay so bestie, quick heads up before we dive in: this page is FENCE_AGENT(8), and it lives in the System Manager's Manual 💖 it's a section 8 joint, so it's system-admin territory. grab a snack, we're going in 🍓

---

🌸 NAME 🌸

fence_nutanix_ahv — a Fence agent for Nutanix AHV Cluster VMs, no cap 💅

---

✨ DESCRIPTION ✨

So fence_nutanix_ahv is a Power Fencing agent for virtual machines that are deployed on a Nutanix AHV cluster, and that AHV cluster is being managed by Prism Central. That's the whole vibe 🦋

Here's the tea about how it takes input: the fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. And the agent can also be run 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.nutanix.com 🔗

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — the fencing action you want. (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required. 👑
• -u, --ipport=[port] — the TCP/UDP port to use for the connection with the device. (Default Value: 80)
• -m, --method=[method] — method to fence, and your choices are onoff|cycle. (Default Value: onoff)
• -t, --notls — disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up. ⚠️
• -p, --password=[password] — login password or passphrase 🔐
• -S, --password-script=[script] — script to run to retrieve the password
• -n, --plug=[id] — physical plug number on the device, UUID, or identification of the machine. This parameter is always required. 👑
• -z, --ssl — use an SSL connection with verifying certificate
• --ssl-insecure — use an SSL connection without verifying certificate
• --ssl-secure — use an SSL connection with verifying certificate
• -l, --username=[name] — login name. This parameter is always required. 👑
• --filter=[filter] — filter list, get_list, e.g: "name eq 'node1-vm'"
• -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. 🗣️
• --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 cmd prompt after login. (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for status change after ON/OFF. (Default Value: 60)
• --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 the gnutls-cli binary. (Default Value: /usr/bin/gnutls-cli)

---

🔥 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 the fence device 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. 🙈
• validate-all — validate if all required parameters are entered. ✅

---

💜 STDIN PARAMETERS 💜

• action — fencing action. (Default Value: reboot)
• ip — IP address or hostname of fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device. (Default Value: 80)
• method — method to fence (onoff|cycle). (Default Value: onoff)
• notls — disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up. ⚠️
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• plug — physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
• ssl — use SSL connection with verifying certificate
• ssl_insecure — use SSL connection without verifying certificate
• ssl_secure — use SSL connection with verifying certificate
• username — login name. This parameter is always required. Obsoletes: login
• filter — filter list, get_list, e.g: "name eq 'node1-vm'"
• 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: 60)
• 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)

---

and that's the whole page, bestie!! 🫶 it's the fence_nutanix_ahv (Fence Agent) situation, dated 2009-10-20, and honestly? it ate. go forth and fence responsibly 💖✨🎀🦋