1IPMI-PEF-CONFIG(8) System Commands IPMI-PEF-CONFIG(8)
2
6 ipmi-pef-config - configure PEF values
7
9 ipmi-pef-config [OPTION...]
10
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 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 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
29 The following options are general options for configuring IPMI communi‐
30 cation and executing general tool commands.
31 -D, --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 --disable-auto-probe
40 Do not probe in-band IPMI devices for default settings.
41 --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 --driver-device=DEVICE
48 Specify the in-band driver device path to be used instead of the
49 probed path.
50 --register-spacing=REGISTER-SPACING
52 Specify the in-band driver register spacing instead of the
53 probed value.
54 -h, --hostname=IPMIHOST1,IPMIHOST2,...
56 Specify the remote host(s) to communicate with. Multiple host‐
57 names may be separated by comma or may be specified in a range
58 format; see HOSTRANGED SUPPORT below.
59 -u, --username=USERNAME
61 Specify the username to use when authenticating with the remote
62 host. If not specified, a null (i.e. anonymous) username is
63 assumed. The user must have atleast ADMIN privileges in order
64 for this tool to operate fully.
65 -p, --password=PASSWORD
67 Specify the password to use when authenticationg with the remote
68 host. If not specified, a null password is assumed. Maximum
69 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
70 -P, --password-prompt
72 Prompt for password to avoid possibility of listing it in
73 process lists.
74 -k, --k-g=K_G
76 Specify the K_g BMC key to use when authenticating with the
77 remote host for IPMI 2.0. If not specified, a null key is
78 assumed. To input the key in hexadecimal form, prefix the string
79 with '0x'. E.g., the key 'abc' can be entered with the either
80 the string 'abc' or the string '0x616263'
81 -K, --k-g-prompt
83 Prompt for k-g to avoid possibility of listing it in process
84 lists.
85 --session-timeout=MILLISECONDS
87 Specify the session timeout in milliseconds. Defaults to 20000
88 milliseconds (20 seconds) if not specified.
89 --retransmission-timeout=MILLISECONDS
91 Specify the packet retransmission timeout in milliseconds.
92 Defaults to 1000 milliseconds (1 second) if not specified. The
93 retransmission timeout cannot be larger than the session time‐
94 out.
95 -a, --authentication-type=AUTHENTICATION-TYPE
97 Specify the IPMI 1.5 authentication type to use. The currently
98 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
99 MD2, and MD5. Defaults to MD5 if not specified.
100 -I, --cipher-suite-id=CIPHER-SUITE-ID
102 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
103 identifies a set of authentication, integrity, and confidential‐
104 ity algorithms to use for IPMI 2.0 communication. The authenti‐
105 cation algorithm identifies the algorithm to use for session
106 setup, the integrity algorithm identifies the algorithm to use
107 for session packet signatures, and the confidentiality algorithm
108 identifies the algorithm to use for payload encryption. Defaults
109 to cipher suite ID 3 if not specified. The following cipher
110 suite ids are currently supported:
111 0 - Authentication Algorithm = None; Integrity Algorithm = None;
113 Confidentiality Algorithm = None
114 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
116 None; Confidentiality Algorithm = None
117 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
119 HMAC-SHA1-96; Confidentiality Algorithm = None
120 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
122 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
123 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
125 None; Confidentiality Algorithm = None
126 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
128 HMAC-MD5-128; Confidentiality Algorithm = None
129 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
131 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
132 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
134 MD5-128; Confidentiality Algorithm = None
135 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
137 MD5-128; Confidentiality Algorithm = AES-CBC-128
138 -l, --privilege-level=PRIVILEGE-LEVEL
140 Specify the privilege level to be used. The currently available
141 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
142 ADMIN if not specified.
143 --config-file=FILE
145 Specify an alternate configuration file.
146 -W, --workaround-flags=WORKAROUNDS
148 Specify workarounds to vendor compliance issues. Multiple work‐
149 arounds can be specified separated by commas. See WORKAROUNDS
150 below for a list of available workarounds.
151 --debug
153 Turn on debugging.
154 -?, --help
156 Output a help list and exit.
157 --usage
159 Output a usage message and exit.
160 -V, --version
162 Output the program version and exit.
163
165 The following options are specific to Ipmi-pef-config.
166 -i, --info
168 Show general information about PEF configuration.
169
171 The following options are used to read, write, and find differences in
172 configuration values.
173 -o, --checkout
175 Fetch configuration information.
176 -c, --commit
178 Update configuration information from a config file or key
179 pairs.
180 -d, --diff
182 Show differences between stored information and a config file or
183 key pairs.
184 -n FILENAME, --filename=FILENAME
186 Specify a config file for checkout/commit/diff.
187 -e "KEY=VALUE", --key-pair="KEY=VALUE"
189 Specify KEY=VALUE pairs for checkout/commit/diff. Specify KEY by
190 SectionName:FieldName. This option can be used multiple times.
191 On commit, any KEY=VALUE pairs will overwrite any pairs speci‐
192 fied in a file with --filename.
193 -S "SECTION", --section="SECTION"
195 Specify a SECTION for checkout. This option can be used multiple
196 times.
197 -L, --listsections
199 List available sections for checkout.
200 -v, --verbose
202 Output additional detailed information. In general will output
203 more detailed information about what fields can and cannot be
204 checked out, committed, etc. When used with --checkout, addi‐
205 tional uncommon, unconfigurable, and/or unused fields may be
206 output.
207
209 The following options manipulate hostranged output. See HOSTRANGED SUP‐
210 PORT below for additional information on hostranges.
211 -B, --buffer-output
213 Buffer hostranged output. For each node, buffer standard output
214 until the node has completed its IPMI operation. When specifying
215 this option, data may appear to output slower to the user since
216 the the entire IPMI operation must complete before any data can
217 be output. See HOSTRANGED SUPPORT below for additional informa‐
218 tion.
219 -C, --consolidate-output
221 Consolidate hostranged output. The complete standard output from
222 every node specified will be consolidated so that nodes with
223 identical output are not output twice. A header will list those
224 nodes with the consolidated output. When this option is speci‐
225 fied, no output can be seen until the IPMI operations to all
226 nodes has completed. If the user breaks out of the program
227 early, all currently consolidated output will be dumped. See
228 HOSTRANGED SUPPORT below for additional information.
229 -F, --fanout
231 Specify multiple host fanout. A "sliding window" (or fanout)
232 algorithm is used for parallel IPMI communication so that slower
233 nodes or timed out nodes will not impede parallel communication.
234 The maximum number of threads available at the same time is lim‐
235 ited by the fanout. The default is 64.
236 -E, --eliminate
238 Eliminate hosts determined as undetected by ipmidetect. This
239 attempts to remove the common issue of hostranged execution tim‐
240 ing out due to several nodes being removed from service in a
241 large cluster. The ipmidetectd daemon must be running on the
242 node executing the command.
243 --always-prefix
245 Always prefix output, even if only one host is specified or com‐
246 municating in-band. This option is primarily useful for script‐
247 ing purposes. Option will be ignored if specified with the -C
248 option.
249
251 Most users of will want to:
252 A) Run with --checkout to get a copy of the current configuration and
254 store it in a file. The standard output can be redirected to a file or
255 a file can be specified with the --filename option.
256 B) Edit the configuration file with an editor.
258 C) Commit the configuration back using the --commit option and specify‐
260 ing the configuration file with the --filename option. The configura‐
261 tion can be committed to multiple hosts in parallel via the hostrange
262 support.
263 Although not typically necessarily, some motherboards do not store con‐
265 figuration values in non-volatile memory. Therefore, after system
266 reboots, some configuration values may have changed. The user may wish
267 to run configuration tools on each boot to ensure configuration values
268 remain.
269
271 Options for editing fields in the checkout file are usually listed in a
272 comment above the field. When there are to many options to make it
273 practical, they are listed here in the MAN page.
274 Sensor_Type Options
276 Reserved, Temperature, Voltage, Current, Fan, Physical_Security,
277 Platform_Security_Violation_Attempt, Processor, Power_Supply,
278 Power_Unit, Cooling_Device, Other_Units_Based_Sensor, Memory,
279 Drive_Slot, Post_Memory_Resize, System_Firmware_Progress,
280 Event_Logging_Disabled, Watchdog1, System_Event, Critical_Inter‐
281 rupt, Button_Switch, Module_Board, Microcontroller_Coprocessor,
282 Add_In_Card, Chassis, Chip_Set, Other_FRU, Cable_Interconnect,
283 Terminator, System_Boot_Initiated, Boot_Error, OS_Boot, OS_Crit‐
284 ical_Stop, Slot_Connector, System_ACPI_Power_State, Watchdog2,
285 Platform_Alert, Entity_Presence, Monitor_Asic_IC, Lan, Manage‐
286 ment_Subsystem_Health, Battery, Session_Audit, Version_Change,
287 FRU_State, and Any
288
290 Multiple hosts can be input either as an explicit comma separated lists
291 of hosts or a range of hostnames in the general form: prefix[n-m,l-
292 k,...], where n < m and l < k, etc. The later form should not be con‐
293 fused with regular expression character classes (also denoted by []).
294 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
295 sents a degenerate range: foo19.
296 This range syntax is meant only as a convenience on clusters with a
298 prefixNN naming convention and specification of ranges should not be
299 considered necessary -- the list foo1,foo9 could be specified as such,
300 or by the range foo[1,9].
301 Some examples of range usage follow:
303 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
304 foo[7,9-10] instead of foo7,foo9,foo10
305 foo[0-3] instead of foo0,foo1,foo2,foo3
306 As a reminder to the reader, some shells will interpret brackets ([ and
308 ]) for pattern matching. Depending on your shell, it may be necessary
309 to enclose ranged lists within quotes.
310 When multiple hosts are specified by the user, a thread will be exe‐
312 cuted for each host in parallel up to the configured fanout (which can
313 be adjusted via the -F option). This will allow communication to large
314 numbers of nodes far more quickly than if done in serial.
315 By default, standard output from each node specified will be output
317 with the hostname prepended to each line. Although this output is read‐
318 able in many situations, it may be difficult to read in other situa‐
319 tions. For example, output from multiple nodes may be mixed together.
320 The -B and -C options can be used to change this default.
321 In-band IPMI Communication will be used when the host "localhost" is
323 specified. This allows the user to add the localhost into the hos‐
324 tranged output.
325
327 Most often, IPMI problems are due to configuration problems. Inband
328 IPMI problems are typically caused by improperly configured drivers or
329 non-standard BMCs. IPMI over LAN problems involve a misconfiguration of
330 the remote machine's BMC. Double check to make sure the following are
331 configured properly in the remote machine's BMC: IP address, MAC
332 address, subnet mask, username, user enablement, user privilege, pass‐
333 word, LAN privilege, LAN enablement, and allowed authentication
334 type(s). For IPMI 2.0 connections, double check to make sure the cipher
335 suite privilege(s) and K_g key are configured properly. The bmc-con‐
336 fig(8) tool can be used to check and/or change these configuration set‐
337 tings.
338 The following are common issues for given error messages:
340 "username invalid" - The username entered (or a NULL username if none
342 was entered) is not available on the remote machine. It may also be
343 possible the remote BMC's username configuration is incorrect.
344 "password invalid" - The password entered (or a NULL password if none
346 was entered) is not correct. It may also be possible the password for
347 the user is not correctly configured on the remote BMC.
348 "password verification timeout" - Password verification has timed out.
350 A "password invalid" error (described above) or a generic "session
351 timeout" (described below) occurred. During this point in the protocol
352 it cannot be differentiated which occurred.
353 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
355 entered) is not correct. It may also be possible the K_g key is not
356 correctly configured on the remote BMC.
357 "privilege level insufficient" - An IPMI command requires a higher user
359 privilege than the one authenticated with. Please try to authenticate
360 with a higher privilege. This may require authenticating to a different
361 user which has a higher maximum privilege.
362 "privilege level cannot be obtained for this user" - The privilege
364 level you are attempting to authenticate with is higher than the maxi‐
365 mum allowed for this user. Please try again with a lower privilege. It
366 may also be possible the maximum privilege level allowed for a user is
367 not configured properly on the remote BMC.
368 "authentication type unavailable for attempted privilege level" - The
370 authentication type you wish to authenticate with is not available for
371 this privilege level. Please try again with an alternate authentication
372 type or alternate privilege level. It may also be possible the avail‐
373 able authentication types you can authenticate with are not correctly
374 configured on the remote BMC.
375 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
377 ticate with is not available on the remote BMC. Please try again with
378 an alternate cipher suite id. It may also be possible the available
379 cipher suite ids are not correctly configured on the remote BMC.
380 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
382 machine. Please try to use IPMI 1.5 instead.
383 "connection timeout" - Initial IPMI communication failed. A number of
385 potential errors are possible, including an invalid hostname specified,
386 an IPMI IP address cannot be resolved, IPMI is not enabled on the
387 remote server, the network connection is bad, etc. Please verify con‐
388 figuration and connectivity.
389 "session timeout" - The IPMI session has timed out. Please reconnect.
391 If this error occurs often, you may wish to increase the retransmission
392 timeout. Some remote BMCs are considerably slower than others.
393 "device not found" - The specified device could not be found. Please
395 check configuration or inputs and try again.
396 "driver timeout" - Communication with the driver or device has timed
398 out. Please try again.
399 "message timeout" - Communication with the driver or device has timed
401 out. Please try again.
402 "BMC busy" - The BMC is currently busy. It may be processing informa‐
404 tion or have too many simultaneous sessions to manage. Please wait and
405 try again.
406 "could not find inband device" - An inband device could not be found.
408 Please check configuration or specify specific device or driver on the
409 command line.
410 Please see WORKAROUNDS below to also if there are any vendor specific
412 bugs that have been discovered and worked around.
413
415 With so many different vendors implementing their own IPMI solutions,
416 different vendors may implement their IPMI protocols incorrectly. The
417 following lists the workarounds currently available to handle discov‐
418 ered compliance issues.
419 When possible, workarounds have been implemented so they will be trans‐
421 parent to the user. However, some will require the user to specify a
422 workaround be used via the -W option.
423 The hardware listed below may only indicate the hardware that a problem
425 was discovered on. Newer versions of hardware may fix the problems
426 indicated below. Similar machines from vendors may or may not exhibit
427 the same problems. Different vendors may license their firmware from
428 the same IPMI firmware developer, so it may be worthwhile to try work‐
429 arounds listed below even if your motherboard is not listed.
430 "idzero" - This workaround option will allow empty session IDs to be
432 accepted by the client. It works around IPMI sessions that report empty
433 session IDs to the client. Those hitting this issue may see "session
434 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
435 "unexpectedauth" - This workaround option will allow unexpected non-
437 null authcodes to be checked as though they were expected. It works
438 around an issue when packets contain non-null authentication data when
439 they should be null due to disabled per-message authentication. Those
440 hitting this issue may see "session timeout" errors. Issue observed on
441 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
442 "forcepermsg" - This workaround option will force per-message authenti‐
444 cation to be used no matter what is advertised by the remote system. It
445 works around an issue when per-message authentication is advertised as
446 disabled on the remote system, but it is actually required for the pro‐
447 tocol. Those hitting this issue may see "session timeout" errors.
448 Issue observed on IBM eServer 325.
449 "endianseq" - This workaround option will flip the endian of the ses‐
451 sion sequence numbers to allow the session to continue properly. It
452 works around IPMI 1.5 session sequence numbers that are the wrong
453 endian. Those hitting this issue may see "session timeout" errors.
454 Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor
455 endian).
456 "authcap" - This workaround option will skip early checks for username
458 capabilities, authentication capabilities, and K_g support and allow
459 IPMI authentication to succeed. It works around multiple issues in
460 which the remote system does not properly report username capabilities,
461 authentication capabilities, or K_g status. Those hitting this issue
462 may see "username invalid", "authentication type unavailable for
463 attempted privilege level", or "k_g invalid" errors. Issue observed on
464 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
465 2200/4150/4450 with ELOM.
466 "intel20" - This workaround option will work around several Intel IPMI
468 2.0 authentication issues. The issues covered include padding of user‐
469 names, automatic acceptance of a RAKP 4 response integrity check when
470 using the integrity algorithm MD5-128, and password truncation if the
471 authentication algorithm is HMAC-MD5-128. Those hitting this issue may
472 see "username invalid", "password invalid", or "k_g invalid" errors.
473 Issue observed on Intel SE7520AF2 with Intel Server Management Module
474 (Professional Edition).
475 "supermicro20" - This workaround option will work around several Super‐
477 micro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
478 firmware. The issues covered include handling invalid length authenti‐
479 cation codes. Those hitting this issue may see "password invalid"
480 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
481 Confirmed fixed on newerver firmware.
482 "sun20" - This workaround option will work work around several Sun IPMI
484 2.0 authentication issues. The issues covered include invalid lengthed
485 hash keys, improperly hashed keys, and invalid cipher suite records.
486 Those hitting this issue may see "password invalid" or "bmc error"
487 errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This
488 workaround automatically includes the "opensesspriv" workaround.
489 "opensesspriv" - This workaround option will slightly alter FreeIPMI's
491 IPMI 2.0 connection protocol to workaround an invalid hashing algorithm
492 used by the remote system. The privilege level sent during the Open
493 Session stage of an IPMI 2.0 connection is sometimes invalid and used
494 for hashing keys instead of the privilege level sent during the RAKP1
495 connection stage. Those hitting this issue may see "password invalid",
496 "k_g invalid", "bad rmcpplus status code", or "privilege level cannot
497 be obtained for this user " errors. Issue observed on Sun Fire
498 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro
499 X8DTH, Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
500 Relion 700. This workaround is automatically triggered with the "sun20"
501 workaround.
502 "integritycheckvalue" - This workaround option will work around an
504 invalid integrity check value during an IPMI 2.0 session establishment
505 when using Cipher Suite ID 0. The integrity check value should be 0
506 length, however the remote motherboard responds with a non-empty field.
507 Those hitting this issue may see "k_g invalid" errors. Issue observed
508 on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
509 Relion 700.
510 "slowcommit" - This workaround will slow down commits to the BMC by
512 sleeping a small amount between the commit of sections. It works around
513 motherboards that have BMCs that can be overwhelmed by commits. Those
514 hitting this issue may see commit errors or commits not being written
515 to the BMC. Issue observed on Supermicro H8QME.
516
518 # ipmi-pef-config --checkout
519 Output all configuration information to the console.
521 # ipmi-pef-config --checkout --filename=pef-data1.conf
523 Store all configuration information in pef-data1.conf.
525 # ipmi-pef-config --diff --filename=pef-data2.conf
527 Show all difference between the current configuration and the pef-
529 data2.conf file.
530 # ipmi-pef-config --commit --filename=pef-data1.conf
532 Commit all configuration values from the pef-data1.conf file.
534
536 On older operating systems, if you input your username, password, and
537 other potentially security relevant information on the command line,
538 this information may be discovered by other users when using tools like
539 the ps(1) command or looking in the /proc file system. It is generally
540 more secure to input password information with options like the -P or
541 -K options. Configuring security relevant information in the FreeIPMI
542 configuration file would also be an appropriate way to hide this infor‐
543 mation.
544 In order to prevent brute force attacks, some BMCs will temporarily
546 "lock up" after a number of remote authentication errors. You may need
547 to wait awhile in order to this temporary "lock up" to pass before you
548 may authenticate again.
549
551 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
552
554 Copyright © 2007-2010 FreeIPMI Core Team.
555 This program is free software; you can redistribute it and/or modify it
557 under the terms of the GNU General Public License as published by the
558 Free Software Foundation; either version 2 of the License, or (at your
559 option) any later version.
560
562 freeipmi(7), bmc-config(8), ipmi-sensors-config(8), ipmi-chassis-con‐
563 fig(8)
564 http://www.gnu.org/software/freeipmi/
566ipmi-pef-config 0.8.8 2010-07-21 IPMI-PEF-CONFIG(8)