FENCE_AGENT(8)

💖 NAME 💖

fence_cisco_ucs — bestie, it's a Fence agent for Cisco UCS ✨

---

🦋 DESCRIPTION 🦋

Okay so fence_cisco_ucs is a Power Fencing agent and it's literally built to be used with Cisco UCS to fence machines. Slay.

Here's the tea: this fence agent takes options from the command line and from stdin. When fenced execs the agent, it sends parameters through stdin. But the agent can also just vibe on its own with command line options — which is highkey useful for testing and for turning outlets on or off from scripts. Main character energy fr fr 💅

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

---

🎀 PARAMETERS 🎀

One bullet per flag, no skips, we're not doing that today 💖

• -o, --action=[action] — the fencing action you want (Default Value: reboot)
• -a, --ip=[ip] — IP address or hostname of the fencing device. This parameter is always required. No ip, no party 🙈
• -u, --ipport=[port] — TCP/UDP port to use for the connection with the device (Default Value: 80)
• -t, --notls — Disable TLS negotiation and force SSL3.0. > Okay bestie listen: this should only be used for devices that do not support TLS1.0 and up. That's the rule. 🌸
• -p, --password=[password] — login password or passphrase
• -S, --password-script=[script] — a 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 too 💅
• -z, --ssl — use SSL connection with verifying certificate
• --ssl-insecure — use SSL connection without verifying certificate
• --ssl-secure — use SSL connection with verifying certificate
• --suborg=[path] — additional path needed to access suborganization (Default Value: empty)
• -l, --username=[name] — login name. Yep, this parameter is always required as well ✨
• -q, --quiet — disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog, so don't get it twisted
• -v, --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).
• -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 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: 5)
• --missing-as-off — missing port returns OFF instead of failure
• --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)
• --gnutlscli-path=[path] — path to the gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

---

🌈 ACTIONS 🌈

• 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 honestly, she said idk 💀)
• validate-all — validate if all required parameters are entered.

---

🫶 STDIN PARAMETERS 🫶

These are the ones that come in through stdin, and yes some of them have Obsoletes — old names that got replaced, so write them down 📝

• action — fencing action (Default Value: reboot)
• 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: 80)
• notls — disable TLS negotiation and force SSL3.0. This should only be used for devices that do not support TLS1.0 and up.
• 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
• ssl — use SSL connection with verifying certificate
• ssl_insecure — use SSL connection without verifying certificate
• ssl_secure — use SSL connection with verifying certificate
• suborg — additional path needed to access suborganization (Default Value: empty)
• 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)
• missing_as_off — missing port returns OFF instead of failure
• 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)
• gnutlscli_path — path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)

---

Okay that's the whole page, you ate that fr fr 💖 This was fence_cisco_ucs (Fence Agent), from 2009-10-20, living in the FENCE_AGENT(8) section of the System Manager's Manual. Go fence something, bestie 🦋✨👑