1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_eaton_snmp - Fence agent for Eaton over SNMP
8

DESCRIPTION

10       fence_eaton_snmp  is  an  I/O  Fencing agent which can be used with the
11       Eaton network power switch. It logs into a device via SNMP and  reboots
12       a specified outlet. It supports SNMP v1 and v3 with all combinations of
13       authenticity/privacy settings.
14
15       fence_eaton_snmp accepts options on the command line as  well  as  from
16       stdin.  Fenced  sends parameters through stdin when it execs the agent.
17       fence_eaton_snmp can be run by itself with command line options.   This
18       is useful for testing and for turning outlets on or off from scripts.
19
20       Vendor URL: http://powerquality.eaton.com
21

PARAMETERS

23
24
25       -o, --action=[action]
26              Fencing action (Default Value: reboot)
27
28       -c, --community=[community]
29              Set the community string (Default Value: private)
30
31       -a, --ip=[ip]
32              IP  address  or hostname of fencing device This parameter is al‐
33              ways required.
34
35       -u, --ipport=[port]
36              TCP/UDP port to use for connection with device  (Default  Value:
37              161)
38
39       -p, --password=[password]
40              Login password or passphrase
41
42       -S, --password-script=[script]
43              Script to run to retrieve password
44
45       -n, --plug=[id]
46              Physical  plug  number  on device, UUID or identification of ma‐
47              chine This parameter is always required.
48
49       -b, --snmp-auth-prot=[prot]
50              Set authentication protocol (MD5|SHA)
51
52       -P, --snmp-priv-passwd=[pass]
53              Set privacy protocol password
54
55       -R, --snmp-priv-passwd-script
56              Script to run to retrieve privacy password
57
58       -B, --snmp-priv-prot=[prot]
59              Set privacy protocol (DES|AES)
60
61       -E, --snmp-sec-level=[level]
62              Set security level (noAuthNoPriv|authNoPriv|authPriv)
63
64       -d, --snmp-version=[version]
65              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
66
67       -l, --username=[name]
68              Login name
69
70       -q, --quiet
71              Disable logging to stderr. Does not affect --verbose or --debug-
72              file or logging to syslog.
73
74       -v, --verbose
75              Verbose  mode.  Multiple  -v flags can be stacked on the command
76              line (e.g., -vvv) to increase verbosity.
77
78       --verbose-level
79              Level of debugging detail in output. Defaults to the  number  of
80              --verbose  flags  specified on the command line, or to 1 if ver‐
81              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
82
83
84       -D, --debug-file=[debugfile]
85              Write debug information to given file
86
87       -V, --version
88              Display version information and exit
89
90       -h, --help
91              Display help and exit
92
93       --plug-separator=[char]
94              Separator  for  plug  parameter when specifying more than 1 plug
95              (Default Value: ,)
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: 2)
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       plug_separator
241              Separator for plug parameter when specifying more  than  1  plug
242              (Default Value: ,)
243
244       separator
245              Separator for CSV created by 'list' operation (Default Value: ,)
246
247
248       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
249
250
251       disable_timeout
252              Disable  timeout (true/false) (default: true when run from Pace‐
253              maker 2.0+)
254
255       login_timeout
256              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
257
258
259       power_timeout
260              Test  X  seconds  for status change after ON/OFF (Default Value:
261              20)
262
263       power_wait
264              Wait X seconds after issuing ON/OFF (Default Value: 2)
265
266       shell_timeout
267              Wait X seconds for cmd prompt  after  issuing  command  (Default
268              Value: 3)
269
270       stonith_status_sleep
271              Sleep  X  seconds  between  status calls during a STONITH action
272              (Default Value: 1)
273
274       retry_on
275              Count of attempts to retry power on (Default Value: 1)
276
277       snmpget_path
278              Path to snmpget binary (Default Value: /usr/bin/snmpget)
279
280       snmpset_path
281              Path to snmpset binary (Default Value: /usr/bin/snmpset)
282
283       snmpwalk_path
284              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
285
286
287
288fence_eaton_snmp (Fence Agent)    2009-10-20                    FENCE_AGENT(8)