FENCE_AGENT(8)

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

okay bestie, welcome to the man page for fence_raritan ✨ — and yes, it lives in section 8 of your System Manager's Manual, so it's a big-girl admin page, not a lil userland one. 🎀

---

🌸 NAME 🌸

fence_raritan — the Power Fencing agent for Raritan Dominion PX. she fences. she powers. she slays. 💅

---

✨ DESCRIPTION ✨

fence_raritan is a Power Fencing agent, and she's the one you want for the Raritan DPXS12-20 Power Distribution Unit. 🫶

How she works: she logs into the device via telnet and reboots a specified outlet. That's it, that's the job. iconic, honestly.

🚨 real talk bestie: avoid lengthy telnet connections while a GFS cluster is running, because the connection will block any necessary fencing actions. And blocking fencing in a cluster is not the vibe. periodt. 😭

The fence agent takes options on the command line and from stdin. fenced sends parameters through stdin when it execs the agent. You can also run the agent by itself with command line options — which is genuinely so useful for testing and for turning outlets on or off from scripts. girlboss automation. ✨

Vendor URL: http://www.raritan.com/

---

🎀 PARAMETERS 🎀

Every single one, no skipping, no cap. 👑

• -o, --action=[action] — the fencing action. Default Value: reboot
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required. 🔥
• -u, --ipport=[port] — TCP/UDP port to use for the 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. 🔥
• -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. stackable, like my iced lattes ☕
• --verbose-level — level of debugging detail in the 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 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). (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 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] — count of attempts to retry power on. Default Value: 1
• --telnet-path=[path] — path to the telnet binary. Default Value: /usr/bin/telnet

---

🌈 ACTIONS 🌈

the things she can actually do for you, bestie:

• 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 is 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. 🙈
• validate-all — validate if all required parameters are entered. ✅

---

🦋 STDIN PARAMETERS 🦋

same energy, snake_case edition. These are the names fenced sends down the pipe. 🌸

• action — fencing action. Default Value: reboot
• ip — IP address or hostname of the fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for the connection with the device. Default Value: 23
• password — login password or passphrase. Obsoletes: passwd
• password_script — script to run to retrieve the password. Obsoletes: passwd_script
• plug — physical plug number on the device, UUID, or identification of the machine. This parameter is always required. Obsoletes: port
• 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 the 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 the given file. Obsoletes: debug
• version — display version information and exit. ⭐
• help — display help and exit. 🫶
• plug_separator — separator for the plug parameter when specifying more than 1 plug. Default Value: ,
• separator — separator for the CSV created by the 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 the cmd prompt after login. Default Value: 5
• power_timeout — test X seconds for a 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 the cmd prompt after issuing a 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
• telnet_path — path to the telnet binary. Default Value: /usr/bin/telnet

---

and that's the whole page, bestie!! 🎀 you read it all, which is main character energy fr fr. 💅

sign-off time: this page is fence_raritan (Fence Agent), dated 2009-10-20, and it's filed under FENCE_AGENT(8). slay, go fence something responsibly. ✨👑💖