FENCE_AGENT(8)

💖 FENCE_AGENT(8) 💖 — the System Manager's Manual, but make it make sense

okay bestie, so this is a page from section 8 of the manual (that's the system manager's manual, the admin-y one), and it's all about fence_shelly_gen2. sit down, grab a strawberry drink, we're doing fencing 🍓

✨ NAME ✨

fence_shelly_gen2 — the fence agent for Shelly Gen 2+ Switches. that's it, that's the name, no cap.

🦋 DESCRIPTION 🦋

so fence_shelly_gen2 is a Power Fencing agent you use with Shelly Switches that speak the gen 2+ API, and its whole job is fencing the hardware that's attached to them. slay.

and here's the thing about how it takes input — the fence agent accepts options on the command line and from stdin. when fenced execs the agent, it sends parameters through stdin. but you can also just run the agent by itself with command line options, which is genuinely so useful for testing and for flipping outlets on or off from scripts. main character behavior honestly.

Vendor URL: https://shelly-api-docs.shelly.cloud/gen2/ — go look, iykyk 💅

🎀 PARAMETERS 🎀

• -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. like, always always.
• -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. ⚠️ lowkey scary: this should only be used for devices that do not support TLS1.0 and up.
• -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. no skipping bestie.
• -z, --ssl — Use SSL connection with verifying certificate. 🔒
• --ssl-insecure — Use SSL connection without verifying certificate. 🙈
• --ssl-secure — Use SSL connection with verifying certificate. 🔒
• -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, literally.
• --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 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 status change after ON/OFF. (Default Value: 20)
• --power-wait=[seconds] — Wait X seconds after issuing ON/OFF. (Default Value: 1)
• --shell-timeout=[seconds] — Wait X seconds for the cmd prompt after issuing a command. (Default Value: 5)
• --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 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. 😭 (yes, that's what it says. we don't know. iconic honestly.)
• validate-all — Validate if all required parameters are entered. ✅

🌸 STDIN PARAMETERS 🌸

same energy, different door — these are the ones that come in over stdin:

• 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
• 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: 1)
• shell_timeout — Wait X seconds for cmd prompt after issuing command (Default Value: 5)
• 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)

quick vibe check: -t/--notls forcing SSL3.0 is not a casual choice. only for devices that don't do TLS1.0 and up. don't be reckless with your security bestie 🫶

and that's the whole page!! this one's fence_shelly_gen2 (Fence Agent), dated 2009-10-20, and it lives in section FENCE_AGENT(8). thanks for reading my little manual rant, you ate 💅✨🌈