.TH FENCE_AGENT 8 2009-10-20 "fence_apc_snmp (Fence Agent)"
.SH NAME
fence_apc_snmp - Fence agent for APC over SNMP
.SH DESCRIPTION
.P
fence_apc_snmp is an I/O Fencing agent which can be used with the APC network power switch. It logs into a device via SNMP and reboots a specified outlet. It supports SNMP v1 and v3 with all combinations of  authenticity/privacy settings.
.P
fence_apc_snmp accepts options on the command line as well
as from stdin. Fenced sends parameters through stdin when it execs the
agent. fence_apc_snmp 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
.SH PARAMETERS

	
.TP
.B -o, --action=<action>
. 
Fencing Action (Default Value: reboot)
	
.TP
.B -a, --ip=<ip>
. 
IP Address or Hostname This parameter is always required.
	
.TP
.B -l, --username=<name>
. 
Login Name
	
.TP
.B -p, --password=<password>
. 
Login password or passphrase
	
.TP
.B -S, --password-script=<script>
. 
Script to retrieve password
	
.TP
.B -n, --plug=<id>
. 
Physical plug number or name of virtual machine This parameter is always required.
	
.TP
.B -d, --snmp-version=<ver>
. 
Specifies SNMP version to use (1,2c,3) (Default Value: 1)
	
.TP
.B -c, --community=<community>
. 
Set the community string (Default Value: private)
	
.TP
.B -b, --snmp-auth-prot=<prot>
. 
Set authentication protocol (MD5|SHA)
	
.TP
.B -E, --snmp-sec-level=<level>
. 
Set security level (noAuthNoPriv|authNoPriv|authPriv)
	
.TP
.B -B, --snmp-priv-prot=<prot>
. 
Set privacy protocol (DES|AES)
	
.TP
.B -P, --snmp-priv-passwd=<pass>
. 
Set privacy protocol password
	
.TP
.B -R, --snmp-priv-passwd-script
. 
Script to run to retrieve privacy password
	
.TP
.B -u, --udpport
. 
UDP/TCP port to use for connection with device (Default Value: 161)
	
.TP
.B -4, --inet4-only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B -6, --inet6-only
. 
Forces agent to use IPv6 addresses only
	
.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 -C, --separator=<char>
. 
Separator for CSV created by operation list (Default Value: ,)
	
.TP
.B --power-timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B --shell-timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B --login-timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B --power-wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B --delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B --retry-on
. 
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
\fBmonitor \fP
Check if fencing device is running. List available plugs/virtual machines or get status of machine (if it does not support more).
	
.TP
\fBmetadata \fP
 The operational behavior of this is not known.

.SH STDIN PARAMETERS

	
.TP
.B action
. 
Fencing Action (Default Value: reboot)
	
.TP
.B ipaddr
. 
IP Address or Hostname This parameter is always required.
	
.TP
.B login
. 
Login Name
	
.TP
.B passwd
. 
Login password or passphrase
	
.TP
.B passwd_script
. 
Script to retrieve password
	
.TP
.B port
. 
Physical plug number or name of virtual machine This parameter is always required.
	
.TP
.B snmp_version
. 
Specifies SNMP version to use (1,2c,3) (Default Value: 1)
	
.TP
.B community
. 
Set the community string (Default Value: private)
	
.TP
.B snmp_auth_prot
. 
Set authentication protocol (MD5|SHA)
	
.TP
.B snmp_sec_level
. 
Set security level (noAuthNoPriv|authNoPriv|authPriv)
	
.TP
.B snmp_priv_prot
. 
Set privacy protocol (DES|AES)
	
.TP
.B snmp_priv_passwd
. 
Set privacy protocol password
	
.TP
.B snmp_priv_passwd_script
. 
Script to run to retrieve privacy password
	
.TP
.B udpport
. 
UDP/TCP port to use for connection with device (Default Value: 161)
	
.TP
.B inet4_only
. 
Forces agent to use IPv4 addresses only
	
.TP
.B inet6_only
. 
Forces agent to use IPv6 addresses only
	
.TP
.B verbose
. 
Verbose mode
	
.TP
.B debug
. 
Write debug information to given file
	
.TP
.B version
. 
Display version information and exit
	
.TP
.B help
. 
Display help and exit
	
.TP
.B separator
. 
Separator for CSV created by operation list (Default Value: ,)
	
.TP
.B power_timeout
. 
Test X seconds for status change after ON/OFF (Default Value: 20)
	
.TP
.B shell_timeout
. 
Wait X seconds for cmd prompt after issuing command (Default Value: 3)
	
.TP
.B login_timeout
. 
Wait X seconds for cmd prompt after login (Default Value: 5)
	
.TP
.B power_wait
. 
Wait X seconds after issuing ON/OFF (Default Value: 0)
	
.TP
.B delay
. 
Wait X seconds before fencing is started (Default Value: 0)
	
.TP
.B retry_on
. 
Count of attempts to retry power on (Default Value: 1)