Xenapi based fencing for the citrix xenserver virtual machines.
fence_cxs is an I/O Fencing agent used on Citrix XenServer hosts. It uses the XenAPI, supplied by Citrix, to establish an XML-RPC sesssion to a XenServer host. Once the session is established, further XML-RPC commands are issued in order to switch on, switch off, restart and query the status of virtual machines running on the host.
fence_xenapi accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_xenapi can be run by itself with command line options. This is useful for testing and for turning outlets on or off from scripts.
-o, --action=<action>
Fencing Action (Default Value: reboot)
-l, --username=<name>
Login Name
-p, --password=<password>
Login password or passphrase
-S, --password-script=<script>
Script to retrieve password
-n, --plug=<id>
Physical plug number or name of virtual machine This parameter is always required.
-s, --session-url
The URL of the XenServer host. This parameter is always required.
-U, --uuid
The UUID of the virtual machine to fence.
-v, --verbose
Verbose mode
-D, --debug-file=<debugfile>
Write debug information to given file
-V, --version
Display version information and exit
-h, --help
Display help and exit
-C, --separator=<char>
Separator for CSV created by operation list (Default Value: ,)
--power-timeout
Test X seconds for status change after ON/OFF (Default Value: 20)
--shell-timeout
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
--login-timeout
Wait X seconds for cmd prompt after login (Default Value: 5)
--power-wait
Wait X seconds after issuing ON/OFF (Default Value: 0)
--delay
Wait X seconds before fencing is started (Default Value: 0)
--retry-on
Count of attempts to retry power on (Default Value: 1)
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.
monitor
Check if fencing device is running. List available plugs/virtual machines or get status of machine (if it does not support more).
metadata
The operational behavior of this is not known.
action
Fencing Action (Default Value: reboot)
login
Login Name
passwd
Login password or passphrase
passwd_script
Script to retrieve password
port
Physical plug number or name of virtual machine This parameter is always required.
session_url
The URL of the XenServer host. This parameter is always required.
uuid
The UUID of the virtual machine to fence.
verbose
Verbose mode
debug
Write debug information to given file
version
Display version information and exit
help
Display help and exit
separator
Separator for CSV created by operation list (Default Value: ,)
power_timeout
Test X seconds for status change after ON/OFF (Default Value: 20)
shell_timeout
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
login_timeout
Wait X seconds for cmd prompt after login (Default Value: 5)
power_wait
Wait X seconds after issuing ON/OFF (Default Value: 0)
delay
Wait X seconds before fencing is started (Default Value: 0)
retry_on
Count of attempts to retry power on (Default Value: 1)