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

NAME

7       fence_ipmilanplus - 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_ipmilanplus  accepts  options on the command line as well as from
35       stdin. Fenced sends parameters through stdin when it execs  the  agent.
36       fence_ipmilanplus can be run by itself with command line options.  This
37       is 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: 1)
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       --stonith-status-sleep=[seconds]
144              Sleep  X  seconds  between  status calls during a STONITH action
145              (Default Value: 1)
146
147       --ipmitool-timeout=[timeout]
148              Timeout (sec) for IPMI operation (Default Value: 2)
149
150       --retry-on=[attempts]
151              Count of attempts to retry power on  (Default  Value:  1)
152
153
154       --use-sudo
155              Use  sudo  (without  password)  when  calling 3rd party software
156
157
158       --sudo-path=[path]
159              Path to sudo binary (Default Value: /usr/bin/sudo)
160
161

ACTIONS

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

STDIN PARAMETERS

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