FENCE_AGENT(8)

💖 NAME 💖

okay so bestie, welcome to fence_xenapi — the fence agent for Citrix XenServer, and it talks over XenAPI. this whole thing lives in the FENCE_AGENT(8) section of the System Manager's Manual, periodt. 🎀

---

🌸 DESCRIPTION 🌸

fence_xenapi is a Power Fencing agent used on Citrix XenServer hosts. it uses the XenAPI — supplied by Citrix, no cap — to set up an XML-RPC session to a XenServer host. once that session is up and living its best life, more XML-RPC commands get sent over to switch on, switch off, restart, and query the status of virtual machines running on the host. slay. 💅

the fence agent takes options on the command line and from stdin. Fenced sends parameters through stdin when it execs the agent. and you can absolutely run the agent by itself with command line options — super useful for testing and for turning outlets on or off from scripts. main character energy fr fr. ✨

Vendor URL: http://www.xenproject.org 🦋

---

⭐ PARAMETERS ⭐

• -o, --action=[action] — the fencing action you want. (Default Value: reboot)
• -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 device, UUID or identification of machine. this parameter is always required. ⚠️
• -s, --session-url — URL to connect to XenServer on. this parameter is always required. ⚠️
• -l, --username=[name] — login name
• -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. stack 'em like bracelets bestie 💅
• --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: 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 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. 🙈 (not me looking for the manual of the manual 😭)
• validate-all — validate if all required parameters are entered.

---

🦋 STDIN PARAMETERS 🦋

• action — fencing action (Default Value: reboot)
• 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
• session_url — URL to connect to XenServer on. this parameter is always required.
• username — login name. 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: 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)

---

and that's the whole page bestie, you ate that 💅✨ this was fence_xenapi from the Fence Agent crew, dated 2009-10-20, living in FENCE_AGENT(8) — go forth and fence responsibly 🫶🌈