1BMC-INFO(8) System Commands BMC-INFO(8)
2
6 bmc-info - display BMC information
7
9 bmc-info [OPTION...]
10
12 Bmc-info displays BMC information, such as device version numbers,
13 device support, and globally unique IDs (guids).
14 Listed below are general IPMI options, tool specific options, trouble
16 shooting information, workaround information, examples, and known
17 issues. For a general introduction to FreeIPMI please see freeipmi(7).
18
20 The following options are general options for configuring IPMI communi‐
21 cation and executing general tool commands.
22 -D, --driver-type=IPMIDRIVER
24 Specify the driver type to use instead of doing an auto selec‐
25 tion. The currently available outofband drivers are LAN and
26 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
27 currently available inband drivers are KCS, SSIF, OPENIPMI, and
28 SUNBMC.
29 --disable-auto-probe
31 Do not probe in-band IPMI devices for default settings.
32 --driver-address=DRIVER-ADDRESS
34 Specify the in-band driver address to be used instead of the
35 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
36 hex value and '0' for an octal value.
37 --driver-device=DEVICE
39 Specify the in-band driver device path to be used instead of the
40 probed path.
41 --register-spacing=REGISTER-SPACING
43 Specify the in-band driver register spacing instead of the
44 probed value.
45 -h, --hostname=IPMIHOST1,IPMIHOST2,...
47 Specify the remote host(s) to communicate with. Multiple host‐
48 names may be separated by comma or may be specified in a range
49 format; see HOSTRANGED SUPPORT below.
50 -u, --username=USERNAME
52 Specify the username to use when authenticating with the remote
53 host. If not specified, a null (i.e. anonymous) username is
54 assumed. The user must have atleast USER privileges in order for
55 this tool to operate fully.
56 -p, --password=PASSWORD
58 Specify the password to use when authenticationg with the remote
59 host. If not specified, a null password is assumed. Maximum
60 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
61 -P, --password-prompt
63 Prompt for password to avoid possibility of listing it in
64 process lists.
65 -k, --k-g=K_G
67 Specify the K_g BMC key to use when authenticating with the
68 remote host for IPMI 2.0. If not specified, a null key is
69 assumed. To input the key in hexadecimal form, prefix the string
70 with '0x'. E.g., the key 'abc' can be entered with the either
71 the string 'abc' or the string '0x616263'
72 -K, --k-g-prompt
74 Prompt for k-g to avoid possibility of listing it in process
75 lists.
76 --session-timeout=MILLISECONDS
78 Specify the session timeout in milliseconds. Defaults to 20000
79 milliseconds (20 seconds) if not specified.
80 --retransmission-timeout=MILLISECONDS
82 Specify the packet retransmission timeout in milliseconds.
83 Defaults to 1000 milliseconds (1 second) if not specified. The
84 retransmission timeout cannot be larger than the session time‐
85 out.
86 -a, --authentication-type=AUTHENTICATION-TYPE
88 Specify the IPMI 1.5 authentication type to use. The currently
89 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
90 MD2, and MD5. Defaults to MD5 if not specified.
91 -I, --cipher-suite-id=CIPHER-SUITE-ID
93 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
94 identifies a set of authentication, integrity, and confidential‐
95 ity algorithms to use for IPMI 2.0 communication. The authenti‐
96 cation algorithm identifies the algorithm to use for session
97 setup, the integrity algorithm identifies the algorithm to use
98 for session packet signatures, and the confidentiality algorithm
99 identifies the algorithm to use for payload encryption. Defaults
100 to cipher suite ID 3 if not specified. The following cipher
101 suite ids are currently supported:
102 0 - Authentication Algorithm = None; Integrity Algorithm = None;
104 Confidentiality Algorithm = None
105 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
107 None; Confidentiality Algorithm = None
108 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
110 HMAC-SHA1-96; Confidentiality Algorithm = None
111 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
113 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
114 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
116 None; Confidentiality Algorithm = None
117 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
119 HMAC-MD5-128; Confidentiality Algorithm = None
120 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
122 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
123 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
125 MD5-128; Confidentiality Algorithm = None
126 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
128 MD5-128; Confidentiality Algorithm = AES-CBC-128
129 -l, --privilege-level=PRIVILEGE-LEVEL
131 Specify the privilege level to be used. The currently available
132 privilege levels are USER, OPERATOR, and ADMIN. Defaults to USER
133 if not specified.
134 --config-file=FILE
136 Specify an alternate configuration file.
137 -W, --workaround-flags=WORKAROUNDS
139 Specify workarounds to vendor compliance issues. Multiple work‐
140 arounds can be specified separated by commas. See WORKAROUNDS
141 below for a list of available workarounds.
142 --debug
144 Turn on debugging.
145 -?, --help
147 Output a help list and exit.
148 --usage
150 Output a usage message and exit.
151 -V, --version
153 Output the program version and exit.
154
156 The following options are specific to Bmc-info.
157 --get-device-id
159 Display only device ID information.
160 --get-device-guid
162 Display only device guid.
163 --get-system-info
165 Display only system info.
166 --get-channel-info
168 Display only channel information.
169 --interpret-oem-data
171 Attempt to interpret OEM data, such as event data, sensor read‐
172 ings, or general extra info, etc. If an OEM interpretation is
173 not available, the default output will be generated. Correctness
174 of OEM interpretations cannot be guaranteed due to potential
175 changes OEM vendors may make in products, firmware, etc. See OEM
176 INTERPRETATION below for confirmed supported motherboard inter‐
177 pretations.
178
180 The following options manipulate hostranged output. See HOSTRANGED SUP‐
181 PORT below for additional information on hostranges.
182 -B, --buffer-output
184 Buffer hostranged output. For each node, buffer standard output
185 until the node has completed its IPMI operation. When specifying
186 this option, data may appear to output slower to the user since
187 the the entire IPMI operation must complete before any data can
188 be output. See HOSTRANGED SUPPORT below for additional informa‐
189 tion.
190 -C, --consolidate-output
192 Consolidate hostranged output. The complete standard output from
193 every node specified will be consolidated so that nodes with
194 identical output are not output twice. A header will list those
195 nodes with the consolidated output. When this option is speci‐
196 fied, no output can be seen until the IPMI operations to all
197 nodes has completed. If the user breaks out of the program
198 early, all currently consolidated output will be dumped. See
199 HOSTRANGED SUPPORT below for additional information.
200 -F, --fanout
202 Specify multiple host fanout. A "sliding window" (or fanout)
203 algorithm is used for parallel IPMI communication so that slower
204 nodes or timed out nodes will not impede parallel communication.
205 The maximum number of threads available at the same time is lim‐
206 ited by the fanout. The default is 64.
207 -E, --eliminate
209 Eliminate hosts determined as undetected by ipmidetect. This
210 attempts to remove the common issue of hostranged execution tim‐
211 ing out due to several nodes being removed from service in a
212 large cluster. The ipmidetectd daemon must be running on the
213 node executing the command.
214 --always-prefix
216 Always prefix output, even if only one host is specified or com‐
217 municating in-band. This option is primarily useful for script‐
218 ing purposes. Option will be ignored if specified with the -C
219 option.
220
222 Multiple hosts can be input either as an explicit comma separated lists
223 of hosts or a range of hostnames in the general form: prefix[n-m,l-
224 k,...], where n < m and l < k, etc. The later form should not be con‐
225 fused with regular expression character classes (also denoted by []).
226 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
227 sents a degenerate range: foo19.
228 This range syntax is meant only as a convenience on clusters with a
230 prefixNN naming convention and specification of ranges should not be
231 considered necessary -- the list foo1,foo9 could be specified as such,
232 or by the range foo[1,9].
233 Some examples of range usage follow:
235 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
236 foo[7,9-10] instead of foo7,foo9,foo10
237 foo[0-3] instead of foo0,foo1,foo2,foo3
238 As a reminder to the reader, some shells will interpret brackets ([ and
240 ]) for pattern matching. Depending on your shell, it may be necessary
241 to enclose ranged lists within quotes.
242 When multiple hosts are specified by the user, a thread will be exe‐
244 cuted for each host in parallel up to the configured fanout (which can
245 be adjusted via the -F option). This will allow communication to large
246 numbers of nodes far more quickly than if done in serial.
247 By default, standard output from each node specified will be output
249 with the hostname prepended to each line. Although this output is read‐
250 able in many situations, it may be difficult to read in other situa‐
251 tions. For example, output from multiple nodes may be mixed together.
252 The -B and -C options can be used to change this default.
253 In-band IPMI Communication will be used when the host "localhost" is
255 specified. This allows the user to add the localhost into the hos‐
256 tranged output.
257
259 Most often, IPMI problems are due to configuration problems. Inband
260 IPMI problems are typically caused by improperly configured drivers or
261 non-standard BMCs. IPMI over LAN problems involve a misconfiguration of
262 the remote machine's BMC. Double check to make sure the following are
263 configured properly in the remote machine's BMC: IP address, MAC
264 address, subnet mask, username, user enablement, user privilege, pass‐
265 word, LAN privilege, LAN enablement, and allowed authentication
266 type(s). For IPMI 2.0 connections, double check to make sure the cipher
267 suite privilege(s) and K_g key are configured properly. The bmc-con‐
268 fig(8) tool can be used to check and/or change these configuration set‐
269 tings.
270 The following are common issues for given error messages:
272 "username invalid" - The username entered (or a NULL username if none
274 was entered) is not available on the remote machine. It may also be
275 possible the remote BMC's username configuration is incorrect.
276 "password invalid" - The password entered (or a NULL password if none
278 was entered) is not correct. It may also be possible the password for
279 the user is not correctly configured on the remote BMC.
280 "password verification timeout" - Password verification has timed out.
282 A "password invalid" error (described above) or a generic "session
283 timeout" (described below) occurred. During this point in the protocol
284 it cannot be differentiated which occurred.
285 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
287 entered) is not correct. It may also be possible the K_g key is not
288 correctly configured on the remote BMC.
289 "privilege level insufficient" - An IPMI command requires a higher user
291 privilege than the one authenticated with. Please try to authenticate
292 with a higher privilege. This may require authenticating to a different
293 user which has a higher maximum privilege.
294 "privilege level cannot be obtained for this user" - The privilege
296 level you are attempting to authenticate with is higher than the maxi‐
297 mum allowed for this user. Please try again with a lower privilege. It
298 may also be possible the maximum privilege level allowed for a user is
299 not configured properly on the remote BMC.
300 "authentication type unavailable for attempted privilege level" - The
302 authentication type you wish to authenticate with is not available for
303 this privilege level. Please try again with an alternate authentication
304 type or alternate privilege level. It may also be possible the avail‐
305 able authentication types you can authenticate with are not correctly
306 configured on the remote BMC.
307 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
309 ticate with is not available on the remote BMC. Please try again with
310 an alternate cipher suite id. It may also be possible the available
311 cipher suite ids are not correctly configured on the remote BMC.
312 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
314 machine. Please try to use IPMI 1.5 instead.
315 "connection timeout" - Initial IPMI communication failed. A number of
317 potential errors are possible, including an invalid hostname specified,
318 an IPMI IP address cannot be resolved, IPMI is not enabled on the
319 remote server, the network connection is bad, etc. Please verify con‐
320 figuration and connectivity.
321 "session timeout" - The IPMI session has timed out. Please reconnect.
323 If this error occurs often, you may wish to increase the retransmission
324 timeout. Some remote BMCs are considerably slower than others.
325 "device not found" - The specified device could not be found. Please
327 check configuration or inputs and try again.
328 "driver timeout" - Communication with the driver or device has timed
330 out. Please try again.
331 "message timeout" - Communication with the driver or device has timed
333 out. Please try again.
334 "BMC busy" - The BMC is currently busy. It may be processing informa‐
336 tion or have too many simultaneous sessions to manage. Please wait and
337 try again.
338 "could not find inband device" - An inband device could not be found.
340 Please check configuration or specify specific device or driver on the
341 command line.
342 Please see WORKAROUNDS below to also if there are any vendor specific
344 bugs that have been discovered and worked around.
345
347 With so many different vendors implementing their own IPMI solutions,
348 different vendors may implement their IPMI protocols incorrectly. The
349 following lists the workarounds currently available to handle discov‐
350 ered compliance issues.
351 When possible, workarounds have been implemented so they will be trans‐
353 parent to the user. However, some will require the user to specify a
354 workaround be used via the -W option.
355 The hardware listed below may only indicate the hardware that a problem
357 was discovered on. Newer versions of hardware may fix the problems
358 indicated below. Similar machines from vendors may or may not exhibit
359 the same problems. Different vendors may license their firmware from
360 the same IPMI firmware developer, so it may be worthwhile to try work‐
361 arounds listed below even if your motherboard is not listed.
362 "idzero" - This workaround option will allow empty session IDs to be
364 accepted by the client. It works around IPMI sessions that report empty
365 session IDs to the client. Those hitting this issue may see "session
366 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
367 "unexpectedauth" - This workaround option will allow unexpected non-
369 null authcodes to be checked as though they were expected. It works
370 around an issue when packets contain non-null authentication data when
371 they should be null due to disabled per-message authentication. Those
372 hitting this issue may see "session timeout" errors. Issue observed on
373 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
374 "forcepermsg" - This workaround option will force per-message authenti‐
376 cation to be used no matter what is advertised by the remote system. It
377 works around an issue when per-message authentication is advertised as
378 disabled on the remote system, but it is actually required for the pro‐
379 tocol. Those hitting this issue may see "session timeout" errors.
380 Issue observed on IBM eServer 325.
381 "endianseq" - This workaround option will flip the endian of the ses‐
383 sion sequence numbers to allow the session to continue properly. It
384 works around IPMI 1.5 session sequence numbers that are the wrong
385 endian. Those hitting this issue may see "session timeout" errors.
386 Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor
387 endian).
388 "authcap" - This workaround option will skip early checks for username
390 capabilities, authentication capabilities, and K_g support and allow
391 IPMI authentication to succeed. It works around multiple issues in
392 which the remote system does not properly report username capabilities,
393 authentication capabilities, or K_g status. Those hitting this issue
394 may see "username invalid", "authentication type unavailable for
395 attempted privilege level", or "k_g invalid" errors. Issue observed on
396 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
397 2200/4150/4450 with ELOM.
398 "intel20" - This workaround option will work around several Intel IPMI
400 2.0 authentication issues. The issues covered include padding of user‐
401 names, automatic acceptance of a RAKP 4 response integrity check when
402 using the integrity algorithm MD5-128, and password truncation if the
403 authentication algorithm is HMAC-MD5-128. Those hitting this issue may
404 see "username invalid", "password invalid", or "k_g invalid" errors.
405 Issue observed on Intel SE7520AF2 with Intel Server Management Module
406 (Professional Edition).
407 "supermicro20" - This workaround option will work around several Super‐
409 micro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
410 firmware. The issues covered include handling invalid length authenti‐
411 cation codes. Those hitting this issue may see "password invalid"
412 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
413 Confirmed fixed on newerver firmware.
414 "sun20" - This workaround option will work work around several Sun IPMI
416 2.0 authentication issues. The issues covered include invalid lengthed
417 hash keys, improperly hashed keys, and invalid cipher suite records.
418 Those hitting this issue may see "password invalid" or "bmc error"
419 errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This
420 workaround automatically includes the "opensesspriv" workaround.
421 "opensesspriv" - This workaround option will slightly alter FreeIPMI's
423 IPMI 2.0 connection protocol to workaround an invalid hashing algorithm
424 used by the remote system. The privilege level sent during the Open
425 Session stage of an IPMI 2.0 connection is sometimes invalid and used
426 for hashing keys instead of the privilege level sent during the RAKP1
427 connection stage. Those hitting this issue may see "password invalid",
428 "k_g invalid", "bad rmcpplus status code", or "privilege level cannot
429 be obtained for this user " errors. Issue observed on Sun Fire
430 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro
431 X8DTH, Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
432 Relion 700. This workaround is automatically triggered with the "sun20"
433 workaround.
434 "integritycheckvalue" - This workaround option will work around an
436 invalid integrity check value during an IPMI 2.0 session establishment
437 when using Cipher Suite ID 0. The integrity check value should be 0
438 length, however the remote motherboard responds with a non-empty field.
439 Those hitting this issue may see "k_g invalid" errors. Issue observed
440 on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
441 Relion 700.
442
444 The following motherboards are confirmed to have atleast some support
445 by the --interpret-oem-data option. While highly probable the OEM data
446 interpretations would work across other motherboards by the same manu‐
447 facturer, there are no guarantees.
448 Intel SR870BN4/Tiger4, Dell Poweredge R610, Dell Poweredge R710
450
452 # bmc-info
453 Get BMC information of the local machine.
455 # bmc-info -h ahost -u myusername -p mypassword
457 Get BMC information of a remote machine using IPMI over LAN.
459 # bmc-info -h mycluster[0-127] -u myusername -p mypassword
461 Get BMC information across a cluster using IPMI over LAN.
463
465 On older operating systems, if you input your username, password, and
466 other potentially security relevant information on the command line,
467 this information may be discovered by other users when using tools like
468 the ps(1) command or looking in the /proc file system. It is generally
469 more secure to input password information with options like the -P or
470 -K options. Configuring security relevant information in the FreeIPMI
471 configuration file would also be an appropriate way to hide this infor‐
472 mation.
473 In order to prevent brute force attacks, some BMCs will temporarily
475 "lock up" after a number of remote authentication errors. You may need
476 to wait awhile in order to this temporary "lock up" to pass before you
477 may authenticate again.
478
480 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
481
483 Copyright © 2003-2010 FreeIPMI Core Team.
484 This program is free software; you can redistribute it and/or modify it
486 under the terms of the GNU General Public License as published by the
487 Free Software Foundation; either version 2 of the License, or (at your
488 option) any later version.
489
491 freeipmi.conf(5), freeipmi(7), bmc-config(8)
492 http://www.gnu.org/software/freeipmi/
494bmc-info 0.8.8 2010-07-21 BMC-INFO(8)