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

NAME

7       fence_eaton_ssh - Fence agent for Eaton ePDU G3 over SSH
8

DESCRIPTION

10       fence_eaton_ssh  is  a fence agent that connects to Eaton ePDU devices.
11       It logs into device via ssh and reboot a specified outlet.
12
13       fence_eaton_ssh accepts options on the command line  as  well  as  from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_eaton_ssh can be run by itself with command line  options.   This
16       is useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: https://www.eaton.com/
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -c, --command-prompt=[prompt]
27              Force Python regex for command prompt
28
29       -k, --identity-file=[filename]
30              Identity file (private key) for SSH
31
32       -4, --inet4-only
33              Forces agent to use IPv4 addresses only
34
35       -6, --inet6-only
36              Forces agent to use IPv6 addresses only
37
38       -a, --ip=[ip]
39              IP  address  or hostname of fencing device This parameter is al‐
40              ways required.
41
42       -u, --ipport=[port]
43              TCP/UDP port to use for connection with device
44
45
46       -p, --password=[password]
47              Login password or passphrase
48
49       -S, --password-script=[script]
50              Script to run to retrieve password
51
52       -n, --plug=[id]
53              Physical  plug  number  on device, UUID or identification of ma‐
54              chine This parameter is always required.
55
56       -x, --ssh
57              Use SSH connection
58
59       --ssh-options=[options]
60              SSH options to use
61
62       -l, --username=[name]
63              Login name This parameter is always required.
64
65       -q, --quiet
66              Disable logging to stderr. Does not affect --verbose or --debug-
67              file or logging to syslog.
68
69       -v, --verbose
70              Verbose  mode.  Multiple  -v flags can be stacked on the command
71              line (e.g., -vvv) to increase verbosity.
72
73       --verbose-level
74              Level of debugging detail in output. Defaults to the  number  of
75              --verbose  flags  specified on the command line, or to 1 if ver‐
76              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
77
78
79       -D, --debug-file=[debugfile]
80              Write debug information to given file
81
82       -V, --version
83              Display version information and exit
84
85       -h, --help
86              Display help and exit
87
88       --plug-separator=[char]
89              Separator  for  plug  parameter when specifying more than 1 plug
90              (Default Value: ,)
91
92       -C, --separator=[char]
93              Separator for CSV created by 'list' operation (Default Value: ,)
94
95
96       --delay=[seconds]
97              Wait  X  seconds  before  fencing  is started (Default Value: 0)
98
99
100       --disable-timeout=[true/false]
101              Disable timeout (true/false) (default: true when run from  Pace‐
102              maker 2.0+)
103
104       --login-timeout=[seconds]
105              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
106
107
108       --power-timeout=[seconds]
109              Test X seconds for status change after  ON/OFF  (Default  Value:
110              20)
111
112       --power-wait=[seconds]
113              Wait X seconds after issuing ON/OFF (Default Value: 0)
114
115       --shell-timeout=[seconds]
116              Wait  X  seconds  for  cmd prompt after issuing command (Default
117              Value: 3)
118
119       --stonith-status-sleep=[seconds]
120              Sleep X seconds between status calls  during  a  STONITH  action
121              (Default Value: 1)
122
123       --retry-on=[attempts]
124              Count of attempts to retry power on (Default Value: 1)
125
126       --ssh-path=[path]
127              Path to ssh binary (Default Value: /usr/bin/ssh)
128
129

ACTIONS

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

STDIN PARAMETERS

163
164
165       action Fencing action (Default Value: reboot)
166
167       command_prompt
168              Force Python regex  for  command  prompt  Obsoletes:  cmd_prompt
169
170
171       identity_file
172              Identity file (private key) for SSH
173
174       inet4_only
175              Forces agent to use IPv4 addresses only
176
177       inet6_only
178              Forces agent to use IPv6 addresses only
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
184
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       ssh    Use SSH connection Obsoletes: secure
198
199       ssh_options
200              SSH options to use
201
202       username
203              Login name This parameter is always required.  Obsoletes:  login
204
205
206       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
207              file or logging to syslog.
208
209       verbose
210              Verbose mode. Multiple -v flags can be stacked  on  the  command
211              line (e.g., -vvv) to increase verbosity.
212
213       verbose_level
214              Level  of  debugging detail in output. Defaults to the number of
215              --verbose flags specified on the command line, or to 1  if  ver‐
216              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
217
218
219       debug_file
220              Write debug information to given file Obsoletes: debug
221
222       version
223              Display version information and exit
224
225       help   Display help and exit
226
227       plug_separator
228              Separator for plug parameter when specifying more  than  1  plug
229              (Default Value: ,)
230
231       separator
232              Separator for CSV created by 'list' operation (Default Value: ,)
233
234
235       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
236
237
238       disable_timeout
239              Disable  timeout (true/false) (default: true when run from Pace‐
240              maker 2.0+)
241
242       login_timeout
243              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
244
245
246       power_timeout
247              Test  X  seconds  for status change after ON/OFF (Default Value:
248              20)
249
250       power_wait
251              Wait X seconds after issuing ON/OFF (Default Value: 0)
252
253       shell_timeout
254              Wait X seconds for cmd prompt  after  issuing  command  (Default
255              Value: 3)
256
257       stonith_status_sleep
258              Sleep  X  seconds  between  status calls during a STONITH action
259              (Default Value: 1)
260
261       retry_on
262              Count of attempts to retry power on (Default Value: 1)
263
264       ssh_path
265              Path to ssh binary (Default Value: /usr/bin/ssh)
266
267
268
269fence_eaton_ssh (Fence Agent)     2009-10-20                    FENCE_AGENT(8)