FENCE_AGENT(8)

💖 NAME 💖

fence_aliyun — the fence agent for Aliyun (aka Aliyun Web Services), bestie 💅

---

🌸 DESCRIPTION 🌸

okay so fence_aliyun is a Power Fencing agent for Aliyun. that's the whole vibe. it fences. it powers. it's giving main character energy in your cluster 🫶

here's the tea: 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 just run the agent by itself with command line options — which is lowkey so useful for testing and for turning outlets on or off from scripts ✨

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

---

✨ PARAMETERS ✨

• -o, --action=[action] — the fencing action, obvi. (Default Value: reboot)
• -n, --plug=[id] — physical plug number on the device, or the UUID / identification of the machine. this one is always required, no skipping 🙅‍♀️
• -r, --region=[name] — the region.
• -a, --access-key=[name] — Access Key.
• -s, --secret-key=[name] — Secret Key.
• --ram-role=[name] — Ram Role.
• --credentials-file=[path] — path to the credentials file.
• --credentials-file-profile=[profile] — credentials file profile. (Default Value: default)
• --filter=[key=value] — filter for list-action.
• -q, --quiet — disable logging to stderr. ngl it does not affect --verbose or --debug-file or logging to syslog.
• -v, --verbose — verbose mode. you can stack multiple -v flags on the command line (like -vvv) to crank the verbosity up 📈
• --verbose-level — level of debugging detail in output. defaults to the number of --verbose flags you 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 cmd prompt after login. (Default Value: 5)
• --power-timeout=[seconds] — test X seconds for status change after ON/OFF. (Default Value: 60)
• --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: 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)

---

🎀 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. 💀 (not me reading that and going "ok bestie, noted")
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

• action — fencing action. (Default Value: reboot)
• plug — physical plug number on device, UUID or identification of machine. this parameter is always required. Obsoletes: port
• region — region.
• access_key — Access Key.
• secret_key — Secret Key.
• ram_role — Ram Role.
• credentials_file — path to credentials file.
• credentials_file_profile — credentials file profile. (Default Value: default)
• filter — filter for list-action.
• 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: 60)
• 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)

---

⭐ friendly reminder bestie: plug is always required, and manpage's operational behavior is genuinely listed as not known. we keep the lore accurate here 💅

---

and that's the whole page, bestie!! this lil doc lives in the Fence Agent manual set for fence_aliyun, dated 2009-10-20, filed under the manual page FENCE_AGENT(8) 🎀✨ slay, go fence something responsibly 🫶💖