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

DESCRIPTION

22       fence_ipmilan  is  an  I/O Fencing agentwhich can be used with machines
23       controlled  by  IPMI.This  agent  calls   support   software   ipmitool
24       (http://ipmitool.sf.net/).
25
26       fence_imm  accepts  options  on the command line as well as from stdin.
27       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
28       fence_imm can be run by itself with command line options.  This is use‐
29       ful for testing and for turning outlets on or off from scripts.
30
31       Vendor URL:
32

PARAMETERS

34
35
36       -o, --action=[action]
37              Fencing Action (Default Value: reboot)
38
39       -A, --auth=[auth]
40              IPMI Lan Auth type.
41
42       -C, --cipher=[cipher]
43              Ciphersuite to use (same as ipmitool -C parameter)
44
45       -4, --inet4-only
46              Forces agent to use IPv4 addresses only
47
48       -6, --inet6-only
49              Forces agent to use IPv6 addresses only
50
51       -a, --ip=[ip]
52              IP Address or Hostname This parameter is always required.
53
54       -u, --ipport=[port]
55              TCP/UDP port to use for connection with device  (Default  Value:
56              623)
57
58       -P, --lanplus
59              Use Lanplus to improve security of connection (Default Value: 0)
60
61
62       -l, --username=[name]
63              Login Name
64
65       -m, --method=[method]
66              Method to fence (onoff|cycle) (Default Value: onoff)
67
68       -p, --password=[password]
69              Login password or passphrase
70
71       -S, --password-script=[script]
72              Script to retrieve password
73
74       -L, --privlvl=[level]
75              Privilege level on IPMI device  (Default  Value:  administrator)
76
77
78       -t [seconds] Timeout (sec) for IPMI operation
79              Timeout (sec) for IPMI operation
80
81       -v, --verbose
82              Verbose mode
83
84       -D, --debug-file=[debugfile]
85              Write debug information to given file
86
87       -V, --version
88              Display version information and exit
89
90       -h, --help
91              Display help and exit
92
93       --delay=[seconds]
94              Wait  X  seconds  before  fencing  is started (Default Value: 0)
95
96
97       --ipmitool-path=[path]
98              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
99
100       --login-timeout=[seconds]
101              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
102
103
104       --power-timeout=[seconds]
105              Test  X  seconds  for status change after ON/OFF (Default Value:
106              20)
107
108       --power-wait=[seconds]
109              Wait X seconds after issuing ON/OFF (Default Value: 2)
110
111       --shell-timeout=[seconds]
112              Wait X seconds for cmd prompt  after  issuing  command  (Default
113              Value: 3)
114
115       --retry-on=[attempts]
116              Count of attempts to retry power on (Default Value: 1)
117
118       --use-sudo
119              Use  sudo  (without  password)  when calling 3rd party sotfware.
120
121
122       --sudo-path=[path]
123              Path to sudo binary (Default Value: /usr/bin/sudo)
124
125

ACTIONS

127
128
129       on     Power on machine.
130
131       off    Power off machine.
132
133       reboot Reboot machine.
134
135       status This returns the status of the plug/virtual machine.
136
137       list   List available plugs with aliases/virtual machines if  there  is
138              support for more then one device. Returns N/A otherwise.
139
140       list-status
141              List  available  plugs  with  aliases/virtual machines and their
142              power state if it can be obtained without  additional  commands.
143
144
145       monitor
146              Check the health of fence device
147
148       metadata
149              Display the XML metadata describing this resource.
150
151       diag   Pulse a diagnostic interrupt to the processor(s).
152
153

STDIN PARAMETERS

155
156
157       action Fencing Action (Default Value: reboot)
158
159       auth   IPMI Lan Auth type.
160
161       cipher Ciphersuite to use (same as ipmitool -C parameter)
162
163       inet4_only
164              Forces agent to use IPv4 addresses only
165
166       inet6_only
167              Forces agent to use IPv6 addresses only
168
169       ipaddr IP Address or Hostname This parameter is always required.
170
171       ipport TCP/UDP  port  to use for connection with device (Default Value:
172              623)
173
174       lanplus
175              Use Lanplus to improve security of connection (Default Value: 0)
176
177
178       login  Login Name
179
180       method Method to fence (onoff|cycle) (Default Value: onoff)
181
182       passwd Login password or passphrase
183
184       passwd_script
185              Script to retrieve password
186
187       privlvl
188              Privilege  level  on  IPMI device (Default Value: administrator)
189
190
191       timeout
192              Timeout (sec) for IPMI operation
193
194       verbose
195              Verbose mode
196
197       debug  Write debug information to given file
198
199       version
200              Display version information and exit
201
202       help   Display help and exit
203
204       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
205
206
207       ipmitool_path
208              Path to ipmitool binary (Default Value: /usr/bin/ipmitool)
209
210       login_timeout
211              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
212
213
214       power_timeout
215              Test X seconds for status change after  ON/OFF  (Default  Value:
216              20)
217
218       power_wait
219              Wait X seconds after issuing ON/OFF (Default Value: 2)
220
221       shell_timeout
222              Wait  X  seconds  for  cmd prompt after issuing command (Default
223              Value: 3)
224
225       retry_on
226              Count of attempts to retry power on (Default Value: 1)
227
228       sudo   Use sudo (without password) when  calling  3rd  party  sotfware.
229
230
231       sudo_path
232              Path to sudo binary (Default Value: /usr/bin/sudo)
233
234
235
236fence_imm (Fence Agent)           2009-10-20                    FENCE_AGENT(8)