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

NAME

7       fence_ilo5_ssh - Fence agent for HP iLO over SSH
8
9       fence_ilo3_ssh - Fence agent for HP iLO3 over SSH (symlink)
10
11
12       fence_ilo4_ssh - Fence agent for HP iLO4 over SSH (symlink)
13
14
15       fence_ilo5_ssh - Fence agent for HP iLO5 over SSH (symlink)
16
17

DESCRIPTION

19       fence_ilo_ssh  is  a  fence  agent that connects to iLO device. It logs
20       into device via ssh and reboot a specified outlet.
21
22       WARNING: The monitor-action is prone to timeouts.  Use  the  fence_ilo-
23       equivalent to avoid this issue.
24
25       fence_ilo5_ssh  accepts  options  on  the  command line as well as from
26       stdin. Fenced sends parameters through stdin when it execs  the  agent.
27       fence_ilo5_ssh can be run by itself with command line options.  This is
28       useful for testing and for turning outlets on or off from scripts.
29
30       Vendor URL: http://www.hp.com
31

PARAMETERS

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

ACTIONS

145
146
147       on     Power on machine.
148
149       off    Power off machine.
150
151       reboot Reboot machine.
152
153       status This returns the status of the plug/virtual machine.
154
155       monitor
156              Check the health of fence device
157
158       metadata
159              Display the XML metadata describing this resource.
160
161       manpage
162               The operational behavior of this is not known.
163
164       validate-all
165              Validate if all required parameters are entered.
166
167

STDIN PARAMETERS

169
170
171       action Fencing action (Default Value: reboot)
172
173       command_prompt
174              Force  Python  regex  for command prompt (Default Value: ['MP>',
175              'hpiLO->']) Obsoletes: cmd_prompt
176
177       identity_file
178              Identity file (private key) for SSH
179
180       inet4_only
181              Forces agent to use IPv4 addresses only
182
183       inet6_only
184              Forces agent to use IPv6 addresses only
185
186       ip     IP address or hostname of fencing device Obsoletes: ipaddr
187
188
189       ipport TCP/UDP  port  to use for connection with device (Default Value:
190              23)
191
192       method Method to fence (onoff|cycle) (Default Value: onoff)
193
194
195       password
196              Login password or passphrase Obsoletes: passwd
197
198       password_script
199              Script  to  run  to  retrieve  password Obsoletes: passwd_script
200
201
202       plug   IP address or hostname of fencing device (together with  --port-
203              as-ip) Obsoletes: port
204
205       ssh    Use SSH connection Obsoletes: secure
206
207       ssh_options
208              SSH options to use
209
210       username
211              Login  name  This parameter is always required. Obsoletes: login
212
213
214       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
215              file or logging to syslog.
216
217       verbose
218              Verbose  mode.  Multiple  -v flags can be stacked on the command
219              line (e.g., -vvv) to increase verbosity.
220
221       verbose_level
222              Level of debugging detail in output. Defaults to the  number  of
223              --verbose  flags  specified on the command line, or to 1 if ver‐
224              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
225
226
227       debug_file
228              Write debug information to given file Obsoletes: debug
229
230       version
231              Display version information and exit
232
233       help   Display help and exit
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       port_as_ip
247              Make "port/plug" to be an alias to IP address
248
249       power_timeout
250              Test X seconds for status change after  ON/OFF  (Default  Value:
251              20)
252
253       power_wait
254              Wait X seconds after issuing ON/OFF (Default Value: 5)
255
256       shell_timeout
257              Wait  X  seconds  for  cmd prompt after issuing command (Default
258              Value: 3)
259
260       stonith_status_sleep
261              Sleep X seconds between status calls  during  a  STONITH  action
262              (Default Value: 1)
263
264       retry_on
265              Count of attempts to retry power on (Default Value: 1)
266
267       ssh_path
268              Path to ssh binary (Default Value: /usr/bin/ssh)
269
270       telnet_path
271              Path to telnet binary (Default Value: /usr/bin/telnet)
272
273
274
275fence_ilo5_ssh (Fence Agent)      2009-10-20                    FENCE_AGENT(8)