FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)
NAME
fence_apc - Fence agent for APC over telnet/ssh
DESCRIPTION
fence_apc is an I/O Fencing agent which can be used with the APC network power switch. It logs into device via telnet/ssh and reboots a
specified outlet. Lengthy telnet/ssh connections should be avoided while a GFS cluster is running because the connection will block
any necessary fencing actions.
fence_apc accepts options on the command line as well as from stdin. Fenced sends parameters through stdin when it execs the agent.
fence_apc 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.apc.com
PARAMETERS
-a, --ip=[ip]
IP Address or Hostname This parameter is always required.
-l, --username=[name]
Login Name This parameter is always required.
-p, --password=[password]
Login password or passphrase
-c, --command-prompt=[prompt]
Force Python regex for command prompt (Default Value: ['0', '0pc>'])
-x, --ssh
SSH connection
-n, --plug=[id]
Physical plug number, name of virtual machine or UUID This parameter is always required.
-s, --switch=[id]
Physical switch number on device
-u, --ipport=[port] TCP/UDP port to use (default 23, 22 if --ssh
TCP/UDP port to use for connection with device (Default Value: 23)
-4, --inet4-only
Forces agent to use IPv4 addresses only
-6, --inet6-only
Forces agent to use IPv6 addresses only
-S, --password-script=[script]
Script to retrieve password
-k, --identity-file=[filename]
Identity file for ssh
--ssh-options=[options]
SSH options to use (Default Value: -1 -c blowfish)
-o, --action=[action]
Fencing Action (Default Value: reboot)
-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 operation list (Default Value: ,)
--power-timeout=[seconds]
Test X seconds for status change after ON/OFF (Default Value: 20)
--shell-timeout=[seconds]
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
--login-timeout=[seconds]
Wait X seconds for cmd prompt after login (Default Value: 5)
--power-wait=[seconds]
Wait X seconds after issuing ON/OFF (Default Value: 0)
--delay=[seconds]
Wait X seconds before fencing is started (Default Value: 0)
--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.
monitor
Check the health of fence device
metadata
Display the XML metadata describing this resource.
STDIN PARAMETERS
ipaddr IP Address or Hostname This parameter is always required.
login Login Name This parameter is always required.
passwd Login password or passphrase
cmd_prompt
Force Python regex for command prompt (Default Value: ['0', '0pc>'])
secure SSH connection
port Physical plug number, name of virtual machine or UUID This parameter is always required.
switch Physical switch number on device
ipport TCP/UDP port to use for connection with device (Default Value: 23)
inet4_only
Forces agent to use IPv4 addresses only
inet6_only
Forces agent to use IPv6 addresses only
passwd_script
Script to retrieve password
identity_file
Identity file for ssh
ssh_options
SSH options to use (Default Value: -1 -c blowfish)
action Fencing Action (Default Value: reboot)
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 operation list (Default Value: ,)
power_timeout
Test X seconds for status change after ON/OFF (Default Value: 20)
shell_timeout
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
login_timeout
Wait X seconds for cmd prompt after login (Default Value: 5)
power_wait
Wait X seconds after issuing ON/OFF (Default Value: 0)
delay Wait X seconds before fencing is started (Default Value: 0)
retry_on
Count of attempts to retry power on (Default Value: 1)
fence_apc (Fence Agent) 2009-10-20 FENCE_AGENT(8)