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       -C, --separator=[char]
94              Separator for CSV created by 'list' operation (Default Value: ,)
95
96
97       --delay=[seconds]
98              Wait X seconds before fencing  is  started  (Default  Value:  0)
99
100
101       --disable-timeout=[true/false]
102              Disable  timeout (true/false) (default: true when run from Pace‐
103              maker 2.0+)
104
105       --login-timeout=[seconds]
106              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
107
108
109       --power-timeout=[seconds]
110              Test  X  seconds  for status change after ON/OFF (Default Value:
111              20)
112
113       --power-wait=[seconds]
114              Wait X seconds after issuing ON/OFF (Default Value: 2)
115
116       --shell-timeout=[seconds]
117              Wait X seconds for cmd prompt  after  issuing  command  (Default
118              Value: 3)
119
120       --stonith-status-sleep=[seconds]
121              Sleep  X  seconds  between  status calls during a STONITH action
122              (Default Value: 1)
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 al‐
178              ways 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  ma‐
191              chine  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: 2)
257
258       shell_timeout
259              Wait X seconds for cmd prompt  after  issuing  command  (Default
260              Value: 3)
261
262       stonith_status_sleep
263              Sleep  X  seconds  between  status calls during a STONITH action
264              (Default Value: 1)
265
266       retry_on
267              Count of attempts to retry power on (Default Value: 1)
268
269       snmpget_path
270              Path to snmpget binary (Default Value: /usr/bin/snmpget)
271
272       snmpset_path
273              Path to snmpset binary (Default Value: /usr/bin/snmpset)
274
275       snmpwalk_path
276              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
277
278
279
280fence_eaton_snmp (Fence Agent)    2009-10-20                    FENCE_AGENT(8)