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

NAME

7       fence_bladecenter - Fence agent for IBM BladeCenter
8

DESCRIPTION

10       fence_bladecenter  is  an  I/O Fencing agent which can be used with IBM
11       Bladecenters with recent enough firmware that includes telnet  support.
12       It  logs  into  a Brocade chasis via telnet or ssh and uses the command
13       line interface to power on and off blades.
14
15       fence_bladecenter accepts options on the command line as well  as  from
16       stdin.  Fenced  sends parameters through stdin when it execs the agent.
17       fence_bladecenter can be run by itself with command line options.  This
18       is useful for testing and for turning outlets on or off from scripts.
19
20       Vendor URL: http://www.ibm.com
21

PARAMETERS

23
24
25       -o, --action=[action]
26              Fencing action (Default Value: reboot)
27
28       -c, --command-prompt=[prompt]
29              Force  Python  regex  for  command prompt (Default Value: ['sys‐
30              tem>'])
31
32       -k, --identity-file=[filename]
33              Identity file (private key) for SSH
34
35       -4, --inet4-only
36              Forces agent to use IPv4 addresses only
37
38       -6, --inet6-only
39              Forces agent to use IPv6 addresses only
40
41       -a, --ip=[ip]
42              IP address or hostname of fencing device This parameter  is  al‐
43              ways required.
44
45       -u, --ipport=[port]
46              TCP/UDP  port  to use for connection with device (Default Value:
47              23)
48
49       -p, --password=[password]
50              Login password or passphrase
51
52       -S, --password-script=[script]
53              Script to run to retrieve password
54
55       -n, --plug=[id]
56              Physical plug number on device, UUID or  identification  of  ma‐
57              chine This parameter is always required.
58
59       -x, --ssh
60              Use SSH connection
61
62       --ssh-options=[options]
63              SSH options to use
64
65       -l, --username=[name]
66              Login name This parameter is always required.
67
68       -q, --quiet
69              Disable logging to stderr. Does not affect --verbose or --debug-
70              file or logging to syslog.
71
72       -v, --verbose
73              Verbose mode. Multiple -v flags can be stacked  on  the  command
74              line (e.g., -vvv) to increase verbosity.
75
76       --verbose-level
77              Level  of  debugging detail in output. Defaults to the number of
78              --verbose flags specified on the command line, or to 1  if  ver‐
79              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
80
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       --plug-separator=[char]
92              Separator for plug parameter when specifying more  than  1  plug
93              (Default Value: ,)
94
95       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait X seconds before fencing  is  started  (Default  Value:  0)
101
102
103       --disable-timeout=[true/false]
104              Disable  timeout (true/false) (default: true when run from Pace‐
105              maker 2.0+)
106
107       --login-timeout=[seconds]
108              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
109
110
111       --missing-as-off
112              Missing port returns OFF instead of failure
113
114       --power-timeout=[seconds]
115              Test  X  seconds  for status change after ON/OFF (Default Value:
116              20)
117
118       --power-wait=[seconds]
119              Wait X seconds after issuing ON/OFF (Default Value: 10)
120
121       --shell-timeout=[seconds]
122              Wait X seconds for cmd prompt  after  issuing  command  (Default
123              Value: 3)
124
125       --stonith-status-sleep=[seconds]
126              Sleep  X  seconds  between  status calls during a STONITH action
127              (Default Value: 1)
128
129       --retry-on=[attempts]
130              Count of attempts to retry power on (Default Value: 1)
131
132       --ssh-path=[path]
133              Path to ssh binary (Default Value: /usr/bin/ssh)
134
135       --telnet-path=[path]
136              Path to telnet binary (Default Value: /usr/bin/telnet)
137
138

ACTIONS

140
141
142       on     Power on machine.
143
144       off    Power off machine.
145
146       reboot Reboot machine.
147
148       status This returns the status of the plug/virtual machine.
149
150       list   List available plugs with aliases/virtual machines if  there  is
151              support for more then one device. Returns N/A otherwise.
152
153       list-status
154              List  available  plugs  with  aliases/virtual machines and their
155              power state if it can be obtained without  additional  commands.
156
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

STDIN PARAMETERS

172
173
174       action Fencing action (Default Value: reboot)
175
176       command_prompt
177              Force  Python  regex  for  command prompt (Default Value: ['sys‐
178              tem>']) Obsoletes: cmd_prompt
179
180       identity_file
181              Identity file (private key) for SSH
182
183       inet4_only
184              Forces agent to use IPv4 addresses only
185
186       inet6_only
187              Forces agent to use IPv6 addresses only
188
189       ip     IP address or hostname of fencing device This parameter  is  al‐
190              ways required. Obsoletes: ipaddr
191
192       ipport TCP/UDP  port  to use for connection with device (Default Value:
193              23)
194
195       password
196              Login password or passphrase Obsoletes: passwd
197
198       password_script
199              Script to run  to  retrieve  password  Obsoletes:  passwd_script
200
201
202       plug   Physical  plug  number  on device, UUID or identification of ma‐
203              chine This parameter is always required. Obsoletes:  port
204
205
206       ssh    Use SSH connection Obsoletes: secure
207
208       ssh_options
209              SSH options to use
210
211       username
212              Login  name  This parameter is always required. Obsoletes: login
213
214
215       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
216              file or logging to syslog.
217
218       verbose
219              Verbose  mode.  Multiple  -v flags can be stacked on the command
220              line (e.g., -vvv) to increase verbosity.
221
222       verbose_level
223              Level of debugging detail in output. Defaults to the  number  of
224              --verbose  flags  specified on the command line, or to 1 if ver‐
225              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
226
227
228       debug_file
229              Write debug information to given file Obsoletes: debug
230
231       version
232              Display version information and exit
233
234       help   Display help and exit
235
236       plug_separator
237              Separator  for  plug  parameter when specifying more than 1 plug
238              (Default Value: ,)
239
240       separator
241              Separator for CSV created by 'list' operation (Default Value: ,)
242
243
244       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
245
246
247       disable_timeout
248              Disable timeout (true/false) (default: true when run from  Pace‐
249              maker 2.0+)
250
251       login_timeout
252              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
253
254
255       missing_as_off
256              Missing port returns OFF instead of failure
257
258       power_timeout
259              Test X seconds for status change after  ON/OFF  (Default  Value:
260              20)
261
262       power_wait
263              Wait X seconds after issuing ON/OFF (Default Value: 10)
264
265       shell_timeout
266              Wait  X  seconds  for  cmd prompt after issuing command (Default
267              Value: 3)
268
269       stonith_status_sleep
270              Sleep X seconds between status calls  during  a  STONITH  action
271              (Default Value: 1)
272
273       retry_on
274              Count of attempts to retry power on (Default Value: 1)
275
276       ssh_path
277              Path to ssh binary (Default Value: /usr/bin/ssh)
278
279       telnet_path
280              Path to telnet binary (Default Value: /usr/bin/telnet)
281
282
283
284fence_bladecenter (Fence Agent)   2009-10-20                    FENCE_AGENT(8)