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 IPMIDRIVER, --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. Argument is in bytes (i.e. 32bit register spacing
45 = 4)
46 --target-channel-number=CHANNEL-NUMBER
48 Specify the in-band driver target channel number to send IPMI
49 requests to.
50 --target-slave-address=SLAVE-ADDRESS
52 Specify the in-band driver target slave number to send IPMI
53 requests to.
54 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
56 HOST2[:PORT],...
57 Specify the remote host(s) to communicate with. Multiple host‐
58 names may be separated by comma or may be specified in a range
59 format; see HOSTRANGED SUPPORT below. An optional port can be
60 specified with each host, which may be useful in port forwarding
61 or similar situations.
62 -u USERNAME, --username=USERNAME
64 Specify the username to use when authenticating with the remote
65 host. If not specified, a null (i.e. anonymous) username is
66 assumed. The user must have atleast USER privileges in order for
67 this tool to operate fully.
68 -p PASSWORD, --password=PASSWORD
70 Specify the password to use when authenticationg with the remote
71 host. If not specified, a null password is assumed. Maximum
72 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
73 -P, --password-prompt
75 Prompt for password to avoid possibility of listing it in
76 process lists.
77 -k K_G, --k-g=K_G
79 Specify the K_g BMC key to use when authenticating with the
80 remote host for IPMI 2.0. If not specified, a null key is
81 assumed. To input the key in hexadecimal form, prefix the string
82 with '0x'. E.g., the key 'abc' can be entered with the either
83 the string 'abc' or the string '0x616263'
84 -K, --k-g-prompt
86 Prompt for k-g to avoid possibility of listing it in process
87 lists.
88 --session-timeout=MILLISECONDS
90 Specify the session timeout in milliseconds. Defaults to 20000
91 milliseconds (20 seconds) if not specified.
92 --retransmission-timeout=MILLISECONDS
94 Specify the packet retransmission timeout in milliseconds.
95 Defaults to 1000 milliseconds (1 second) if not specified. The
96 retransmission timeout cannot be larger than the session time‐
97 out.
98 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
100 Specify the IPMI 1.5 authentication type to use. The currently
101 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
102 MD2, and MD5. Defaults to MD5 if not specified.
103 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
105 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
106 identifies a set of authentication, integrity, and confidential‐
107 ity algorithms to use for IPMI 2.0 communication. The authenti‐
108 cation algorithm identifies the algorithm to use for session
109 setup, the integrity algorithm identifies the algorithm to use
110 for session packet signatures, and the confidentiality algorithm
111 identifies the algorithm to use for payload encryption. Defaults
112 to cipher suite ID 3 if not specified. The following cipher
113 suite ids are currently supported:
114 0 - Authentication Algorithm = None; Integrity Algorithm = None;
116 Confidentiality Algorithm = None
117 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
119 None; Confidentiality Algorithm = None
120 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
122 HMAC-SHA1-96; Confidentiality Algorithm = None
123 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
125 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
126 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
128 None; Confidentiality Algorithm = None
129 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
131 HMAC-MD5-128; Confidentiality Algorithm = None
132 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
134 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
135 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
137 MD5-128; Confidentiality Algorithm = None
138 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
140 MD5-128; Confidentiality Algorithm = AES-CBC-128
141 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
143 = None; Confidentiality Algorithm = None
144 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
146 = HMAC_SHA256_128; Confidentiality Algorithm = None
147 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
149 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
150 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
152 Specify the privilege level to be used. The currently available
153 privilege levels are USER, OPERATOR, and ADMIN. Defaults to USER
154 if not specified.
155 --config-file=FILE
157 Specify an alternate configuration file.
158 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
160 Specify workarounds to vendor compliance issues. Multiple work‐
161 arounds can be specified separated by commas. A special command
162 line flag of "none", will indicate no workarounds (may be useful
163 for overriding configured defaults). See WORKAROUNDS below for a
164 list of available workarounds.
165 --debug
167 Turn on debugging.
168 -?, --help
170 Output a help list and exit.
171 --usage
173 Output a usage message and exit.
174 -V, --version
176 Output the program version and exit.
177
179 The following options are specific to Bmc-info.
180 --get-device-id
182 Display only device ID information.
183 --get-device-guid
185 Display only device guid.
186 --get-system-info
188 Display only system info.
189 --get-channel-info
191 Display only channel information.
192 --interpret-oem-data
194 Attempt to interpret OEM data, such as event data, sensor read‐
195 ings, or general extra info, etc. If an OEM interpretation is
196 not available, the default output will be generated. Correctness
197 of OEM interpretations cannot be guaranteed due to potential
198 changes OEM vendors may make in products, firmware, etc. See OEM
199 INTERPRETATION below for confirmed supported motherboard inter‐
200 pretations.
201
203 The following options manipulate hostranged output. See HOSTRANGED SUP‐
204 PORT below for additional information on hostranges.
205 -B, --buffer-output
207 Buffer hostranged output. For each node, buffer standard output
208 until the node has completed its IPMI operation. When specifying
209 this option, data may appear to output slower to the user since
210 the the entire IPMI operation must complete before any data can
211 be output. See HOSTRANGED SUPPORT below for additional informa‐
212 tion.
213 -C, --consolidate-output
215 Consolidate hostranged output. The complete standard output from
216 every node specified will be consolidated so that nodes with
217 identical output are not output twice. A header will list those
218 nodes with the consolidated output. When this option is speci‐
219 fied, no output can be seen until the IPMI operations to all
220 nodes has completed. If the user breaks out of the program
221 early, all currently consolidated output will be dumped. See
222 HOSTRANGED SUPPORT below for additional information.
223 -F NUM, --fanout=NUM
225 Specify multiple host fanout. A "sliding window" (or fanout)
226 algorithm is used for parallel IPMI communication so that slower
227 nodes or timed out nodes will not impede parallel communication.
228 The maximum number of threads available at the same time is lim‐
229 ited by the fanout. The default is 64.
230 -E, --eliminate
232 Eliminate hosts determined as undetected by ipmidetect. This
233 attempts to remove the common issue of hostranged execution tim‐
234 ing out due to several nodes being removed from service in a
235 large cluster. The ipmidetectd daemon must be running on the
236 node executing the command.
237 --always-prefix
239 Always prefix output, even if only one host is specified or com‐
240 municating in-band. This option is primarily useful for script‐
241 ing purposes. Option will be ignored if specified with the -C
242 option.
243
245 Multiple hosts can be input either as an explicit comma separated lists
246 of hosts or a range of hostnames in the general form: prefix[n-m,l-
247 k,...], where n < m and l < k, etc. The later form should not be con‐
248 fused with regular expression character classes (also denoted by []).
249 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
250 sents a degenerate range: foo19.
251 This range syntax is meant only as a convenience on clusters with a
253 prefixNN naming convention and specification of ranges should not be
254 considered necessary -- the list foo1,foo9 could be specified as such,
255 or by the range foo[1,9].
256 Some examples of range usage follow:
258 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
259 foo[7,9-10] instead of foo7,foo9,foo10
260 foo[0-3] instead of foo0,foo1,foo2,foo3
261 As a reminder to the reader, some shells will interpret brackets ([ and
263 ]) for pattern matching. Depending on your shell, it may be necessary
264 to enclose ranged lists within quotes.
265 When multiple hosts are specified by the user, a thread will be exe‐
267 cuted for each host in parallel up to the configured fanout (which can
268 be adjusted via the -F option). This will allow communication to large
269 numbers of nodes far more quickly than if done in serial.
270 By default, standard output from each node specified will be output
272 with the hostname prepended to each line. Although this output is read‐
273 able in many situations, it may be difficult to read in other situa‐
274 tions. For example, output from multiple nodes may be mixed together.
275 The -B and -C options can be used to change this default.
276 In-band IPMI Communication will be used when the host "localhost" is
278 specified. This allows the user to add the localhost into the hos‐
279 tranged output.
280
282 Most often, IPMI problems are due to configuration problems.
283 IPMI over LAN problems involve a misconfiguration of the remote
285 machine's BMC. Double check to make sure the following are configured
286 properly in the remote machine's BMC: IP address, MAC address, subnet
287 mask, username, user enablement, user privilege, password, LAN privi‐
288 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
289 connections, double check to make sure the cipher suite privilege(s)
290 and K_g key are configured properly. The bmc-config(8) tool can be used
291 to check and/or change these configuration settings.
292 Inband IPMI problems are typically caused by improperly configured
294 drivers or non-standard BMCs.
295 In addition to the troubleshooting tips below, please see WORKAROUNDS
297 below to also if there are any vendor specific bugs that have been dis‐
298 covered and worked around.
299 Listed below are many of the common issues for error messages. For
301 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
302 list.
303 "username invalid" - The username entered (or a NULL username if none
305 was entered) is not available on the remote machine. It may also be
306 possible the remote BMC's username configuration is incorrect.
307 "password invalid" - The password entered (or a NULL password if none
309 was entered) is not correct. It may also be possible the password for
310 the user is not correctly configured on the remote BMC.
311 "password verification timeout" - Password verification has timed out.
313 A "password invalid" error (described above) or a generic "session
314 timeout" (described below) occurred. During this point in the protocol
315 it cannot be differentiated which occurred.
316 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
318 entered) is not correct. It may also be possible the K_g key is not
319 correctly configured on the remote BMC.
320 "privilege level insufficient" - An IPMI command requires a higher user
322 privilege than the one authenticated with. Please try to authenticate
323 with a higher privilege. This may require authenticating to a different
324 user which has a higher maximum privilege.
325 "privilege level cannot be obtained for this user" - The privilege
327 level you are attempting to authenticate with is higher than the maxi‐
328 mum allowed for this user. Please try again with a lower privilege. It
329 may also be possible the maximum privilege level allowed for a user is
330 not configured properly on the remote BMC.
331 "authentication type unavailable for attempted privilege level" - The
333 authentication type you wish to authenticate with is not available for
334 this privilege level. Please try again with an alternate authentication
335 type or alternate privilege level. It may also be possible the avail‐
336 able authentication types you can authenticate with are not correctly
337 configured on the remote BMC.
338 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
340 ticate with is not available on the remote BMC. Please try again with
341 an alternate cipher suite id. It may also be possible the available
342 cipher suite ids are not correctly configured on the remote BMC.
343 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
345 machine. Please try to use IPMI 1.5 instead.
346 "connection timeout" - Initial IPMI communication failed. A number of
348 potential errors are possible, including an invalid hostname specified,
349 an IPMI IP address cannot be resolved, IPMI is not enabled on the
350 remote server, the network connection is bad, etc. Please verify con‐
351 figuration and connectivity.
352 "session timeout" - The IPMI session has timed out. Please reconnect.
354 If this error occurs often, you may wish to increase the retransmission
355 timeout. Some remote BMCs are considerably slower than others.
356 "device not found" - The specified device could not be found. Please
358 check configuration or inputs and try again.
359 "driver timeout" - Communication with the driver or device has timed
361 out. Please try again.
362 "message timeout" - Communication with the driver or device has timed
364 out. Please try again.
365 "BMC busy" - The BMC is currently busy. It may be processing informa‐
367 tion or have too many simultaneous sessions to manage. Please wait and
368 try again.
369 "could not find inband device" - An inband device could not be found.
371 Please check configuration or specify specific device or driver on the
372 command line.
373 "driver timeout" - The inband driver has timed out communicating to the
375 local BMC or service processor. The BMC or service processor may be
376 busy or (worst case) possibly non-functioning.
377
379 With so many different vendors implementing their own IPMI solutions,
380 different vendors may implement their IPMI protocols incorrectly. The
381 following describes a number of workarounds currently available to han‐
382 dle discovered compliance issues. When possible, workarounds have been
383 implemented so they will be transparent to the user. However, some will
384 require the user to specify a workaround be used via the -W option.
385 The hardware listed below may only indicate the hardware that a problem
387 was discovered on. Newer versions of hardware may fix the problems
388 indicated below. Similar machines from vendors may or may not exhibit
389 the same problems. Different vendors may license their firmware from
390 the same IPMI firmware developer, so it may be worthwhile to try work‐
391 arounds listed below even if your motherboard is not listed.
392 If you believe your hardware has an additional compliance issue that
394 needs a workaround to be implemented, please contact the FreeIPMI main‐
395 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
396 assumeio - This workaround flag will assume inband interfaces communi‐
398 cate with system I/O rather than being memory-mapped. This will work
399 around systems that report invalid base addresses. Those hitting this
400 issue may see "device not supported" or "could not find inband device"
401 errors. Issue observed on HP ProLiant DL145 G1.
402 spinpoll - This workaround flag will inform some inband drivers (most
404 notably the KCS driver) to spin while polling rather than putting the
405 process to sleep. This may significantly improve the wall clock running
406 time of tools because an operating system scheduler's granularity may
407 be much larger than the time it takes to perform a single IPMI message
408 transaction. However, by spinning, your system may be performing less
409 useful work by not contexting out the tool for a more useful task.
410 authcap - This workaround flag will skip early checks for username
412 capabilities, authentication capabilities, and K_g support and allow
413 IPMI authentication to succeed. It works around multiple issues in
414 which the remote system does not properly report username capabilities,
415 authentication capabilities, or K_g status. Those hitting this issue
416 may see "username invalid", "authentication type unavailable for
417 attempted privilege level", or "k_g invalid" errors. Issue observed on
418 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
419 2200/4150/4450 with ELOM.
420 idzero - This workaround flag will allow empty session IDs to be
422 accepted by the client. It works around IPMI sessions that report empty
423 session IDs to the client. Those hitting this issue may see "session
424 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
425 unexpectedauth - This workaround flag will allow unexpected non-null
427 authcodes to be checked as though they were expected. It works around
428 an issue when packets contain non-null authentication data when they
429 should be null due to disabled per-message authentication. Those hit‐
430 ting this issue may see "session timeout" errors. Issue observed on
431 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
432 forcepermsg - This workaround flag will force per-message authentica‐
434 tion to be used no matter what is advertised by the remote system. It
435 works around an issue when per-message authentication is advertised as
436 disabled on the remote system, but it is actually required for the pro‐
437 tocol. Those hitting this issue may see "session timeout" errors.
438 Issue observed on IBM eServer 325.
439 endianseq - This workaround flag will flip the endian of the session
441 sequence numbers to allow the session to continue properly. It works
442 around IPMI 1.5 session sequence numbers that are the wrong endian.
443 Those hitting this issue may see "session timeout" errors. Issue
444 observed on some Sun ILOM 1.0/2.0 (depends on service processor
445 endian).
446 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
448 the authentication codes returned from IPMI 1.5 command responses. It
449 works around systems to return invalid authentication codes due to
450 hashing or implementation errors. Users are cautioned on the use of
451 this option, as it removes an authentication check verifying the valid‐
452 ity of a packet. However, in most organizations, this is unlikely to be
453 a security issue. Those hitting this issue may see "connection time‐
454 out", "session timeout", or "password verification timeout" errors.
455 Issue observed on Xyratex FB-H8-SRAY.
456 intel20 - This workaround flag will work around several Intel IPMI 2.0
458 authentication issues. The issues covered include padding of usernames,
459 and password truncation if the authentication algorithm is HMAC-
460 MD5-128. Those hitting this issue may see "username invalid", "password
461 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
462 with Intel Server Management Module (Professional Edition).
463 supermicro20 - This workaround flag will work around several Supermicro
465 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
466 firmware. The issues covered include handling invalid length authenti‐
467 cation codes. Those hitting this issue may see "password invalid"
468 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
469 Confirmed fixed on newerver firmware.
470 sun20 - This workaround flag will work work around several Sun IPMI 2.0
472 authentication issues. The issues covered include invalid lengthed hash
473 keys, improperly hashed keys, and invalid cipher suite records. Those
474 hitting this issue may see "password invalid" or "bmc error" errors.
475 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
476 automatically includes the "opensesspriv" workaround.
477 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
479 2.0 connection protocol to workaround an invalid hashing algorithm used
480 by the remote system. The privilege level sent during the Open Session
481 stage of an IPMI 2.0 connection is used for hashing keys instead of the
482 privilege level sent during the RAKP1 connection stage. Those hitting
483 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
484 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
485 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
486 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
487 QSSC-S4R//Appro GB812X-CN. This workaround is automatically triggered
488 with the "sun20" workaround.
489 integritycheckvalue - This workaround flag will work around an invalid
491 integrity check value during an IPMI 2.0 session establishment when
492 using Cipher Suite ID 0. The integrity check value should be 0 length,
493 however the remote motherboard responds with a non-empty field. Those
494 hitting this issue may see "k_g invalid" errors. Issue observed on
495 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
496 700, and Intel S2600JF/Appro 512X.
497 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
499 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
500 2.0 unavailable" or "connection timeout" errors. This issue can be
501 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
502 --driver-address=LAN_2_0. Issue observed on HP Proliant DL 145.
503
505 The following motherboards are confirmed to have atleast some support
506 by the --interpret-oem-data option. While highly probable the OEM data
507 interpretations would work across other motherboards by the same manu‐
508 facturer, there are no guarantees. Some of the motherboards below may
509 be rebranded by vendors/distributors.
510 Dell Poweredge R610, Dell Poweredge R710, Intel SR870BN4/Tiger4
512
514 # bmc-info
515 Get BMC information of the local machine.
517 # bmc-info -h ahost -u myusername -p mypassword
519 Get BMC information of a remote machine using IPMI over LAN.
521 # bmc-info -h mycluster[0-127] -u myusername -p mypassword
523 Get BMC information across a cluster using IPMI over LAN.
525
527 Upon successful execution, exit status is 0. On error, exit status is
528 1.
529 If multiple hosts are specified for communication, the exit status is 0
531 if and only if all targets successfully execute. Otherwise the exit
532 status is 1.
533
535 On older operating systems, if you input your username, password, and
536 other potentially security relevant information on the command line,
537 this information may be discovered by other users when using tools like
538 the ps(1) command or looking in the /proc file system. It is generally
539 more secure to input password information with options like the -P or
540 -K options. Configuring security relevant information in the FreeIPMI
541 configuration file would also be an appropriate way to hide this infor‐
542 mation.
543 In order to prevent brute force attacks, some BMCs will temporarily
545 "lock up" after a number of remote authentication errors. You may need
546 to wait awhile in order to this temporary "lock up" to pass before you
547 may authenticate again.
548
550 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
551
553 Copyright © 2003-2012 FreeIPMI Core Team.
554 This program is free software; you can redistribute it and/or modify it
556 under the terms of the GNU General Public License as published by the
557 Free Software Foundation; either version 3 of the License, or (at your
558 option) any later version.
559
561 freeipmi.conf(5), freeipmi(7), bmc-config(8)
562 http://www.gnu.org/software/freeipmi/
564bmc-info 1.2.1 2017-03-22 BMC-INFO(8)