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       -C, --separator=[char]
92              Separator for CSV created by 'list' operation (Default Value: ,)
93
94
95       --delay=[seconds]
96              Wait  X  seconds  before  fencing  is started (Default Value: 0)
97
98
99       --disable-timeout=[true/false]
100              Disable timeout (true/false) (default: true when run from  Pace‐
101              maker 2.0+)
102
103       --login-timeout=[seconds]
104              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
105
106
107       --missing-as-off
108              Missing port returns OFF instead of failure
109
110       --power-timeout=[seconds]
111              Test X seconds for status change after  ON/OFF  (Default  Value:
112              20)
113
114       --power-wait=[seconds]
115              Wait X seconds after issuing ON/OFF (Default Value: 10)
116
117       --shell-timeout=[seconds]
118              Wait  X  seconds  for  cmd prompt after issuing command (Default
119              Value: 3)
120
121       --stonith-status-sleep=[seconds]
122              Sleep X seconds between status calls  during  a  STONITH  action
123              (Default Value: 1)
124
125       --retry-on=[attempts]
126              Count of attempts to retry power on (Default Value: 1)
127
128       --ssh-path=[path]
129              Path to ssh binary (Default Value: /usr/bin/ssh)
130
131       --telnet-path=[path]
132              Path to telnet binary (Default Value: /usr/bin/telnet)
133
134

ACTIONS

136
137
138       on     Power on machine.
139
140       off    Power off machine.
141
142       reboot Reboot machine.
143
144       status This returns the status of the plug/virtual machine.
145
146       list   List  available  plugs with aliases/virtual machines if there is
147              support for more then one device. Returns N/A otherwise.
148
149       list-status
150              List available plugs with  aliases/virtual  machines  and  their
151              power  state  if it can be obtained without additional commands.
152
153
154       monitor
155              Check the health of fence device
156
157       metadata
158              Display the XML metadata describing this resource.
159
160       manpage
161               The operational behavior of this is not known.
162
163       validate-all
164              Validate if all required parameters are entered.
165
166

STDIN PARAMETERS

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