FENCE_AGENT(8)

💖 fence_wti — the WTI girlies' fencing agent 💖

okay so bestie, welcome to fence_wti(8) from the System Manager's Manual section 8. yes she's a manual page, yes she's serving, let's get into it ✨

---

🌸 NAME 🌸

fence_wti — the fence agent for WTI, no cap 💅

---

✨ DESCRIPTION ✨

So fence_wti is a Power Fencing agent that works with the WTI Network Power Switch (NPS). It logs into an NPS via telnet or ssh and boots a specified plug. That's the whole vibe. 🎀

⚠️ okay this part is important, listen up: lengthy telnet connections to the NPS should be avoided while a GFS cluster is running, because the connection will block any necessary fencing actions. not me letting a telnet session hold up the whole cluster 😭

The fence agent accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. And the agent can be run by itself with command line options — which is lowkey iconic for testing and for turning outlets on or off from scripts. 🦋

Vendor URL: http://www.wti.com — go say hi, iykyk 🫶

---

💅 PARAMETERS 💅

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -c, --command-prompt=[prompt] — force the Python regex for the command prompt (Default Value: ['RSM>', 'MPC>', 'IPS>', 'TPS>', 'NBB>', 'NPS>', 'VMR>'])
• -k, --identity-file=[filename] — identity file (private key) for SSH 🔑
• -4, --inet4-only — forces the agent to use IPv4 addresses only
• -6, --inet6-only — forces the agent to use IPv6 addresses only
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required, fr fr
• -u, --ipport=[port] — TCP/UDP port to use for connection with the device (Default Value: 23)
• -p, --password=[password] — login password or passphrase
• -S, --password-script=[script] — script to run to retrieve the password
• -n, --plug=[id] — physical plug number on the device, UUID or identification of the machine. This parameter is always required, periodt
• -x, --ssh — use an SSH connection
• --ssh-options=[options] — SSH options to use
• -l, --username=[name] — login name
• -q, --quiet — disable logging to stderr. does not affect --verbose or --debug-file or logging to syslog, just so we're clear 💀
• -v, --verbose — verbose mode. multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity. go off, stack them
• --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 the 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: ,)
• -C, --separator=[char] — separator for 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) (default: true when run from Pacemaker 2.0+)
• --login-timeout=[seconds] — wait X seconds for cmd prompt after login (Default Value: 10)
• --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 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] — count of attempts to retry power on (Default Value: 1)
• --ssh-path=[path] — path to the ssh binary (Default Value: /usr/bin/ssh)
• --telnet-path=[path] — path to the telnet binary (Default Value: /usr/bin/telnet)

---

🎀 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. slay, efficiency
• monitor — check the health of the fence device. vibe check, basically 🩺
• metadata — display the XML metadata describing this resource.
• manpage — the operational behavior of this is not known. yeah. we don't know her 🙈
• validate-all — validate if all required parameters are entered.

---

🌈 STDIN PARAMETERS 🌈

• action — fencing action (Default Value: reboot)
• command_prompt — force Python regex for command prompt (Default Value: ['RSM>', 'MPC>', 'IPS>', 'TPS>', 'NBB>', 'NPS>', 'VMR>']) Obsoletes: cmd_prompt
• identity_file — identity file (private key) for SSH
• inet4_only — forces agent to use IPv4 addresses only
• inet6_only — forces agent to use IPv6 addresses only
• ip — IP address or hostname of fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for connection with device (Default Value: 23)
• 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
• ssh — use SSH connection. Obsoletes: secure
• ssh_options — SSH options to use
• username — login name. 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: 10)
• 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)
• ssh_path — path to ssh binary (Default Value: /usr/bin/ssh)
• telnet_path — path to telnet binary (Default Value: /usr/bin/telnet)

---

🫶 and that's the whole page bestie, every flag accounted for, nothing skipped, we ate 💅

okay bye, this was fence_wti (Fence Agent) and she was dated 2009-10-20 — she's been serving since 2009 and she still eats every time. mwah. 🎀💖✨