FENCE_AGENT(8)

💖 fence_raritan_px3 — FENCE_AGENT(8) 💖

okay bestie, sit down, hydrate, and let's talk about fence_raritan_px3, a section-8 system manager's manual situation. yes this is a real manpage and yes I made it cute. you're welcome 🫶

---

✨ NAME ✨

fence_raritan_px3 — Power Fencing agent for Raritan Dominion PX2 and PX3

---

🌸 DESCRIPTION 🌸

So fence_raritan_px3 is a Power Fencing agent and it's built to hang out with the Raritan PX2 and PX3 Power Distribution Unit series. It logs into the device via telnet or ssh and reboots a specified outlet. Single outlets AND grouped outlets are supported, we contain multitudes. 💅

The fence is tested on this model: PX3-5466V. 🎀

heads up bestie 😭 There have been issues seen with the telnet prompt on 3.4.x and 3.5.x Raritan firmware versions. It's recommended to update to at least version 3.6.x. no cap, just go update.

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 plot twist — the agent can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts. main character energy fr fr. ✨

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

---

💅 PARAMETERS 💅

okay here come the flags, every single one, I did NOT skip a single one because that's not the vibe:

• -o, --action=[action] — Fencing action (Default Value: reboot)
• -c, --command-prompt=[prompt] — Force Python regex for command prompt (Default Value: .*\[My PDU\] #)
• -k, --identity-file=[filename] — Identity file (private key) for SSH
• -4, --inet4-only — Forces agent to use IPv4 addresses only
• -6, --inet6-only — Forces agent to use IPv6 addresses only
• -a, --ip=[ip] — IP address or hostname of fencing device. This parameter is always required. 🫡
• -u, --ipport=[port] — TCP/UDP port to use for connection with device (Default Value: 23)
• -p, --password=[password] — Login password or passphrase
• -S, --password-script=[script] — Script to run to retrieve password
• -n, --plug=[id] — Physical plug number on device, UUID or identification of machine. This parameter is always required.
• -x, --ssh — Use SSH connection
• --ssh-options=[options] — SSH options to use
• -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. stacking buffs, iconic.
• --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 plug parameter when specifying more than 1 plug (Default Value: ,)
• -C, --separator=[char] — Separator for CSV created by '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: 5)
• --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: 8)
• --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 ssh binary (Default Value: /usr/bin/ssh)
• --telnet-path=[path] — Path to telnet binary (Default Value: /usr/bin/telnet)

---

🦋 ACTIONS 🦋

the moves you can pull. the menu. the vibe check. 💜

• on — Power on machine.
• off — Power off machine.
• reboot — Reboot 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 then 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 fence device
• metadata — Display the XML metadata describing this resource.
• manpage — The operational behavior of this is not known. 🙈 (yes really, that's what it says, I'm just the messenger)
• validate-all — Validate if all required parameters are entered.

---

⭐ STDIN PARAMETERS ⭐

same energy, different delivery system — these come in through stdin, and some of them have obsolete aliases that still lurk. keep an eye on those:

• action — Fencing action (Default Value: reboot)
• command_prompt — Force Python regex for command prompt (Default Value: .*\[My PDU\] #) 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. 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: ,)
• 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: 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: 8)
• 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)

---

that's the whole page bestie, no crumbs left 🍓 and before you go — this lil masterpiece is fence_raritan_px3 (Fence Agent), dated 2009-10-20, and it lives in the FENCE_AGENT(8) section of the manual. slay, go fence something responsibly 💖✨👑