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

ACTIONS

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

STDIN PARAMETERS

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