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

NAME

7       fence_ibmblade - Fence agent for IBM BladeCenter over SNMP
8

DESCRIPTION

10       fence_ibmblade  is  an  I/O  Fencing  agent  which can be used with IBM
11       BladeCenter chassis. It issues SNMP Set request to BladeCenter chassis,
12       rebooting, powering up or down the specified Blade Server.
13
14       fence_ibmblade  accepts  options  on  the  command line as well as from
15       stdin. Fenced sends parameters through stdin when it execs  the  agent.
16       fence_ibmblade can be run by itself with command line options.  This is
17       useful for testing and for turning outlets on or off from scripts.
18
19       Vendor URL: http://www.ibm.com
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: reboot)
26
27       -c, --community=[community]
28              Set the community string
29
30       -4, --inet4-only
31              Forces agent to use IPv4 addresses only
32
33       -6, --inet6-only
34              Forces agent to use IPv6 addresses only
35
36       -a, --ip=[ip]
37              IP address or hostname  of  fencing  device  This  parameter  is
38              always required.
39
40       -u, --ipport=[port]
41              TCP/UDP  port  to use for connection with device (Default Value:
42              161)
43
44       -p, --password=[password]
45              Login password or passphrase
46
47       -S, --password-script=[script]
48              Script to run to retrieve password
49
50       -n, --plug=[id]
51              Physical plug  number  on  device,  UUID  or  identification  of
52              machine This parameter is always required.
53
54       -b, --snmp-auth-prot=[prot]
55              Set authentication protocol (MD5|SHA)
56
57       -P, --snmp-priv-passwd=[pass]
58              Set privacy protocol password
59
60       -R, --snmp-priv-passwd-script
61              Script to run to retrieve privacy password
62
63       -B, --snmp-priv-prot=[prot]
64              Set privacy protocol (DES|AES)
65
66       -E, --snmp-sec-level=[level]
67              Set security level (noAuthNoPriv|authNoPriv|authPriv)
68
69       -d, --snmp-version=[version]
70              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
71
72       -l, --username=[name]
73              Login name
74
75       -q, --quiet
76              Disable logging to stderr. Does not affect --verbose or --debug-
77              file or logging to syslog.
78
79       -v, --verbose
80              Verbose mode
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       --login-timeout=[seconds]
100              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
101
102
103       --power-timeout=[seconds]
104              Test  X  seconds  for status change after ON/OFF (Default Value:
105              20)
106
107       --power-wait=[seconds]
108              Wait X seconds after issuing ON/OFF (Default Value: 0)
109
110       --shell-timeout=[seconds]
111              Wait X seconds for cmd prompt  after  issuing  command  (Default
112              Value: 3)
113
114       --retry-on=[attempts]
115              Count of attempts to retry power on (Default Value: 1)
116
117       --snmpget-path=[path]
118              Path to snmpget binary (Default Value: /usr/bin/snmpget)
119
120       --snmpset-path=[path]
121              Path to snmpset binary (Default Value: /usr/bin/snmpset)
122
123       --snmpwalk-path=[path]
124              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
125
126

ACTIONS

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

STDIN PARAMETERS

160
161
162       action Fencing action (Default Value: reboot)
163
164       community
165              Set the community string
166
167       inet4_only
168              Forces agent to use IPv4 addresses only
169
170       inet6_only
171              Forces agent to use IPv6 addresses only
172
173       ip     IP address or hostname  of  fencing  device  This  parameter  is
174              always required. Obsoletes: ipaddr
175
176       ipport TCP/UDP  port  to use for connection with device (Default Value:
177              161)
178
179       password
180              Login password or passphrase Obsoletes: passwd
181
182       password_script
183              Script to run  to  retrieve  password  Obsoletes:  passwd_script
184
185
186       plug   Physical  plug  number  on  device,  UUID  or  identification of
187              machine This parameter is always required. Obsoletes: port
188
189
190       snmp_auth_prot
191              Set authentication protocol (MD5|SHA)
192
193       snmp_priv_passwd
194              Set privacy protocol password
195
196       snmp_priv_passwd_script
197              Script to run to retrieve privacy password
198
199       snmp_priv_prot
200              Set privacy protocol (DES|AES)
201
202       snmp_sec_level
203              Set security level (noAuthNoPriv|authNoPriv|authPriv)
204
205       snmp_version
206              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
207
208       username
209              Login name Obsoletes: login
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
216
217       debug_file
218              Write debug information to given file Obsoletes: debug
219
220       version
221              Display version information and exit
222
223       help   Display help and exit
224
225       separator
226              Separator for CSV created by 'list' operation (Default Value: ,)
227
228
229       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
230
231
232       login_timeout
233              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
234
235
236       power_timeout
237              Test  X  seconds  for status change after ON/OFF (Default Value:
238              20)
239
240       power_wait
241              Wait X seconds after issuing ON/OFF (Default Value: 0)
242
243       shell_timeout
244              Wait X seconds for cmd prompt  after  issuing  command  (Default
245              Value: 3)
246
247       retry_on
248              Count of attempts to retry power on (Default Value: 1)
249
250       snmpget_path
251              Path to snmpget binary (Default Value: /usr/bin/snmpget)
252
253       snmpset_path
254              Path to snmpset binary (Default Value: /usr/bin/snmpset)
255
256       snmpwalk_path
257              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
258
259
260
261fence_ibmblade (Fence Agent)      2009-10-20                    FENCE_AGENT(8)