fence_ilo5_ssh(8)

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       --plug-separator=[char]
105              Separator  for  plug  parameter when specifying more than 1 plug
106              (Default Value: ,)
107
108       --delay=[seconds]
109              Wait X seconds before fencing  is  started  (Default  Value:  0)
110
111
112       --disable-timeout=[true/false]
113              Disable  timeout (true/false) (default: true when run from Pace‐
114              maker 2.0+)
115
116       --login-timeout=[seconds]
117              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
118
119
120       --port-as-ip
121              Make "port/plug" to be an alias to IP address
122
123       --power-timeout=[seconds]
124              Test  X  seconds  for status change after ON/OFF (Default Value:
125              20)
126
127       --power-wait=[seconds]
128              Wait X seconds after issuing ON/OFF (Default Value: 5)
129
130       --shell-timeout=[seconds]
131              Wait X seconds for cmd prompt  after  issuing  command  (Default
132              Value: 3)
133
134       --stonith-status-sleep=[seconds]
135              Sleep  X  seconds  between  status calls during a STONITH action
136              (Default Value: 1)
137
138       --retry-on=[attempts]
139              Count of attempts to retry power on (Default Value: 1)
140
141       --ssh-path=[path]
142              Path to ssh binary (Default Value: /usr/bin/ssh)
143
144       --telnet-path=[path]
145              Path to telnet binary (Default Value: /usr/bin/telnet)
146
147

ACTIONS

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

STDIN PARAMETERS

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