FENCE_AGENT(8)

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

okay bestie, sit down, hydrate, because we're learning fence_apc today and honestly? it's giving "unix but make it cute". this page lives in the System Manager's Manual (section 8, obviously, we're fancy like that 🎀).

---

✨ NAME ✨

fence_apc — the fence agent for APC, and it does its thing over telnet or ssh. no cap.

---

🌸 DESCRIPTION 🌸

so fence_apc is a Power Fencing agent and it's the one you call when you need the APC network power switch to do its job. the way it works is: it logs into the device via telnet or ssh, and then it reboots a specified outlet. that's the whole vibe. 🦋

real talk though — avoid lengthy telnet/ssh connections while a GFS cluster is running, because that connection will block any necessary fencing actions. like, do not do it. it's giving sabotage.

okay and here's the cute part: the fence agent takes options on the command line and from stdin. when fenced execs the agent, it sends parameters through stdin. but you can also run the agent all by itself with command line options — which is perfect for testing and for turning outlets on or off from scripts. main character energy fr fr. 💅

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

---

👑 PARAMETERS 👑

here come the flags, bestie. all of them. every single one. periodt.

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -c, --command-prompt=[prompt] — forces a Python regex for the command prompt (Default Value: ['\n>', '\napc>'])
• -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.
• -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.
• -x, --ssh — use an SSH connection
• --ssh-options=[options] — SSH options to use (Default Value: -1 -c blowfish)
• -s, --switch=[id] — physical switch number on the device
• -l, --username=[name] — login name. This parameter is always required.
• -q, --quiet — disable logging to stderr. it 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. stack 'em like bracelets 💅
• --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 you're 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)
• --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 🦋

the things this agent can do. choose your fighter:

• 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'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. 🙈 (iconic of it honestly)
• validate-all — validate if all required parameters are entered.

---

💜 STDIN PARAMETERS 💜

same energy, snake_case edition. fenced sends these through stdin 🫶

• action — fencing action (Default Value: reboot)
• command_prompt — force Python regex for command prompt (Default Value: ['\n>', '\napc>']). Obsoletes: cmd_prompt
• identity_file — identity file (private key) for SSH
• inet4_only — forces the agent to use IPv4 addresses only
• inet6_only — forces the agent to use IPv6 addresses only
• ip — IP address or hostname of the fencing device. This parameter is always required. Obsoletes: ipaddr
• ipport — TCP/UDP port to use for 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
• ssh — use SSH connection. Obsoletes: secure
• ssh_options — SSH options to use (Default Value: -1 -c blowfish)
• switch — physical switch number on the device
• 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 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)
• ssh_path — path to the ssh binary (Default Value: /usr/bin/ssh)
• telnet_path — path to the telnet binary (Default Value: /usr/bin/telnet)

---

okay that's the whole page, you ate that. 🍓 this was fence_apc (Fence Agent), dated 2009-10-20, and it's part of FENCE_AGENT(8). go forth and fence responsibly, bestie 💖✨