.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 --auth-url=[authurl]
. 
Keystone Auth URL This parameter is always required.
	
	
	
	
.TP
.B -p, --password=[password]
. 
Login password or passphrase
	
.TP
.B -S, --password-script=[script]
. 
Script to run to retrieve password
	
	
	
.TP
.B --project-domain-name=[project-domain]
. 
Keystone Project Domain Name (Default Value: Default)
	
.TP
.B --project-name=[project]
. 
Keystone Project (Default Value: admin)
	
	
.TP
.B --user-domain-name=[user-domain]
. 
Keystone User Domain Name (Default Value: Default)
	
.TP
.B -l, --username=[name]
. 
Login name This parameter is always required.
	
.TP
.B --uuid=[uuid]
. 
UUID of the nova instance This parameter is always required.
	
.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
	
	
.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 --delay=[seconds]
. 
Wait X seconds before fencing is started (Default Value: 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: 20)
	
.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 --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
\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 auth_url
. 
Keystone Auth URL This parameter is always required. Obsoletes: auth-url
	
	
	
	
.TP
.B password
. 
Login password or passphrase Obsoletes: passwd
	
.TP
.B password_script
. 
Script to run to retrieve password Obsoletes: passwd_script
	
	
	
.TP
.B project_domain_name
. 
Keystone Project Domain Name (Default Value: Default) Obsoletes: project-domain-name
	
.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 username
. 
Login name This parameter is always required. Obsoletes: login
	
.TP
.B uuid
. 
UUID of the nova instance This parameter is always required.
	
.TP
.B quiet
. 
Disable logging to stderr. Does not affect --verbose or --debug-file or logging to syslog.
	
.TP
.B verbose
. 
Verbose mode
	
	
.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 delay
. 
Wait X seconds before fencing is started (Default Value: 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: 20)
	
.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 retry_on
. 
Count of attempts to retry power on (Default Value: 1)