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

NAME

7       fence_apc_snmp - Fence agent for APC, Tripplite PDU over SNMP
8
9       fence_tripplite_snmp - Fence agent for Tripplife over SNMP (symlink)
10
11

DESCRIPTION

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

PARAMETERS

26
27
28       -o, --action=[action]
29              Fencing action (Default Value: reboot)
30
31       -c, --community=[community]
32              Set the community string (Default Value: private)
33
34       -a, --ip=[ip]
35              IP  address  or  hostname  of  fencing  device This parameter is
36              always required.
37
38       -u, --ipport=[port]
39              TCP/UDP port to use for connection with device  (Default  Value:
40              161)
41
42       -p, --password=[password]
43              Login password or passphrase
44
45       -S, --password-script=[script]
46              Script to run to retrieve password
47
48       -n, --plug=[id]
49              Physical  plug  number  on  device,  UUID  or  identification of
50              machine This parameter is always required.
51
52       -b, --snmp-auth-prot=[prot]
53              Set authentication protocol (MD5|SHA)
54
55       -P, --snmp-priv-passwd=[pass]
56              Set privacy protocol password
57
58       -R, --snmp-priv-passwd-script
59              Script to run to retrieve privacy password
60
61       -B, --snmp-priv-prot=[prot]
62              Set privacy protocol (DES|AES)
63
64       -E, --snmp-sec-level=[level]
65              Set security level (noAuthNoPriv|authNoPriv|authPriv)
66
67       -d, --snmp-version=[version]
68              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
69
70       -l, --username=[name]
71              Login name
72
73       -q, --quiet
74              Disable logging to stderr. Does not affect --verbose or --debug-
75              file or logging to syslog.
76
77       -v, --verbose
78              Verbose  mode.  Multiple  -v flags can be stacked on the command
79              line (e.g., -vvv) to increase verbosity.
80
81       --verbose-level
82              Level of debugging detail in output. Defaults to the  number  of
83              --verbose  flags  specified on the command line, or to 1 if ver‐
84              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
85
86
87       -D, --debug-file=[debugfile]
88              Write debug information to given file
89
90       -V, --version
91              Display version information and exit
92
93       -h, --help
94              Display help and exit
95
96       -C, --separator=[char]
97              Separator for CSV created by 'list' operation (Default Value: ,)
98
99
100       --delay=[seconds]
101              Wait X seconds before fencing  is  started  (Default  Value:  0)
102
103
104       --disable-timeout=[true/false]
105              Disable  timeout (true/false) (default: true when run from Pace‐
106              maker 2.0+)
107
108       --login-timeout=[seconds]
109              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
110
111
112       --power-timeout=[seconds]
113              Test  X  seconds  for status change after ON/OFF (Default Value:
114              20)
115
116       --power-wait=[seconds]
117              Wait X seconds after issuing ON/OFF (Default Value: 0)
118
119       --shell-timeout=[seconds]
120              Wait X seconds for cmd prompt  after  issuing  command  (Default
121              Value: 3)
122
123       --retry-on=[attempts]
124              Count of attempts to retry power on (Default Value: 1)
125
126       --snmpget-path=[path]
127              Path to snmpget binary (Default Value: /usr/bin/snmpget)
128
129       --snmpset-path=[path]
130              Path to snmpset binary (Default Value: /usr/bin/snmpset)
131
132       --snmpwalk-path=[path]
133              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
134
135

ACTIONS

137
138
139       on     Power on machine.
140
141       off    Power off machine.
142
143       reboot Reboot machine.
144
145       status This returns the status of the plug/virtual machine.
146
147       list   List  available  plugs with aliases/virtual machines if there is
148              support for more then one device. Returns N/A otherwise.
149
150       list-status
151              List available plugs with  aliases/virtual  machines  and  their
152              power  state  if it can be obtained without additional commands.
153
154
155       monitor
156              Check the health of fence device
157
158       metadata
159              Display the XML metadata describing this resource.
160
161       manpage
162               The operational behavior of this is not known.
163
164       validate-all
165              Validate if all required parameters are entered.
166
167

STDIN PARAMETERS

169
170
171       action Fencing action (Default Value: reboot)
172
173       community
174              Set the community string (Default Value: private)
175
176       ip     IP address or hostname  of  fencing  device  This  parameter  is
177              always required. Obsoletes: ipaddr
178
179       ipport TCP/UDP  port  to use for connection with device (Default Value:
180              161)
181
182       password
183              Login password or passphrase Obsoletes: passwd
184
185       password_script
186              Script to run  to  retrieve  password  Obsoletes:  passwd_script
187
188
189       plug   Physical  plug  number  on  device,  UUID  or  identification of
190              machine This parameter is always required. Obsoletes: port
191
192
193       snmp_auth_prot
194              Set authentication protocol (MD5|SHA)
195
196       snmp_priv_passwd
197              Set privacy protocol password
198
199       snmp_priv_passwd_script
200              Script to run to retrieve privacy password
201
202       snmp_priv_prot
203              Set privacy protocol (DES|AES)
204
205       snmp_sec_level
206              Set security level (noAuthNoPriv|authNoPriv|authPriv)
207
208       snmp_version
209              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
210
211       username
212              Login name Obsoletes: login
213
214       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
215              file or logging to syslog.
216
217       verbose
218              Verbose mode. Multiple -v flags can be stacked  on  the  command
219              line (e.g., -vvv) to increase verbosity.
220
221       verbose_level
222              Level  of  debugging detail in output. Defaults to the number of
223              --verbose flags specified on the command line, or to 1  if  ver‐
224              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
225
226
227       debug_file
228              Write debug information to given file Obsoletes: debug
229
230       version
231              Display version information and exit
232
233       help   Display help and exit
234
235       separator
236              Separator for CSV created by 'list' operation (Default Value: ,)
237
238
239       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
240
241
242       disable_timeout
243              Disable timeout (true/false) (default: true when run from  Pace‐
244              maker 2.0+)
245
246       login_timeout
247              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
248
249
250       power_timeout
251              Test X seconds for status change after  ON/OFF  (Default  Value:
252              20)
253
254       power_wait
255              Wait X seconds after issuing ON/OFF (Default Value: 0)
256
257       shell_timeout
258              Wait  X  seconds  for  cmd prompt after issuing command (Default
259              Value: 3)
260
261       retry_on
262              Count of attempts to retry power on (Default Value: 1)
263
264       snmpget_path
265              Path to snmpget binary (Default Value: /usr/bin/snmpget)
266
267       snmpset_path
268              Path to snmpset binary (Default Value: /usr/bin/snmpset)
269
270       snmpwalk_path
271              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
272
273
274
275fence_apc_snmp (Fence Agent)      2009-10-20                    FENCE_AGENT(8)