FENCE_AGENT(8)

💖 NAME 💖

okay so bestie, gather round — this page is all about fence_vmware_vcloud, and no, that's not a typo, it's the Fence agent for VMware vCloud Director API. periodt.

---

✨ DESCRIPTION ✨

fence_vmware_vcloud is a Power Fencing agent — like, it fences virtual machines, that's its whole thing 💅 — and you can hook it up with the VMware vCloud Director API to do exactly that.

The fence agent is so flexible: it accepts 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 lowkey perfect for testing and for turning outlets on or off from scripts. 🎀

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

---

🌈 PARAMETERS 🌈

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of fencing device. This parameter is always required, no skipsies ✋
• -u, --ipport=[port] — TCP/UDP port to use for connection with device (Default Value: 80)
• -t, --notls — Disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up. (like… it's giving legacy, be careful bestie 😭)
• -p, --password=[password] — login password or passphrase 🔐
• -S, --password-script=[script] — script to run to retrieve password
• -n, --plug=[id] — physical plug number on device, UUID or identification of machine. This parameter is always required 💯
• -z, --ssl — use SSL connection with verifying certificate
• --ssl-insecure — use SSL connection without verifying certificate
• --ssl-secure — use SSL connection with verifying certificate
• -l, --username=[name] — login name. This parameter is always required ✨
• --api-path=[path] — the path part of the API URL (Default Value: /api)
• -q, --quiet — disable logging to stderr. Doesn't affect --verbose or --debug-file or logging to syslog. (she's quiet, not gone 🤫)
• -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 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: 1)
• --shell-timeout=[seconds] — wait X seconds for cmd prompt after issuing command (Default Value: 5)
• --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 👑

• on — power on machine. she's up 💅
• 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. (no cap, that's literally what it says 🙈)
• 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)
• 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
• api_path — the path part of the API URL (Default Value: /api)
• quiet — disable logging to stderr. Doesn't 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: 1)
• shell_timeout — wait X seconds for cmd prompt after issuing command (Default Value: 5)
• 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)

fr fr bestie, that's the whole thing — nothing skipped, nothing summarised, every flag accounted for 🫶

---

okay that's a wrap 🌸 this was fence_vmware_vcloud from the Fence Agent source, and the page is dated 2009-10-20. she's been iconic since 2009 and she's still serving. mwah 💋✨