fence_ilo3_ssh(8)

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

NAME

7       fence_ilo3_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

DESCRIPTION

16       fence_ilo_ssh  is  a  fence  agent that connects to iLO device. It logs
17       into device via ssh and reboot a specified outlet.
18
19       fence_ilo3_ssh accepts options on the command  line  as  well  as  from
20       stdin.  Fenced  sends parameters through stdin when it execs the agent.
21       fence_ilo3_ssh can be run by itself with command line options.  This is
22       useful for testing and for turning outlets on or off from scripts.
23
24       Vendor URL: http://www.hp.com
25

PARAMETERS

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

ACTIONS

112
113
114       on     Power on machine.
115
116       off    Power off machine.
117
118       reboot Reboot machine.
119
120       status This returns the status of the plug/virtual machine.
121
122       list   List  available  plugs with aliases/virtual machines if there is
123              support for more then one device. Returns N/A otherwise.
124
125       list-status
126              List available plugs with  aliases/virtual  machines  and  their
127              power  state  if it can be obtained without additional commands.
128
129
130       monitor
131              Check the health of fence device
132
133       metadata
134              Display the XML metadata describing this resource.
135
136

STDIN PARAMETERS

138
139
140       action Fencing Action (Default Value: reboot)
141
142       cmd_prompt
143              Force Python regex for command prompt  (Default  Value:  ['MP>',
144              'hpiLO->'])
145
146       identity_file
147              Identity file for ssh
148
149       inet4_only
150              Forces agent to use IPv4 addresses only
151
152       inet6_only
153              Forces agent to use IPv6 addresses only
154
155       ipaddr IP Address or Hostname This parameter is always required.
156
157       ipport TCP/UDP  port  to use for connection with device (Default Value:
158              23)
159
160       login  Login Name This parameter is always required.
161
162       method Method to fence (onoff|cycle) (Default Value: onoff)
163
164       passwd Login password or passphrase
165
166       passwd_script
167              Script to retrieve password
168
169       secure SSH connection
170
171       ssh_options
172              SSH options to use
173
174       verbose
175              Verbose mode
176
177       debug  Write debug information to given file
178
179       version
180              Display version information and exit
181
182       help   Display help and exit
183
184       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
185
186
187       login_timeout
188              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
189
190
191       power_timeout
192              Test X seconds for status change after  ON/OFF  (Default  Value:
193              20)
194
195       power_wait
196              Wait X seconds after issuing ON/OFF (Default Value: 5)
197
198       shell_timeout
199              Wait  X  seconds  for  cmd prompt after issuing command (Default
200              Value: 3)
201
202       retry_on
203              Count of attempts to retry power on (Default Value: 1)
204
205       ssh_path
206              Path to ssh binary (Default Value: /usr/bin/ssh)
207
208       telnet_path
209              Path to telnet binary (Default Value: /usr/bin/telnet)
210
211
212
213fence_ilo3_ssh (Fence Agent)      2009-10-20                    FENCE_AGENT(8)