fence_apc_snmp(8)

1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_apc_snmp - Fence agent for APC over SNMP
8

DESCRIPTION

10       fence_apc_snmp  is  an I/O Fencing agent which can be used with the APC
11       network power switch. It logs into a device  via  SNMP  and  reboots  a
12       specified  outlet.  It supports SNMP v1 and v3 with all combinations of
13       authenticity/privacy settings.
14
15       fence_apc_snmp accepts options on the command  line  as  well  as  from
16       stdin.  Fenced  sends parameters through stdin when it execs the agent.
17       fence_apc_snmp can be run by itself with command line options.  This is
18       useful for testing and for turning outlets on or off from scripts.
19
20       Vendor URL: http://www.apc.com
21

PARAMETERS

23
24
25       -o, --action=<action>
26              Fencing Action (Default Value: reboot)
27
28       -a, --ip=<ip>
29              IP Address or Hostname This parameter is always required.
30
31       -l, --username=<name>
32              Login Name
33
34       -p, --password=<password>
35              Login password or passphrase
36
37       -S, --password-script=<script>
38              Script to retrieve password
39
40       -n, --plug=<id>
41              Physical  plug  number or name of virtual machine This parameter
42              is always required.
43
44       -d, --snmp-version=<ver>
45              Specifies SNMP version to use (1,2c,3) (Default Value: 1)
46
47       -c, --community=<community>
48              Set the community string (Default Value: private)
49
50       -b, --snmp-auth-prot=<prot>
51              Set authentication protocol (MD5|SHA)
52
53       -E, --snmp-sec-level=<level>
54              Set security level (noAuthNoPriv|authNoPriv|authPriv)
55
56       -B, --snmp-priv-prot=<prot>
57              Set privacy protocol (DES|AES)
58
59       -P, --snmp-priv-passwd=<pass>
60              Set privacy protocol password
61
62       -R, --snmp-priv-passwd-script
63              Script to run to retrieve privacy password
64
65       -u, --udpport
66              UDP/TCP port to use for connection with device  (Default  Value:
67              161)
68
69       -4, --inet4-only
70              Forces agent to use IPv4 addresses only
71
72       -6, --inet6-only
73              Forces agent to use IPv6 addresses only
74
75       -v, --verbose
76              Verbose mode
77
78       -D, --debug-file=<debugfile>
79              Write debug information to given file
80
81       -V, --version
82              Display version information and exit
83
84       -h, --help
85              Display help and exit
86
87       -C, --separator=<char>
88              Separator  for  CSV created by operation list (Default Value: ,)
89
90
91       --power-timeout
92              Test X seconds for status change after  ON/OFF  (Default  Value:
93              20)
94
95       --shell-timeout
96              Wait  X  seconds  for  cmd prompt after issuing command (Default
97              Value: 3)
98
99       --login-timeout
100              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
101
102
103       --power-wait
104              Wait X seconds after issuing ON/OFF (Default Value: 0)
105
106       --delay
107              Wait  X  seconds  before  fencing  is started (Default Value: 0)
108
109
110       --retry-on
111              Count of attempts to retry power on (Default Value: 1)
112
113

ACTIONS

115
116
117       on     Power on machine.
118
119       off    Power off machine.
120
121       reboot Reboot machine.
122
123       status This returns the status of the plug/virtual machine.
124
125       list   List available plugs with aliases/virtual machines if  there  is
126              support for more then one device. Returns N/A otherwise.
127
128       monitor
129              Check if fencing device is running. List available plugs/virtual
130              machines or get status of machine (if it does not support more).
131
132
133       metadata
134               The operational behavior of this is not known.
135
136

STDIN PARAMETERS

138
139
140       action Fencing Action (Default Value: reboot)
141
142       ipaddr IP Address or Hostname This parameter is always required.
143
144       login  Login Name
145
146       passwd Login password or passphrase
147
148       passwd_script
149              Script to retrieve password
150
151       port   Physical  plug  number or name of virtual machine This parameter
152              is always required.
153
154       snmp_version
155              Specifies SNMP version to use (1,2c,3) (Default Value: 1)
156
157       community
158              Set the community string (Default Value: private)
159
160       snmp_auth_prot
161              Set authentication protocol (MD5|SHA)
162
163       snmp_sec_level
164              Set security level (noAuthNoPriv|authNoPriv|authPriv)
165
166       snmp_priv_prot
167              Set privacy protocol (DES|AES)
168
169       snmp_priv_passwd
170              Set privacy protocol password
171
172       snmp_priv_passwd_script
173              Script to run to retrieve privacy password
174
175       udpport
176              UDP/TCP port to use for connection with device  (Default  Value:
177              161)
178
179       inet4_only
180              Forces agent to use IPv4 addresses only
181
182       inet6_only
183              Forces agent to use IPv6 addresses only
184
185       verbose
186              Verbose mode
187
188       debug  Write debug information to given file
189
190       version
191              Display version information and exit
192
193       help   Display help and exit
194
195       separator
196              Separator  for  CSV created by operation list (Default Value: ,)
197
198
199       power_timeout
200              Test X seconds for status change after  ON/OFF  (Default  Value:
201              20)
202
203       shell_timeout
204              Wait  X  seconds  for  cmd prompt after issuing command (Default
205              Value: 3)
206
207       login_timeout
208              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
209
210
211       power_wait
212              Wait X seconds after issuing ON/OFF (Default Value: 0)
213
214       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
215
216
217       retry_on
218              Count of attempts to retry power on (Default Value: 1)
219
220
221
222fence_apc_snmp (Fence Agent)      2009-10-20                    FENCE_AGENT(8)