1IPMI-CHASSIS-CONFIG(8) System Commands IPMI-CHASSIS-CONFIG(8)
2
6 ipmi-chassis-config - configure chassis fields
7
9 ipmi-chassis-config [OPTION...]
10
12 Ipmi-chassis-config is used to get and set chassis configuration param‐
13 eters, such as boot device and power restore policy configuration. Most
14 IPMI users will not need to use this tool, although some may need it
15 for advanced configuration. For more general chassis management such as
16 power control or identification, please see ipmi-chassis(8) or
17 ipmipower(8).
18 Some chassis configuration may not be stored in non-volatile memory, so
20 users may wish to veryify that new configurations exist after system
21 reboots or to always run ipmi-chassis-config during system initializa‐
22 tion.
23 For configuration of general BMC parameters, platform event filtering
25 (PEF), or sensors, please see the bmc-config(8), ipmi-pef-config(8), or
26 ipmi-sensors-config(8) tools respectively. For some OEM specific con‐
27 figurations, please see ipmi-oem(8).
28 Listed below are general IPMI options, tool specific options, trouble
30 shooting information, workaround information, examples, and known
31 issues. For a general introduction to FreeIPMI please see freeipmi(7).
32 See GENERAL USE below for a description on how most will want to use
33 Ipmi-chassis-config.
34
36 The following options are general options for configuring IPMI communi‐
37 cation and executing general tool commands.
38 -D, --driver-type=IPMIDRIVER
40 Specify the driver type to use instead of doing an auto selec‐
41 tion. The currently available outofband drivers are LAN and
42 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
43 currently available inband drivers are KCS, SSIF, OPENIPMI, and
44 SUNBMC.
45 --disable-auto-probe
47 Do not probe in-band IPMI devices for default settings.
48 --driver-address=DRIVER-ADDRESS
50 Specify the in-band driver address to be used instead of the
51 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
52 hex value and '0' for an octal value.
53 --driver-device=DEVICE
55 Specify the in-band driver device path to be used instead of the
56 probed path.
57 --register-spacing=REGISTER-SPACING
59 Specify the in-band driver register spacing instead of the
60 probed value.
61 -h, --hostname=IPMIHOST1,IPMIHOST2,...
63 Specify the remote host(s) to communicate with. Multiple host‐
64 names may be separated by comma or may be specified in a range
65 format; see HOSTRANGED SUPPORT below.
66 -u, --username=USERNAME
68 Specify the username to use when authenticating with the remote
69 host. If not specified, a null (i.e. anonymous) username is
70 assumed. The user must have atleast ADMIN privileges in order
71 for this tool to operate fully.
72 -p, --password=PASSWORD
74 Specify the password to use when authenticationg with the remote
75 host. If not specified, a null password is assumed. Maximum
76 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
77 -P, --password-prompt
79 Prompt for password to avoid possibility of listing it in
80 process lists.
81 -k, --k-g=K_G
83 Specify the K_g BMC key to use when authenticating with the
84 remote host for IPMI 2.0. If not specified, a null key is
85 assumed. To input the key in hexadecimal form, prefix the string
86 with '0x'. E.g., the key 'abc' can be entered with the either
87 the string 'abc' or the string '0x616263'
88 -K, --k-g-prompt
90 Prompt for k-g to avoid possibility of listing it in process
91 lists.
92 --session-timeout=MILLISECONDS
94 Specify the session timeout in milliseconds. Defaults to 20000
95 milliseconds (20 seconds) if not specified.
96 --retransmission-timeout=MILLISECONDS
98 Specify the packet retransmission timeout in milliseconds.
99 Defaults to 1000 milliseconds (1 second) if not specified. The
100 retransmission timeout cannot be larger than the session time‐
101 out.
102 -a, --authentication-type=AUTHENTICATION-TYPE
104 Specify the IPMI 1.5 authentication type to use. The currently
105 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
106 MD2, and MD5. Defaults to MD5 if not specified.
107 -I, --cipher-suite-id=CIPHER-SUITE-ID
109 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
110 identifies a set of authentication, integrity, and confidential‐
111 ity algorithms to use for IPMI 2.0 communication. The authenti‐
112 cation algorithm identifies the algorithm to use for session
113 setup, the integrity algorithm identifies the algorithm to use
114 for session packet signatures, and the confidentiality algorithm
115 identifies the algorithm to use for payload encryption. Defaults
116 to cipher suite ID 3 if not specified. The following cipher
117 suite ids are currently supported:
118 0 - Authentication Algorithm = None; Integrity Algorithm = None;
120 Confidentiality Algorithm = None
121 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
123 None; Confidentiality Algorithm = None
124 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
126 HMAC-SHA1-96; Confidentiality Algorithm = None
127 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
129 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
130 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
132 None; Confidentiality Algorithm = None
133 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
135 HMAC-MD5-128; Confidentiality Algorithm = None
136 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
138 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
139 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
141 MD5-128; Confidentiality Algorithm = None
142 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
144 MD5-128; Confidentiality Algorithm = AES-CBC-128
145 -l, --privilege-level=PRIVILEGE-LEVEL
147 Specify the privilege level to be used. The currently available
148 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
149 ADMIN if not specified.
150 --config-file=FILE
152 Specify an alternate configuration file.
153 -W, --workaround-flags=WORKAROUNDS
155 Specify workarounds to vendor compliance issues. Multiple work‐
156 arounds can be specified separated by commas. See WORKAROUNDS
157 below for a list of available workarounds.
158 --debug
160 Turn on debugging.
161 -?, --help
163 Output a help list and exit.
164 --usage
166 Output a usage message and exit.
167 -V, --version
169 Output the program version and exit.
170
172 The following options are used to read, write, and find differences in
173 configuration values.
174 -o, --checkout
176 Fetch configuration information.
177 -c, --commit
179 Update configuration information from a config file or key
180 pairs.
181 -d, --diff
183 Show differences between stored information and a config file or
184 key pairs.
185 -n FILENAME, --filename=FILENAME
187 Specify a config file for checkout/commit/diff.
188 -e "KEY=VALUE", --key-pair="KEY=VALUE"
190 Specify KEY=VALUE pairs for checkout/commit/diff. Specify KEY by
191 SectionName:FieldName. This option can be used multiple times.
192 On commit, any KEY=VALUE pairs will overwrite any pairs speci‐
193 fied in a file with --filename.
194 -S "SECTION", --section="SECTION"
196 Specify a SECTION for checkout. This option can be used multiple
197 times.
198 -L, --listsections
200 List available sections for checkout.
201 -v, --verbose
203 Output additional detailed information. In general will output
204 more detailed information about what fields can and cannot be
205 checked out, committed, etc. When used with --checkout, addi‐
206 tional uncommon, unconfigurable, and/or unused fields may be
207 output.
208
210 The following options manipulate hostranged output. See HOSTRANGED SUP‐
211 PORT below for additional information on hostranges.
212 -B, --buffer-output
214 Buffer hostranged output. For each node, buffer standard output
215 until the node has completed its IPMI operation. When specifying
216 this option, data may appear to output slower to the user since
217 the the entire IPMI operation must complete before any data can
218 be output. See HOSTRANGED SUPPORT below for additional informa‐
219 tion.
220 -C, --consolidate-output
222 Consolidate hostranged output. The complete standard output from
223 every node specified will be consolidated so that nodes with
224 identical output are not output twice. A header will list those
225 nodes with the consolidated output. When this option is speci‐
226 fied, no output can be seen until the IPMI operations to all
227 nodes has completed. If the user breaks out of the program
228 early, all currently consolidated output will be dumped. See
229 HOSTRANGED SUPPORT below for additional information.
230 -F, --fanout
232 Specify multiple host fanout. A "sliding window" (or fanout)
233 algorithm is used for parallel IPMI communication so that slower
234 nodes or timed out nodes will not impede parallel communication.
235 The maximum number of threads available at the same time is lim‐
236 ited by the fanout. The default is 64.
237 -E, --eliminate
239 Eliminate hosts determined as undetected by ipmidetect. This
240 attempts to remove the common issue of hostranged execution tim‐
241 ing out due to several nodes being removed from service in a
242 large cluster. The ipmidetectd daemon must be running on the
243 node executing the command.
244 --always-prefix
246 Always prefix output, even if only one host is specified or com‐
247 municating in-band. This option is primarily useful for script‐
248 ing purposes. Option will be ignored if specified with the -C
249 option.
250
252 Most users of will want to:
253 A) Run with --checkout to get a copy of the current configuration and
255 store it in a file. The standard output can be redirected to a file or
256 a file can be specified with the --filename option.
257 B) Edit the configuration file with an editor.
259 C) Commit the configuration back using the --commit option and specify‐
261 ing the configuration file with the --filename option. The configura‐
262 tion can be committed to multiple hosts in parallel via the hostrange
263 support.
264 Although not typically necessarily, some motherboards do not store con‐
266 figuration values in non-volatile memory. Therefore, after system
267 reboots, some configuration values may have changed. The user may wish
268 to run configuration tools on each boot to ensure configuration values
269 remain.
270
272 The Chassis_Front_Panel_Buttons:Enable_Standby_Button_For_Enter‐
273 ing_Standy, Chassis_Front_Panel_Buttons:Enable_Diagnostic_Inter‐
274 rupt_Button Chassis_Front_Panel_Buttons:Enable_Reset_Button, and Chas‐
275 sis_Front_Panel_Buttons:Enable_Power_Off_Button_For_Power_Off_Only
276 fields may not be able to be checked out on some IPMI systems, there‐
277 fore the checked out value may be blank. Some of these fields may be
278 disableable, while some are not. The Chassis_Power_Conf:Power_Con‐
279 trol_Interval field cannot be checked out. Therefore the checked out
280 value will always be blank.
281
283 Multiple hosts can be input either as an explicit comma separated lists
284 of hosts or a range of hostnames in the general form: prefix[n-m,l-
285 k,...], where n < m and l < k, etc. The later form should not be con‐
286 fused with regular expression character classes (also denoted by []).
287 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
288 sents a degenerate range: foo19.
289 This range syntax is meant only as a convenience on clusters with a
291 prefixNN naming convention and specification of ranges should not be
292 considered necessary -- the list foo1,foo9 could be specified as such,
293 or by the range foo[1,9].
294 Some examples of range usage follow:
296 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
297 foo[7,9-10] instead of foo7,foo9,foo10
298 foo[0-3] instead of foo0,foo1,foo2,foo3
299 As a reminder to the reader, some shells will interpret brackets ([ and
301 ]) for pattern matching. Depending on your shell, it may be necessary
302 to enclose ranged lists within quotes.
303 When multiple hosts are specified by the user, a thread will be exe‐
305 cuted for each host in parallel up to the configured fanout (which can
306 be adjusted via the -F option). This will allow communication to large
307 numbers of nodes far more quickly than if done in serial.
308 By default, standard output from each node specified will be output
310 with the hostname prepended to each line. Although this output is read‐
311 able in many situations, it may be difficult to read in other situa‐
312 tions. For example, output from multiple nodes may be mixed together.
313 The -B and -C options can be used to change this default.
314 In-band IPMI Communication will be used when the host "localhost" is
316 specified. This allows the user to add the localhost into the hos‐
317 tranged output.
318
320 Most often, IPMI problems are due to configuration problems. Inband
321 IPMI problems are typically caused by improperly configured drivers or
322 non-standard BMCs. IPMI over LAN problems involve a misconfiguration of
323 the remote machine's BMC. Double check to make sure the following are
324 configured properly in the remote machine's BMC: IP address, MAC
325 address, subnet mask, username, user enablement, user privilege, pass‐
326 word, LAN privilege, LAN enablement, and allowed authentication
327 type(s). For IPMI 2.0 connections, double check to make sure the cipher
328 suite privilege(s) and K_g key are configured properly. The bmc-con‐
329 fig(8) tool can be used to check and/or change these configuration set‐
330 tings.
331 The following are common issues for given error messages:
333 "username invalid" - The username entered (or a NULL username if none
335 was entered) is not available on the remote machine. It may also be
336 possible the remote BMC's username configuration is incorrect.
337 "password invalid" - The password entered (or a NULL password if none
339 was entered) is not correct. It may also be possible the password for
340 the user is not correctly configured on the remote BMC.
341 "password verification timeout" - Password verification has timed out.
343 A "password invalid" error (described above) or a generic "session
344 timeout" (described below) occurred. During this point in the protocol
345 it cannot be differentiated which occurred.
346 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
348 entered) is not correct. It may also be possible the K_g key is not
349 correctly configured on the remote BMC.
350 "privilege level insufficient" - An IPMI command requires a higher user
352 privilege than the one authenticated with. Please try to authenticate
353 with a higher privilege. This may require authenticating to a different
354 user which has a higher maximum privilege.
355 "privilege level cannot be obtained for this user" - The privilege
357 level you are attempting to authenticate with is higher than the maxi‐
358 mum allowed for this user. Please try again with a lower privilege. It
359 may also be possible the maximum privilege level allowed for a user is
360 not configured properly on the remote BMC.
361 "authentication type unavailable for attempted privilege level" - The
363 authentication type you wish to authenticate with is not available for
364 this privilege level. Please try again with an alternate authentication
365 type or alternate privilege level. It may also be possible the avail‐
366 able authentication types you can authenticate with are not correctly
367 configured on the remote BMC.
368 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
370 ticate with is not available on the remote BMC. Please try again with
371 an alternate cipher suite id. It may also be possible the available
372 cipher suite ids are not correctly configured on the remote BMC.
373 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
375 machine. Please try to use IPMI 1.5 instead.
376 "connection timeout" - Initial IPMI communication failed. A number of
378 potential errors are possible, including an invalid hostname specified,
379 an IPMI IP address cannot be resolved, IPMI is not enabled on the
380 remote server, the network connection is bad, etc. Please verify con‐
381 figuration and connectivity.
382 "session timeout" - The IPMI session has timed out. Please reconnect.
384 If this error occurs often, you may wish to increase the retransmission
385 timeout. Some remote BMCs are considerably slower than others.
386 "device not found" - The specified device could not be found. Please
388 check configuration or inputs and try again.
389 "driver timeout" - Communication with the driver or device has timed
391 out. Please try again.
392 "message timeout" - Communication with the driver or device has timed
394 out. Please try again.
395 "BMC busy" - The BMC is currently busy. It may be processing informa‐
397 tion or have too many simultaneous sessions to manage. Please wait and
398 try again.
399 "could not find inband device" - An inband device could not be found.
401 Please check configuration or specify specific device or driver on the
402 command line.
403 Please see WORKAROUNDS below to also if there are any vendor specific
405 bugs that have been discovered and worked around.
406
408 With so many different vendors implementing their own IPMI solutions,
409 different vendors may implement their IPMI protocols incorrectly. The
410 following lists the workarounds currently available to handle discov‐
411 ered compliance issues.
412 When possible, workarounds have been implemented so they will be trans‐
414 parent to the user. However, some will require the user to specify a
415 workaround be used via the -W option.
416 The hardware listed below may only indicate the hardware that a problem
418 was discovered on. Newer versions of hardware may fix the problems
419 indicated below. Similar machines from vendors may or may not exhibit
420 the same problems. Different vendors may license their firmware from
421 the same IPMI firmware developer, so it may be worthwhile to try work‐
422 arounds listed below even if your motherboard is not listed.
423 "idzero" - This workaround option will allow empty session IDs to be
425 accepted by the client. It works around IPMI sessions that report empty
426 session IDs to the client. Those hitting this issue may see "session
427 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
428 "unexpectedauth" - This workaround option will allow unexpected non-
430 null authcodes to be checked as though they were expected. It works
431 around an issue when packets contain non-null authentication data when
432 they should be null due to disabled per-message authentication. Those
433 hitting this issue may see "session timeout" errors. Issue observed on
434 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
435 "forcepermsg" - This workaround option will force per-message authenti‐
437 cation to be used no matter what is advertised by the remote system. It
438 works around an issue when per-message authentication is advertised as
439 disabled on the remote system, but it is actually required for the pro‐
440 tocol. Those hitting this issue may see "session timeout" errors.
441 Issue observed on IBM eServer 325.
442 "endianseq" - This workaround option will flip the endian of the ses‐
444 sion sequence numbers to allow the session to continue properly. It
445 works around IPMI 1.5 session sequence numbers that are the wrong
446 endian. Those hitting this issue may see "session timeout" errors.
447 Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor
448 endian).
449 "authcap" - This workaround option will skip early checks for username
451 capabilities, authentication capabilities, and K_g support and allow
452 IPMI authentication to succeed. It works around multiple issues in
453 which the remote system does not properly report username capabilities,
454 authentication capabilities, or K_g status. Those hitting this issue
455 may see "username invalid", "authentication type unavailable for
456 attempted privilege level", or "k_g invalid" errors. Issue observed on
457 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
458 2200/4150/4450 with ELOM.
459 "intel20" - This workaround option will work around several Intel IPMI
461 2.0 authentication issues. The issues covered include padding of user‐
462 names, automatic acceptance of a RAKP 4 response integrity check when
463 using the integrity algorithm MD5-128, and password truncation if the
464 authentication algorithm is HMAC-MD5-128. Those hitting this issue may
465 see "username invalid", "password invalid", or "k_g invalid" errors.
466 Issue observed on Intel SE7520AF2 with Intel Server Management Module
467 (Professional Edition).
468 "supermicro20" - This workaround option will work around several Super‐
470 micro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
471 firmware. The issues covered include handling invalid length authenti‐
472 cation codes. Those hitting this issue may see "password invalid"
473 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
474 Confirmed fixed on newerver firmware.
475 "sun20" - This workaround option will work work around several Sun IPMI
477 2.0 authentication issues. The issues covered include invalid lengthed
478 hash keys, improperly hashed keys, and invalid cipher suite records.
479 Those hitting this issue may see "password invalid" or "bmc error"
480 errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This
481 workaround automatically includes the "opensesspriv" workaround.
482 "opensesspriv" - This workaround option will slightly alter FreeIPMI's
484 IPMI 2.0 connection protocol to workaround an invalid hashing algorithm
485 used by the remote system. The privilege level sent during the Open
486 Session stage of an IPMI 2.0 connection is sometimes invalid and used
487 for hashing keys instead of the privilege level sent during the RAKP1
488 connection stage. Those hitting this issue may see "password invalid",
489 "k_g invalid", "bad rmcpplus status code", or "privilege level cannot
490 be obtained for this user " errors. Issue observed on Sun Fire
491 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro
492 X8DTH, Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
493 Relion 700. This workaround is automatically triggered with the "sun20"
494 workaround.
495 "integritycheckvalue" - This workaround option will work around an
497 invalid integrity check value during an IPMI 2.0 session establishment
498 when using Cipher Suite ID 0. The integrity check value should be 0
499 length, however the remote motherboard responds with a non-empty field.
500 Those hitting this issue may see "k_g invalid" errors. Issue observed
501 on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
502 Relion 700.
503 "slowcommit" - This workaround will slow down commits to the BMC by
505 sleeping a small amount between the commit of sections. It works around
506 motherboards that have BMCs that can be overwhelmed by commits. Those
507 hitting this issue may see commit errors or commits not being written
508 to the BMC. Issue observed on Supermicro H8QME.
509
511 # ipmi-chassis-config --checkout
512 Output all configuration information to the console.
514 # ipmi-chassis-config --checkout --filename=chassis-data1.conf
516 Store all BMC configuration information in chassis-data1.conf.
518 # ipmi-chassis-config --diff --filename=chassis-data2.conf
520 Show all difference between the current configuration and the chassis-
522 data2.conf file.
523 # ipmi-chassis-config --commit --filename=chassis-data1.conf
525 Commit all configuration values from the chassis-data1.conf file.
527
529 On older operating systems, if you input your username, password, and
530 other potentially security relevant information on the command line,
531 this information may be discovered by other users when using tools like
532 the ps(1) command or looking in the /proc file system. It is generally
533 more secure to input password information with options like the -P or
534 -K options. Configuring security relevant information in the FreeIPMI
535 configuration file would also be an appropriate way to hide this infor‐
536 mation.
537 In order to prevent brute force attacks, some BMCs will temporarily
539 "lock up" after a number of remote authentication errors. You may need
540 to wait awhile in order to this temporary "lock up" to pass before you
541 may authenticate again.
542
544 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
545
547 Copyright © 2008-2010 FreeIPMI Core Team.
548 This program is free software; you can redistribute it and/or modify it
550 under the terms of the GNU General Public License as published by the
551 Free Software Foundation; either version 2 of the License, or (at your
552 option) any later version.
553
555 freeipmi(7), bmc-config(8), ipmi-pef-config(8), ipmi-sensors-config(8),
556 ipmipower(8)
557 http://www.gnu.org/software/freeipmi/
559ipmi-chassis-config 0.8.8 2010-07-21 IPMI-CHASSIS-CONFIG(8)