FENCE_AGENT(8)

✨ NAME ✨

okay bestie, so this is fence_ovm — a Fence agent for Oracle VM 💅, and it lives in section 8 of the System Manager's Manual. yes, section 8. the big-kid sysadmin section. slay.

🦋 DESCRIPTION 🦋

fence_ovm is a Power Fencing agent — and the way that it just fences power, iconic — which you can use with the virtual machines that Oracle VM Manager handles. 💖

The fence agent takes options on the command line and from stdin. When fenced execs the agent, it sends the parameters through stdin. But also!! you can run the agent all by itself with command line options, which is super useful for testing and for turning outlets on or off from scripts. main character energy fr fr. 🎀

Vendor URL: https://www.oracle.com/virtualization/technologies/vm/

👑 PARAMETERS 👑

okay so here's the whole roster, no cap, every single one:

• -o, --action=[action] — the fencing action (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required. like, always always.
• -u, --ipport=[port] — TCP/UDP port to use for the connection with the device (Default Value: 7002)
• -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, or the UUID or identification of the machine. This parameter is always required too.
• -z, --ssl — use an SSL connection with verifying the certificate
• --ssl-client-certificate-file=[filename] — SSL client certificate file
• --ssl-insecure — use an SSL connection without verifying the certificate
• --ssl-secure — use an SSL connection with verifying the certificate
• -l, --username=[name] — login name
• -q, --quiet — disable logging to stderr. It does not affect --verbose or --debug-file or logging to syslog. so don't get it twisted. 🙈
• -v, --verbose — verbose mode. You can stack multiple -v flags on the command line (e.g., -vvv) to increase the verbosity. go off.
• --verbose-level — level of debugging detail in the output. It defaults to however many --verbose flags you 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 the cmd prompt after login (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for a 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 the cmd prompt after issuing a 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 the available plugs with their aliases/virtual machines, if there's support for more than one device. Returns N/A otherwise.
• list-status — list the available plugs with their 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. we said what we said.
• validate-all — validate whether all the required parameters are entered.

🎀 STDIN PARAMETERS 🎀

same crew, but they come in through stdin with underscores instead of dashes. obsessed.

• action — fencing action (Default Value: reboot)
• ip — IP address or hostname of the fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for the connection with the device (Default Value: 7002)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve the password. Obsoletes: passwd_script
• plug — physical plug number on the device, or the UUID or identification of the machine. This parameter is always required. Obsoletes: port
• ssl — use an SSL connection with verifying the certificate
• ssl_client_certificate_file — SSL client certificate file
• ssl_insecure — use an SSL connection without verifying the certificate
• ssl_secure — use an SSL connection with verifying the certificate
• username — login name. Obsoletes: login
• quiet — disable logging to stderr. It 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 the 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 the given file. Obsoletes: debug
• version — display version information and exit
• help — display help and exit
• plug_separator — separator for the plug parameter when specifying more than 1 plug (Default Value: ,)
• separator — separator for the CSV created by the 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 the cmd prompt after login (Default Value: 5)
• power_timeout — test X seconds for a 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 the cmd prompt after issuing a 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 the gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

okay that's the whole page, you ate that fr fr 🫶 this one's filed under fence_ovm (Fence Agent) and it's dated 2009-10-20 — vintage but still serving. bye bestie, go fence something responsibly 💅✨