FENCE_AGENT(8)

💖 fence_ironic — the FENCE_AGENT(8) page but make it make sense 💖

okay bestie, so this is a System Manager's Manual page, section 8, and it's literally about fence_ironic. grab a strawberry 🍓 and let's go.

---

✨ NAME ✨

fence_ironic — Fence agent for OpenStack's Ironic (Bare Metal as a service) service

---

🌸 DESCRIPTION 🌸

So fence_ironic is a Power Fencing agent, right? You use it with machines that are controlled by the Ironic service. This agent calls the openstack CLI. that's the whole vibe.

⚠️ WARNING! This fence agent is not intended for production use. Relying on a functional ironic service for fencing is not a good design choice. like, not me telling you to risk it 💀 it's giving "please don't."

The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. The agent can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts. slay, scriptable.

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

---

🎀 PARAMETERS 🎀

• -o, --action=[action] — Fencing action (Default Value: reboot)
• --auth-url=[authurl] — Keystone Admin Auth URL. This parameter is always required. no skipping it bestie.
• -p, --password=[password] — Login password or passphrase
• -S, --password-script=[script] — Script to run to retrieve password
• -n, --plug=[id] — Physical plug number on device, UUID or identification of machine. This parameter is always required.
• -t, --tenant-name=[tenant] — Keystone Admin Tenant (Default Value: admin)
• -l, --username=[name] — Login name. This parameter is always required.
• -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 them 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)
• --openstack-path=[path] — Path to the OpenStack binary (Default Value: /usr/bin/openstack)
• --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: 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 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.
• monitor — Check the health of fence device
• metadata — Display the XML metadata describing this resource.
• manpage — The operational behavior of this is not known. (😭 iconic honestly, nobody knows what she does)
• validate-all — Validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

• action — Fencing action (Default Value: reboot)
• auth_url — Keystone Admin Auth URL. This parameter is always required. Obsoletes: auth-url
• 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
• tenant_name — Keystone Admin Tenant (Default Value: admin). Obsoletes: tenant-name
• 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)
• openstack_path — Path to the OpenStack binary (Default Value: /usr/bin/openstack). Obsoletes: openstack-path
• 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)

---

and that's the whole page, bestie 💅✨

this one's from the fence_ironic (Fence Agent) crew, dated 2009-10-20, and it lives in section FENCE_AGENT(8) of your friendly neighborhood System Manager's Manual 🫶 go forth and fence responsibly (but not in production, fr fr 🙈) 🎀