FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖

System Manager's Manual ✨ — and yes bestie, we're doing the whole thing, no skips, no shortcuts. This is fence_evacuate, the fence agent for the automatic resurrection of OpenStack compute instances. 🧟♀️➡️✨

---

🌸 NAME 🌸

fence_evacuate — fence agent for the automatic resurrection of OpenStack compute instances 🦋

---

💅 DESCRIPTION 💅

Okay so, what does it do? It's used to reschedule flagged instances. That's the whole vibe. 🔥

Now here's the tea: the fence agent takes options from the command line and from stdin, both. When fenced execs the agent, it sends the parameters through stdin. But you can also just run the agent all by itself with command-line options — which is lowkey iconic for testing, and for turning outlets on or off from scripts. 🎀

Vendor URL: (nothing here, it's literally blank, no cap)

---

👑 PARAMETERS 👑

• -o, --action=[action] — the fencing action, bestie. Which move are we making? (Default Value: reboot)
• -k, --auth-url=[url] — Keystone Admin Auth URL, the whole where do I even log in situation (Default Value: empty)
• -e, --endpoint-type=[endpoint] — Nova Endpoint type, aka which door we're knocking on (Default Value: internalURL)
• -p, --password=[password] — login password or passphrase 🔐
• -S, --password-script=[script] — a script to run that goes and fetches the password for you, so you don't have to hold it yourself 🫶
• -n, --plug=[id] — physical plug number on device, UUID, or identification of machine. This parameter is always required. Periodt. You literally cannot skip it. 💀
• --region-name=[region] — Region Name (Default Value: empty)
• -t, --tenant-name=[name] — Keystone Admin Tenant or v3 Project (Default Value: empty)
• -l, --username=[name] — login name ✨
• --insecure — allow Insecure TLS Requests 🙈 (yes it's called that, and yes that's a little scary, it's giving "we're not verifying certificates")
• -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] — 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)
• --compute-domain=[string] — replaced by domain ⚠️ (old news, use domain instead)
• -q, --quiet — disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog. It's selectively quiet, iykyk. 🤫
• -v, --verbose — verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. Stack 'em like bracelets. 💫
• --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: 0)
• --shell-timeout=[seconds] — wait X seconds for cmd prompt after issuing 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 🌈

• on — power on machine. Wakey wakey bestie ☀️
• off — power off machine. Night night 💤
• reboot — reboot machine. The classic "turn it off and on again" but make it ✨official✨
• 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. Two-for-one. 🎀
• monitor — check the health of fence device 🩺
• metadata — display the XML metadata describing this resource 📜
• manpage — the operational behavior of this is not known. 💀 literally nobody knows what this does, it's a mystery, we're all just vibing
• validate-all — validate if all required parameters are entered ✅

---

🦋 STDIN PARAMETERS 🦋

• action — fencing action (Default Value: reboot)
• auth_url — Keystone Admin Auth URL (Default Value: empty)
• 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: empty)
• tenant_name — Keystone Admin Tenant or v3 Project (Default Value: empty)
• 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)
• 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)

---

and that's the whole page, bestie, every single flag, default, obsolete name and action accounted for 💖

This was fence_evacuate (Fence Agent), dated 2009-10-20, from FENCE_AGENT(8) — slay, go forth and evacuate those instances responsibly 🫶✨🎀