fence_ilo4_ssh(8)

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       fence_ilo4_ssh accepts options on the command  line  as  well  as  from
23       stdin.  Fenced  sends parameters through stdin when it execs the agent.
24       fence_ilo4_ssh can be run by itself with command line options.  This is
25       useful for testing and for turning outlets on or off from scripts.
26
27       Vendor URL: http://www.hp.com
28

PARAMETERS

30
31
32       -o, --action=[action]
33              Fencing action (Default Value: reboot)
34
35       -c, --command-prompt=[prompt]
36              Force  Python  regex  for command prompt (Default Value: ['MP>',
37              'hpiLO->'])
38
39       -k, --identity-file=[filename]
40              Identity file (private key) for SSH
41
42       -4, --inet4-only
43              Forces agent to use IPv4 addresses only
44
45       -6, --inet6-only
46              Forces agent to use IPv6 addresses only
47
48       -a, --ip=[ip]
49              IP address or hostname of fencing device
50
51       -u, --ipport=[port]
52              TCP/UDP port to use for connection with device  (Default  Value:
53              23)
54
55       -m, --method=[method]
56              Method to fence (onoff|cycle) (Default Value: onoff)
57
58
59       -p, --password=[password]
60              Login password or passphrase
61
62       -S, --password-script=[script]
63              Script to run to retrieve password
64
65       -n, --plug=[ip]
66              IP address or hostname of fencing device (together with  --port-
67              as-ip)
68
69       -x, --ssh
70              Use SSH connection
71
72       --ssh-options=[options]
73              SSH options to use
74
75       -l, --username=[name]
76              Login name This parameter is always required.
77
78       -q, --quiet
79              Disable logging to stderr. Does not affect --verbose or --debug-
80              file or logging to syslog.
81
82       -v, --verbose
83              Verbose mode
84
85       -D, --debug-file=[debugfile]
86              Write debug information to given file
87
88       -V, --version
89              Display version information and exit
90
91       -h, --help
92              Display help and exit
93
94       --delay=[seconds]
95              Wait X seconds before fencing  is  started  (Default  Value:  0)
96
97
98       --login-timeout=[seconds]
99              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
100
101
102       --port-as-ip
103              Make "port/plug" to be an alias to IP address
104
105       --power-timeout=[seconds]
106              Test X seconds for status change after  ON/OFF  (Default  Value:
107              20)
108
109       --power-wait=[seconds]
110              Wait X seconds after issuing ON/OFF (Default Value: 5)
111
112       --shell-timeout=[seconds]
113              Wait  X  seconds  for  cmd prompt after issuing command (Default
114              Value: 3)
115
116       --retry-on=[attempts]
117              Count of attempts to retry power on (Default Value: 1)
118
119       --ssh-path=[path]
120              Path to ssh binary (Default Value: /usr/bin/ssh)
121
122       --telnet-path=[path]
123              Path to telnet binary (Default Value: /usr/bin/telnet)
124
125

ACTIONS

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

STDIN PARAMETERS

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