FENCE_AGENT(8)

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

okay bestie, sit down, hydrate, because this is fence_ovh from the System Manager's Manual section of the FENCE_AGENT(8) family, and she is lowkey iconic. 🎀

---

✨ NAME ✨

fence_ovh — the fence agent for OVH 🦋

---

🌸 DESCRIPTION 🌸

so fence_ovh is a Power Fencing agent and you can run her inside an OVH datacentre. that's her whole thing. ✨

and here's the tea: poweroff is simulated with a reboot into rescue-pro mode. yes bestie, she doesn't actually kill the machine, she makes it go take a little nap in rescue-pro. not me being dramatic about it but that IS the behaviour, fr fr. 💀

she takes options on the command line and from stdin. when fenced execs the agent, it sends the parameters through stdin. but she can also run all by herself with command line options — which is highkey useful for testing and for turning outlets on or off from scripts. main character energy tbh. 👑

Vendor URL: http://www.ovh.net

---

🎀 PARAMETERS 🎀

every flag, every default, no cap. here we go:

• -o, --action=[action] — the fencing action you want. (Default Value: reboot)
• -Z, --email=[email] — the reboot email. 🍓 heads up: this parameter is always required.
• -p, --password=[password] — your login password or passphrase 🔐
• -S, --password-script=[script] — a script to run to retrieve the password
• -n, --plug=[id] — the physical plug number on the device, UUID, or the identification of the machine. this parameter is always required. 🔌
• -l, --username=[name] — the login name. this parameter is always required.
• -q, --quiet — disable logging to stderr. doesn't affect --verbose or --debug-file or logging to syslog. shhh 🤫
• -v, --verbose — verbose mode. you can stack multiple -v flags on the command line (e.g., -vvv) to increase verbosity. the way she just keeps talking 💅
• --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] — the separator for the plug parameter when you're specifying more than 1 plug. (Default Value: ,)
• -C, --separator=[char] — the 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 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) 🔥

---

💅 ACTIONS 💅

• on — power on the machine. ⭐
• off — power off the machine.
• reboot — reboot the 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. 🙈 (literally what the manpage says, i'm not even kidding)
• validate-all — validate if all required parameters are entered.

---

🌈 STDIN PARAMETERS 🌈

same energy, but they come in through stdin this time:

• action — fencing action (Default Value: reboot)
• email — reboot email. this parameter is always required.
• 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
• username — login name. this parameter is always required. Obsoletes: login
• 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)

---

🌸 quick reminder bestie: fence_ovh's poweroff is simulated with a reboot into rescue-pro mode — that's the actual documented behaviour, so don't come for me when the machine comes back in rescue-pro. it's giving "not a real poweroff" and that's just how she is. 💖

---

and that's the whole page, periodt. 🎀 this gem is from the fence_ovh (Fence Agent) source, dated 2009-10-20, filed under FENCE_AGENT(8). slay, bye bestie!! 🦋✨💜