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

       -o, --action=<action>
              Fencing Action (Default Value: reboot)

       -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

       -S, --password-script=<script>
              Script to retrieve password

       -x, --ssh
              SSH connection

       -n, --plug=<id>
              Physical  plug number or name of virtual machine This parameter is always required.

       -k, --identity-file=<filename>
              Identity file for ssh

       -s, --switch=<id>
              Physical switch number on device

       -4, --inet4-only
              Forces agent to use IPv4 addresses only

       -6, --inet6-only
              Forces agent to use IPv6 addresses only

       -u, --ipport=<port>
              TCP port to use for connection with device

       -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
              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)

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  if  fencing  device is running. List available plugs/virtual machines or get
              status of machine (if it does not support more).

       metadata
               The operational behavior of this is not known.

STDIN PARAMETERS

       action Fencing Action (Default Value: reboot)

       ipaddr IP Address or Hostname This parameter is always required.

       login  Login Name This parameter is always required.

       passwd Login password or passphrase

       passwd_script
              Script to retrieve password

       secure SSH connection

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

       identity_file
              Identity file for ssh

       switch Physical switch number on device

       inet4_only
              Forces agent to use IPv4 addresses only

       inet6_only
              Forces agent to use IPv6 addresses only

       ipport TCP port to use for connection with device

       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)