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
33              always 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
47              machine 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       --retry-on=[attempts]
121              Count of attempts to retry power on (Default Value: 1)
122
123       --snmpget-path=[path]
124              Path to snmpget binary (Default Value: /usr/bin/snmpget)
125
126       --snmpset-path=[path]
127              Path to snmpset binary (Default Value: /usr/bin/snmpset)
128
129       --snmpwalk-path=[path]
130              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
131
132

ACTIONS

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

STDIN PARAMETERS

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