1IPMI-CONFIG(8)                  System Commands                 IPMI-CONFIG(8)
2
3
4

NAME

6       ipmi-config - configure IPMI values
7

SYNOPSIS

9       ipmi-config [OPTION...]
10

DESCRIPTION

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
18       remotely.  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.
24       Although  connecting  via  a user with ADMIN privileges is not required
25       for out-of-band use, the vast majority of  configuration  options  will
26       not be retrieved or set.
27
28       Listed  below  are general IPMI options, tool specific options, trouble
29       shooting  information,  workaround  information,  examples,  and  known
30       issues.  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

GENERAL OPTIONS

34       The following options are general options for configuring IPMI communi‐
35       cation and executing general tool commands.
36
37       -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
44       --disable-auto-probe
45              Do not probe in-band IPMI devices for default settings.
46
47       --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
52       --driver-device=DEVICE
53              Specify the in-band driver device path to be used instead of the
54              probed path.
55
56       --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
61       --target-channel-number=CHANNEL-NUMBER
62              Specify the in-band driver target channel number  to  send  IPMI
63              requests to.
64
65       --target-slave-address=SLAVE-ADDRESS
66              Specify  the  in-band  driver  target  slave number to send IPMI
67              requests to.
68
69       -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
77       -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
83       -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
88       -P, --password-prompt
89              Prompt for password  to  avoid  possibility  of  listing  it  in
90              process lists.
91
92       -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
99       -K, --k-g-prompt
100              Prompt  for  k-g  to  avoid possibility of listing it in process
101              lists.
102
103       --session-timeout=MILLISECONDS
104              Specify the session timeout in milliseconds. Defaults  to  20000
105              milliseconds (20 seconds) if not specified.
106
107       --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
113       -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
118       -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
129              0 - Authentication Algorithm = None; Integrity Algorithm = None;
130              Confidentiality Algorithm = None
131
132              1  - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
133              None; Confidentiality Algorithm = None
134
135              2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm  =
136              HMAC-SHA1-96; Confidentiality Algorithm = None
137
138              3  - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
139              HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
140
141              6 - Authentication Algorithm = HMAC-MD5; Integrity  Algorithm  =
142              None; Confidentiality Algorithm = None
143
144              7  -  Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
145              HMAC-MD5-128; Confidentiality Algorithm = None
146
147              8 - Authentication Algorithm = HMAC-MD5; Integrity  Algorithm  =
148              HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
149
150              11  - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
151              MD5-128; Confidentiality Algorithm = None
152
153              12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm  =
154              MD5-128; Confidentiality Algorithm = AES-CBC-128
155
156              15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
157              = None; Confidentiality Algorithm = None
158
159              16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
160              = HMAC_SHA256_128; Confidentiality Algorithm = None
161
162              17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
163              = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
164
165       -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
170       --config-file=FILE
171              Specify an alternate configuration file.
172
173       -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
180       --debug
181              Turn on debugging.
182
183       -?, --help
184              Output a help list and exit.
185
186       --usage
187              Output a usage message and exit.
188
189       -V, --version
190              Output the program version and exit.
191

IPMI-CONFIG OPTIONS

193       The following options are used to read, write, and find differences  in
194       configuration values.
195
196       -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 sytem, such as configuration for users, passwords,
202              authentication, networking, and serial-over-lan  (SOL).  chassis
203              includes  all  chassis  relevant  configuration  including  boot
204              options, front panel buttons, and power behavior. dcmi  includes
205              specialized  functions  provided  by  the Data Center Management
206              Interface (DCMI). Defaults to core if not specified.
207
208       -o, --checkout
209              Fetch configuration information.
210
211       -c, --commit
212              Update configuration information  from  a  config  file  or  key
213              pairs.
214
215       -d, --diff
216              Show differences between stored information and a config file or
217              key pairs.
218
219       -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
222              --always-prefix.
223
224       -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
230       -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
235       -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
241       -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
250       -vv    Output very  verbose  information.  Output  additional  detailed
251              information 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
255       --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
260       --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
265       --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

HOSTRANGED OPTIONS

271       The following options manipulate hostranged output. See HOSTRANGED SUP‐
272       PORT below for additional information on hostranges.
273
274       -B, --buffer-output
275              Buffer hostranged output. For each node, buffer standard  output
276              until the node has completed its IPMI operation. When specifying
277              this option, data may appear to output slower to the user  since
278              the  the entire IPMI operation must complete before any data can
279              be output.  See HOSTRANGED SUPPORT below for additional informa‐
280              tion.
281
282       -C, --consolidate-output
283              Consolidate hostranged output. The complete standard output from
284              every node specified will be consolidated  so  that  nodes  with
285              identical  output are not output twice. A header will list those
286              nodes with the consolidated output. When this option  is  speci‐
287              fied,  no  output  can  be seen until the IPMI operations to all
288              nodes has completed. If the  user  breaks  out  of  the  program
289              early,  all  currently  consolidated  output will be dumped. See
290              HOSTRANGED SUPPORT below for additional information.
291
292       -F NUM, --fanout=NUM
293              Specify multiple host fanout. A  "sliding  window"  (or  fanout)
294              algorithm is used for parallel IPMI communication so that slower
295              nodes or timed out nodes will not impede parallel communication.
296              The maximum number of threads available at the same time is lim‐
297              ited by the fanout. The default is 64.
298
299       -E, --eliminate
300              Eliminate hosts determined as undetected  by  ipmidetect.   This
301              attempts to remove the common issue of hostranged execution tim‐
302              ing out due to several nodes being removed  from  service  in  a
303              large  cluster.  The  ipmidetectd  daemon must be running on the
304              node executing the command.
305
306       --always-prefix
307              Always prefix output, even if only one host is specified or com‐
308              municating  in-band. This option is primarily useful for script‐
309              ing purposes. Option will be ignored if specified  with  the  -C
310              option.
311

GENERAL USE

313       Most users of will want to:
314
315       A)  Run  with --checkout to get a copy of the current configuration and
316       store it in a file. The standard output can be redirected to a file  or
317       a file can be specified with the --filename option.
318
319       B) Edit the configuration file with an editor.
320
321       C) Commit the configuration back using the --commit option and specify‐
322       ing the configuration file with the --filename option.  The  configura‐
323       tion  can  be committed to multiple hosts in parallel via the hostrange
324       support.
325
326       Although not typically necessarily, some motherboards do not store con‐
327       figuration  values  in  non-volatile  memory.  Therefore,  after system
328       reboots, some configuration values may have changed. The user may  wish
329       to  run configuration tools on each boot to ensure configuration values
330       remain.
331
332       Comments will be listed on occassion in checked out files with informa‐
333       tion  on how to configure fields.  The ipmi-config.conf(5) manpage also
334       provides additional information on the meaning of different fields.
335
336       For users with large clusters or sets of nodes, you may wish to use the
337       same  configuration  file  for  all nodes. The one problem with this is
338       that the IP address and MAC address will be different on each  node  in
339       your cluster and thus can't be configured through the same config file.
340       The IP address and MAC address in your config file may  be  overwritten
341       on  the  command  line  using  --key-pair option. The following example
342       could be used in a script to configure each node in a cluster with  the
343       same BMC config file. The script only needs to determine the correct IP
344       address and MAC address to use.
345
346       #    ipmi-config    --commit    -k    Lan_Conf:Ip_Address=$MY_IP     -k
347       Lan_Conf:Mac_Address=$MY_MAC --filename=my_bmc.conf
348

CORE SPECIAL CASE CONFIGURATION INFORMATION

350       The  UserN:Password  fields (where N is a number) cannot be checked out
351       on some systems, therefore the checked out value will always be blank.
352
353       The UserN:Enable_User field (where N is a number) cannot be checked out
354       on older IPMI systems, therefore the checked out value will sometime be
355       blank.
356
357       The  UserN:Lan_Session_Limit  and   UserN:Serial_Session_Limit   fields
358       (where  N is a number) cannot be checked out on some systems, therefore
359       the checked out value will always be blank. If not specified  in  later
360       commits  of  configurations,  the  field  may  be  reset  to 0 due to a
361       requirement that other fields (configured along with the session limit)
362       will  require  an input value for the session limit.  Under most condi‐
363       tions, it is not necessary to set this field and most users may  choose
364       to  ignore it. This field is considered optional by IPMI standards, and
365       may result in errors when attempting to  configure  it  to  a  non-zero
366       value.  If  errors to occur, setting the value back to 0 should resolve
367       problems.
368
369       The fields Lan_Conf:IP_Address and Lan_Conf:MAC_Address cannot be  com‐
370       mitted  in parallel via hostrange support. Each machine must be config‐
371       ured with a unique IP Address and MAC Address tuple, therefore we  dis‐
372       allow this configuration in ipmi-config.
373
374       On some motherboards, Lan_Conf:MAC_Address may be read only and the MAC
375       address is automatically configured.
376
377       On some motherboards, Lan_Conf:MAC_Address may be read only and the MAC
378       address is configured via an OEM command. See ipmi-oem(8) to see if OEM
379       configuration for your motherboard is supported.
380
381       On some motherboards, a number of user configuration fields  cannot  be
382       read or configured until after a non-null username or non-null password
383       is configured. In some of these cases, an  appropriate  output  in  the
384       config  file will indicate this situation. However, not all motherboard
385       corner cases may be detected. Users may wish to play  around  with  the
386       ordering of fields to work around these problems.
387
388       On  some  motherboards,  OEM  Authentication in Lan_Conf_Auth cannot be
389       enabled. However, the default motherboard settings  have  these  fields
390       enabled.  Users  are  advised to disable all OEM Authentication in this
391       section.
392
393       On some motherboards, multiple channels may exist  for  either  LAN  or
394       Serial IPMI communication. If multiple channels exist, configuration of
395       both channels can  be  viewed  and  ultimately  configured  by  running
396       --checkout  under  verbose  mode. Each section or key name will be suf‐
397       fixed appropriately with the word Channel and the channel  number.  For
398       example,  you  might  see  a Lan_Conf_Channel_1 and Lan_Conf_Channel_3,
399       where you can configure LAN configuration on Channels 1 and  3  respec‐
400       tively.
401
402       On  some  motherboards, configuration changes will not be "absorbed" by
403       the system until the motherboard is  hard-reset.  This  can  be  accom‐
404       plished  by  physically  powering  off  and  on the system (e.g. button
405       push), or it can be accomplished through a cold-reset. A cold-reset can
406       be executed via bmc-device.
407

CHASSIS SPECIAL CASE CONFIGURATION INFORMATION

409       The        Chassis_Front_Panel_Buttons:Enable_Standby_Button_For_Enter‐
410       ing_Standy,        Chassis_Front_Panel_Buttons:Enable_Diagnostic_Inter‐
411       rupt_Button  Chassis_Front_Panel_Buttons:Enable_Reset_Button, and Chas‐
412       sis_Front_Panel_Buttons:Enable_Power_Off_Button_For_Power_Off_Only
413       fields  may  not be able to be checked out on some IPMI systems, there‐
414       fore the checked out value may be blank. Some of these  fields  may  be
415       disableable,  while  some  are  not.  The Chassis_Power_Conf:Power_Con‐
416       trol_Interval field cannot be checked out. Therefore  the  checked  out
417       value will always be blank.
418

PEF SPECIAL CASE CONFIGURATION INFORMATION

420       On some motherboards, multiple channels may exist for LAN IPMI communi‐
421       cation. If multiple channels exist, configuration of both channels  can
422       be viewed and ultimately configured by running --checkout under verbose
423       mode. Each section name will be suffixed appropriately  with  the  word
424       Channel  and  the  channel  number. For example, you might see a Commu‐
425       nity_String_Channel_1 and  Community_String_Channel_3,  where  you  can
426       configure  the  Community String on Channels 1 and 3 respectively.  The
427       following are the options suitable for input  for  Sensor_Type  in  PEF
428       configuration.
429
430       Sensor_Type Options
431              Reserved, Temperature, Voltage, Current, Fan, Physical_Security,
432              Platform_Security_Violation_Attempt,  Processor,   Power_Supply,
433              Power_Unit,  Cooling_Device,  Other_Units_Based_Sensor,  Memory,
434              Drive_Slot,    Post_Memory_Resize,     System_Firmware_Progress,
435              Event_Logging_Disabled, Watchdog1, System_Event, Critical_Inter‐
436              rupt, Button_Switch, Module_Board,  Microcontroller_Coprocessor,
437              Add_In_Card,  Chassis,  Chip_Set, Other_FRU, Cable_Interconnect,
438              Terminator, System_Boot_Initiated, Boot_Error, OS_Boot, OS_Crit‐
439              ical_Stop,  Slot_Connector,  System_ACPI_Power_State, Watchdog2,
440              Platform_Alert, Entity_Presence, Monitor_Asic_IC,  Lan,  Manage‐
441              ment_Subsystem_Health,  Battery,  Session_Audit, Version_Change,
442              FRU_State, and Any
443

SENSORS SPECIAL CASE CONFIGURATION INFORMATION

445       Since  many  configurable  fields  involve  decimal   numbers,   preci‐
446       sion/floating point inaccuracies may occur when configuring new thresh‐
447       olds. The inaccuracies may not be apparent immediately. It is recommend
448       users verify their changes after configuring new thresholds.
449

HOSTRANGED SUPPORT

451       Multiple hosts can be input either as an explicit comma separated lists
452       of hosts or a range of hostnames in  the  general  form:  prefix[n-m,l-
453       k,...],  where  n < m and l < k, etc. The later form should not be con‐
454       fused with regular expression character classes (also denoted  by  []).
455       For example, foo[19] does not represent foo1 or foo9, but rather repre‐
456       sents a degenerate range: foo19.
457
458       This range syntax is meant only as a convenience  on  clusters  with  a
459       prefixNN  naming  convention  and specification of ranges should not be
460       considered necessary -- the list foo1,foo9 could be specified as  such,
461       or by the range foo[1,9].
462
463       Some examples of range usage follow:
464           foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
465           foo[7,9-10] instead of foo7,foo9,foo10
466           foo[0-3] instead of foo0,foo1,foo2,foo3
467
468       As a reminder to the reader, some shells will interpret brackets ([ and
469       ]) for pattern matching. Depending on your shell, it may  be  necessary
470       to enclose ranged lists within quotes.
471
472       When  multiple  hosts  are specified by the user, a thread will be exe‐
473       cuted for each host in parallel up to the configured fanout (which  can
474       be  adjusted via the -F option). This will allow communication to large
475       numbers of nodes far more quickly than if done in serial.
476
477       By default, standard output from each node  specified  will  be  output
478       with the hostname prepended to each line. Although this output is read‐
479       able in many situations, it may be difficult to read  in  other  situa‐
480       tions.  For  example, output from multiple nodes may be mixed together.
481       The -B and -C options can be used to change this default.
482
483       In-band IPMI Communication will be used when the  host  "localhost"  is
484       specified.  This  allows  the  user  to add the localhost into the hos‐
485       tranged output.
486

GENERAL TROUBLESHOOTING

488       Most often, IPMI problems are due to configuration problems.
489
490       IPMI over  LAN  problems  involve  a  misconfiguration  of  the  remote
491       machine's  BMC.  Double check to make sure the following are configured
492       properly in the remote machine's BMC: IP address, MAC  address,  subnet
493       mask,  username,  user enablement, user privilege, password, LAN privi‐
494       lege, LAN enablement, and allowed authentication type(s). For IPMI  2.0
495       connections,  double  check  to make sure the cipher suite privilege(s)
496       and K_g key are configured properly. The  ipmi-config(8)  tool  can  be
497       used to check and/or change these configuration settings.
498
499       Inband  IPMI  problems  are  typically  caused by improperly configured
500       drivers or non-standard BMCs.
501
502       In addition to the troubleshooting tips below, please  see  WORKAROUNDS
503       below to also if there are any vendor specific bugs that have been dis‐
504       covered and worked around.
505
506       Listed below are many of the common issues  for  error  messages.   For
507       additional  support, please e-mail the <freeipmi-users@gnu.org> mailing
508       list.
509
510       "username invalid" - The username entered (or a NULL username  if  none
511       was  entered)  is  not  available on the remote machine. It may also be
512       possible the remote BMC's username configuration is incorrect.
513
514       "password invalid" - The password entered (or a NULL password  if  none
515       was  entered)  is not correct. It may also be possible the password for
516       the user is not correctly configured on the remote BMC.
517
518       "password verification timeout" - Password verification has timed  out.
519       A  "password  invalid"  error  (described  above) or a generic "session
520       timeout" (described below) occurred.  During this point in the protocol
521       it cannot be differentiated which occurred.
522
523       "k_g  invalid"  -  The  K_g  key entered (or a NULL K_g key if none was
524       entered) is not correct. It may also be possible the  K_g  key  is  not
525       correctly configured on the remote BMC.
526
527       "privilege level insufficient" - An IPMI command requires a higher user
528       privilege than the one authenticated with. Please try  to  authenticate
529       with a higher privilege. This may require authenticating to a different
530       user which has a higher maximum privilege.
531
532       "privilege level cannot be obtained for  this  user"  -  The  privilege
533       level  you are attempting to authenticate with is higher than the maxi‐
534       mum allowed for this user. Please try again with a lower privilege.  It
535       may  also be possible the maximum privilege level allowed for a user is
536       not configured properly on the remote BMC.
537
538       "authentication type unavailable for attempted privilege level"  -  The
539       authentication  type you wish to authenticate with is not available for
540       this privilege level. Please try again with an alternate authentication
541       type  or  alternate privilege level. It may also be possible the avail‐
542       able authentication types you can authenticate with are  not  correctly
543       configured on the remote BMC.
544
545       "cipher suite id unavailable" - The cipher suite id you wish to authen‐
546       ticate with is not available on the remote BMC. Please try  again  with
547       an  alternate  cipher  suite  id. It may also be possible the available
548       cipher suite ids are not correctly configured on the remote BMC.
549
550       "ipmi 2.0 unavailable" - IPMI 2.0 was  not  discovered  on  the  remote
551       machine. Please try to use IPMI 1.5 instead.
552
553       "connection  timeout"  - Initial IPMI communication failed. A number of
554       potential errors are possible, including an invalid hostname specified,
555       an  IPMI  IP  address  cannot  be  resolved, IPMI is not enabled on the
556       remote server, the network connection is bad, etc. Please  verify  con‐
557       figuration and connectivity.
558
559       "session  timeout"  - The IPMI session has timed out. Please reconnect.
560       If this error occurs often, you may wish to increase the retransmission
561       timeout. Some remote BMCs are considerably slower than others.
562
563       "device  not  found"  - The specified device could not be found. Please
564       check configuration or inputs and try again.
565
566       "driver timeout" - Communication with the driver or  device  has  timed
567       out. Please try again.
568
569       "message  timeout"  - Communication with the driver or device has timed
570       out. Please try again.
571
572       "BMC busy" - The BMC is currently busy. It may be  processing  informa‐
573       tion  or have too many simultaneous sessions to manage. Please wait and
574       try again.
575
576       "could not find inband device" - An inband device could not  be  found.
577       Please  check configuration or specify specific device or driver on the
578       command line.
579
580       "driver timeout" - The inband driver has timed out communicating to the
581       local  BMC  or  service  processor. The BMC or service processor may be
582       busy or (worst case) possibly non-functioning.
583

WORKAROUNDS

585       With so many different vendors implementing their own  IPMI  solutions,
586       different  vendors  may implement their IPMI protocols incorrectly. The
587       following describes a number of workarounds currently available to han‐
588       dle  discovered compliance issues. When possible, workarounds have been
589       implemented so they will be transparent to the user. However, some will
590       require the user to specify a workaround be used via the -W option.
591
592       The hardware listed below may only indicate the hardware that a problem
593       was discovered on. Newer versions of  hardware  may  fix  the  problems
594       indicated  below.  Similar machines from vendors may or may not exhibit
595       the same problems. Different vendors may license  their  firmware  from
596       the  same IPMI firmware developer, so it may be worthwhile to try work‐
597       arounds listed below even if your motherboard is not listed.
598
599       If you believe your hardware has an additional  compliance  issue  that
600       needs a workaround to be implemented, please contact the FreeIPMI main‐
601       tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
602
603       assumeio - This workaround flag will assume inband interfaces  communi‐
604       cate  with  system  I/O rather than being memory-mapped. This will work
605       around systems that report invalid base addresses. Those  hitting  this
606       issue  may see "device not supported" or "could not find inband device"
607       errors.  Issue observed on HP ProLiant DL145 G1.
608
609       spinpoll - This workaround flag will inform some inband  drivers  (most
610       notably  the  KCS driver) to spin while polling rather than putting the
611       process to sleep. This may significantly improve the wall clock running
612       time  of  tools because an operating system scheduler's granularity may
613       be much larger than the time it takes to perform a single IPMI  message
614       transaction.  However,  by spinning, your system may be performing less
615       useful work by not contexting out the tool for a more useful task.
616
617       authcap - This workaround flag will  skip  early  checks  for  username
618       capabilities,  authentication  capabilities,  and K_g support and allow
619       IPMI authentication to succeed. It  works  around  multiple  issues  in
620       which the remote system does not properly report username capabilities,
621       authentication capabilities, or K_g status. Those  hitting  this  issue
622       may  see  "username  invalid",  "authentication  type  unavailable  for
623       attempted privilege level", or "k_g invalid" errors.  Issue observed on
624       Asus  P5M2/P5MT-R/RS162-E4/RX4,  Intel  SR1520ML/X38ML,  and  Sun  Fire
625       2200/4150/4450 with ELOM.
626
627       nochecksumcheck - This workaround flag will tell FreeIPMI to not  check
628       the  checksums  returned  from  IPMI command responses. It works around
629       systems that return invalid checksums due to implementation errors, but
630       the  packet  is otherwise valid. Users are cautioned on the use of this
631       option, as it removes validation of packet integrity  in  a  number  of
632       circumstances.  However,  it  is unlikely to be an issue in most situa‐
633       tions. Those hitting this issue may see "connection timeout",  "session
634       timeout",  or  "password verification timeout" errors. On IPMI 1.5 con‐
635       nections, the "noauthcodecheck" workaround may also needed  too.  Issue
636       observed  on  Supermicro  X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
637       X9DRFR.
638
639       idzero - This workaround flag  will  allow  empty  session  IDs  to  be
640       accepted by the client. It works around IPMI sessions that report empty
641       session IDs to the client. Those hitting this issue  may  see  "session
642       timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
643
644       unexpectedauth  -  This  workaround flag will allow unexpected non-null
645       authcodes to be checked as though they were expected. It  works  around
646       an  issue  when  packets contain non-null authentication data when they
647       should be null due to disabled per-message authentication.  Those  hit‐
648       ting  this  issue  may  see "session timeout" errors. Issue observed on
649       Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
650
651       forcepermsg - This workaround flag will force  per-message  authentica‐
652       tion  to  be used no matter what is advertised by the remote system. It
653       works around an issue when per-message authentication is advertised  as
654       disabled on the remote system, but it is actually required for the pro‐
655       tocol. Those hitting this  issue  may  see  "session  timeout"  errors.
656       Issue observed on IBM eServer 325.
657
658       endianseq  -  This  workaround flag will flip the endian of the session
659       sequence numbers to allow the session to continue  properly.  It  works
660       around  IPMI  1.5  session  sequence numbers that are the wrong endian.
661       Those hitting this  issue  may  see  "session  timeout"  errors.  Issue
662       observed  on  some  Sun  ILOM  1.0/2.0  (depends  on  service processor
663       endian).
664
665       noauthcodecheck - This workaround flag will tell FreeIPMI to not  check
666       the  authentication  codes returned from IPMI 1.5 command responses. It
667       works around systems that return invalid authentication  codes  due  to
668       hashing  or  implementation  errors.  Users are cautioned on the use of
669       this option, as it removes an authentication check verifying the valid‐
670       ity of a packet. However, in most organizations, this is unlikely to be
671       a security issue. Those hitting this issue may  see  "connection  time‐
672       out",  "session  timeout",  or  "password verification timeout" errors.
673       Issue observed on Xyratex FB-H8-SRAY, Intel  Windmill,  Quanta  Winter‐
674       fell, and Wiwynn Windmill.
675
676       intel20  - This workaround flag will work around several Intel IPMI 2.0
677       authentication issues. The issues covered include padding of usernames,
678       and  password  truncation  if  the  authentication  algorithm  is HMAC-
679       MD5-128. Those hitting this issue may see "username invalid", "password
680       invalid",  or  "k_g  invalid" errors. Issue observed on Intel SE7520AF2
681       with Intel Server Management Module (Professional Edition).
682
683       supermicro20 - This workaround flag will work around several Supermicro
684       IPMI  2.0  authentication  issues  on  motherboards  w/  Peppercon IPMI
685       firmware. The issues covered include handling invalid length  authenti‐
686       cation  codes.  Those  hitting  this  issue  may see "password invalid"
687       errors.  Issue observed on Supermicro H8QME with SIMSO  daughter  card.
688       Confirmed fixed on newerver firmware.
689
690       sun20 - This workaround flag will work work around several Sun IPMI 2.0
691       authentication issues. The issues covered include invalid lengthed hash
692       keys,  improperly  hashed keys, and invalid cipher suite records. Those
693       hitting this issue may see "password invalid" or  "bmc  error"  errors.
694       Issue  observed  on Sun Fire 4100/4200/4500 with ILOM.  This workaround
695       automatically includes the "opensesspriv" workaround.
696
697       opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
698       2.0 connection protocol to workaround an invalid hashing algorithm used
699       by the remote system. The privilege level sent during the Open  Session
700       stage of an IPMI 2.0 connection is used for hashing keys instead of the
701       privilege level sent during the RAKP1 connection stage.  Those  hitting
702       this  issue may see "password invalid", "k_g invalid", or "bad rmcpplus
703       status code" errors.  Issue observed on Sun  Fire  4100/4200/4500  with
704       ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
705       Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
706       QSSC-S4R/Appro  GB812X-CN.  This  workaround is automatically triggered
707       with the "sun20" workaround.
708
709       integritycheckvalue - This workaround flag will work around an  invalid
710       integrity  check  value  during  an IPMI 2.0 session establishment when
711       using Cipher Suite ID 0. The integrity check value should be 0  length,
712       however  the  remote motherboard responds with a non-empty field. Those
713       hitting this issue may see "k_g  invalid"  errors.  Issue  observed  on
714       Supermicro  X8DTG,  Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
715       700, and Intel S2600JF/Appro 512X.
716
717       No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
718       found  to  not support IPMI 1.5. Those hitting this issue may see "ipmi
719       2.0 unavailable" or "connection timeout"  errors.  This  issue  can  be
720       worked  around  by  using  IPMI  2.0  instead of IPMI 1.5 by specifying
721       --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
722
723       slowcommit - This workaround will slow  down  commits  to  the  BMC  by
724       sleeping  one  second  between  the commit of sections. It works around
725       motherboards that have BMCs that can be overwhelmed by commits.   Those
726       hitting  this  issue may see commit errors or commits not being written
727       to the BMC. Issue observed on Supermicro H8QME.
728
729       veryslowcommit - This workaround will slow down commits to the  BMC  by
730       sleeping  one  second  between the commit of every key. It works around
731       motherboards that have BMCs that can be overwhelmed by commits.   Those
732       hitting  this  issue may see commit errors or commits not being written
733       to the BMC. Issue observed on Quanta S99Q/Dell FS12-TY.
734
735       solchannelassumelanchannel - This workaround will force ipmi-config  to
736       assume  that  the channel used SOL is identical to the channel used for
737       LAN. On some motherboards, the SOL  channel  is  reported  incorrectly,
738       leading to incorrect configuration. Most notably, this problem has come
739       up when attempting to configure multiple channels.  Issue  observed  on
740       Intel S5500WBV/Penguin Relion 700.
741

EXAMPLES

743       # ipmi-config --checkout
744
745       Output  all core configuration information to the console.  # ipmi-con‐
746       fig --checkout --category=pef
747
748       Output all pef configuration information to the console.  # ipmi-config
749       --checkout --category=pef,chassis
750
751       Output all pef and chassis configuration information to the console.
752
753       # ipmi-config --checkout --filename=bmc-data1.conf
754
755       Store all core configuration information in bmc-data1.conf.
756
757       # ipmi-config --diff --filename=bmc-data2.conf
758
759       Show  all  difference  between  the  current configuration and the bmc-
760       data2.conf file.
761
762       #  ipmi-config  --diff  --key-pair="lan_conf_misc:gratuitous_arp_inter‐
763       val=8"
764
765       Show    difference    with    the   current   configuration   and   the
766       'lan_conf_misc:gratuitous_arp_interval' of value '8'.
767
768       # ipmi-config --commit --filename=bmc-data1.conf
769
770       Commit all configuration values from the bmc-data1.conf file.
771
772       # ipmi-config --commit  --key-pair="lan_conf_misc:gratuitous_arp_inter‐
773       val=4"
774
775       Commit key 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
776
777       #    ipmi-config    --commit    --filename=bmc-data-updt.conf    --key-
778       pair="lan_conf_misc:gratuitous_arp_interval=4"
779
780       Commit  all  configuration  values  from  bmc-data-updt.conf  and   key
781       'lan_conf_misc:gratuitous_arp_interval' of value '4'.
782

DIAGNOSTICS

784       Upon  successful  execution, exit status is 0. On non-fatal error, exit
785       status is 1. On fatal error, exit status is 2.
786
787       If multiple hosts are specified for communication, the exit status is 0
788       if and only if all targets successfully execute. If any non-fatal error
789       occurs, exit status is 1. If any fatal error occurs, exit status is 2.
790

KNOWN ISSUES

792       On older operating systems, if you input your username,  password,  and
793       other  potentially  security  relevant information on the command line,
794       this information may be discovered by other users when using tools like
795       the  ps(1) command or looking in the /proc file system. It is generally
796       more secure to input password information with options like the  -P  or
797       -K  options.  Configuring security relevant information in the FreeIPMI
798       configuration file would also be an appropriate way to hide this infor‐
799       mation.
800
801       In  order  to  prevent  brute force attacks, some BMCs will temporarily
802       "lock up" after a number of remote authentication errors. You may  need
803       to  wait awhile in order to this temporary "lock up" to pass before you
804       may authenticate again.
805

REPORTING BUGS

807       Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
808
810       Copyright © 2003-2015 FreeIPMI Core Team.
811
812       This program is free software; you can redistribute it and/or modify it
813       under  the  terms of the GNU General Public License as published by the
814       Free Software Foundation; either version 3 of the License, or (at  your
815       option) any later version.
816

SEE ALSO

818       ipmi-config.conf(5), freeipmi(7), bmc-device(8)
819
820       http://www.gnu.org/software/freeipmi/
821
822
823
824ipmi-config 1.5.7                 2018-04-11                    IPMI-CONFIG(8)
Impressum