FENCE_AGENT(8)

✨ NAME ✨

fence_sbd — the fence agent for sbd, bestie 💖

---

🌸 DESCRIPTION 🌸

fence_sbd is an I/O Fencing agent that you can use in any environment where sbd works — aka, shared storage situations, iykyk 🦋

So here's the vibe: this fence agent takes options on the command line and from stdin. When fenced execs the agent, it sends the parameters through stdin. But you can also just run the agent by itself with command line options, no cap — that's lowkey perfect for testing and for turning outlets on or off from scripts 🔥

Vendor URL:

---

💅 PARAMETERS 💅

• -o, --action=[action] — the fencing action you want (Default Value: reboot) ⭐
• --devices=[device_a,device_b] — the SBD Device, periodt
• -m, --method=[method] — the method to fence, and it's onoff|cycle (Default Value: cycle)
• -n, --plug=[id] — physical plug number on the device, or the UUID, or the identification of the machine. 🚨 This parameter is always required. Like, always always.
• -q, --quiet — disable logging to stderr. It does not affect --verbose, or --debug-file, or logging to syslog. Not those. Just stderr. 💀
• -v, --verbose — verbose mode. You can stack multiple -v flags on the command line (e.g., -vvv) to increase verbosity, go off 👑
• --verbose-level — level of debugging detail in output. Defaults to the number of --verbose flags you gave 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] — the separator for the plug parameter when you're specifying more than 1 plug (Default Value: ,)
• -C, --separator=[char] — the 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 style (default: true when run from Pacemaker 2.0+) 🙈
• --login-timeout=[seconds] — wait X seconds for the cmd prompt after login (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for status change after ON/OFF (Default Value: 30)
• --power-wait=[seconds] — wait X seconds after issuing ON/OFF (Default Value: 0)
• --sbd-path=[path] — path to the SBD binary (Default Value: /usr/sbin/sbd)
• --shell-timeout=[seconds] — wait X seconds for the cmd prompt after issuing a command (Default Value: 3)
• --stonith-status-sleep=[seconds] — sleep X seconds between status calls during a STONITH action (Default Value: 1)
• --crashdump — crashdump instead of a regular fence 💥
• --retry-on=[attempts] — how many attempts to retry power on (Default Value: 1)

---

🌈 ACTIONS 🌈

• on — power on the machine. ✨
• off — power off the machine.
• reboot — reboot the 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. (not us shrugging 💀)
• validate-all — validate if all required parameters are entered. ✅

---

🫶 STDIN PARAMETERS 🫶

• action — fencing action (Default Value: reboot)
• devices — SBD Device
• method — method to fence (onoff|cycle) (Default Value: cycle)
• plug — physical plug number on device, UUID or identification of machine. This parameter is always required. Obsoletes: port
• 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: 30)
• power_wait — wait X seconds after issuing ON/OFF (Default Value: 0)
• sbd_path — path to SBD binary (Default Value: /usr/sbin/sbd)
• 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)
• crashdump — crashdump instead of regular fence
• retry_on — count of attempts to retry power on (Default Value: 1)

---

okay that's literally the whole page, you ate that 🍓 This was fence_sbd (Fence Agent), dated 2009-10-20, from the FENCE_AGENT(8) manual. mwah 💋