1BMC-CONFIG(8) System Commands BMC-CONFIG(8)
2
6 bmc-config - configure BMC values
7
9 bmc-config [OPTION...]
10
12 Bmc-config is used to get and set BMC configuration parameters, such as
13 usernames, passwords, networking information, security, Serial-over-LAN
14 (SOL), and other core IPMI fields. This configuration is required
15 before most IPMI tools can be used to access a machine remotely.
16 The majority of configuration operations require ADMIN privilege when
18 using bmc-config out-of-band. Although connecting via a user with ADMIN
19 privileges is not required for out-of-band use, the vast majority of
20 configuration options will not be retrieved or set.
21 For configuration of chassis, platform event filtering (PEF), or sen‐
23 sors, please see the ipmi-chassis-config(8), ipmi-pef-config(8), or
24 ipmi-sensors-config(8) tools respectively. For some OEM specific con‐
25 figurations, please see ipmi-oem(8).
26 Listed below are general IPMI options, tool specific options, trouble
28 shooting information, workaround information, examples, and known
29 issues. For a general introduction to FreeIPMI please see freeipmi(7).
30 See GENERAL USE below for a description on how most will want to use
31 Bmc-config.
32
34 The following options are general options for configuring IPMI communi‐
35 cation and executing general tool commands.
36 -D IPMIDRIVER, --driver-type=IPMIDRIVER
38 Specify the driver type to use instead of doing an auto selec‐
39 tion. The currently available outofband drivers are LAN and
40 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
41 currently available inband drivers are KCS, SSIF, OPENIPMI, and
42 SUNBMC.
43 --disable-auto-probe
45 Do not probe in-band IPMI devices for default settings.
46 --driver-address=DRIVER-ADDRESS
48 Specify the in-band driver address to be used instead of the
49 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
50 hex value and '0' for an octal value.
51 --driver-device=DEVICE
53 Specify the in-band driver device path to be used instead of the
54 probed path.
55 --register-spacing=REGISTER-SPACING
57 Specify the in-band driver register spacing instead of the
58 probed value. Argument is in bytes (i.e. 32bit register spacing
59 = 4)
60 --target-channel-number=CHANNEL-NUMBER
62 Specify the in-band driver target channel number to send IPMI
63 requests to.
64 --target-slave-address=SLAVE-ADDRESS
66 Specify the in-band driver target slave number to send IPMI
67 requests to.
68 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
70 HOST2[:PORT],...
71 Specify the remote host(s) to communicate with. Multiple host‐
72 names may be separated by comma or may be specified in a range
73 format; see HOSTRANGED SUPPORT below. An optional port can be
74 specified with each host, which may be useful in port forwarding
75 or similar situations.
76 -u USERNAME, --username=USERNAME
78 Specify the username to use when authenticating with the remote
79 host. If not specified, a null (i.e. anonymous) username is
80 assumed. The user must have atleast ADMIN privileges in order
81 for this tool to operate fully.
82 -p PASSWORD, --password=PASSWORD
84 Specify the password to use when authenticationg with the remote
85 host. If not specified, a null password is assumed. Maximum
86 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
87 -P, --password-prompt
89 Prompt for password to avoid possibility of listing it in
90 process lists.
91 -k K_G, --k-g=K_G
93 Specify the K_g BMC key to use when authenticating with the
94 remote host for IPMI 2.0. If not specified, a null key is
95 assumed. To input the key in hexadecimal form, prefix the string
96 with '0x'. E.g., the key 'abc' can be entered with the either
97 the string 'abc' or the string '0x616263'
98 -K, --k-g-prompt
100 Prompt for k-g to avoid possibility of listing it in process
101 lists.
102 --session-timeout=MILLISECONDS
104 Specify the session timeout in milliseconds. Defaults to 20000
105 milliseconds (20 seconds) if not specified.
106 --retransmission-timeout=MILLISECONDS
108 Specify the packet retransmission timeout in milliseconds.
109 Defaults to 1000 milliseconds (1 second) if not specified. The
110 retransmission timeout cannot be larger than the session time‐
111 out.
112 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
114 Specify the IPMI 1.5 authentication type to use. The currently
115 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
116 MD2, and MD5. Defaults to MD5 if not specified.
117 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
119 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
120 identifies a set of authentication, integrity, and confidential‐
121 ity algorithms to use for IPMI 2.0 communication. The authenti‐
122 cation algorithm identifies the algorithm to use for session
123 setup, the integrity algorithm identifies the algorithm to use
124 for session packet signatures, and the confidentiality algorithm
125 identifies the algorithm to use for payload encryption. Defaults
126 to cipher suite ID 3 if not specified. The following cipher
127 suite ids are currently supported:
128 0 - Authentication Algorithm = None; Integrity Algorithm = None;
130 Confidentiality Algorithm = None
131 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
133 None; Confidentiality Algorithm = None
134 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
136 HMAC-SHA1-96; Confidentiality Algorithm = None
137 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
139 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
140 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
142 None; Confidentiality Algorithm = None
143 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
145 HMAC-MD5-128; Confidentiality Algorithm = None
146 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
148 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
149 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
151 MD5-128; Confidentiality Algorithm = None
152 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
154 MD5-128; Confidentiality Algorithm = AES-CBC-128
155 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
157 = None; Confidentiality Algorithm = None
158 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
160 = HMAC_SHA256_128; Confidentiality Algorithm = None
161 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
163 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
164 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
166 Specify the privilege level to be used. The currently available
167 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
168 ADMIN if not specified.
169 --config-file=FILE
171 Specify an alternate configuration file.
172 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
174 Specify workarounds to vendor compliance issues. Multiple work‐
175 arounds can be specified separated by commas. A special command
176 line flag of "none", will indicate no workarounds (may be useful
177 for overriding configured defaults). See WORKAROUNDS below for a
178 list of available workarounds.
179 --debug
181 Turn on debugging.
182 -?, --help
184 Output a help list and exit.
185 --usage
187 Output a usage message and exit.
188 -V, --version
190 Output the program version and exit.
191
193 The following options are used to read, write, and find differences in
194 configuration values.
195 -o, --checkout
197 Fetch configuration information.
198 -c, --commit
200 Update configuration information from a config file or key
201 pairs.
202 -d, --diff
204 Show differences between stored information and a config file or
205 key pairs.
206 -n FILENAME, --filename=FILENAME
208 Specify a config file for checkout/commit/diff.
209 -e "KEY=VALUE", --key-pair="KEY=VALUE"
211 Specify KEY=VALUE pairs for checkout/commit/diff. Specify KEY by
212 SectionName:FieldName. This option can be used multiple times.
213 On commit, any KEY=VALUE pairs will overwrite any pairs speci‐
214 fied in a file with --filename.
215 -S SECTION, --section=SECTION
217 Specify a SECTION for checkout. This option can be used multiple
218 times.
219 -L, --listsections
221 List available sections for checkout. Some sections in the list
222 may not be checked out by default and may require verbosity to
223 be increased.
224 -v, --verbose
226 Output verbose information. When used with --checkout, addi‐
227 tional uncommon sections and/or fields will be shown. In bmc-
228 config, this includes checking out Serial Configuration parame‐
229 ters, Vlan parameters, IPv4 Header parameters, RMCP port, and
230 sections for each channel on a system, if multiple channels
231 exist.
232 -vv Output very verbose information. Output additional detailed
234 information about what fields can and cannot be checked out, and
235 sometimes the reason why. Sometimes output fields that are iden‐
236 tified as unsupported on the motherboard.
237 --lan-channel-number=NUMBER
239 Use an specific channel number for LAN configuration. Particu‐
240 larly useful if motherboard contains multiple LAN channels and a
241 user wishes to use a specific one.
242 --serial-channel-number=NUMBER
244 Use an specific channel number for serial configuration. Partic‐
245 ularly useful if motherboard contains multiple serial channels
246 and a user wishes to use a specific one.
247 --sol-channel-number=NUMBER
249 Use an specific channel number for SOL configuration. Particu‐
250 larly useful if motherboard contains multiple SOL channels and a
251 user wishes to use a specific one.
252
254 The following options manipulate hostranged output. See HOSTRANGED SUP‐
255 PORT below for additional information on hostranges.
256 -B, --buffer-output
258 Buffer hostranged output. For each node, buffer standard output
259 until the node has completed its IPMI operation. When specifying
260 this option, data may appear to output slower to the user since
261 the the entire IPMI operation must complete before any data can
262 be output. See HOSTRANGED SUPPORT below for additional informa‐
263 tion.
264 -C, --consolidate-output
266 Consolidate hostranged output. The complete standard output from
267 every node specified will be consolidated so that nodes with
268 identical output are not output twice. A header will list those
269 nodes with the consolidated output. When this option is speci‐
270 fied, no output can be seen until the IPMI operations to all
271 nodes has completed. If the user breaks out of the program
272 early, all currently consolidated output will be dumped. See
273 HOSTRANGED SUPPORT below for additional information.
274 -F NUM, --fanout=NUM
276 Specify multiple host fanout. A "sliding window" (or fanout)
277 algorithm is used for parallel IPMI communication so that slower
278 nodes or timed out nodes will not impede parallel communication.
279 The maximum number of threads available at the same time is lim‐
280 ited by the fanout. The default is 64.
281 -E, --eliminate
283 Eliminate hosts determined as undetected by ipmidetect. This
284 attempts to remove the common issue of hostranged execution tim‐
285 ing out due to several nodes being removed from service in a
286 large cluster. The ipmidetectd daemon must be running on the
287 node executing the command.
288 --always-prefix
290 Always prefix output, even if only one host is specified or com‐
291 municating in-band. This option is primarily useful for script‐
292 ing purposes. Option will be ignored if specified with the -C
293 option.
294
296 Most users of will want to:
297 A) Run with --checkout to get a copy of the current configuration and
299 store it in a file. The standard output can be redirected to a file or
300 a file can be specified with the --filename option.
301 B) Edit the configuration file with an editor.
303 C) Commit the configuration back using the --commit option and specify‐
305 ing the configuration file with the --filename option. The configura‐
306 tion can be committed to multiple hosts in parallel via the hostrange
307 support.
308 Although not typically necessarily, some motherboards do not store con‐
310 figuration values in non-volatile memory. Therefore, after system
311 reboots, some configuration values may have changed. The user may wish
312 to run configuration tools on each boot to ensure configuration values
313 remain.
314 Comments throughout the checked out file will give instructions on how
316 to configure the fields. The bmc-config.conf(5) manpage also provides
317 additional information on the meaning of different fields.
318 For users with large clusters or sets of nodes, you may wish to use the
320 same configuration file for all nodes. The one problem with this is
321 that the IP address and MAC address will be different on each node in
322 your cluster and thus can't be configured through the same config file.
323 The IP address and MAC address in your config file may be overwritten
324 on the command line using --key-pair option. The following example
325 could be used in a script to configure each node in a cluster with the
326 same BMC config file. The script only needs to determine the correct IP
327 address and MAC address to use.
328 # bmc-config --commit -k Lan_Conf:Ip_Address=$MY_IP -k
330 Lan_Conf:Mac_Address=$MY_MAC -n my_bmc.conf
331
333 The UserN:Password fields (where N is a number) cannot be checked out
334 on some systems, therefore the checked out value will always be blank.
335 The UserN:Enable_User field (where N is a number) cannot be checked out
337 on older IPMI systems, therefore the checked out value will sometime be
338 blank.
339 The UserN:Lan_Session_Limit and UserN:Serial_Session_Limit fields
341 (where N is a number) cannot be checked out on some systems, therefore
342 the checked out value will always be blank. If not specified in later
343 commits of configurations, the field may be reset to 0 due to a
344 requirement that other fields (configured along with the session limit)
345 will require an input value for the session limit. Under most condi‐
346 tions, it is not necessary to set this field and most users may choose
347 to ignore it. This field is considered optional by IPMI standards, and
348 may result in errors when attempting to configure it to a non-zero
349 value. If errors to occur, setting the value back to 0 should resolve
350 problems.
351 The fields Lan_Conf:IP_Address and Lan_Conf:MAC_Address cannot be com‐
353 mitted in parallel via hostrange support. Each machine must be config‐
354 ured with a unique IP Address and MAC Address tuple, therefore we dis‐
355 allow this configuration in bmc-config.
356 On some motherboards, Lan_Conf:MAC_Address may be read only and the MAC
358 address is automatically configured.
359 On some motherboards, Lan_Conf:MAC_Address may be read only and the MAC
361 address is configured via an OEM command. See ipmi-oem(8) to see if OEM
362 configuration for your motherboard is supported.
363 On some motherboards, a number of user configuration fields cannot be
365 read or configured until after a non-null username or non-null password
366 is configured. In some of these cases, an appropriate output in the
367 config file will indicate this situation. However, not all motherboard
368 corner cases may be detected. Users may wish to play around with the
369 ordering of fields to work around these problems.
370 On some motherboards, OEM Authentication in Lan_Conf_Auth cannot be
372 enabled. However, the default motherboard settings have these fields
373 enabled. Users are advised to disable all OEM Authentication in this
374 section.
375 On some motherboards, multiple channels may exist for either LAN or
377 Serial IPMI communication. If multiple channels exist, configuration of
378 both channels can be viewed and ultimately configured by running
379 --checkout under verbose mode. Each section or key name will be suf‐
380 fixed appropriately with the word Channel and the channel number. For
381 example, you might see a Lan_Conf_Channel_1 and Lan_Conf_Channel_3,
382 where you can configure LAN configuration on Channels 1 and 3 respec‐
383 tively.
384 On some motherboards, configuration changes will not be "absorbed" by
386 the system until the motherboard is hard-reset. This can be accom‐
387 plished by physically powering off and on the system (e.g. button
388 push), or it can be accomplished through a cold-reset. A cold-reset can
389 be executed via bmc-device.
390
392 Multiple hosts can be input either as an explicit comma separated lists
393 of hosts or a range of hostnames in the general form: prefix[n-m,l-
394 k,...], where n < m and l < k, etc. The later form should not be con‐
395 fused with regular expression character classes (also denoted by []).
396 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
397 sents a degenerate range: foo19.
398 This range syntax is meant only as a convenience on clusters with a
400 prefixNN naming convention and specification of ranges should not be
401 considered necessary -- the list foo1,foo9 could be specified as such,
402 or by the range foo[1,9].
403 Some examples of range usage follow:
405 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
406 foo[7,9-10] instead of foo7,foo9,foo10
407 foo[0-3] instead of foo0,foo1,foo2,foo3
408 As a reminder to the reader, some shells will interpret brackets ([ and
410 ]) for pattern matching. Depending on your shell, it may be necessary
411 to enclose ranged lists within quotes.
412 When multiple hosts are specified by the user, a thread will be exe‐
414 cuted for each host in parallel up to the configured fanout (which can
415 be adjusted via the -F option). This will allow communication to large
416 numbers of nodes far more quickly than if done in serial.
417 By default, standard output from each node specified will be output
419 with the hostname prepended to each line. Although this output is read‐
420 able in many situations, it may be difficult to read in other situa‐
421 tions. For example, output from multiple nodes may be mixed together.
422 The -B and -C options can be used to change this default.
423 In-band IPMI Communication will be used when the host "localhost" is
425 specified. This allows the user to add the localhost into the hos‐
426 tranged output.
427
429 Most often, IPMI problems are due to configuration problems.
430 IPMI over LAN problems involve a misconfiguration of the remote
432 machine's BMC. Double check to make sure the following are configured
433 properly in the remote machine's BMC: IP address, MAC address, subnet
434 mask, username, user enablement, user privilege, password, LAN privi‐
435 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
436 connections, double check to make sure the cipher suite privilege(s)
437 and K_g key are configured properly. The bmc-config(8) tool can be used
438 to check and/or change these configuration settings.
439 Inband IPMI problems are typically caused by improperly configured
441 drivers or non-standard BMCs.
442 In addition to the troubleshooting tips below, please see WORKAROUNDS
444 below to also if there are any vendor specific bugs that have been dis‐
445 covered and worked around.
446 Listed below are many of the common issues for error messages. For
448 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
449 list.
450 "username invalid" - The username entered (or a NULL username if none
452 was entered) is not available on the remote machine. It may also be
453 possible the remote BMC's username configuration is incorrect.
454 "password invalid" - The password entered (or a NULL password if none
456 was entered) is not correct. It may also be possible the password for
457 the user is not correctly configured on the remote BMC.
458 "password verification timeout" - Password verification has timed out.
460 A "password invalid" error (described above) or a generic "session
461 timeout" (described below) occurred. During this point in the protocol
462 it cannot be differentiated which occurred.
463 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
465 entered) is not correct. It may also be possible the K_g key is not
466 correctly configured on the remote BMC.
467 "privilege level insufficient" - An IPMI command requires a higher user
469 privilege than the one authenticated with. Please try to authenticate
470 with a higher privilege. This may require authenticating to a different
471 user which has a higher maximum privilege.
472 "privilege level cannot be obtained for this user" - The privilege
474 level you are attempting to authenticate with is higher than the maxi‐
475 mum allowed for this user. Please try again with a lower privilege. It
476 may also be possible the maximum privilege level allowed for a user is
477 not configured properly on the remote BMC.
478 "authentication type unavailable for attempted privilege level" - The
480 authentication type you wish to authenticate with is not available for
481 this privilege level. Please try again with an alternate authentication
482 type or alternate privilege level. It may also be possible the avail‐
483 able authentication types you can authenticate with are not correctly
484 configured on the remote BMC.
485 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
487 ticate with is not available on the remote BMC. Please try again with
488 an alternate cipher suite id. It may also be possible the available
489 cipher suite ids are not correctly configured on the remote BMC.
490 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
492 machine. Please try to use IPMI 1.5 instead.
493 "connection timeout" - Initial IPMI communication failed. A number of
495 potential errors are possible, including an invalid hostname specified,
496 an IPMI IP address cannot be resolved, IPMI is not enabled on the
497 remote server, the network connection is bad, etc. Please verify con‐
498 figuration and connectivity.
499 "session timeout" - The IPMI session has timed out. Please reconnect.
501 If this error occurs often, you may wish to increase the retransmission
502 timeout. Some remote BMCs are considerably slower than others.
503 "device not found" - The specified device could not be found. Please
505 check configuration or inputs and try again.
506 "driver timeout" - Communication with the driver or device has timed
508 out. Please try again.
509 "message timeout" - Communication with the driver or device has timed
511 out. Please try again.
512 "BMC busy" - The BMC is currently busy. It may be processing informa‐
514 tion or have too many simultaneous sessions to manage. Please wait and
515 try again.
516 "could not find inband device" - An inband device could not be found.
518 Please check configuration or specify specific device or driver on the
519 command line.
520 "driver timeout" - The inband driver has timed out communicating to the
522 local BMC or service processor. The BMC or service processor may be
523 busy or (worst case) possibly non-functioning.
524
526 With so many different vendors implementing their own IPMI solutions,
527 different vendors may implement their IPMI protocols incorrectly. The
528 following describes a number of workarounds currently available to han‐
529 dle discovered compliance issues. When possible, workarounds have been
530 implemented so they will be transparent to the user. However, some will
531 require the user to specify a workaround be used via the -W option.
532 The hardware listed below may only indicate the hardware that a problem
534 was discovered on. Newer versions of hardware may fix the problems
535 indicated below. Similar machines from vendors may or may not exhibit
536 the same problems. Different vendors may license their firmware from
537 the same IPMI firmware developer, so it may be worthwhile to try work‐
538 arounds listed below even if your motherboard is not listed.
539 If you believe your hardware has an additional compliance issue that
541 needs a workaround to be implemented, please contact the FreeIPMI main‐
542 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
543 assumeio - This workaround flag will assume inband interfaces communi‐
545 cate with system I/O rather than being memory-mapped. This will work
546 around systems that report invalid base addresses. Those hitting this
547 issue may see "device not supported" or "could not find inband device"
548 errors. Issue observed on HP ProLiant DL145 G1.
549 spinpoll - This workaround flag will inform some inband drivers (most
551 notably the KCS driver) to spin while polling rather than putting the
552 process to sleep. This may significantly improve the wall clock running
553 time of tools because an operating system scheduler's granularity may
554 be much larger than the time it takes to perform a single IPMI message
555 transaction. However, by spinning, your system may be performing less
556 useful work by not contexting out the tool for a more useful task.
557 authcap - This workaround flag will skip early checks for username
559 capabilities, authentication capabilities, and K_g support and allow
560 IPMI authentication to succeed. It works around multiple issues in
561 which the remote system does not properly report username capabilities,
562 authentication capabilities, or K_g status. Those hitting this issue
563 may see "username invalid", "authentication type unavailable for
564 attempted privilege level", or "k_g invalid" errors. Issue observed on
565 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
566 2200/4150/4450 with ELOM.
567 idzero - This workaround flag will allow empty session IDs to be
569 accepted by the client. It works around IPMI sessions that report empty
570 session IDs to the client. Those hitting this issue may see "session
571 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
572 unexpectedauth - This workaround flag will allow unexpected non-null
574 authcodes to be checked as though they were expected. It works around
575 an issue when packets contain non-null authentication data when they
576 should be null due to disabled per-message authentication. Those hit‐
577 ting this issue may see "session timeout" errors. Issue observed on
578 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
579 forcepermsg - This workaround flag will force per-message authentica‐
581 tion to be used no matter what is advertised by the remote system. It
582 works around an issue when per-message authentication is advertised as
583 disabled on the remote system, but it is actually required for the pro‐
584 tocol. Those hitting this issue may see "session timeout" errors.
585 Issue observed on IBM eServer 325.
586 endianseq - This workaround flag will flip the endian of the session
588 sequence numbers to allow the session to continue properly. It works
589 around IPMI 1.5 session sequence numbers that are the wrong endian.
590 Those hitting this issue may see "session timeout" errors. Issue
591 observed on some Sun ILOM 1.0/2.0 (depends on service processor
592 endian).
593 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
595 the authentication codes returned from IPMI 1.5 command responses. It
596 works around systems to return invalid authentication codes due to
597 hashing or implementation errors. Users are cautioned on the use of
598 this option, as it removes an authentication check verifying the valid‐
599 ity of a packet. However, in most organizations, this is unlikely to be
600 a security issue. Those hitting this issue may see "connection time‐
601 out", "session timeout", or "password verification timeout" errors.
602 Issue observed on Xyratex FB-H8-SRAY.
603 intel20 - This workaround flag will work around several Intel IPMI 2.0
605 authentication issues. The issues covered include padding of usernames,
606 and password truncation if the authentication algorithm is HMAC-
607 MD5-128. Those hitting this issue may see "username invalid", "password
608 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
609 with Intel Server Management Module (Professional Edition).
610 supermicro20 - This workaround flag will work around several Supermicro
612 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
613 firmware. The issues covered include handling invalid length authenti‐
614 cation codes. Those hitting this issue may see "password invalid"
615 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
616 Confirmed fixed on newerver firmware.
617 sun20 - This workaround flag will work work around several Sun IPMI 2.0
619 authentication issues. The issues covered include invalid lengthed hash
620 keys, improperly hashed keys, and invalid cipher suite records. Those
621 hitting this issue may see "password invalid" or "bmc error" errors.
622 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
623 automatically includes the "opensesspriv" workaround.
624 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
626 2.0 connection protocol to workaround an invalid hashing algorithm used
627 by the remote system. The privilege level sent during the Open Session
628 stage of an IPMI 2.0 connection is used for hashing keys instead of the
629 privilege level sent during the RAKP1 connection stage. Those hitting
630 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
631 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
632 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
633 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
634 QSSC-S4R//Appro GB812X-CN. This workaround is automatically triggered
635 with the "sun20" workaround.
636 integritycheckvalue - This workaround flag will work around an invalid
638 integrity check value during an IPMI 2.0 session establishment when
639 using Cipher Suite ID 0. The integrity check value should be 0 length,
640 however the remote motherboard responds with a non-empty field. Those
641 hitting this issue may see "k_g invalid" errors. Issue observed on
642 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
643 700, and Intel S2600JF/Appro 512X.
644 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
646 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
647 2.0 unavailable" or "connection timeout" errors. This issue can be
648 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
649 --driver-address=LAN_2_0. Issue observed on HP Proliant DL 145.
650 slowcommit - This workaround will slow down commits to the BMC by
652 sleeping one second between the commit of sections. It works around
653 motherboards that have BMCs that can be overwhelmed by commits. Those
654 hitting this issue may see commit errors or commits not being written
655 to the BMC. Issue observed on Supermicro H8QME.
656 veryslowcommit - This workaround will slow down commits to the BMC by
658 sleeping one second between the commit of every key. It works around
659 motherboards that have BMCs that can be overwhelmed by commits. Those
660 hitting this issue may see commit errors or commits not being written
661 to the BMC. Issue observed on Quanta S99Q/Dell FS12-TY.
662 solchannelassumelanchannel - This workaround will force bmc-config to
664 assume that the channel used SOL is identical to the channel used for
665 LAN. On some motherboards, the SOL channel is reported incorrectly,
666 leading to incorrect configuration. Most notably, this problem has come
667 up when attempting to configure multiple channels. Issue observed on
668 Intel S5500WBV/Penguin Relion 700.
669
671 # bmc-config --checkout
672 Output all configuration information to the console.
674 # bmc-config --checkout --filename=bmc-data1.conf
676 Store all configuration information in bmc-data1.conf.
678 # bmc-config --diff --filename=bmc-data2.conf
680 Show all difference between the current configuration and the bmc-
682 data2.conf file.
683 # bmc-config --diff --key-pair="lan_conf_misc:gratuitous_arp_inter‐
685 val=8"
686 Show difference with the current configuration and the
688 'lan_conf_misc:gratuitous_arp_interval' of value '8'.
689 # bmc-config --commit --filename=bmc-data1.conf
691 Commit all configuration values from the bmc-data1.conf file.
693 # bmc-config --commit --key-pair="lan_conf_misc:gratuitous_arp_inter‐
695 val=4"
696 Commit key 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
698 # bmc-config --commit --filename=bmc-data-updt.conf --key-
700 pair="lan_conf_misc:gratuitous_arp_interval=4"
701 Commit all configuration values from bmc-data-updt.conf and key
703 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
704
706 Upon successful execution, exit status is 0. On error, exit status is
707 1.
708 If multiple hosts are specified for communication, the exit status is 0
710 if and only if all targets successfully execute. Otherwise the exit
711 status is 1.
712
714 On older operating systems, if you input your username, password, and
715 other potentially security relevant information on the command line,
716 this information may be discovered by other users when using tools like
717 the ps(1) command or looking in the /proc file system. It is generally
718 more secure to input password information with options like the -P or
719 -K options. Configuring security relevant information in the FreeIPMI
720 configuration file would also be an appropriate way to hide this infor‐
721 mation.
722 In order to prevent brute force attacks, some BMCs will temporarily
724 "lock up" after a number of remote authentication errors. You may need
725 to wait awhile in order to this temporary "lock up" to pass before you
726 may authenticate again.
727
729 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
730
732 Copyright © 2003-2012 FreeIPMI Core Team.
733 This program is free software; you can redistribute it and/or modify it
735 under the terms of the GNU General Public License as published by the
736 Free Software Foundation; either version 3 of the License, or (at your
737 option) any later version.
738
740 bmc-config.conf(5), freeipmi(7), ipmi-chassis-config(8), ipmi-pef-con‐
741 fig(8), ipmi-sensors-config(8), bmc-device(8)
742 http://www.gnu.org/software/freeipmi/
744bmc-config 1.2.1 2017-03-22 BMC-CONFIG(8)