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

NAME

7       fence_tripplite_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_tripplite_snmp accepts options on the command  line  as  well  as
19       from  stdin.  Fenced  sends  parameters through stdin when it execs the
20       agent. fence_tripplite_snmp can be run by itself with command line  op‐
21       tions.   This  is  useful for testing and for turning outlets on or off
22       from scripts.
23
24       Vendor URL: http://www.apc.com
25

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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