FENCE_AGENT
NAME
fence_xenapi - Fence agent for Citrix XenServer over XenAPI
DESCRIPTION
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.
Vendor URL: http://www.xenproject.org
PARAMETERS
|
|
-o, --action=[action]
|
|
|
Fencing action (Default Value: reboot)
|
-l, --username=[name]
-p, --password=[password]
|
|
|
Login password or passphrase
|
-S, --password-script=[script]
|
|
|
Script to run to retrieve 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.
|
-q, --quiet
|
|
|
Disable logging to stderr. Does not affect --verbose or --debug logging to syslog.
|
-v, --verbose
-D, --debug-file=[debugfile]
|
|
|
Write debug information to given file
|
-V, --version
|
|
|
Display version information and exit
|
-h, --help
-C, --separator=[char]
|
|
|
Separator for CSV created by ’list’ operation (Default Value: ,)
|
--delay=[seconds]
|
|
|
Wait X seconds before fencing is started (Default Value: 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)
|
--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.
validate-all
Validate if all required parameters are entered.
STDIN PARAMETERS
|
action
|
|
Fencing action (Default Value: reboot)
|
|
|
login
|
|
Login name
|
|
|
passwd
|
|
Login password or passphrase
|
|
passwd_script
Script to run to retrieve password
|
port
|
|
Physical plug number on device, UUID or identification of machine This parameter is always required.
|
session_url
URL to connect to XenServer on This parameter is always required.
|
quiet
|
|
Disable logging to stderr. Does not affect --verbose or --debug logging to syslog.
|
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 ’list’ operation (Default Value: ,)
|
delay
|
|
Wait X seconds before fencing is started (Default Value: 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)
retry_on
Count of attempts to retry power on (Default Value: 1)
|
|
