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

NAME

7       fence_imm - 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_imm  accepts  options  on the command line as well as from stdin.
32       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
33       fence_imm can be run by itself with command line options.  This is use‐
34       ful 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       --retry-on=[attempts]
136              Count of attempts to retry power on  (Default  Value:  1)
137
138
139       --use-sudo
140              Use  sudo  (without  password)  when  calling 3rd party software
141
142
143       --sudo-path=[path]
144              Path to sudo binary (Default Value: /usr/bin/sudo)
145
146

ACTIONS

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

STDIN PARAMETERS

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