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       -C, --separator=[char]
98              Separator for CSV created by 'list' operation (Default Value: ,)
99
100
101       --delay=[seconds]
102              Wait  X  seconds  before  fencing  is started (Default Value: 0)
103
104
105       --disable-timeout=[true/false]
106              Disable timeout (true/false) (default: true when run from  Pace‐
107              maker 2.0+)
108
109       --login-timeout=[seconds]
110              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
111
112
113       --power-timeout=[seconds]
114              Test X seconds for status change after  ON/OFF  (Default  Value:
115              20)
116
117       --power-wait=[seconds]
118              Wait X seconds after issuing ON/OFF (Default Value: 0)
119
120       --shell-timeout=[seconds]
121              Wait  X  seconds  for  cmd prompt after issuing command (Default
122              Value: 3)
123
124       --stonith-status-sleep=[seconds]
125              Sleep X seconds between status calls  during  a  STONITH  action
126              (Default Value: 1)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131       --snmpget-path=[path]
132              Path to snmpget binary (Default Value: /usr/bin/snmpget)
133
134       --snmpset-path=[path]
135              Path to snmpset binary (Default Value: /usr/bin/snmpset)
136
137       --snmpwalk-path=[path]
138              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
139
140

ACTIONS

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

STDIN PARAMETERS

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