FENCE_AGENT(8)

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

okay bestie, sit down, hydrate, and let me tell you about fence_openstack(8) from the System Manager's Manual. this is the one, this is the moment. 🫶

---

✨ NAME ✨

fence_openstack</p> — the fence agent for OpenStack's Nova service. yes, that's her. she's a fencing agent, she's from the OpenStack Nova world, and she's that girl. 💅

---

🌸 DESCRIPTION 🌸

fence_openstack</p> is a Power Fencing agent you can use with machines controlled by the Openstack's Nova service. she calls up python-novaclient and honestly? that dependency is mandatory — it has to be installed, no negotiating, no cap. ✨

and here's the vibe: the fence agent takes options on the command line and from stdin. fenced sends parameters through stdin when it execs the agent. but you can also just run the agent by itself with command line options — which is lowkey iconic for testing and for turning outlets on or off from scripts. main character energy fr fr. 🔥

Vendor URL: https://wiki.openstack.org/wiki/Nova

---

🎀 PARAMETERS 🎀

every single one, in order, no skips, no "eh you don't need that one." we don't do that here. 😤

• -o, --action=[action] — the fencing action. (Default Value: reboot)
• -p, --password=[password] — login password or passphrase. 🤫
• -S, --password-script=[script] — script to run to retrieve the password.
• -n, --plug=[UUID] — the UUID of the node to be fenced.
• --ssl-insecure — use an SSL connection without verifying the certificate. (> lowkey risky, bestie — she said what she said.)
• -l, --username=[name] — login name.
• --auth-url=[authurl] — Keystone Auth URL.
• --project-name=[project] — Keystone Project. (Default Value: admin)
• --user-domain-name=[domain] — Keystone User Domain Name. (Default Value: Default)
• --project-domain-name=[domain] — Keystone Project Domain Name. (Default Value: Default)
• --cloud=[cloud] — Cloud from clouds.yaml. ☁️
• --openrc=[openrc] — openrc config file.
• --uuid=[uuid] — replaced by port/-n/--plug. (she's retired, respect her legacy 💀)
• --cacert=[cacert] — SSL X.509 certificates file. (Default Value: — yes, it's blank, that's literally what it says 🙈)
• --apitimeout=[seconds] — timeout in seconds to use for API calls, default is 60. (Default Value: 60)
• -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. stack her up, she eats. 🔥
• --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: 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)

---

🌈 ACTIONS 🌈

the whole roster. every single one of them shows up and shows out. 👑

• 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. efficiency queen. ✨
• monitor — check the health of fence device. 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. 💀 (she's mysterious, we love her anyway)
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same energy, snake_case era. these are the ones that come in through stdin, obsoletes and all. 🐍

• action — fencing action (Default Value: reboot)
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve password. Obsoletes: passwd_script
• plug — UUID of the node to be fenced. Obsoletes: port
• ssl_insecure — use SSL connection without verifying certificate
• username — login name. Obsoletes: login
• auth_url — Keystone Auth URL. Obsoletes: auth-url
• project_name — Keystone Project (Default Value: admin) Obsoletes: project-name
• user_domain_name — Keystone User Domain Name (Default Value: Default) Obsoletes: user-domain-name
• project_domain_name — Keystone Project Domain Name (Default Value: Default) Obsoletes: project-domain-name
• cloud — Cloud from clouds.yaml. ☁️
• openrc — openrc config file
• uuid — replaced by port/-n/--plug
• cacert — SSL X.509 certificates file (Default Value: — blank, as above 🙈)
• apitimeout — timeout in seconds to use for API calls, default is 60. (Default Value: 60)
• 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)

---

and that's the whole page, bestie. no notes. periodt. 💖✨

this lil masterpiece is brought to you by fence_openstack (Fence Agent), dated 2009-10-20 — vintage, iconic, still slaying. mwah. 🎀💅🫶