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 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 This parameter is always required.
43
44       -u, --ipport=[port]
45              TCP/UDP port to use for connection with device  (Default  Value:
46              23)
47
48       -l, --username=[name]
49              Login Name This parameter is always required.
50
51       -p, --password=[password]
52              Login password or passphrase
53
54       -S, --password-script=[script]
55              Script to retrieve password
56
57       -n, --plug=[id]
58              Physical  plug  number,  name  of  virtual  machine or UUID This
59              parameter is always required.
60
61       -x, --ssh
62              SSH connection
63
64       --ssh-options=[options]
65              SSH options to use
66
67       -v, --verbose
68              Verbose mode
69
70       -D, --debug-file=[debugfile]
71              Write debug information to given file
72
73       -V, --version
74              Display version information and exit
75
76       -h, --help
77              Display help and exit
78
79       -C, --separator=[char]
80              Separator for CSV created by operation list (Default  Value:  ,)
81
82
83       --delay=[seconds]
84              Wait  X  seconds  before  fencing  is started (Default Value: 0)
85
86
87       --login-timeout=[seconds]
88              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
89
90
91       --missing-as-off
92              Missing port returns OFF instead of failure
93
94       --power-timeout=[seconds]
95              Test  X  seconds  for status change after ON/OFF (Default Value:
96              20)
97
98       --power-wait=[seconds]
99              Wait X seconds after issuing ON/OFF (Default Value: 10)
100
101       --shell-timeout=[seconds]
102              Wait X seconds for cmd prompt  after  issuing  command  (Default
103              Value: 3)
104
105       --retry-on=[attempts]
106              Count of attempts to retry power on (Default Value: 1)
107
108       --ssh-path=[path]
109              Path to ssh binary (Default Value: /usr/bin/ssh)
110
111       --telnet-path=[path]
112              Path to telnet binary (Default Value: /usr/bin/telnet)
113
114

ACTIONS

116
117
118       on     Power on machine.
119
120       off    Power off machine.
121
122       reboot Reboot machine.
123
124       status This returns the status of the plug/virtual machine.
125
126       list   List  available  plugs with aliases/virtual machines if there is
127              support for more then one device. Returns N/A otherwise.
128
129       list-status
130              List available plugs with  aliases/virtual  machines  and  their
131              power  state  if it can be obtained without additional commands.
132
133
134       monitor
135              Check the health of fence device
136
137       metadata
138              Display the XML metadata describing this resource.
139
140

STDIN PARAMETERS

142
143
144       action Fencing Action (Default Value: reboot)
145
146       cmd_prompt
147              Force Python regex for command  prompt  (Default  Value:  ['sys‐
148              tem>'])
149
150       identity_file
151              Identity file for ssh
152
153       inet4_only
154              Forces agent to use IPv4 addresses only
155
156       inet6_only
157              Forces agent to use IPv6 addresses only
158
159       ipaddr IP Address or Hostname This parameter is always required.
160
161       ipport TCP/UDP  port  to use for connection with device (Default Value:
162              23)
163
164       login  Login Name This parameter is always required.
165
166       passwd Login password or passphrase
167
168       passwd_script
169              Script to retrieve password
170
171       port   Physical plug number, name  of  virtual  machine  or  UUID  This
172              parameter is always required.
173
174       secure SSH connection
175
176       ssh_options
177              SSH options to use
178
179       verbose
180              Verbose mode
181
182       debug  Write debug information to given file
183
184       version
185              Display version information and exit
186
187       help   Display help and exit
188
189       separator
190              Separator  for  CSV created by operation list (Default Value: ,)
191
192
193       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
194
195
196       login_timeout
197              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
198
199
200       missing_as_off
201              Missing port returns OFF instead of failure
202
203       power_timeout
204              Test X seconds for status change after  ON/OFF  (Default  Value:
205              20)
206
207       power_wait
208              Wait X seconds after issuing ON/OFF (Default Value: 10)
209
210       shell_timeout
211              Wait  X  seconds  for  cmd prompt after issuing command (Default
212              Value: 3)
213
214       retry_on
215              Count of attempts to retry power on (Default Value: 1)
216
217       ssh_path
218              Path to ssh binary (Default Value: /usr/bin/ssh)
219
220       telnet_path
221              Path to telnet binary (Default Value: /usr/bin/telnet)
222
223
224
225fence_bladecenter (Fence Agent)   2009-10-20                    FENCE_AGENT(8)