FENCE_AGENT(8)

🦋 FENCE_AGENT(8) — fence_redfish, bestie edition ✨

okay so hi!! welcome to the System Manager's Manual section 8, where we're talking about fence_redfish — a power fencing agent, and yes it's exactly as iconic as it sounds 💅

---

💖 NAME 💖

fence_redfish — Power Fencing agent for Redfish 🐟✨ (no, not the fish, the API, but honestly? equally powerful)

---

🌸 DESCRIPTION 🌸

so basically, fence_redfish is a Power Fencing agent that you pair up with Out-of-Band controllers that speak Redfish APIs. What do those controllers do? They give you remote access so you can control the power on a server. From, like, anywhere. main character energy honestly 🔥

The fence agent takes options from the command line and from stdin — both!! Fenced sends its parameters through stdin when it execs the agent. But also, you can just run the agent by itself with command line options, which is super handy for testing and for turning outlets on or off from scripts. no cap 🫶

Vendor URL: http://www.dmtf.org

---

✨ PARAMETERS ✨

here's the whole menu, and I do mean the whole menu — every single one of them, periodt:

• -o, --action=[action] — the fencing action (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of the fencing device
• -u, --ipport=[port] — TCP/UDP port to use for the connection with the device (Default Value: 443)
• -p, --password=[password] — login password or passphrase
• -S, --password-script=[script] — script to run to retrieve the password
• -n, --plug=[ip] — IP address or hostname of the fencing device (this one works together with --port-as-ip)
• --redfish-uri=[uri] — base or starting Redfish URI (Default Value: /redfish/v1)
• -z, --ssl — use SSL connection with verifying certificate (Default Value: 1)
• --ssl-insecure — use SSL connection without verifying certificate
• --ssl-secure — use SSL connection with verifying certificate
• --systems-uri=[uri] — Redfish Systems resource URI, i.e. /redfish/v1/Systems/System.Embedded.1
• -l, --username=[name] — login name. This parameter is always required. like, always always 🙈
• -q, --quiet — disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog, just so you know
• -v, --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)
• -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 the plug parameter when specifying more than 1 plug (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)
• --port-as-ip — make "port/plug" be an alias to IP address
• --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)
• --gnutlscli-path=[path] — path to the gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

---

🎀 ACTIONS 🎀

the whole vibe check of things you can ask it to do:

• on — Power on machine. 💡
• off — Power off machine. 💀
• reboot — Reboot machine. 🔄
• status — This returns the status of the plug/virtual machine.
• 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. (yeah, that's literally all it says, I'm not making it up 🙈)
• validate-all — Validate if all required parameters are entered. ✅
• diag — Pulse a diagnostic interrupt to the processor(s).

---

🌈 STDIN PARAMETERS 🌈

same energy, different delivery method — these come in over stdin, and some of them have obsoletes, which we are not hiding:

• action — Fencing action (Default Value: reboot)
• ip — IP address or hostname of fencing device. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 443)
• password — Login password or passphrase. Obsoletes: passwd
• password_script — Script to run to retrieve password. Obsoletes: passwd_script
• plug — IP address or hostname of fencing device (together with --port-as-ip). Obsoletes: port
• redfish_uri — Base or starting Redfish URI (Default Value: /redfish/v1). Obsoletes: redfish-uri
• ssl — Use SSL connection with verifying certificate (Default Value: 1)
• ssl_insecure — Use SSL connection without verifying certificate
• ssl_secure — Use SSL connection with verifying certificate
• systems_uri — Redfish Systems resource URI, i.e. /redfish/v1/Systems/System.Embedded.1. Obsoletes: systems-uri
• 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: ,)
• 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)
• port_as_ip — Make "port/plug" to be an alias to IP address
• 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)
• gnutlscli_path — Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

---

okay that's the whole page bestie, you ate it 💅✨ and for the cute sign-off: this is the fence_redfish (Fence Agent) page, dated 2009-10-20, living in FENCE_AGENT(8). iconic, timeless, obsessed 🎀🦋💖