FENCE_AGENT(8)

💖 FENCE_AGENT(8) — the fence_amt page, bestie edition 💖

okay so. welcome to the fence_amt manual page, straight out of the System Manager's Manual. pull up a chair, grab a strawberry 🍓, and let's get into it.

---

✨ NAME ✨

fence_amt — Fence agent for AMT. that's it, that's the name, short and iconic 👑

---

🌸 DESCRIPTION 🌸

so fence_amt is a Power Fencing agent, and it's the one you want when you're dealing with Intel AMT. it calls on its support-software bestie amttool to do the actual work — here's where that lives: http://www.kraxel.org/cgit/amtterm/. 💅

here's the tea: this fence agent takes options from the command line and from stdin. both. because why not. when fenced execs the agent, it sends parameters through stdin — that's the whole system, that's the vibe.

but also?? you can totally run the agent all by itself with command line options. that's lowkey so useful for testing, and for turning outlets on or off from scripts. no cap. 🔥

Vendor URL: http://www.intel.com/ — the intel girlies said hi.

---

🎀 PARAMETERS 🎀

every single flag, in order, no skips, no cuts. periodt.

• -o, --action=[action] — the fencing action you want. (Default Value: reboot)
• -b, --boot-option=[option] — changes the default boot behavior of the machine. options are (pxe|hd|hdsafe|cd|diag) 🥾
• -a, --ip=[ip] — IP address or hostname of the fencing device. that's the address, bestie.
• -u, --ipport=[port] — the TCP/UDP port used to connect to the device. (Default Value: 16994)
• -m, --method=[method] — the method to fence with. choices are (onoff|cycle). (Default Value: onoff)
• -p, --password=[password] — login password or passphrase. keep it secret, keep it safe 🔐
• -S, --password-script=[script] — a script you run to go retrieve that password. very spy-core.
• -n, --plug=[ip] — IP address or hostname of the fencing device (used together with --port-as-ip).
• -q, --quiet — disables logging to stderr. and heads up: it does not affect --verbose or --debug-file or logging to syslog. those keep doing their thing.
• -v, --verbose — verbose mode. and the way this stacks?? multiple -v flags can be piled up on the command line (e.g., -vvv) to increase verbosity. go off.
• --verbose-level — the level of debugging detail in the output. defaults to the number of --verbose flags you 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. bye 👋
• -h, --help — display help and exit. also bye 👋
• --plug-separator=[char] — the separator for the plug parameter when you're specifying more than 1 plug. (Default Value: ,)
• --amttool-path=[path] — path to the amttool binary. (Default Value: /usr/bin/amttool)
• --delay=[seconds] — wait X seconds before fencing is started. (Default Value: 0)
• --disable-timeout=[true/false] — disable the timeout, true or false. (default: true when run from Pacemaker 2.0+)
• --login-timeout=[seconds] — wait X seconds for the cmd prompt after login. (Default Value: 5)
• --port-as-ip — makes "port/plug" an alias to the IP address. cute little shortcut.
• --power-timeout=[seconds] — test X seconds for a 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 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)
• --retry-on=[attempts] — how many attempts to retry power on. (Default Value: 1)
• --use-sudo — use sudo (without password) when calling 3rd party software. no password needed, wild.
• --sudo-path=[path] — path to the sudo binary. (Default Value: /usr/bin/sudo)

---

⭐ ACTIONS ⭐

the things it can actually do. main character moves only.

• 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 fence device. vibe check, basically 🩺
• metadata — Display the XML metadata describing this resource.
• manpage — The operational behavior of this is not known. 😭 no fr, that's genuinely what it says, we don't know.
• validate-all — Validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

same energy, but these are the stdin names. (notice they're the underscore versions, iykyk.)

• action — Fencing action (Default Value: reboot)
• boot_option — Change the default boot behavior of the machine. (pxe|hd|hdsafe|cd|diag)
• ip — IP address or hostname of fencing device. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 16994)
• method — Method to fence (onoff|cycle) (Default Value: onoff)
• 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
• 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: ,)
• amttool_path — Path to amttool binary (Default Value: /usr/bin/amttool)
• 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)
• use_sudo — Use sudo (without password) when calling 3rd party software. Obsoletes: sudo
• sudo_path — Path to sudo binary (Default Value: /usr/bin/sudo)

---

⚠️ quick real-talk: manpage says its operational behavior "is not known" — that's not me being cute, that's literally the documentation. don't come for me, come for the manpage. 🙈

---

and that's the whole page, bestie. you ate. 💅✨

sign-off szn: this one's fence_amt (Fence Agent), dated 2009-10-20, and it lives in FENCE_AGENT(8) 🫶 take care of her, she's been here since 2009 and she's still serving. 🎀