1IPMI-CONFIG(8) System Commands IPMI-CONFIG(8)
2
6 ipmi-config - configure IPMI values
7
9 ipmi-config [OPTION...]
10
12 ipmi-config is used to get and set configuration parameters in IPMI. In
13 can be used to configured usernames, passwords, networking information,
14 security, Serial-over-LAN (SOL), Platform Event Filtering (PEF), boot
15 devices, power restoration policy, sensor thresholds, sensor events,
16 and many more configuration options. Some configuration is typically
17 required before most IPMI tools can be used to access a machine re‐
18 motely. By default, ipmi-config, will let you --checkout or --commit
19 only the core IPMI values necessary for IPMI configuration. For addi‐
20 tional advanced configuration fields related to Chassis configuration
21 (including boot options), Platform Event Filtering (PEF), or Sensors,
22 see the --category option below. The majority of configuration opera‐
23 tions require ADMIN privilege when using ipmi-config out-of-band. Al‐
24 though connecting via a user with ADMIN privileges is not required for
25 out-of-band use, the vast majority of configuration options will not be
26 retrieved or set.
27 Listed below are general IPMI options, tool specific options, trouble
29 shooting information, workaround information, examples, and known is‐
30 sues. For a general introduction to FreeIPMI please see freeipmi(7).
31 See GENERAL USE below for a description on basic use of ipmi-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,
42 SUNBMC, and INTELDCMI.
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 re‐
67 quests 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. If specifying an IPv6 address and port,
76 use the format [ADDRESS]:PORT.
77 -u USERNAME, --username=USERNAME
79 Specify the username to use when authenticating with the remote
80 host. If not specified, a null (i.e. anonymous) username is as‐
81 sumed. The user must have atleast ADMIN privileges in order for
82 this tool to operate fully.
83 -p PASSWORD, --password=PASSWORD
85 Specify the password to use when authenticationg with the remote
86 host. If not specified, a null password is assumed. Maximum
87 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
88 -P, --password-prompt
90 Prompt for password to avoid possibility of listing it in
91 process lists.
92 -k K_G, --k-g=K_G
94 Specify the K_g BMC key to use when authenticating with the re‐
95 mote host for IPMI 2.0. If not specified, a null key is assumed.
96 To input the key in hexadecimal form, prefix the string with
97 '0x'. E.g., the key 'abc' can be entered with the either the
98 string 'abc' or the string '0x616263'
99 -K, --k-g-prompt
101 Prompt for k-g to avoid possibility of listing it in process
102 lists.
103 --session-timeout=MILLISECONDS
105 Specify the session timeout in milliseconds. Defaults to 20000
106 milliseconds (20 seconds) if not specified.
107 --retransmission-timeout=MILLISECONDS
109 Specify the packet retransmission timeout in milliseconds. De‐
110 faults to 1000 milliseconds (1 second) if not specified. The re‐
111 transmission timeout cannot be larger than the session timeout.
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 AD‐
168 MIN 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 -g CATEGORY, --category=CATEGORY
197 Specify the category or categories of configuration data to con‐
198 figure. Currently available choices: core, chassis, sensors,
199 pef, dcmi. Multiple categories can be separated by comma. core
200 includes all major IPMI configuration necessary to get IPMI to
201 function on a system, such as configuration for users, pass‐
202 words, authentication, networking, and serial-over-lan (SOL).
203 chassis includes all chassis relevant configuration including
204 boot options, front panel buttons, and power behavior. dcmi in‐
205 cludes specialized functions provided by the Data Center Manage‐
206 ment Interface (DCMI). Defaults to core if not specified.
207 -o, --checkout
209 Fetch configuration information.
210 -c, --commit
212 Update configuration information from a config file or key
213 pairs.
214 -d, --diff
216 Show differences between stored information and a config file or
217 key pairs.
218 -n FILENAME, --filename=FILENAME
220 Specify a config file for checkout/commit/diff. If specified
221 with checkout, cannot use with multiple hosts or with --al‐
222 ways-prefix.
223 -e "KEY=VALUE", --key-pair="KEY=VALUE"
225 Specify KEY=VALUE pairs for checkout/commit/diff. Specify KEY by
226 SectionName:FieldName. This option can be used multiple times.
227 On commit, any KEY=VALUE pairs will overwrite any pairs speci‐
228 fied in a file with --filename.
229 -S SECTION, --section=SECTION
231 Specify a SECTION for checkout. This option can be used multiple
232 times. The SECTION you are specifying must be within the cate‐
233 gory or categories specified with --category.
234 -L, --listsections
236 List available sections for checkout with respect to the cate‐
237 gory or categories under --category. Some sections in the list
238 may not be checked out by default and may require verbosity to
239 be increased.
240 -v, --verbose
242 Output verbose information. When used with --checkout, addi‐
243 tional uncommon sections and/or fields will be shown. In the
244 core category, this includes checking out Serial Configuration
245 parameters, Vlan parameters, IPv4 Header parameters, RMCP port,
246 and sections for each channel on a system, if multiple channels
247 exist. In the pef category, this includes checkout out sections
248 for each channel on a system, if multiple channels exist.
249 -vv Output very verbose information. Output additional detailed in‐
251 formation about what fields can and cannot be checked out, and
252 sometimes the reason why. Sometimes output fields that are iden‐
253 tified as unsupported on the motherboard.
254 --lan-channel-number=NUMBER
256 Use an specific channel number for LAN configuration. Particu‐
257 larly useful if motherboard contains multiple LAN channels and a
258 user wishes to use a specific one.
259 --serial-channel-number=NUMBER
261 Use an specific channel number for serial configuration. Partic‐
262 ularly useful if motherboard contains multiple serial channels
263 and a user wishes to use a specific one.
264 --sol-channel-number=NUMBER
266 Use an specific channel number for SOL configuration. Particu‐
267 larly useful if motherboard contains multiple SOL channels and a
268 user wishes to use a specific one.
269
271 This tool requires access to the sensor data repository (SDR) cache for
272 general operation. By default, SDR data will be downloaded and cached
273 on the local machine. The following options apply to the SDR cache.
274 --flush-cache
276 Flush a cached version of the sensor data repository (SDR)
277 cache. The SDR is typically cached for faster subsequent access.
278 However, it may need to be flushed and re-generated if the SDR
279 has been updated on a system.
280 --quiet-cache
282 Do not output information about cache creation/deletion. May be
283 useful in scripting.
284 --sdr-cache-recreate
286 If the SDR cache is out of date or invalid, automatically recre‐
287 ate the sensor data repository (SDR) cache. This option may be
288 useful for scripting purposes.
289 --sdr-cache-file=FILE
291 Specify a specific sensor data repository (SDR) cache file to be
292 stored or read from. If this option is used when multiple hosts
293 are specified, the same SDR cache file will be used for all
294 hosts.
295 --sdr-cache-directory=DIRECTORY
297 Specify an alternate directory for sensor data repository (SDR)
298 caches to be stored or read from. Defaults to the home directory
299 if not specified.
300
302 The following options manipulate hostranged output. See HOSTRANGED SUP‐
303 PORT below for additional information on hostranges.
304 -B, --buffer-output
306 Buffer hostranged output. For each node, buffer standard output
307 until the node has completed its IPMI operation. When specifying
308 this option, data may appear to output slower to the user since
309 the the entire IPMI operation must complete before any data can
310 be output. See HOSTRANGED SUPPORT below for additional informa‐
311 tion.
312 -C, --consolidate-output
314 Consolidate hostranged output. The complete standard output from
315 every node specified will be consolidated so that nodes with
316 identical output are not output twice. A header will list those
317 nodes with the consolidated output. When this option is speci‐
318 fied, no output can be seen until the IPMI operations to all
319 nodes has completed. If the user breaks out of the program
320 early, all currently consolidated output will be dumped. See
321 HOSTRANGED SUPPORT below for additional information.
322 -F NUM, --fanout=NUM
324 Specify multiple host fanout. A "sliding window" (or fanout) al‐
325 gorithm is used for parallel IPMI communication so that slower
326 nodes or timed out nodes will not impede parallel communication.
327 The maximum number of threads available at the same time is lim‐
328 ited by the fanout. The default is 64.
329 -E, --eliminate
331 Eliminate hosts determined as undetected by ipmidetect. This
332 attempts to remove the common issue of hostranged execution tim‐
333 ing out due to several nodes being removed from service in a
334 large cluster. The ipmidetectd daemon must be running on the
335 node executing the command.
336 --always-prefix
338 Always prefix output, even if only one host is specified or com‐
339 municating in-band. This option is primarily useful for script‐
340 ing purposes. Option will be ignored if specified with the -C
341 option.
342
344 Most users of will want to:
345 A) Run with --checkout to get a copy of the current configuration and
347 store it in a file. The standard output can be redirected to a file or
348 a file can be specified with the --filename option.
349 B) Edit the configuration file with an editor.
351 C) Commit the configuration back using the --commit option and specify‐
353 ing the configuration file with the --filename option. The configura‐
354 tion can be committed to multiple hosts in parallel via the hostrange
355 support.
356 Although not typically necessarily, some motherboards do not store con‐
358 figuration values in non-volatile memory. Therefore, after system re‐
359 boots, some configuration values may have changed. The user may wish to
360 run configuration tools on each boot to ensure configuration values re‐
361 main.
362 Comments will be listed on occassion in checked out files with informa‐
364 tion on how to configure fields. The ipmi-config.conf(5) manpage also
365 provides additional information on the meaning of different fields.
366 For users with large clusters or sets of nodes, you may wish to use the
368 same configuration file for all nodes. The one problem with this is
369 that the IP address and MAC address will be different on each node in
370 your cluster and thus can't be configured through the same config file.
371 The IP address and MAC address in your config file may be overwritten
372 on the command line using --key-pair option. The following example
373 could be used in a script to configure each node in a cluster with the
374 same BMC config file. The script only needs to determine the correct IP
375 address and MAC address to use.
376 # ipmi-config --commit -k Lan_Conf:Ip_Address=$MY_IP -k
378 Lan_Conf:Mac_Address=$MY_MAC --filename=my_bmc.conf
379
381 The UserN:Password fields (where N is a number) cannot be checked out
382 on some systems, therefore the checked out value will always be blank.
383 The UserN:Enable_User field (where N is a number) cannot be checked out
385 on older IPMI systems, therefore the checked out value will sometime be
386 blank.
387 The UserN:Lan_Session_Limit and UserN:Serial_Session_Limit fields
389 (where N is a number) cannot be checked out on some systems, therefore
390 the checked out value will always be blank. If not specified in later
391 commits of configurations, the field may be reset to 0 due to a re‐
392 quirement that other fields (configured along with the session limit)
393 will require an input value for the session limit. Under most condi‐
394 tions, it is not necessary to set this field and most users may choose
395 to ignore it. This field is considered optional by IPMI standards, and
396 may result in errors when attempting to configure it to a non-zero
397 value. If errors to occur, setting the value back to 0 should resolve
398 problems.
399 The fields Lan_Conf:IP_Address and Lan_Conf:MAC_Address cannot be com‐
401 mitted in parallel via hostrange support. Each machine must be config‐
402 ured with a unique IP Address and MAC Address tuple, therefore we dis‐
403 allow this configuration in ipmi-config.
404 On some motherboards, Lan_Conf:MAC_Address may be read only and the MAC
406 address is automatically configured.
407 On some motherboards, Lan_Conf:MAC_Address may be read only and the MAC
409 address is configured via an OEM command. See ipmi-oem(8) to see if OEM
410 configuration for your motherboard is supported.
411 On some motherboards, a number of user configuration fields cannot be
413 read or configured until after a non-null username or non-null password
414 is configured. In some of these cases, an appropriate output in the
415 config file will indicate this situation. However, not all motherboard
416 corner cases may be detected. Users may wish to play around with the
417 ordering of fields to work around these problems.
418 On some motherboards, OEM Authentication in Lan_Conf_Auth cannot be en‐
420 abled. However, the default motherboard settings have these fields en‐
421 abled. Users are advised to disable all OEM Authentication in this sec‐
422 tion.
423 On some motherboards, multiple channels may exist for either LAN or Se‐
425 rial IPMI communication. If multiple channels exist, configuration of
426 both channels can be viewed and ultimately configured by running
427 --checkout under verbose mode. Each section or key name will be suf‐
428 fixed appropriately with the word Channel and the channel number. For
429 example, you might see a Lan_Conf_Channel_1 and Lan_Conf_Channel_3,
430 where you can configure LAN configuration on Channels 1 and 3 respec‐
431 tively.
432 On some motherboards, configuration changes will not be "absorbed" by
434 the system until the motherboard is hard-reset. This can be accom‐
435 plished by physically powering off and on the system (e.g. button
436 push), or it can be accomplished through a cold-reset. A cold-reset can
437 be executed via bmc-device.
438
440 The Chassis_Front_Panel_Buttons:Enable_Standby_Button_For_Enter‐
441 ing_Standy, Chassis_Front_Panel_Buttons:Enable_Diagnostic_Inter‐
442 rupt_Button Chassis_Front_Panel_Buttons:Enable_Reset_Button, and Chas‐
443 sis_Front_Panel_Buttons:Enable_Power_Off_Button_For_Power_Off_Only
444 fields may not be able to be checked out on some IPMI systems, there‐
445 fore the checked out value may be blank. Some of these fields may be
446 disableable, while some are not. The Chassis_Power_Conf:Power_Con‐
447 trol_Interval field cannot be checked out. Therefore the checked out
448 value will always be blank.
449
451 On some motherboards, multiple channels may exist for LAN IPMI communi‐
452 cation. If multiple channels exist, configuration of both channels can
453 be viewed and ultimately configured by running --checkout under verbose
454 mode. Each section name will be suffixed appropriately with the word
455 Channel and the channel number. For example, you might see a Commu‐
456 nity_String_Channel_1 and Community_String_Channel_3, where you can
457 configure the Community String on Channels 1 and 3 respectively. The
458 following are the options suitable for input for Sensor_Type in PEF
459 configuration.
460 Sensor_Type Options
462 Reserved, Temperature, Voltage, Current, Fan, Physical_Security,
463 Platform_Security_Violation_Attempt, Processor, Power_Supply,
464 Power_Unit, Cooling_Device, Other_Units_Based_Sensor, Memory,
465 Drive_Slot, Post_Memory_Resize, System_Firmware_Progress,
466 Event_Logging_Disabled, Watchdog1, System_Event, Critical_Inter‐
467 rupt, Button_Switch, Module_Board, Microcontroller_Coprocessor,
468 Add_In_Card, Chassis, Chip_Set, Other_FRU, Cable_Interconnect,
469 Terminator, System_Boot_Initiated, Boot_Error, OS_Boot, OS_Crit‐
470 ical_Stop, Slot_Connector, System_ACPI_Power_State, Watchdog2,
471 Platform_Alert, Entity_Presence, Monitor_Asic_IC, Lan, Manage‐
472 ment_Subsystem_Health, Battery, Session_Audit, Version_Change,
473 FRU_State, and Any
474
476 Since many configurable fields involve decimal numbers, preci‐
477 sion/floating point inaccuracies may occur when configuring new thresh‐
478 olds. The inaccuracies may not be apparent immediately. It is recommend
479 users verify their changes after configuring new thresholds.
480
482 Multiple hosts can be input either as an explicit comma separated lists
483 of hosts or a range of hostnames in the general form: prefix[n-m,l-
484 k,...], where n < m and l < k, etc. The later form should not be con‐
485 fused with regular expression character classes (also denoted by []).
486 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
487 sents a degenerate range: foo19.
488 This range syntax is meant only as a convenience on clusters with a
490 prefixNN naming convention and specification of ranges should not be
491 considered necessary -- the list foo1,foo9 could be specified as such,
492 or by the range foo[1,9].
493 Some examples of range usage follow:
495 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
496 foo[7,9-10] instead of foo7,foo9,foo10
497 foo[0-3] instead of foo0,foo1,foo2,foo3
498 As a reminder to the reader, some shells will interpret brackets ([ and
500 ]) for pattern matching. Depending on your shell, it may be necessary
501 to enclose ranged lists within quotes.
502 When multiple hosts are specified by the user, a thread will be exe‐
504 cuted for each host in parallel up to the configured fanout (which can
505 be adjusted via the -F option). This will allow communication to large
506 numbers of nodes far more quickly than if done in serial.
507 By default, standard output from each node specified will be output
509 with the hostname prepended to each line. Although this output is read‐
510 able in many situations, it may be difficult to read in other situa‐
511 tions. For example, output from multiple nodes may be mixed together.
512 The -B and -C options can be used to change this default.
513 In-band IPMI Communication will be used when the host "localhost" is
515 specified. This allows the user to add the localhost into the hos‐
516 tranged output.
517
519 Most often, IPMI problems are due to configuration problems.
520 IPMI over LAN problems involve a misconfiguration of the remote ma‐
522 chine's BMC. Double check to make sure the following are configured
523 properly in the remote machine's BMC: IP address, MAC address, subnet
524 mask, username, user enablement, user privilege, password, LAN privi‐
525 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
526 connections, double check to make sure the cipher suite privilege(s)
527 and K_g key are configured properly. The ipmi-config(8) tool can be
528 used to check and/or change these configuration settings.
529 Inband IPMI problems are typically caused by improperly configured
531 drivers or non-standard BMCs.
532 In addition to the troubleshooting tips below, please see WORKAROUNDS
534 below to also if there are any vendor specific bugs that have been dis‐
535 covered and worked around.
536 Listed below are many of the common issues for error messages. For ad‐
538 ditional support, please e-mail the <freeipmi-users@gnu.org> mailing
539 list.
540 "username invalid" - The username entered (or a NULL username if none
542 was entered) is not available on the remote machine. It may also be
543 possible the remote BMC's username configuration is incorrect.
544 "password invalid" - The password entered (or a NULL password if none
546 was entered) is not correct. It may also be possible the password for
547 the user is not correctly configured on the remote BMC.
548 "password verification timeout" - Password verification has timed out.
550 A "password invalid" error (described above) or a generic "session
551 timeout" (described below) occurred. During this point in the protocol
552 it cannot be differentiated which occurred.
553 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was en‐
555 tered) is not correct. It may also be possible the K_g key is not cor‐
556 rectly configured on the remote BMC.
557 "privilege level insufficient" - An IPMI command requires a higher user
559 privilege than the one authenticated with. Please try to authenticate
560 with a higher privilege. This may require authenticating to a different
561 user which has a higher maximum privilege.
562 "privilege level cannot be obtained for this user" - The privilege
564 level you are attempting to authenticate with is higher than the maxi‐
565 mum allowed for this user. Please try again with a lower privilege. It
566 may also be possible the maximum privilege level allowed for a user is
567 not configured properly on the remote BMC.
568 "authentication type unavailable for attempted privilege level" - The
570 authentication type you wish to authenticate with is not available for
571 this privilege level. Please try again with an alternate authentication
572 type or alternate privilege level. It may also be possible the avail‐
573 able authentication types you can authenticate with are not correctly
574 configured on the remote BMC.
575 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
577 ticate with is not available on the remote BMC. Please try again with
578 an alternate cipher suite id. It may also be possible the available ci‐
579 pher suite ids are not correctly configured on the remote BMC.
580 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote ma‐
582 chine. Please try to use IPMI 1.5 instead.
583 "connection timeout" - Initial IPMI communication failed. A number of
585 potential errors are possible, including an invalid hostname specified,
586 an IPMI IP address cannot be resolved, IPMI is not enabled on the re‐
587 mote server, the network connection is bad, etc. Please verify configu‐
588 ration and connectivity.
589 "session timeout" - The IPMI session has timed out. Please reconnect.
591 If this error occurs often, you may wish to increase the retransmission
592 timeout. Some remote BMCs are considerably slower than others.
593 "device not found" - The specified device could not be found. Please
595 check configuration or inputs and try again.
596 "driver timeout" - Communication with the driver or device has timed
598 out. Please try again.
599 "message timeout" - Communication with the driver or device has timed
601 out. Please try again.
602 "BMC busy" - The BMC is currently busy. It may be processing informa‐
604 tion or have too many simultaneous sessions to manage. Please wait and
605 try again.
606 "could not find inband device" - An inband device could not be found.
608 Please check configuration or specify specific device or driver on the
609 command line.
610 "driver timeout" - The inband driver has timed out communicating to the
612 local BMC or service processor. The BMC or service processor may be
613 busy or (worst case) possibly non-functioning.
614
616 With so many different vendors implementing their own IPMI solutions,
617 different vendors may implement their IPMI protocols incorrectly. The
618 following describes a number of workarounds currently available to han‐
619 dle discovered compliance issues. When possible, workarounds have been
620 implemented so they will be transparent to the user. However, some will
621 require the user to specify a workaround be used via the -W option.
622 The hardware listed below may only indicate the hardware that a problem
624 was discovered on. Newer versions of hardware may fix the problems in‐
625 dicated below. Similar machines from vendors may or may not exhibit the
626 same problems. Different vendors may license their firmware from the
627 same IPMI firmware developer, so it may be worthwhile to try work‐
628 arounds listed below even if your motherboard is not listed.
629 If you believe your hardware has an additional compliance issue that
631 needs a workaround to be implemented, please contact the FreeIPMI main‐
632 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
633 assumeio - This workaround flag will assume inband interfaces communi‐
635 cate with system I/O rather than being memory-mapped. This will work
636 around systems that report invalid base addresses. Those hitting this
637 issue may see "device not supported" or "could not find inband device"
638 errors. Issue observed on HP ProLiant DL145 G1.
639 spinpoll - This workaround flag will inform some inband drivers (most
641 notably the KCS driver) to spin while polling rather than putting the
642 process to sleep. This may significantly improve the wall clock running
643 time of tools because an operating system scheduler's granularity may
644 be much larger than the time it takes to perform a single IPMI message
645 transaction. However, by spinning, your system may be performing less
646 useful work by not contexting out the tool for a more useful task.
647 authcap - This workaround flag will skip early checks for username ca‐
649 pabilities, authentication capabilities, and K_g support and allow IPMI
650 authentication to succeed. It works around multiple issues in which the
651 remote system does not properly report username capabilities, authenti‐
652 cation capabilities, or K_g status. Those hitting this issue may see
653 "username invalid", "authentication type unavailable for attempted
654 privilege level", or "k_g invalid" errors. Issue observed on Asus
655 P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
656 2200/4150/4450 with ELOM.
657 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
659 the checksums returned from IPMI command responses. It works around
660 systems that return invalid checksums due to implementation errors, but
661 the packet is otherwise valid. Users are cautioned on the use of this
662 option, as it removes validation of packet integrity in a number of
663 circumstances. However, it is unlikely to be an issue in most situa‐
664 tions. Those hitting this issue may see "connection timeout", "session
665 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
666 nections, the "noauthcodecheck" workaround may also needed too. Issue
667 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
668 X9DRFR.
669 idzero - This workaround flag will allow empty session IDs to be ac‐
671 cepted by the client. It works around IPMI sessions that report empty
672 session IDs to the client. Those hitting this issue may see "session
673 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
674 unexpectedauth - This workaround flag will allow unexpected non-null
676 authcodes to be checked as though they were expected. It works around
677 an issue when packets contain non-null authentication data when they
678 should be null due to disabled per-message authentication. Those hit‐
679 ting this issue may see "session timeout" errors. Issue observed on
680 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
681 forcepermsg - This workaround flag will force per-message authentica‐
683 tion to be used no matter what is advertised by the remote system. It
684 works around an issue when per-message authentication is advertised as
685 disabled on the remote system, but it is actually required for the pro‐
686 tocol. Those hitting this issue may see "session timeout" errors. Is‐
687 sue observed on IBM eServer 325.
688 endianseq - This workaround flag will flip the endian of the session
690 sequence numbers to allow the session to continue properly. It works
691 around IPMI 1.5 session sequence numbers that are the wrong endian.
692 Those hitting this issue may see "session timeout" errors. Issue ob‐
693 served on some Sun ILOM 1.0/2.0 (depends on service processor endian).
694 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
696 the authentication codes returned from IPMI 1.5 command responses. It
697 works around systems that return invalid authentication codes due to
698 hashing or implementation errors. Users are cautioned on the use of
699 this option, as it removes an authentication check verifying the valid‐
700 ity of a packet. However, in most organizations, this is unlikely to be
701 a security issue. Those hitting this issue may see "connection time‐
702 out", "session timeout", or "password verification timeout" errors.
703 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
704 fell, and Wiwynn Windmill.
705 intel20 - This workaround flag will work around several Intel IPMI 2.0
707 authentication issues. The issues covered include padding of usernames,
708 and password truncation if the authentication algorithm is HMAC-
709 MD5-128. Those hitting this issue may see "username invalid", "password
710 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
711 with Intel Server Management Module (Professional Edition).
712 supermicro20 - This workaround flag will work around several Supermicro
714 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
715 firmware. The issues covered include handling invalid length authenti‐
716 cation codes. Those hitting this issue may see "password invalid" er‐
717 rors. Issue observed on Supermicro H8QME with SIMSO daughter card.
718 Confirmed fixed on newerver firmware.
719 sun20 - This workaround flag will work work around several Sun IPMI 2.0
721 authentication issues. The issues covered include invalid lengthed hash
722 keys, improperly hashed keys, and invalid cipher suite records. Those
723 hitting this issue may see "password invalid" or "bmc error" errors.
724 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
725 automatically includes the "opensesspriv" workaround.
726 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
728 2.0 connection protocol to workaround an invalid hashing algorithm used
729 by the remote system. The privilege level sent during the Open Session
730 stage of an IPMI 2.0 connection is used for hashing keys instead of the
731 privilege level sent during the RAKP1 connection stage. Those hitting
732 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
733 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
734 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
735 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta
736 QSSC-S4R/Appro GB812X-CN, and Dell C5220. This workaround is automati‐
737 cally triggered with the "sun20" workaround.
738 integritycheckvalue - This workaround flag will work around an invalid
740 integrity check value during an IPMI 2.0 session establishment when us‐
741 ing Cipher Suite ID 0. The integrity check value should be 0 length,
742 however the remote motherboard responds with a non-empty field. Those
743 hitting this issue may see "k_g invalid" errors. Issue observed on Su‐
744 permicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
745 700, and Intel S2600JF/Appro 512X.
746 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
748 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
749 2.0 unavailable" or "connection timeout" errors. This issue can be
750 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
751 --driver-type=LAN_2_0. Issue observed on a number of HP and Supermicro
752 motherboards.
753 slowcommit - This workaround will slow down commits to the BMC by
755 sleeping one second between the commit of sections. It works around
756 motherboards that have BMCs that can be overwhelmed by commits. Those
757 hitting this issue may see commit errors or commits not being written
758 to the BMC. Issue observed on Supermicro H8QME.
759 veryslowcommit - This workaround will slow down commits to the BMC by
761 sleeping one second between the commit of every key. It works around
762 motherboards that have BMCs that can be overwhelmed by commits. Those
763 hitting this issue may see commit errors or commits not being written
764 to the BMC. Issue observed on Quanta S99Q/Dell FS12-TY.
765 solchannelassumelanchannel - This workaround will force ipmi-config to
767 assume that the channel used SOL is identical to the channel used for
768 LAN. On some motherboards, the SOL channel is reported incorrectly,
769 leading to incorrect configuration. Most notably, this problem has come
770 up when attempting to configure multiple channels. Issue observed on
771 Intel S5500WBV/Penguin Relion 700.
772
774 # ipmi-config --checkout
775 Output all core configuration information to the console. # ipmi-con‐
777 fig --checkout --category=pef
778 Output all pef configuration information to the console. # ipmi-config
780 --checkout --category=pef,chassis
781 Output all pef and chassis configuration information to the console.
783 # ipmi-config --checkout --filename=bmc-data1.conf
785 Store all core configuration information in bmc-data1.conf.
787 # ipmi-config --diff --filename=bmc-data2.conf
789 Show all difference between the current configuration and the bmc-
791 data2.conf file.
792 # ipmi-config --diff --key-pair="lan_conf_misc:gratuitous_arp_inter‐
794 val=8"
795 Show difference with the current configuration and the
797 'lan_conf_misc:gratuitous_arp_interval' of value '8'.
798 # ipmi-config --commit --filename=bmc-data1.conf
800 Commit all configuration values from the bmc-data1.conf file.
802 # ipmi-config --commit --key-pair="lan_conf_misc:gratuitous_arp_inter‐
804 val=4"
805 Commit key 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
807 # ipmi-config --commit --filename=bmc-data-updt.conf --key-
809 pair="lan_conf_misc:gratuitous_arp_interval=4"
810 Commit all configuration values from bmc-data-updt.conf and key
812 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
813
815 Upon successful execution, exit status is 0. On non-fatal error, exit
816 status is 1. On fatal error, exit status is 2.
817 If multiple hosts are specified for communication, the exit status is 0
819 if and only if all targets successfully execute. If any non-fatal error
820 occurs, exit status is 1. If any fatal error occurs, exit status is 2.
821
823 On older operating systems, if you input your username, password, and
824 other potentially security relevant information on the command line,
825 this information may be discovered by other users when using tools like
826 the ps(1) command or looking in the /proc file system. It is generally
827 more secure to input password information with options like the -P or
828 -K options. Configuring security relevant information in the FreeIPMI
829 configuration file would also be an appropriate way to hide this infor‐
830 mation.
831 In order to prevent brute force attacks, some BMCs will temporarily
833 "lock up" after a number of remote authentication errors. You may need
834 to wait awhile in order to this temporary "lock up" to pass before you
835 may authenticate again.
836
838 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
839
841 Copyright © 2003-2015 FreeIPMI Core Team.
842 This program is free software; you can redistribute it and/or modify it
844 under the terms of the GNU General Public License as published by the
845 Free Software Foundation; either version 3 of the License, or (at your
846 option) any later version.
847
849 ipmi-config.conf(5), freeipmi(7), bmc-device(8)
850 http://www.gnu.org/software/freeipmi/
852ipmi-config 1.6.8 2021-05-20 IPMI-CONFIG(8)