FENCE_AGENT(8)

💖 FENCE_AGENT(8) — the manual, but make it make sense 💖

System Manager's Manual ✨ this is the page for fence_compute and bestie, we're gonna get through it together, no cap 🫶

---

🌸 NAME 🌸

fence_compute — the fence agent for the automatic resurrection of OpenStack compute instances 🧟‍♀️✨ like, it literally brings things back from the dead, it's giving necromancy but make it infrastructure 💅

---

🦋 DESCRIPTION 🦋

So what does this thing actually do? It tells Nova that compute nodes are down, and then it reschedules the instances that got flagged. Periodt. That's the whole vibe.

Okay and here's the tea ☕ — this fence agent takes options from the command line and from stdin. When fenced execs the agent, it sends parameters through stdin. But you can also just run the agent all by itself with command line options, which is lowkey so useful for testing and for turning outlets on or off from scripts. Iconic behavior honestly.

Vendor URL: (it's empty in the original, bestie — nothing there) 🙈

---

✨ PARAMETERS ✨

Okay buckle up, here comes the whole list. Every single one. I'm not skipping a thing 💖

• -o, --action=[action] — the fencing action. (Default Value: off)
• -k, --auth-url=[url] — Keystone Admin Auth URL. (Default Value: — yes, empty)
• -e, --endpoint-type=[endpoint] — Nova Endpoint type. (Default Value: internalURL)
• -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. No plug, no party.
• --region-name=[region] — Region Name. (Default Value: — empty again)
• -t, --tenant-name=[name] — Keystone Admin Tenant or v3 Project. (Default Value: )
• -l, --username=[name] — login name.
• --insecure — allow Insecure TLS Requests. 😬 (says it right there, bestie, it's insecure)
• -P, --project-domain=[name] — Keystone v3 Project Domain. (Default Value: Default)
• -u, --user-domain=[name] — Keystone v3 User Domain. (Default Value: Default)
• -d, --domain=[string] — the DNS domain in which hosts live.
• --instance-filtering — allow instances to be evacuated. (Default Value: True)
• --no-shared-storage — disable functionality for dealing with shared storage. (Default Value: False)
• --record-only — only record the target as needing evacuation. (Default Value: False)
• --compute-domain=[string] — replaced by domain. (it's deprecated, babe, use the new one 💀)
• -q, --quiet — disable logging to stderr. Does not affect --verbose, --debug-file, or logging to syslog. Read that again, it matters.
• -v, --verbose — verbose mode. You can stack multiple -v flags on the command line (e.g., -vvv) to increase verbosity. The more v's the more you see 👀
• --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: 20)
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF. (Default Value: 0)
• --shell-timeout=[seconds] — wait X seconds for cmd prompt after issuing a command. (Default Value: 180)
• --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 things this agent can actually do when you ask it to:

• on — power on machine. ⚡
• off — power off machine. 💤
• status — this returns the status of the plug/virtual machine.
• list — list available plugs with aliases/virtual machines if there's 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. 😭 no fr, that's literally what it says, bestie, nobody knows.
• validate-all — validate if all required parameters are entered.

---

🌈 STDIN PARAMETERS 🌈

Same energy, different delivery system — these are the ones that come in through stdin:

• action — fencing action. (Default Value: off)
• auth_url — Keystone Admin Auth URL. (Default Value: )
• endpoint_type — Nova Endpoint type. (Default Value: internalURL)
• 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
• region_name — Region Name. (Default Value: )
• tenant_name — Keystone Admin Tenant or v3 Project. (Default Value: )
• username — login name. Obsoletes: login
• insecure — allow Insecure TLS Requests.
• project_domain — Keystone v3 Project Domain. (Default Value: Default) Obsoletes: project-domain
• user_domain — Keystone v3 User Domain. (Default Value: Default) Obsoletes: user-domain
• domain — DNS domain in which hosts live.
• instance_filtering — allow instances to be evacuated. (Default Value: True)
• no_shared_storage — disable functionality for dealing with shared storage. (Default Value: False)
• record_only — only record the target as needing evacuation. (Default Value: False)
• compute_domain — replaced by domain. Obsoletes: compute-domain
• 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: 180)
• 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)

---

Reminder bestie: --compute-domain / compute_domain is replaced by domain — it's old news, don't build anything new on it 💀

---

And that's the whole page!! 🫶 Written under fence_compute (Fence Agent), dated 2009-10-20, and filed as FENCE_AGENT(8). Slay, go fence something responsibly 💅✨🌸