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

NAME

6       ipmi-pef-config - configure PEF values
7

SYNOPSIS

9       ipmi-pef-config [OPTION...]
10

DESCRIPTION

12       Ipmi-pef-config is a Platform Event Filtering (PEF) configuration util‐
13       ity.  This configuration tool is for advanced IPMI users and  generally
14       not-required for IPMI to function. Most IPMI users will not need to use
15       this tool.
16
17       For configuration of  general  BMC  parameters,  sensors,  or  chassis,
18       please see the bmc-config(8), ipmi-sensors-config(8), and ipmi-chassis-
19       config(8) tools respectively. For  some  OEM  specific  configurations,
20       please see ipmi-oem(8).
21
22       Listed  below  are general IPMI options, tool specific options, trouble
23       shooting  information,  workaround  information,  examples,  and  known
24       issues.  For a general introduction to FreeIPMI please see freeipmi(7).
25       See GENERAL USE below for a description on how most will  want  to  use
26       Ipmi-pef-config.
27

GENERAL OPTIONS

29       The following options are general options for configuring IPMI communi‐
30       cation and executing general tool commands.
31
32       -D IPMIDRIVER, --driver-type=IPMIDRIVER
33              Specify the driver type to use instead of doing an  auto  selec‐
34              tion.   The  currently  available  outofband drivers are LAN and
35              LAN_2_0, which perform IPMI 1.5 and IPMI 2.0  respectively.  The
36              currently  available inband drivers are KCS, SSIF, OPENIPMI, and
37              SUNBMC.
38
39       --disable-auto-probe
40              Do not probe in-band IPMI devices for default settings.
41
42       --driver-address=DRIVER-ADDRESS
43              Specify the in-band driver address to be  used  instead  of  the
44              probed  value. DRIVER-ADDRESS should be prefixed with "0x" for a
45              hex value and '0' for an octal value.
46
47       --driver-device=DEVICE
48              Specify the in-band driver device path to be used instead of the
49              probed path.
50
51       --register-spacing=REGISTER-SPACING
52              Specify  the  in-band  driver  register  spacing  instead of the
53              probed value. Argument is in bytes (i.e. 32bit register  spacing
54              = 4)
55
56       --target-channel-number=CHANNEL-NUMBER
57              Specify  the  in-band  driver target channel number to send IPMI
58              requests to.
59
60       --target-slave-address=SLAVE-ADDRESS
61              Specify the in-band driver target  slave  number  to  send  IPMI
62              requests to.
63
64       -h      IPMIHOST1,IPMIHOST2,...,      --hostname=IPMIHOST1[:PORT],IPMI‐
65       HOST2[:PORT],...
66              Specify the remote host(s) to communicate with.  Multiple  host‐
67              names  may  be separated by comma or may be specified in a range
68              format; see HOSTRANGED SUPPORT below. An optional  port  can  be
69              specified with each host, which may be useful in port forwarding
70              or similar situations.
71
72       -u USERNAME, --username=USERNAME
73              Specify the username to use when authenticating with the  remote
74              host.   If  not  specified,  a null (i.e. anonymous) username is
75              assumed. The user must have atleast ADMIN  privileges  in  order
76              for this tool to operate fully.
77
78       -p PASSWORD, --password=PASSWORD
79              Specify the password to use when authenticationg with the remote
80              host.  If not specified, a null  password  is  assumed.  Maximum
81              password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
82
83       -P, --password-prompt
84              Prompt  for  password  to  avoid  possibility  of  listing it in
85              process lists.
86
87       -k K_G, --k-g=K_G
88              Specify the K_g BMC key to  use  when  authenticating  with  the
89              remote  host  for  IPMI  2.0.  If  not  specified, a null key is
90              assumed. To input the key in hexadecimal form, prefix the string
91              with  '0x'.  E.g.,  the key 'abc' can be entered with the either
92              the string 'abc' or the string '0x616263'
93
94       -K, --k-g-prompt
95              Prompt for k-g to avoid possibility of  listing  it  in  process
96              lists.
97
98       --session-timeout=MILLISECONDS
99              Specify  the  session timeout in milliseconds. Defaults to 20000
100              milliseconds (20 seconds) if not specified.
101
102       --retransmission-timeout=MILLISECONDS
103              Specify  the  packet  retransmission  timeout  in  milliseconds.
104              Defaults  to  1000 milliseconds (1 second) if not specified. The
105              retransmission timeout cannot be larger than the  session  time‐
106              out.
107
108       -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
109              Specify  the  IPMI 1.5 authentication type to use. The currently
110              available authentication types are NONE,  STRAIGHT_PASSWORD_KEY,
111              MD2, and MD5. Defaults to MD5 if not specified.
112
113       -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
114              Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
115              identifies a set of authentication, integrity, and confidential‐
116              ity  algorithms to use for IPMI 2.0 communication. The authenti‐
117              cation algorithm identifies the algorithm  to  use  for  session
118              setup,  the  integrity algorithm identifies the algorithm to use
119              for session packet signatures, and the confidentiality algorithm
120              identifies the algorithm to use for payload encryption. Defaults
121              to cipher suite ID 3 if  not  specified.  The  following  cipher
122              suite ids are currently supported:
123
124              0 - Authentication Algorithm = None; Integrity Algorithm = None;
125              Confidentiality Algorithm = None
126
127              1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm  =
128              None; Confidentiality Algorithm = None
129
130              2  - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
131              HMAC-SHA1-96; Confidentiality Algorithm = None
132
133              3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm  =
134              HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
135
136              6  -  Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
137              None; Confidentiality Algorithm = None
138
139              7 - Authentication Algorithm = HMAC-MD5; Integrity  Algorithm  =
140              HMAC-MD5-128; Confidentiality Algorithm = None
141
142              8  -  Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
143              HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
144
145              11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm  =
146              MD5-128; Confidentiality Algorithm = None
147
148              12  - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
149              MD5-128; Confidentiality Algorithm = AES-CBC-128
150
151              15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
152              = None; Confidentiality Algorithm = None
153
154              16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
155              = HMAC_SHA256_128; Confidentiality Algorithm = None
156
157              17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
158              = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
159
160       -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
161              Specify  the privilege level to be used. The currently available
162              privilege levels are USER,  OPERATOR,  and  ADMIN.  Defaults  to
163              ADMIN if not specified.
164
165       --config-file=FILE
166              Specify an alternate configuration file.
167
168       -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
169              Specify  workarounds to vendor compliance issues. Multiple work‐
170              arounds can be specified separated by commas. A special  command
171              line flag of "none", will indicate no workarounds (may be useful
172              for overriding configured defaults). See WORKAROUNDS below for a
173              list of available workarounds.
174
175       --debug
176              Turn on debugging.
177
178       -?, --help
179              Output a help list and exit.
180
181       --usage
182              Output a usage message and exit.
183
184       -V, --version
185              Output the program version and exit.
186

IPMI-PEF-CONFIG OPTIONS

188       The following options are specific to Ipmi-pef-config.
189
190       -i, --info
191              Show general information about PEF configuration.
192

CONFIG OPTIONS

194       The  following options are used to read, write, and find differences in
195       configuration values.
196
197       -o, --checkout
198              Fetch configuration information.
199
200       -c, --commit
201              Update configuration information  from  a  config  file  or  key
202              pairs.
203
204       -d, --diff
205              Show differences between stored information and a config file or
206              key pairs.
207
208       -n FILENAME, --filename=FILENAME
209              Specify a config file for checkout/commit/diff.
210
211       -e "KEY=VALUE", --key-pair="KEY=VALUE"
212              Specify KEY=VALUE pairs for checkout/commit/diff. Specify KEY by
213              SectionName:FieldName.  This  option can be used multiple times.
214              On commit, any KEY=VALUE pairs will overwrite any  pairs  speci‐
215              fied in a file with --filename.
216
217       -S SECTION, --section=SECTION
218              Specify a SECTION for checkout. This option can be used multiple
219              times.
220
221       -L, --listsections
222              List available sections for checkout. Some sections in the  list
223              may  not  be checked out by default and may require verbosity to
224              be increased.
225
226       -v, --verbose
227              Output verbose information. When  used  with  --checkout,  addi‐
228              tional  uncommon  sections and/or fields will be shown. In ipmi-
229              pef-config, this includes checking out sections for each channel
230              on a system, if multiple channels exist.
231
232       -vv    Output  very  verbose  information.  Output  additional detailed
233              information about what fields can and cannot be checked out, and
234              sometimes the reason why. Sometimes output fields that are iden‐
235              tified as unsupported on the motherboard.
236
237       --lan-channel-number=NUMBER
238              Use an specific channel number for LAN  configuration.  Particu‐
239              larly useful if motherboard contains multiple LAN channels and a
240              user wishes to use a specific one.
241

HOSTRANGED OPTIONS

243       The following options manipulate hostranged output. See HOSTRANGED SUP‐
244       PORT below for additional information on hostranges.
245
246       -B, --buffer-output
247              Buffer  hostranged output. For each node, buffer standard output
248              until the node has completed its IPMI operation. When specifying
249              this  option, data may appear to output slower to the user since
250              the the entire IPMI operation must complete before any data  can
251              be output.  See HOSTRANGED SUPPORT below for additional informa‐
252              tion.
253
254       -C, --consolidate-output
255              Consolidate hostranged output. The complete standard output from
256              every  node  specified  will  be consolidated so that nodes with
257              identical output are not output twice. A header will list  those
258              nodes  with  the consolidated output. When this option is speci‐
259              fied, no output can be seen until the  IPMI  operations  to  all
260              nodes  has  completed.  If  the  user  breaks out of the program
261              early, all currently consolidated output  will  be  dumped.  See
262              HOSTRANGED SUPPORT below for additional information.
263
264       -F NUM, --fanout=NUM
265              Specify  multiple  host  fanout.  A "sliding window" (or fanout)
266              algorithm is used for parallel IPMI communication so that slower
267              nodes or timed out nodes will not impede parallel communication.
268              The maximum number of threads available at the same time is lim‐
269              ited by the fanout. The default is 64.
270
271       -E, --eliminate
272              Eliminate  hosts  determined  as undetected by ipmidetect.  This
273              attempts to remove the common issue of hostranged execution tim‐
274              ing  out  due  to  several nodes being removed from service in a
275              large cluster. The ipmidetectd daemon must  be  running  on  the
276              node executing the command.
277
278       --always-prefix
279              Always prefix output, even if only one host is specified or com‐
280              municating in-band. This option is primarily useful for  script‐
281              ing  purposes.  Option  will be ignored if specified with the -C
282              option.
283

GENERAL USE

285       Most users of will want to:
286
287       A) Run with --checkout to get a copy of the current  configuration  and
288       store  it in a file. The standard output can be redirected to a file or
289       a file can be specified with the --filename option.
290
291       B) Edit the configuration file with an editor.
292
293       C) Commit the configuration back using the --commit option and specify‐
294       ing  the  configuration file with the --filename option. The configura‐
295       tion can be committed to multiple hosts in parallel via  the  hostrange
296       support.
297
298       Although not typically necessarily, some motherboards do not store con‐
299       figuration values  in  non-volatile  memory.  Therefore,  after  system
300       reboots,  some configuration values may have changed. The user may wish
301       to run configuration tools on each boot to ensure configuration  values
302       remain.
303

EDITING THE CHECKOUT FILE

305       Options for editing fields in the checkout file are usually listed in a
306       comment above the field. When there are to  many  options  to  make  it
307       practical, they are listed here in the MAN page.
308
309       Sensor_Type Options
310              Reserved, Temperature, Voltage, Current, Fan, Physical_Security,
311              Platform_Security_Violation_Attempt,  Processor,   Power_Supply,
312              Power_Unit,  Cooling_Device,  Other_Units_Based_Sensor,  Memory,
313              Drive_Slot,    Post_Memory_Resize,     System_Firmware_Progress,
314              Event_Logging_Disabled, Watchdog1, System_Event, Critical_Inter‐
315              rupt, Button_Switch, Module_Board,  Microcontroller_Coprocessor,
316              Add_In_Card,  Chassis,  Chip_Set, Other_FRU, Cable_Interconnect,
317              Terminator, System_Boot_Initiated, Boot_Error, OS_Boot, OS_Crit‐
318              ical_Stop,  Slot_Connector,  System_ACPI_Power_State, Watchdog2,
319              Platform_Alert, Entity_Presence, Monitor_Asic_IC,  Lan,  Manage‐
320              ment_Subsystem_Health,  Battery,  Session_Audit, Version_Change,
321              FRU_State, and Any
322

IPMI-PEF-CONFIG SPECIAL CASE CONFIGURATION INFORMATION

324       On some motherboards, multiple channels may exist for LAN IPMI communi‐
325       cation.  If multiple channels exist, configuration of both channels can
326       be viewed and ultimately configured by running --checkout under verbose
327       mode.  Each  section  name will be suffixed appropriately with the word
328       Channel and the channel number. For example, you  might  see  a  Commu‐
329       nity_String_Channel_1  and  Community_String_Channel_3,  where  you can
330       configure the Community String on Channels 1 and 3 respectively.
331

HOSTRANGED SUPPORT

333       Multiple hosts can be input either as an explicit comma separated lists
334       of  hosts  or  a  range of hostnames in the general form: prefix[n-m,l-
335       k,...], where n < m and l < k, etc. The later form should not  be  con‐
336       fused  with  regular expression character classes (also denoted by []).
337       For example, foo[19] does not represent foo1 or foo9, but rather repre‐
338       sents a degenerate range: foo19.
339
340       This  range  syntax  is  meant only as a convenience on clusters with a
341       prefixNN naming convention and specification of ranges  should  not  be
342       considered  necessary -- the list foo1,foo9 could be specified as such,
343       or by the range foo[1,9].
344
345       Some examples of range usage follow:
346           foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
347           foo[7,9-10] instead of foo7,foo9,foo10
348           foo[0-3] instead of foo0,foo1,foo2,foo3
349
350       As a reminder to the reader, some shells will interpret brackets ([ and
351       ])  for  pattern matching. Depending on your shell, it may be necessary
352       to enclose ranged lists within quotes.
353
354       When multiple hosts are specified by the user, a thread  will  be  exe‐
355       cuted  for each host in parallel up to the configured fanout (which can
356       be adjusted via the -F option). This will allow communication to  large
357       numbers of nodes far more quickly than if done in serial.
358
359       By  default,  standard  output  from each node specified will be output
360       with the hostname prepended to each line. Although this output is read‐
361       able  in  many  situations, it may be difficult to read in other situa‐
362       tions. For example, output from multiple nodes may be  mixed  together.
363       The -B and -C options can be used to change this default.
364
365       In-band  IPMI  Communication  will be used when the host "localhost" is
366       specified. This allows the user to add  the  localhost  into  the  hos‐
367       tranged output.
368

GENERAL TROUBLESHOOTING

370       Most often, IPMI problems are due to configuration problems.
371
372       IPMI  over  LAN  problems  involve  a  misconfiguration  of  the remote
373       machine's BMC.  Double check to make sure the following are  configured
374       properly  in  the remote machine's BMC: IP address, MAC address, subnet
375       mask, username, user enablement, user privilege, password,  LAN  privi‐
376       lege,  LAN enablement, and allowed authentication type(s). For IPMI 2.0
377       connections, double check to make sure the  cipher  suite  privilege(s)
378       and K_g key are configured properly. The bmc-config(8) tool can be used
379       to check and/or change these configuration settings.
380
381       Inband IPMI problems are  typically  caused  by  improperly  configured
382       drivers or non-standard BMCs.
383
384       In  addition  to the troubleshooting tips below, please see WORKAROUNDS
385       below to also if there are any vendor specific bugs that have been dis‐
386       covered and worked around.
387
388       Listed  below  are  many  of the common issues for error messages.  For
389       additional support, please e-mail the <freeipmi-users@gnu.org>  mailing
390       list.
391
392       "username  invalid"  - The username entered (or a NULL username if none
393       was entered) is not available on the remote machine.  It  may  also  be
394       possible the remote BMC's username configuration is incorrect.
395
396       "password  invalid"  - The password entered (or a NULL password if none
397       was entered) is not correct. It may also be possible the  password  for
398       the user is not correctly configured on the remote BMC.
399
400       "password  verification timeout" - Password verification has timed out.
401       A "password invalid" error (described  above)  or  a  generic  "session
402       timeout" (described below) occurred.  During this point in the protocol
403       it cannot be differentiated which occurred.
404
405       "k_g invalid" - The K_g key entered (or a NULL  K_g  key  if  none  was
406       entered)  is  not  correct.  It may also be possible the K_g key is not
407       correctly configured on the remote BMC.
408
409       "privilege level insufficient" - An IPMI command requires a higher user
410       privilege  than  the one authenticated with. Please try to authenticate
411       with a higher privilege. This may require authenticating to a different
412       user which has a higher maximum privilege.
413
414       "privilege  level  cannot  be  obtained  for this user" - The privilege
415       level you are attempting to authenticate with is higher than the  maxi‐
416       mum  allowed for this user. Please try again with a lower privilege. It
417       may also be possible the maximum privilege level allowed for a user  is
418       not configured properly on the remote BMC.
419
420       "authentication  type  unavailable for attempted privilege level" - The
421       authentication type you wish to authenticate with is not available  for
422       this privilege level. Please try again with an alternate authentication
423       type or alternate privilege level. It may also be possible  the  avail‐
424       able  authentication  types you can authenticate with are not correctly
425       configured on the remote BMC.
426
427       "cipher suite id unavailable" - The cipher suite id you wish to authen‐
428       ticate  with  is not available on the remote BMC. Please try again with
429       an alternate cipher suite id. It may also  be  possible  the  available
430       cipher suite ids are not correctly configured on the remote BMC.
431
432       "ipmi  2.0  unavailable"  -  IPMI  2.0 was not discovered on the remote
433       machine. Please try to use IPMI 1.5 instead.
434
435       "connection timeout" - Initial IPMI communication failed. A  number  of
436       potential errors are possible, including an invalid hostname specified,
437       an IPMI IP address cannot be resolved,  IPMI  is  not  enabled  on  the
438       remote  server,  the network connection is bad, etc. Please verify con‐
439       figuration and connectivity.
440
441       "session timeout" - The IPMI session has timed out.  Please  reconnect.
442       If this error occurs often, you may wish to increase the retransmission
443       timeout. Some remote BMCs are considerably slower than others.
444
445       "device not found" - The specified device could not  be  found.  Please
446       check configuration or inputs and try again.
447
448       "driver  timeout"  -  Communication with the driver or device has timed
449       out. Please try again.
450
451       "message timeout" - Communication with the driver or device  has  timed
452       out. Please try again.
453
454       "BMC  busy"  - The BMC is currently busy. It may be processing informa‐
455       tion or have too many simultaneous sessions to manage. Please wait  and
456       try again.
457
458       "could  not  find inband device" - An inband device could not be found.
459       Please check configuration or specify specific device or driver on  the
460       command line.
461
462       "driver timeout" - The inband driver has timed out communicating to the
463       local BMC or service processor. The BMC or  service  processor  may  be
464       busy or (worst case) possibly non-functioning.
465

WORKAROUNDS

467       With  so  many different vendors implementing their own IPMI solutions,
468       different vendors may implement their IPMI protocols  incorrectly.  The
469       following describes a number of workarounds currently available to han‐
470       dle discovered compliance issues. When possible, workarounds have  been
471       implemented so they will be transparent to the user. However, some will
472       require the user to specify a workaround be used via the -W option.
473
474       The hardware listed below may only indicate the hardware that a problem
475       was  discovered  on.  Newer  versions  of hardware may fix the problems
476       indicated below. Similar machines from vendors may or may  not  exhibit
477       the  same  problems.  Different vendors may license their firmware from
478       the same IPMI firmware developer, so it may be worthwhile to try  work‐
479       arounds listed below even if your motherboard is not listed.
480
481       If  you  believe  your hardware has an additional compliance issue that
482       needs a workaround to be implemented, please contact the FreeIPMI main‐
483       tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
484
485       assumeio  - This workaround flag will assume inband interfaces communi‐
486       cate with system I/O rather than being memory-mapped.  This  will  work
487       around  systems  that report invalid base addresses. Those hitting this
488       issue may see "device not supported" or "could not find inband  device"
489       errors.  Issue observed on HP ProLiant DL145 G1.
490
491       spinpoll  -  This workaround flag will inform some inband drivers (most
492       notably the KCS driver) to spin while polling rather than  putting  the
493       process to sleep. This may significantly improve the wall clock running
494       time of tools because an operating system scheduler's  granularity  may
495       be  much larger than the time it takes to perform a single IPMI message
496       transaction. However, by spinning, your system may be  performing  less
497       useful work by not contexting out the tool for a more useful task.
498
499       authcap  -  This  workaround  flag  will skip early checks for username
500       capabilities, authentication capabilities, and K_g  support  and  allow
501       IPMI  authentication  to  succeed.  It  works around multiple issues in
502       which the remote system does not properly report username capabilities,
503       authentication  capabilities,  or  K_g status. Those hitting this issue
504       may  see  "username  invalid",  "authentication  type  unavailable  for
505       attempted privilege level", or "k_g invalid" errors.  Issue observed on
506       Asus  P5M2/P5MT-R/RS162-E4/RX4,  Intel  SR1520ML/X38ML,  and  Sun  Fire
507       2200/4150/4450 with ELOM.
508
509       idzero  -  This  workaround  flag  will  allow  empty session IDs to be
510       accepted by the client. It works around IPMI sessions that report empty
511       session  IDs  to  the client. Those hitting this issue may see "session
512       timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
513
514       unexpectedauth - This workaround flag will  allow  unexpected  non-null
515       authcodes  to  be checked as though they were expected. It works around
516       an issue when packets contain non-null authentication  data  when  they
517       should  be  null due to disabled per-message authentication. Those hit‐
518       ting this issue may see "session timeout"  errors.  Issue  observed  on
519       Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
520
521       forcepermsg  -  This workaround flag will force per-message authentica‐
522       tion to be used no matter what is advertised by the remote  system.  It
523       works  around an issue when per-message authentication is advertised as
524       disabled on the remote system, but it is actually required for the pro‐
525       tocol.  Those  hitting  this  issue  may  see "session timeout" errors.
526       Issue observed on IBM eServer 325.
527
528       endianseq - This workaround flag will flip the endian  of  the  session
529       sequence  numbers  to  allow the session to continue properly. It works
530       around IPMI 1.5 session sequence numbers that  are  the  wrong  endian.
531       Those  hitting  this  issue  may  see  "session  timeout" errors. Issue
532       observed on  some  Sun  ILOM  1.0/2.0  (depends  on  service  processor
533       endian).
534
535       noauthcodecheck  - This workaround flag will tell FreeIPMI to not check
536       the authentication codes returned from IPMI 1.5 command  responses.  It
537       works  around  systems  to  return  invalid authentication codes due to
538       hashing or implementation errors. Users are cautioned  on  the  use  of
539       this option, as it removes an authentication check verifying the valid‐
540       ity of a packet. However, in most organizations, this is unlikely to be
541       a  security  issue.  Those hitting this issue may see "connection time‐
542       out", "session timeout", or  "password  verification  timeout"  errors.
543       Issue observed on Xyratex FB-H8-SRAY.
544
545       intel20  - This workaround flag will work around several Intel IPMI 2.0
546       authentication issues. The issues covered include padding of usernames,
547       and  password  truncation  if  the  authentication  algorithm  is HMAC-
548       MD5-128. Those hitting this issue may see "username invalid", "password
549       invalid",  or  "k_g  invalid" errors. Issue observed on Intel SE7520AF2
550       with Intel Server Management Module (Professional Edition).
551
552       supermicro20 - This workaround flag will work around several Supermicro
553       IPMI  2.0  authentication  issues  on  motherboards  w/  Peppercon IPMI
554       firmware. The issues covered include handling invalid length  authenti‐
555       cation  codes.  Those  hitting  this  issue  may see "password invalid"
556       errors.  Issue observed on Supermicro H8QME with SIMSO  daughter  card.
557       Confirmed fixed on newerver firmware.
558
559       sun20 - This workaround flag will work work around several Sun IPMI 2.0
560       authentication issues. The issues covered include invalid lengthed hash
561       keys,  improperly  hashed keys, and invalid cipher suite records. Those
562       hitting this issue may see "password invalid" or  "bmc  error"  errors.
563       Issue  observed  on Sun Fire 4100/4200/4500 with ILOM.  This workaround
564       automatically includes the "opensesspriv" workaround.
565
566       opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
567       2.0 connection protocol to workaround an invalid hashing algorithm used
568       by the remote system. The privilege level sent during the Open  Session
569       stage of an IPMI 2.0 connection is used for hashing keys instead of the
570       privilege level sent during the RAKP1 connection stage.  Those  hitting
571       this  issue may see "password invalid", "k_g invalid", or "bad rmcpplus
572       status code" errors.  Issue observed on Sun  Fire  4100/4200/4500  with
573       ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
574       Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
575       QSSC-S4R//Appro  GB812X-CN.  This workaround is automatically triggered
576       with the "sun20" workaround.
577
578       integritycheckvalue - This workaround flag will work around an  invalid
579       integrity  check  value  during  an IPMI 2.0 session establishment when
580       using Cipher Suite ID 0. The integrity check value should be 0  length,
581       however  the  remote motherboard responds with a non-empty field. Those
582       hitting this issue may see "k_g  invalid"  errors.  Issue  observed  on
583       Supermicro  X8DTG,  Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
584       700, and Intel S2600JF/Appro 512X.
585
586       No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
587       found  to  not support IPMI 1.5. Those hitting this issue may see "ipmi
588       2.0 unavailable" or "connection timeout"  errors.  This  issue  can  be
589       worked  around  by  using  IPMI  2.0  instead of IPMI 1.5 by specifying
590       --driver-address=LAN_2_0. Issue observed on HP Proliant DL 145.
591
592       slowcommit - This workaround will slow  down  commits  to  the  BMC  by
593       sleeping  one  second  between  the commit of sections. It works around
594       motherboards that have BMCs that can be overwhelmed by commits.   Those
595       hitting  this  issue may see commit errors or commits not being written
596       to the BMC. Issue observed on Supermicro H8QME.
597
598       veryslowcommit - This workaround will slow down commits to the  BMC  by
599       sleeping  one  second  between the commit of every key. It works around
600       motherboards that have BMCs that can be overwhelmed by commits.   Those
601       hitting  this  issue may see commit errors or commits not being written
602       to the BMC. Issue observed on Quanta S99Q/Dell FS12-TY.
603

EXAMPLES

605       # ipmi-pef-config --checkout
606
607       Output all configuration information to the console.
608
609       # ipmi-pef-config --checkout --filename=pef-data1.conf
610
611       Store all configuration information in pef-data1.conf.
612
613       # ipmi-pef-config --diff --filename=pef-data2.conf
614
615       Show all difference between the  current  configuration  and  the  pef-
616       data2.conf file.
617
618       # ipmi-pef-config --commit --filename=pef-data1.conf
619
620       Commit all configuration values from the pef-data1.conf file.
621

DIAGNOSTICS

623       Upon  successful  execution, exit status is 0. On error, exit status is
624       1.
625
626       If multiple hosts are specified for communication, the exit status is 0
627       if  and  only  if  all targets successfully execute. Otherwise the exit
628       status is 1.
629

KNOWN ISSUES

631       On older operating systems, if you input your username,  password,  and
632       other  potentially  security  relevant information on the command line,
633       this information may be discovered by other users when using tools like
634       the  ps(1) command or looking in the /proc file system. It is generally
635       more secure to input password information with options like the  -P  or
636       -K  options.  Configuring security relevant information in the FreeIPMI
637       configuration file would also be an appropriate way to hide this infor‐
638       mation.
639
640       In  order  to  prevent  brute force attacks, some BMCs will temporarily
641       "lock up" after a number of remote authentication errors. You may  need
642       to  wait awhile in order to this temporary "lock up" to pass before you
643       may authenticate again.
644

REPORTING BUGS

646       Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
647
649       Copyright © 2007-2012 FreeIPMI Core Team.
650
651       This program is free software; you can redistribute it and/or modify it
652       under  the  terms of the GNU General Public License as published by the
653       Free Software Foundation; either version 3 of the License, or (at  your
654       option) any later version.
655

SEE ALSO

657       freeipmi(7),  bmc-config(8),  ipmi-sensors-config(8), ipmi-chassis-con‐
658       fig(8)
659
660       http://www.gnu.org/software/freeipmi/
661
662
663
664ipmi-pef-config 1.2.1             2017-03-22                IPMI-PEF-CONFIG(8)
Impressum