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
21       options.   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
37              always 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
51              machine 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       --retry-on=[attempts]
125              Count of attempts to retry power on (Default Value: 1)
126
127       --snmpget-path=[path]
128              Path to snmpget binary (Default Value: /usr/bin/snmpget)
129
130       --snmpset-path=[path]
131              Path to snmpset binary (Default Value: /usr/bin/snmpset)
132
133       --snmpwalk-path=[path]
134              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
135
136

ACTIONS

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

STDIN PARAMETERS

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