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

ACTIONS

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

STDIN PARAMETERS

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