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