FENCE_AGENT(8)						      System Manager's Manual						    FENCE_AGENT(8)

NAME

       fence_apc_snmp - Fence agent for APC over SNMP

DESCRIPTION

       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.

       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

PARAMETERS


       -a, --ip=[ip]
	      IP Address or Hostname This parameter is always required.

       -l, --username=[name]
	      Login Name

       -p, --password=[password]
	      Login password or passphrase

       -n, --plug=[id]
	      Physical plug number, name of virtual machine or UUID This parameter is always required.

       -d, --snmp-version=[version]
	      Specifies SNMP version to use (1,2c,3) (Default Value: 1)

       -c, --community=[community]
	      Set the community string (Default Value: private)

       -u, --ipport=[port]
	      TCP/UDP port to use for connection with device (Default Value: 161)

       -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

       -b, --snmp-auth-prot=[prot]
	      Set authentication protocol (MD5|SHA)

       -E, --snmp-sec-level=[level]
	      Set security level (noAuthNoPriv|authNoPriv|authPriv)

       -B, --snmp-priv-prot=[prot]
	      Set privacy protocol (DES|AES)

       -P, --snmp-priv-passwd=[pass]
	      Set privacy protocol password

       -R, --snmp-priv-passwd-script
	      Script to run to retrieve privacy password

       -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

       passwd Login password or passphrase

       port   Physical plug number, name of virtual machine or UUID This parameter is always required.

       snmp_version
	      Specifies SNMP version to use (1,2c,3) (Default Value: 1)

       community
	      Set the community string (Default Value: private)

       ipport TCP/UDP port to use for connection with device (Default Value: 161)

       inet4_only
	      Forces agent to use IPv4 addresses only

       inet6_only
	      Forces agent to use IPv6 addresses only

       passwd_script
	      Script to retrieve password

       snmp_auth_prot
	      Set authentication protocol (MD5|SHA)

       snmp_sec_level
	      Set security level (noAuthNoPriv|authNoPriv|authPriv)

       snmp_priv_prot
	      Set privacy protocol (DES|AES)

       snmp_priv_passwd
	      Set privacy protocol password

       snmp_priv_passwd_script
	      Script to run to retrieve privacy password

       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_snmp (Fence Agent)					    2009-10-20							    FENCE_AGENT(8)