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

NAME

7       fence_ipmilan - Fence agent for IPMI
8
9       fence_ilo3 - Fence agent for HP iLO3 (symlink)
10
11
12       fence_ilo4 - Fence agent for HP iLO4 (symlink)
13
14
15       fence_ilo5 - Fence agent for HP iLO5 (symlink)
16
17
18       fence_ipmilanplus - Fence agent for IPMIv2 lanplus (symlink)
19
20
21       fence_imm - Fence agent for IBM Integrated Management Module (symlink)
22
23
24       fence_idrac - Fence agent for Dell iDRAC (symlink)
25
26

DESCRIPTION

28       fence_ipmilan  is  an I/O Fencing agent which can be used with machines
29       controlled  by  IPMI.  This  agent  calls  support  software   ipmitool
30       (http://ipmitool.sf.net/).  WARNING! This fence agent might report suc‐
31       cess before the node is powered off. You should use -m/method onoff  if
32       your fence device works correctly with that option.
33
34       fence_ipmilan  accepts  options  on  the  command  line as well as from
35       stdin. Fenced sends parameters through stdin when it execs  the  agent.
36       fence_ipmilan  can be run by itself with command line options.  This is
37       useful for testing and for turning outlets on or off from scripts.
38
39       Vendor URL:
40

PARAMETERS

42
43
44       -o, --action=[action]
45              Fencing action (Default Value: reboot)
46
47       -A, --auth=[auth]
48              IPMI Lan Auth type. (md5|password|none)
49
50       -C, --cipher=[cipher]
51              Ciphersuite to use (same as ipmitool -C parameter)
52
53       --hexadecimal-kg=[key]
54              Hexadecimal-encoded Kg key for IPMIv2 authentication
55
56       -a, --ip=[ip]
57              IP address or hostname of fencing device
58
59       -u, --ipport=[port]
60              TCP/UDP port to use for connection with device  (Default  Value:
61              623)
62
63       -P, --lanplus
64              Use Lanplus to improve security of connection (Default Value: 0)
65
66
67       -m, --method=[method]
68              Method to fence (onoff|cycle) (Default Value: onoff)
69
70
71       -p, --password=[password]
72              Login password or passphrase
73
74       -S, --password-script=[script]
75              Script to run to retrieve password
76
77       -n, --plug=[ip]
78              IP  address or hostname of fencing device (together with --port-
79              as-ip)
80
81       -L, --privlvl=[level]
82              Privilege level on IPMI device  (callback|user|operator|adminis‐
83              trator) (Default Value: administrator)
84
85       --target=[targetaddress]
86              Bridge IPMI requests to the remote target address
87
88       -l, --username=[name]
89              Login name
90
91       -q, --quiet
92              Disable logging to stderr. Does not affect --verbose or --debug-
93              file or logging to syslog.
94
95       -v, --verbose
96              Verbose mode. Multiple -v flags can be stacked  on  the  command
97              line (e.g., -vvv) to increase verbosity.
98
99       --verbose-level
100              Level  of  debugging detail in output. Defaults to the number of
101              --verbose flags specified on the command line, or to 1  if  ver‐
102              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
103
104
105       -D, --debug-file=[debugfile]
106              Write debug information to given file
107
108       -V, --version
109              Display version information and exit
110
111       -h, --help
112              Display help and exit
113
114       --plug-separator=[char]
115              Separator for plug parameter when specifying more  than  1  plug
116              (Default Value: ,)
117
118       --delay=[seconds]
119              Wait  X  seconds  before  fencing  is started (Default Value: 0)
120
121
122       --disable-timeout=[true/false]
123              Disable timeout (true/false) (default: true when run from  Pace‐
124              maker 2.0+)
125
126       --ipmitool-path=[path]
127              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
128
129       --login-timeout=[seconds]
130              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
131
132
133       --port-as-ip
134              Make "port/plug" to be an alias to IP address
135
136       --power-timeout=[seconds]
137              Test X seconds for status change after  ON/OFF  (Default  Value:
138              20)
139
140       --power-wait=[seconds]
141              Wait X seconds after issuing ON/OFF (Default Value: 2)
142
143       --shell-timeout=[seconds]
144              Wait  X  seconds  for  cmd prompt after issuing command (Default
145              Value: 3)
146
147       --stonith-status-sleep=[seconds]
148              Sleep X seconds between status calls  during  a  STONITH  action
149              (Default Value: 1)
150
151       --ipmitool-timeout=[timeout]
152              Timeout (sec) for IPMI operation (Default Value: 2)
153
154       --retry-on=[attempts]
155              Count  of  attempts  to  retry power on (Default Value: 1)
156
157
158       --use-sudo
159              Use sudo (without password)  when  calling  3rd  party  software
160
161
162       --sudo-path=[path]
163              Path to sudo binary (Default Value: /usr/bin/sudo)
164
165

ACTIONS

167
168
169       on     Power on machine.
170
171       off    Power off machine.
172
173       reboot Reboot machine.
174
175       status This returns the status of the plug/virtual machine.
176
177       monitor
178              Check the health of fence device
179
180       metadata
181              Display the XML metadata describing this resource.
182
183       manpage
184               The operational behavior of this is not known.
185
186       validate-all
187              Validate if all required parameters are entered.
188
189       diag   Pulse a diagnostic interrupt to the processor(s).
190
191

STDIN PARAMETERS

193
194
195       action Fencing action (Default Value: reboot)
196
197       auth   IPMI Lan Auth type. (md5|password|none)
198
199       cipher Ciphersuite to use (same as ipmitool -C parameter)
200
201       hexadecimal_kg
202              Hexadecimal-encoded Kg key for IPMIv2 authentication
203
204       ip     IP address or hostname of fencing device Obsoletes: ipaddr
205
206
207       ipport TCP/UDP port to use for connection with device  (Default  Value:
208              623)
209
210       lanplus
211              Use Lanplus to improve security of connection (Default Value: 0)
212
213
214       method Method to fence (onoff|cycle) (Default Value: onoff)
215
216
217       password
218              Login password or passphrase Obsoletes: passwd
219
220       password_script
221              Script  to  run  to  retrieve  password Obsoletes: passwd_script
222
223
224       plug   IP address or hostname of fencing device (together with  --port-
225              as-ip) Obsoletes: port
226
227       privlvl
228              Privilege  level on IPMI device (callback|user|operator|adminis‐
229              trator) (Default Value: administrator)
230
231       target Bridge IPMI requests to the remote target address
232
233       username
234              Login name Obsoletes: login
235
236       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
237              file or logging to syslog.
238
239       verbose
240              Verbose  mode.  Multiple  -v flags can be stacked on the command
241              line (e.g., -vvv) to increase verbosity.
242
243       verbose_level
244              Level of debugging detail in output. Defaults to the  number  of
245              --verbose  flags  specified on the command line, or to 1 if ver‐
246              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
247
248
249       debug_file
250              Write debug information to given file Obsoletes: debug
251
252       version
253              Display version information and exit
254
255       help   Display help and exit
256
257       plug_separator
258              Separator  for  plug  parameter when specifying more than 1 plug
259              (Default Value: ,)
260
261       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
262
263
264       disable_timeout
265              Disable  timeout (true/false) (default: true when run from Pace‐
266              maker 2.0+)
267
268       ipmitool_path
269              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
270
271       login_timeout
272              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
273
274
275       port_as_ip
276              Make "port/plug" to be an alias to IP address
277
278       power_timeout
279              Test  X  seconds  for status change after ON/OFF (Default Value:
280              20)
281
282       power_wait
283              Wait X seconds after issuing ON/OFF (Default Value: 2)
284
285       shell_timeout
286              Wait X seconds for cmd prompt  after  issuing  command  (Default
287              Value: 3)
288
289       stonith_status_sleep
290              Sleep  X  seconds  between  status calls during a STONITH action
291              (Default Value: 1)
292
293       ipmitool_timeout
294              Timeout (sec) for IPMI operation (Default Value: 2)
295
296       retry_on
297              Count of attempts to retry power on  (Default  Value:  1)
298
299
300       use_sudo
301              Use  sudo (without password) when calling 3rd party software Ob‐
302              soletes: sudo
303
304       sudo_path
305              Path to sudo binary (Default Value: /usr/bin/sudo)
306
307
308
309fence_ipmilan (Fence Agent)       2009-10-20                    FENCE_AGENT(8)
Impressum