fence_tripplite_snmp(8)

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       -4, --inet4-only
36              Forces agent to use IPv4 addresses only
37
38       -6, --inet6-only
39              Forces agent to use IPv6 addresses only
40
41       -a, --ip=[ip]
42              IP address or hostname  of  fencing  device  This  parameter  is
43              always required.
44
45       -u, --ipport=[port]
46              TCP/UDP  port  to use for connection with device (Default Value:
47              161)
48
49       -p, --password=[password]
50              Login password or passphrase
51
52       -S, --password-script=[script]
53              Script to run to retrieve password
54
55       -n, --plug=[id]
56              Physical plug  number  on  device,  UUID  or  identification  of
57              machine This parameter is always required.
58
59       -b, --snmp-auth-prot=[prot]
60              Set authentication protocol (MD5|SHA)
61
62       -P, --snmp-priv-passwd=[pass]
63              Set privacy protocol password
64
65       -R, --snmp-priv-passwd-script
66              Script to run to retrieve privacy password
67
68       -B, --snmp-priv-prot=[prot]
69              Set privacy protocol (DES|AES)
70
71       -E, --snmp-sec-level=[level]
72              Set security level (noAuthNoPriv|authNoPriv|authPriv)
73
74       -d, --snmp-version=[version]
75              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
76
77       -l, --username=[name]
78              Login name
79
80       -q, --quiet
81              Disable logging to stderr. Does not affect --verbose or --debug-
82              file or logging to syslog.
83
84       -v, --verbose
85              Verbose mode
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       --login-timeout=[seconds]
105              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
106
107
108       --power-timeout=[seconds]
109              Test  X  seconds  for status change after ON/OFF (Default Value:
110              20)
111
112       --power-wait=[seconds]
113              Wait X seconds after issuing ON/OFF (Default Value: 0)
114
115       --shell-timeout=[seconds]
116              Wait X seconds for cmd prompt  after  issuing  command  (Default
117              Value: 3)
118
119       --retry-on=[attempts]
120              Count of attempts to retry power on (Default Value: 1)
121
122       --snmpget-path=[path]
123              Path to snmpget binary (Default Value: /usr/bin/snmpget)
124
125       --snmpset-path=[path]
126              Path to snmpset binary (Default Value: /usr/bin/snmpset)
127
128       --snmpwalk-path=[path]
129              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
130
131

ACTIONS

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

STDIN PARAMETERS

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