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_imm - Fence agent for IBM Integrated Management Module (symlink)
19
20
21       fence_idrac - Fence agent for Dell iDRAC (symlink)
22
23

DESCRIPTION

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

PARAMETERS

39
40
41       -o, --action=[action]
42              Fencing action (Default Value: reboot)
43
44       -A, --auth=[auth]
45              IPMI Lan Auth type. (md5|password|none)
46
47       -C, --cipher=[cipher]
48              Ciphersuite to use (same as ipmitool -C parameter)
49
50       --hexadecimal-kg=[key]
51              Hexadecimal-encoded Kg key for IPMIv2 authentication
52
53       -4, --inet4-only
54              Forces agent to use IPv4 addresses only
55
56       -6, --inet6-only
57              Forces agent to use IPv6 addresses only
58
59       -a, --ip=[ip]
60              IP address or hostname of fencing device
61
62       -u, --ipport=[port]
63              TCP/UDP port to use for connection with device  (Default  Value:
64              623)
65
66       -P, --lanplus
67              Use Lanplus to improve security of connection (Default Value: 0)
68
69
70       -m, --method=[method]
71              Method to fence (onoff|cycle) (Default Value: onoff)
72
73
74       -p, --password=[password]
75              Login password or passphrase
76
77       -S, --password-script=[script]
78              Script to run to retrieve password
79
80       -n, --plug=[ip]
81              IP  address or hostname of fencing device (together with --port-
82              as-ip)
83
84       -L, --privlvl=[level]
85              Privilege level on IPMI device  (callback|user|operator|adminis‐
86              trator) (Default Value: administrator)
87
88       --target=[targetaddress]
89              Bridge IPMI requests to the remote target address
90
91       -l, --username=[name]
92              Login name
93
94       -q, --quiet
95              Disable logging to stderr. Does not affect --verbose or --debug-
96              file or logging to syslog.
97
98       -v, --verbose
99              Verbose mode
100
101       -D, --debug-file=[debugfile]
102              Write debug information to given file
103
104       -V, --version
105              Display version information and exit
106
107       -h, --help
108              Display help and exit
109
110       --delay=[seconds]
111              Wait X seconds before fencing  is  started  (Default  Value:  0)
112
113
114       --ipmitool-path=[path]
115              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
116
117       --login-timeout=[seconds]
118              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
119
120
121       --port-as-ip
122              Make "port/plug" to be an alias to IP address
123
124       --power-timeout=[seconds]
125              Test X seconds for status change after  ON/OFF  (Default  Value:
126              20)
127
128       --power-wait=[seconds]
129              Wait X seconds after issuing ON/OFF (Default Value: 2)
130
131       --shell-timeout=[seconds]
132              Wait  X  seconds  for  cmd prompt after issuing command (Default
133              Value: 3)
134
135       --ipmitool-timeout=[timeout]
136              Timeout (sec) for IPMI operation (Default Value: 2)
137
138       --retry-on=[attempts]
139              Count of attempts to retry power on  (Default  Value:  1)
140
141
142       --use-sudo
143              Use  sudo  (without  password)  when  calling 3rd party software
144
145
146       --sudo-path=[path]
147              Path to sudo binary (Default Value: /usr/bin/sudo)
148
149

ACTIONS

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

STDIN PARAMETERS

177
178
179       action Fencing action (Default Value: reboot)
180
181       auth   IPMI Lan Auth type. (md5|password|none)
182
183       cipher Ciphersuite to use (same as ipmitool -C parameter)
184
185       hexadecimal_kg
186              Hexadecimal-encoded Kg key for IPMIv2 authentication
187
188       inet4_only
189              Forces agent to use IPv4 addresses only
190
191       inet6_only
192              Forces agent to use IPv6 addresses only
193
194       ip     IP address or hostname of fencing device Obsoletes: ipaddr
195
196
197       ipport TCP/UDP  port  to use for connection with device (Default Value:
198              623)
199
200       lanplus
201              Use Lanplus to improve security of connection (Default Value: 0)
202
203
204       method Method to fence (onoff|cycle) (Default Value: onoff)
205
206
207       password
208              Login password or passphrase Obsoletes: passwd
209
210       password_script
211              Script to run  to  retrieve  password  Obsoletes:  passwd_script
212
213
214       plug   IP  address or hostname of fencing device (together with --port-
215              as-ip) Obsoletes: port
216
217       privlvl
218              Privilege level on IPMI device  (callback|user|operator|adminis‐
219              trator) (Default Value: administrator)
220
221       target Bridge IPMI requests to the remote target address
222
223       username
224              Login name Obsoletes: login
225
226       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
227              file or logging to syslog.
228
229       verbose
230              Verbose mode
231
232       debug_file
233              Write debug information to given file Obsoletes: debug
234
235       version
236              Display version information and exit
237
238       help   Display help and exit
239
240       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
241
242
243       ipmitool_path
244              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
245
246       login_timeout
247              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
248
249
250       port_as_ip
251              Make "port/plug" to be an alias to IP address
252
253       power_timeout
254              Test X seconds for status change after  ON/OFF  (Default  Value:
255              20)
256
257       power_wait
258              Wait X seconds after issuing ON/OFF (Default Value: 2)
259
260       shell_timeout
261              Wait  X  seconds  for  cmd prompt after issuing command (Default
262              Value: 3)
263
264       ipmitool_timeout
265              Timeout (sec) for IPMI operation (Default Value: 2)
266
267       retry_on
268              Count of attempts to retry power on  (Default  Value:  1)
269
270
271       use_sudo
272              Use  sudo  (without  password)  when  calling 3rd party software
273              Obsoletes: sudo
274
275       sudo_path
276              Path to sudo binary (Default Value: /usr/bin/sudo)
277
278
279
280fence_ipmilan (Fence Agent)       2009-10-20                    FENCE_AGENT(8)