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

NAME

7       fence_ilo_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_ilo_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_ilo_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
87
88       -D, --debug-file=[debugfile]
89              Write debug information to given file
90
91       -V, --version
92              Display version information and exit
93
94       -h, --help
95              Display help and exit
96
97       --delay=[seconds]
98              Wait  X  seconds  before  fencing  is started (Default Value: 0)
99
100
101       --login-timeout=[seconds]
102              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
103
104
105       --port-as-ip
106              Make "port/plug" to be an alias to IP address
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: 5)
114
115       --shell-timeout=[seconds]
116              Wait X seconds for cmd prompt  after  issuing  command  (Default
117              Value: 3)
118
119       --retry-on=[attempts]
120              Count of attempts to retry power on (Default Value: 1)
121
122       --ssh-path=[path]
123              Path to ssh binary (Default Value: /usr/bin/ssh)
124
125       --telnet-path=[path]
126              Path to telnet binary (Default Value: /usr/bin/telnet)
127
128

ACTIONS

130
131
132       on     Power on machine.
133
134       off    Power off machine.
135
136       reboot Reboot machine.
137
138       status This returns the status of the plug/virtual machine.
139
140       monitor
141              Check the health of fence device
142
143       metadata
144              Display the XML metadata describing this resource.
145
146       manpage
147               The operational behavior of this is not known.
148
149       validate-all
150              Validate if all required parameters are entered.
151
152

STDIN PARAMETERS

154
155
156       action Fencing action (Default Value: reboot)
157
158       command_prompt
159              Force  Python  regex  for command prompt (Default Value: ['MP>',
160              'hpiLO->']) Obsoletes: cmd_prompt
161
162       identity_file
163              Identity file (private key) for SSH
164
165       inet4_only
166              Forces agent to use IPv4 addresses only
167
168       inet6_only
169              Forces agent to use IPv6 addresses only
170
171       ip     IP address or hostname of fencing device Obsoletes: ipaddr
172
173
174       ipport TCP/UDP  port  to use for connection with device (Default Value:
175              23)
176
177       method Method to fence (onoff|cycle) (Default Value: onoff)
178
179
180       password
181              Login password or passphrase Obsoletes: passwd
182
183       password_script
184              Script  to  run  to  retrieve  password Obsoletes: passwd_script
185
186
187       plug   IP address or hostname of fencing device (together with  --port-
188              as-ip) Obsoletes: port
189
190       ssh    Use SSH connection Obsoletes: secure
191
192       ssh_options
193              SSH options to use
194
195       username
196              Login  name  This parameter is always required. Obsoletes: login
197
198
199       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
200              file or logging to syslog.
201
202       verbose
203              Verbose mode
204
205       debug_file
206              Write debug information to given file Obsoletes: debug
207
208       version
209              Display version information and exit
210
211       help   Display help and exit
212
213       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
214
215
216       login_timeout
217              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
218
219
220       port_as_ip
221              Make "port/plug" to be an alias to IP address
222
223       power_timeout
224              Test  X  seconds  for status change after ON/OFF (Default Value:
225              20)
226
227       power_wait
228              Wait X seconds after issuing ON/OFF (Default Value: 5)
229
230       shell_timeout
231              Wait X seconds for cmd prompt  after  issuing  command  (Default
232              Value: 3)
233
234       retry_on
235              Count of attempts to retry power on (Default Value: 1)
236
237       ssh_path
238              Path to ssh binary (Default Value: /usr/bin/ssh)
239
240       telnet_path
241              Path to telnet binary (Default Value: /usr/bin/telnet)
242
243
244
245fence_ilo_ssh (Fence Agent)       2009-10-20                    FENCE_AGENT(8)