fence_compute man page

fence_compute — Fence agent for the automatic resurrection of OpenStack compute instances

Description

Used to tell Nova that compute nodes are down and to reschedule flagged instances

fence_compute accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent. fence_compute 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:

Parameters

-o, --action=[action]
Fencing action (Default Value: off)
-k, --auth-url=[tenant]
Keystone Admin Auth URL (Default Value: )
-e, --endpoint-type=[endpoint]
Nova Endpoint type (Default Value: internalURL)
-l, --username=[name]
Login 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.
--region-name=[region]
Region Name (Default Value: )
-t, --tenant-name=[tenant]
Keystone Admin Tenant (Default Value: )
--insecure
Allow Insecure TLS Requests (Default Value: False)
-d, --domain=[string]
DNS domain in which hosts live
--instance-filtering
Allow instances to be evacuated (Default Value: True)
--no-shared-storage
Disable functionality for dealing with shared storage (Default Value: False)
--record-only
Only record the target as needing evacuation (Default Value: False)
-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 '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: 180)
--retry-on=[attempts]
Count of attempts to retry power on (Default Value: 1)

Actions

on
Power on machine.
off
Power off 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: off)
auth-url
Keystone Admin Auth URL (Default Value: )
endpoint-type
Nova Endpoint type (Default Value: internalURL)
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.
region-name
Region Name (Default Value: )
tenant-name
Keystone Admin Tenant (Default Value: )
insecure
Allow Insecure TLS Requests (Default Value: False)
domain
DNS domain in which hosts live
instance-filtering
Allow instances to be evacuated (Default Value: True)
no-shared-storage
Disable functionality for dealing with shared storage (Default Value: False)
record-only
Only record the target as needing evacuation (Default Value: False)
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: 180)
retry_on
Count of attempts to retry power on (Default Value: 1)

Info

2009-10-20 fence_compute (Fence Agent)