Poster of Linux kernelThe best gift for a Linux geek
FENCE_AGENT

FENCE_AGENT

Section: Maintenance Commands (8) Updated: 2009-10-20
Local index Up
 

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

        

-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         
-p, --password=<password>
Login password or passphrase         
-S, --password-script=<script>
Script to retrieve password         
-n, --plug=<id>
Physical plug number or name of virtual machine This parameter is always required.         
-d, --snmp-version=<ver>
Specifies SNMP version to use (1,2c,3) (Default Value: 1)         
-c, --community=<community>
Set the community string (Default Value: private)         
-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         
-u, --udpport
UDP/TCP 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         
-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: ,)

 

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         
passwd
Login password or passphrase         
passwd_script
Script to retrieve password         
port
Physical plug number or name of virtual machine 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)         
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         
udpport
UDP/TCP 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         
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: ,)


 

Index

NAME
DESCRIPTION
PARAMETERS
ACTIONS
STDIN PARAMETERS

This document was created by man2html, using the manual pages.
Time: 22:01:37 GMT, April 16, 2011