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 agentwhich 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       --delay=[seconds]
115              Wait X seconds before fencing  is  started  (Default  Value:  0)
116
117
118       --disable-timeout=[true/false]
119              Disable  timeout (true/false) (default: true when run from Pace‐
120              maker 2.0+)
121
122       --ipmitool-path=[path]
123              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
124
125       --login-timeout=[seconds]
126              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
127
128
129       --port-as-ip
130              Make "port/plug" to be an alias to IP address
131
132       --power-timeout=[seconds]
133              Test  X  seconds  for status change after ON/OFF (Default Value:
134              20)
135
136       --power-wait=[seconds]
137              Wait X seconds after issuing ON/OFF (Default Value: 2)
138
139       --shell-timeout=[seconds]
140              Wait X seconds for cmd prompt  after  issuing  command  (Default
141              Value: 3)
142
143       --ipmitool-timeout=[timeout]
144              Timeout (sec) for IPMI operation (Default Value: 2)
145
146       --retry-on=[attempts]
147              Count  of  attempts  to  retry power on (Default Value: 1)
148
149
150       --use-sudo
151              Use sudo (without password)  when  calling  3rd  party  software
152
153
154       --sudo-path=[path]
155              Path to sudo binary (Default Value: /usr/bin/sudo)
156
157

ACTIONS

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

STDIN PARAMETERS

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