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

NAME

7       fence_ilo4_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_ilo4_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_ilo4_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       --retry-on=[attempts]
131              Count of attempts to retry power on (Default Value: 1)
132
133       --ssh-path=[path]
134              Path to ssh binary (Default Value: /usr/bin/ssh)
135
136       --telnet-path=[path]
137              Path to telnet binary (Default Value: /usr/bin/telnet)
138
139

ACTIONS

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

STDIN PARAMETERS

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