.TH FENCE_AGENT 8 2009-10-20 "fence_openstack (Fence Agent)"
.SH NAME
fence_openstack - Fence agent for OpenStack's Nova service
.SH DESCRIPTION
.P
fence_openstack is a Fencing agent which can be used with machines controlled by the Openstack's Nova service. This agent calls the python-novaclient and it is mandatory to be installed 
.P
fence_openstack accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_openstack 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: https://wiki.openstack.org/wiki/Nova
.SH PARAMETERS

	
.TP
.B -o, --action=[action]
. 
Fencing action (Default Value: reboot)
	
	
	
	
.TP
.B -p, --password=[password]
. 
Login password or passphrase
	
.TP
.B -S, --password-script=[script]
. 
Script to run to retrieve password
	
.TP
.B -n, --plug=[UUID]
. 
UUID of the node to be fenced.
	
	
.TP
.B --ssl-insecure
. 
Use SSL connection without verifying certificate
	
.TP
.B -l, --username=[name]
. 
Login name
	
	
.TP
.B --auth-url=[authurl]
. 
Keystone Auth URL
	
	
.TP
.B --project-name=[project]
. 
Keystone Project (Default Value: admin)
	
	
.TP
.B --user-domain-name=[domain]
. 
Keystone User Domain Name (Default Value: Default)
	
	
.TP
.B --project-domain-name=[domain]
. 
Keystone Project Domain Name (Default Value: Default)
	
.TP
.B --cloud=[cloud]
. 
Cloud from clouds.yaml
	
.TP
.B --openrc=[openrc]
. 
openrc config file
	
.TP
.B --uuid=[uuid]
. 
Replaced by port/-n/--plug
	
.TP
.B --cacert=[cacert]
. 
SSL X.509 certificates file (Default Value: )
	
.TP
.B --apitimeout=[seconds]
. 
Timeout in seconds to use for API calls, default is 60. (Default Value: 60)
	
.TP
.B -q, --quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B -v, --verbose
. 
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
	
.TP
.B --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).
	
	
.TP
.B -D, --debug-file=[debugfile]
. 
Write debug information to given file
	
.TP
.B -V, --version
. 
Display version information and exit
	
.TP
.B -h, --help
. 
Display help and exit
	
.TP
.B --plug-separator=[char]
. 
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
	
.TP
.B -C, --separator=[char]
. 
Separator for CSV created by 'list' operation (Default Value: ,)
	
.TP
.B --delay=[seconds]
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --disable-timeout=[true/false]
. 
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
	
.TP
.B --login-timeout=[seconds]
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B --power-timeout=[seconds]
. 
Test X seconds for status change after ON/OFF (Default Value: 60)
	
.TP
.B --power-wait=[seconds]
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B --shell-timeout=[seconds]
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B --stonith-status-sleep=[seconds]
. 
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
	
.TP
.B --retry-on=[attempts]
. 
Count of attempts to retry power on (Default Value: 1)

.SH ACTIONS

	
.TP
\fBon \fP
Power on machine.
	
.TP
\fBoff \fP
Power off machine.
	
.TP
\fBreboot \fP
Reboot machine.
	
.TP
\fBstatus \fP
This returns the status of the plug/virtual machine.
	
.TP
\fBlist \fP
List available plugs with aliases/virtual machines if there is support for more then one device. Returns N/A otherwise.
	
.TP
\fBlist-status \fP
List available plugs with aliases/virtual machines and their power state if it can be obtained without additional commands.
	
.TP
\fBmonitor \fP
Check the health of fence device
	
.TP
\fBmetadata \fP
Display the XML metadata describing this resource.
	
.TP
\fBmanpage \fP
 The operational behavior of this is not known.
	
.TP
\fBvalidate-all \fP
Validate if all required parameters are entered.

.SH STDIN PARAMETERS

	
.TP
.B action
. 
Fencing action (Default Value: reboot)
	
	
	
	
.TP
.B password
. 
Login password or passphrase Obsoletes: passwd
	
.TP
.B password_script
. 
Script to run to retrieve password Obsoletes: passwd_script
	
.TP
.B plug
. 
UUID of the node to be fenced. Obsoletes: port
	
	
.TP
.B ssl_insecure
. 
Use SSL connection without verifying certificate
	
.TP
.B username
. 
Login name Obsoletes: login
	
	
.TP
.B auth_url
. 
Keystone Auth URL Obsoletes: auth-url
	
	
.TP
.B project_name
. 
Keystone Project (Default Value: admin) Obsoletes: project-name
	
	
.TP
.B user_domain_name
. 
Keystone User Domain Name (Default Value: Default) Obsoletes: user-domain-name
	
	
.TP
.B project_domain_name
. 
Keystone Project Domain Name (Default Value: Default) Obsoletes: project-domain-name
	
.TP
.B cloud
. 
Cloud from clouds.yaml
	
.TP
.B openrc
. 
openrc config file
	
.TP
.B uuid
. 
Replaced by port/-n/--plug
	
.TP
.B cacert
. 
SSL X.509 certificates file (Default Value: )
	
.TP
.B apitimeout
. 
Timeout in seconds to use for API calls, default is 60. (Default Value: 60)
	
.TP
.B quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B verbose
. 
Verbose mode. Multiple -v flags can be stacked on the command line (e.g., -vvv) to increase verbosity.
	
.TP
.B 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).
	
	
.TP
.B debug_file
. 
Write debug information to given file Obsoletes: debug
	
.TP
.B version
. 
Display version information and exit
	
.TP
.B help
. 
Display help and exit
	
.TP
.B plug_separator
. 
Separator for plug parameter when specifying more than 1 plug (Default Value: ,)
	
.TP
.B separator
. 
Separator for CSV created by 'list' operation (Default Value: ,)
	
.TP
.B delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B disable_timeout
. 
Disable timeout (true/false) (default: true when run from Pacemaker 2.0+)
	
.TP
.B login_timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B power_timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 60)
	
.TP
.B power_wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B stonith_status_sleep
. 
Sleep X seconds between status calls during a STONITH action (Default Value: 1)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)