fence_openstack - Man Page
Fence agent for OpenStack's Nova service
Description
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
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
Parameters
- -o, --action=[action]
Fencing action (Default Value: reboot)
- -p, --password=[password]
Login password or passphrase
- -S, --password-script=[script]
Script to run to retrieve password
- -n, --plug=[UUID]
UUID of the node to be fenced.
- --ssl-insecure
Use SSL connection without verifying certificate
- -l, --username=[name]
Login name
- --auth-url=[authurl]
Keystone Auth URL
- --project-name=[project]
Keystone Project (Default Value: admin)
- --user-domain-name=[domain]
Keystone User Domain Name (Default Value: Default)
- --project-domain-name=[domain]
Keystone Project Domain Name (Default Value: Default)
- --cloud=[cloud]
Cloud from clouds.yaml
- --openrc=[openrc]
openrc config file
- --uuid=[uuid]
- --cacert=[cacert]
SSL X.509 certificates file (Default Value: )
- --apitimeout=[seconds]
Timeout in seconds to use for API calls, default is 60. (Default Value: 60)
- -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.
- --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: 60)
- --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.
- 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
UUID of the node to be fenced. Obsoletes: port
- ssl_insecure
Use SSL connection without verifying certificate
- username
Login name Obsoletes: login
- auth_url
Keystone Auth URL Obsoletes: auth-url
- project_name
Keystone Project (Default Value: admin) Obsoletes: project-name
- user_domain_name
Keystone User Domain Name (Default Value: Default) Obsoletes: user-domain-name
- project_domain_name
Keystone Project Domain Name (Default Value: Default) Obsoletes: project-domain-name
- cloud
Cloud from clouds.yaml
- openrc
openrc config file
- uuid
- cacert
SSL X.509 certificates file (Default Value: )
- apitimeout
Timeout in seconds to use for API calls, default is 60. (Default Value: 60)
- 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: 60)
- 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)