1IPMI-SENSORS(8) System Commands IPMI-SENSORS(8)
2
6 ipmi-sensors - display IPMI sensor information
7
9 ipmi-sensors [OPTION...]
10
12 ipmi-sensors displays current readings of sensors and sensor data
13 repository (SDR) information. The default display outputs each sensor's
14 record id, sensor name, sensor type name, sensor reading (if appropri‐
15 ate), and the current sensor event. More verbose information can be
16 found using the verbose options specified below. ipmi-sensors does not
17 inform the user if a problem exists with a particular sensor because
18 sensor readings and events are not analyzed by default. Users may wish
19 to use the --output-sensor-state option to output the analyzed sensor
20 state. Some sensors may have a sensor reading or sensor event of "N/A"
21 if the information is unavailable. This is typical of a sensor that is
22 not enabled or not owned by a BMC. Please see --bridge-sensors option
23 below to deal with sensors not owned by a BMC. Sensors may output a
24 sensor event of "Unknown" if the sensor reading cannot be read. This is
25 typical of a sensor that is busy or a reading that cannot be calcu‐
26 lated. If sensors report "Unrecognized State", it is indicative of an
27 unknown sensor type, typically an OEM sensor. If the sensor OEM inter‐
28 pretation is available, the --interpret-oem-data may be able to report
29 the appropriate sensor state. Sensors need not always report a sensor
30 event. When a sensor event is not present, "OK" is typically reported.
31 Listed below are general IPMI options, tool specific options, trouble
33 shooting information, workaround information, examples, and known
34 issues. For a general introduction to FreeIPMI please see freeipmi(7).
35 To perform IPMI sensor configuration, please see ipmi-config(8). To
36 perform some advanced SDR management, please see bmc-device(8).
37
39 The following options are general options for configuring IPMI communi‐
40 cation and executing general tool commands.
41 -D IPMIDRIVER, --driver-type=IPMIDRIVER
43 Specify the driver type to use instead of doing an auto selec‐
44 tion. The currently available outofband drivers are LAN and
45 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
46 currently available inband drivers are KCS, SSIF, OPENIPMI,
47 SUNBMC, and INTELDCMI.
48 --disable-auto-probe
50 Do not probe in-band IPMI devices for default settings.
51 --driver-address=DRIVER-ADDRESS
53 Specify the in-band driver address to be used instead of the
54 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
55 hex value and '0' for an octal value.
56 --driver-device=DEVICE
58 Specify the in-band driver device path to be used instead of the
59 probed path.
60 --register-spacing=REGISTER-SPACING
62 Specify the in-band driver register spacing instead of the
63 probed value. Argument is in bytes (i.e. 32bit register spacing
64 = 4)
65 --target-channel-number=CHANNEL-NUMBER
67 Specify the in-band driver target channel number to send IPMI
68 requests to.
69 --target-slave-address=SLAVE-ADDRESS
71 Specify the in-band driver target slave number to send IPMI
72 requests to.
73 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
75 HOST2[:PORT],...
76 Specify the remote host(s) to communicate with. Multiple host‐
77 names may be separated by comma or may be specified in a range
78 format; see HOSTRANGED SUPPORT below. An optional port can be
79 specified with each host, which may be useful in port forwarding
80 or similar situations.
81 -u USERNAME, --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=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=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=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=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 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
162 = None; Confidentiality Algorithm = None
163 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
165 = HMAC_SHA256_128; Confidentiality Algorithm = None
166 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
168 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
169 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
171 Specify the privilege level to be used. The currently available
172 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
173 OPERATOR if not specified.
174 --config-file=FILE
176 Specify an alternate configuration file.
177 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
179 Specify workarounds to vendor compliance issues. Multiple work‐
180 arounds can be specified separated by commas. A special command
181 line flag of "none", will indicate no workarounds (may be useful
182 for overriding configured defaults). See WORKAROUNDS below for a
183 list of available workarounds.
184 --debug
186 Turn on debugging.
187 -?, --help
189 Output a help list and exit.
190 --usage
192 Output a usage message and exit.
193 -V, --version
195 Output the program version and exit.
196
198 The following options are specific to ipmi-sensors.
199 -v, --verbose
201 Output verbose sensor output. This option will output additional
202 information about sensors such as thresholds, ranges, numbers,
203 and event/reading type codes.
204 -vv Output very verbose sensor output. This option will output more
206 additional information than the verbose option such as informa‐
207 tion about events, other sensor types, and oem sensors.
208 -i, --sdr-info
210 Show sensor data repository (SDR) information
211 -q, --quiet-readings
213 Do not output sensor reading values by default. This option is
214 particularly useful if you want to use hostranged output across
215 a cluster and want to consolidate the output.
216 -r RECORD-IDS-LIST, --record-ids=RECORD-IDS-LIST
218 Specify sensors to show by record id. Multiple record ids can be
219 separated by commas or spaces. If both --record-ids and --sen‐
220 sor-types are specified, --record-ids takes precedence. A spe‐
221 cial command line record id of "all", will indicate all record
222 ids should be shown (may be useful for overriding configured
223 defaults).
224 -R RECORD-IDS-LIST, --exclude-record-ids=RECORD-IDS-LIST
226 Specify sensors to not show by record id. Multiple record ids
227 can be separated by commas or spaces. A special command line
228 record id of "none", will indicate no record ids should be
229 excluded (may be useful for overriding configured defaults).
230 -t SENSOR-TYPE-LIST, --sensor-types=SENSOR-TYPE-LIST
232 Specify sensor types to show outputs for. Multiple types can be
233 separated by commas or spaces. If both --record-ids and --sen‐
234 sor-types are specified, --record-ids takes precedence. A spe‐
235 cial command line type of "all", will indicate all types should
236 be shown (may be useful for overriding configured defaults).
237 Users may specify sensor types by string (see --list-sen‐
238 sor-types below) or by number (decimal or hex).
239 -T SENSOR-TYPE-LIST, --exclude-sensor-types=SENSOR-TYPE-LIST
241 Specify sensor types to not show outputs for. Multiple types can
242 be eparated by commas or spaces. A special command line type of
243 "none", will indicate no types should be excluded (may be useful
244 for overriding configured defaults). Users may specify sensor
245 types by string (see --list-sensor-types below) or by number
246 (decimal or hex).
247 -L, --list-sensor-types
249 List sensor types.
250 -b, --bridge-sensors
252 By default, sensors readings are not attempted for sensors on
253 non-BMC owners. By setting this option, sensor requests can be
254 bridged to non-BMC owners to obtain sensor readings. Bridging
255 may not work on some interfaces/driver types.
256 --shared-sensors
258 Some sensors share the same sensor data record (SDR). This is
259 typically utilized for system event log (SEL) entries and not
260 for sensor readings. However, there may be some motherboards in
261 which this format is utilized for multiple active sensors, or
262 the user simply has interest in seeing the permutation of
263 entries shared by a SDR entry. By setting this option, each sen‐
264 sor number shared by a record will be iterated over and output.
265 --interpret-oem-data
267 Attempt to interpret OEM data, such as event data, sensor read‐
268 ings, or general extra info, etc. If an OEM interpretation is
269 not available, the default output will be generated. Correctness
270 of OEM interpretations cannot be guaranteed due to potential
271 changes OEM vendors may make in products, firmware, etc. See OEM
272 INTERPRETATION below for confirmed supported motherboard inter‐
273 pretations.
274 --ignore-not-available-sensors
276 Ignore not-available (i.e. N/A) sensors in output.
277 --ignore-unrecognized-events
279 Ignore unrecognized sensor events. This will suppress output of
280 unrecognized events, typically shown as 'Unrecognized Event =
281 XXXXh' in output. In addition, unrecognized events will be
282 ignored when calculating sensor state with --output-sensor-state
283 below.
284 --output-event-bitmask
286 Output event bitmask value instead of the string representation.
287 --output-sensor-state
289 Output sensor state in output. This will add an additional out‐
290 put reporting if a sensor is in a NOMINAL, WARNING, or CRITICAL
291 state. The sensor state is an interpreted value based on the
292 current sensor event. The sensor state interpretations are
293 determined by the configuration file
294 /etc/freeipmi//freeipmi_interpret_sensor.conf. See
295 freeipmi_interpret_sensor.conf(5) for more information. This
296 option gives identical output to the sensor state previously
297 output by ipmimonitoring(8).
298 --sensor-state-config-file=FILE
300 Specify an alternate sensor state configuration file. Option
301 ignored if --output-sensor-state not specified.
302 --entity-sensor-names
304 Output sensor names prefixed with their entity id and instance
305 number when appropriate. This may be necessary on some mother‐
306 boards to help identify what sensors are referencing. For exam‐
307 ple, a motherboard may have multiple sensors named 'TEMP'. The
308 entity id and instance number may help clarify which sensor
309 refers to "Processor 1" vs. "Processor 2".
310 --output-sensor-thresholds
312 Output sensor thresholds in output. This will add columns to the
313 default output for lower non-recoverable, lower critical, lower
314 non-critical, upper non-critical, upper critical, and upper non-
315 recoverable thresholds.
316 --no-sensor-type-output
318 Do not show sensor type output for each entry. On many systems,
319 the sensor type is redundant to the name of the sensor. This can
320 especially be true if --entity-sensor-names is specified. If
321 the sensor name is sufficient, or if the sensor type is of no
322 interest to the user, this option can be specified to condense
323 output.
324 --comma-separated-output
326 Output fields in comma separated format.
327 --no-header-output
329 Do not output column headers. May be useful in scripting.
330 --non-abbreviated-units
332 Output non-abbreviated units (e.g. 'Amps' instead of 'A'). May
333 aid in disambiguation of units (e.g. 'C' for Celsius or
334 Coulombs).
335 --legacy-output
337 Output in legacy format. Newer options may not be applicable to
338 legacy output.
339 --ipmimonitoring-legacy-output
341 Output legacy format of legacy ipmimonitoring tool. Newer
342 options may not be applicable to legacy output.
343
345 This tool requires access to the sensor data repository (SDR) cache for
346 general operation. By default, SDR data will be downloaded and cached
347 on the local machine. The following options apply to the SDR cache.
348 -f, --flush-cache
350 Flush a cached version of the sensor data repository (SDR)
351 cache. The SDR is typically cached for faster subsequent access.
352 However, it may need to be flushed and re-generated if the SDR
353 has been updated on a system.
354 -Q, --quiet-cache
356 Do not output information about cache creation/deletion. May be
357 useful in scripting.
358 --sdr-cache-recreate
360 If the SDR cache is out of date or invalid, automatically recre‐
361 ate the sensor data repository (SDR) cache. This option may be
362 useful for scripting purposes.
363 --sdr-cache-file=FILE
365 Specify a specific sensor data repository (SDR) cache file to be
366 stored or read from. If this option is used when multiple hosts
367 are specified, the same SDR cache file will be used for all
368 hosts.
369 --sdr-cache-directory=DIRECTORY
371 Specify an alternate directory for sensor data repository (SDR)
372 caches to be stored or read from. Defaults to the home directory
373 if not specified.
374
376 By IPMI definition, all IPMI times and timestamps are stored in local‐
377 time. However, in many situations, the timestamps will not be stored in
378 localtime. Whether or not a system truly stored the timestamps in
379 localtime varies on many factors, such as the vendor, BIOS, and operat‐
380 ing system. The following options will allow the user to adjust the
381 interpretation of the stored timestamps and how they should be output.
382 --utc-to-localtime
384 Assume all times are reported in UTC time and convert the time
385 to localtime before being output.
386 --localtime-to-utc
388 Convert all localtime timestamps to UTC before being output.
389 --utc-offset=SECONDS
391 Specify a specific UTC offset in seconds to be added to time‐
392 stamps. Value can range from -86400 to 86400 seconds. Defaults
393 to 0.
394
396 The following options manipulate hostranged output. See HOSTRANGED SUP‐
397 PORT below for additional information on hostranges.
398 -B, --buffer-output
400 Buffer hostranged output. For each node, buffer standard output
401 until the node has completed its IPMI operation. When specifying
402 this option, data may appear to output slower to the user since
403 the the entire IPMI operation must complete before any data can
404 be output. See HOSTRANGED SUPPORT below for additional informa‐
405 tion.
406 -C, --consolidate-output
408 Consolidate hostranged output. The complete standard output from
409 every node specified will be consolidated so that nodes with
410 identical output are not output twice. A header will list those
411 nodes with the consolidated output. When this option is speci‐
412 fied, no output can be seen until the IPMI operations to all
413 nodes has completed. If the user breaks out of the program
414 early, all currently consolidated output will be dumped. See
415 HOSTRANGED SUPPORT below for additional information.
416 -F NUM, --fanout=NUM
418 Specify multiple host fanout. A "sliding window" (or fanout)
419 algorithm is used for parallel IPMI communication so that slower
420 nodes or timed out nodes will not impede parallel communication.
421 The maximum number of threads available at the same time is lim‐
422 ited by the fanout. The default is 64.
423 -E, --eliminate
425 Eliminate hosts determined as undetected by ipmidetect. This
426 attempts to remove the common issue of hostranged execution tim‐
427 ing out due to several nodes being removed from service in a
428 large cluster. The ipmidetectd daemon must be running on the
429 node executing the command.
430 --always-prefix
432 Always prefix output, even if only one host is specified or com‐
433 municating in-band. This option is primarily useful for script‐
434 ing purposes. Option will be ignored if specified with the -C
435 option.
436
438 Multiple hosts can be input either as an explicit comma separated lists
439 of hosts or a range of hostnames in the general form: prefix[n-m,l-
440 k,...], where n < m and l < k, etc. The later form should not be con‐
441 fused with regular expression character classes (also denoted by []).
442 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
443 sents a degenerate range: foo19.
444 This range syntax is meant only as a convenience on clusters with a
446 prefixNN naming convention and specification of ranges should not be
447 considered necessary -- the list foo1,foo9 could be specified as such,
448 or by the range foo[1,9].
449 Some examples of range usage follow:
451 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
452 foo[7,9-10] instead of foo7,foo9,foo10
453 foo[0-3] instead of foo0,foo1,foo2,foo3
454 As a reminder to the reader, some shells will interpret brackets ([ and
456 ]) for pattern matching. Depending on your shell, it may be necessary
457 to enclose ranged lists within quotes.
458 When multiple hosts are specified by the user, a thread will be exe‐
460 cuted for each host in parallel up to the configured fanout (which can
461 be adjusted via the -F option). This will allow communication to large
462 numbers of nodes far more quickly than if done in serial.
463 By default, standard output from each node specified will be output
465 with the hostname prepended to each line. Although this output is read‐
466 able in many situations, it may be difficult to read in other situa‐
467 tions. For example, output from multiple nodes may be mixed together.
468 The -B and -C options can be used to change this default.
469 In-band IPMI Communication will be used when the host "localhost" is
471 specified. This allows the user to add the localhost into the hos‐
472 tranged output.
473
475 Most often, IPMI problems are due to configuration problems.
476 IPMI over LAN problems involve a misconfiguration of the remote
478 machine's BMC. Double check to make sure the following are configured
479 properly in the remote machine's BMC: IP address, MAC address, subnet
480 mask, username, user enablement, user privilege, password, LAN privi‐
481 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
482 connections, double check to make sure the cipher suite privilege(s)
483 and K_g key are configured properly. The ipmi-config(8) tool can be
484 used to check and/or change these configuration settings.
485 Inband IPMI problems are typically caused by improperly configured
487 drivers or non-standard BMCs.
488 In addition to the troubleshooting tips below, please see WORKAROUNDS
490 below to also if there are any vendor specific bugs that have been dis‐
491 covered and worked around.
492 Listed below are many of the common issues for error messages. For
494 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
495 list.
496 "username invalid" - The username entered (or a NULL username if none
498 was entered) is not available on the remote machine. It may also be
499 possible the remote BMC's username configuration is incorrect.
500 "password invalid" - The password entered (or a NULL password if none
502 was entered) is not correct. It may also be possible the password for
503 the user is not correctly configured on the remote BMC.
504 "password verification timeout" - Password verification has timed out.
506 A "password invalid" error (described above) or a generic "session
507 timeout" (described below) occurred. During this point in the protocol
508 it cannot be differentiated which occurred.
509 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
511 entered) is not correct. It may also be possible the K_g key is not
512 correctly configured on the remote BMC.
513 "privilege level insufficient" - An IPMI command requires a higher user
515 privilege than the one authenticated with. Please try to authenticate
516 with a higher privilege. This may require authenticating to a different
517 user which has a higher maximum privilege.
518 "privilege level cannot be obtained for this user" - The privilege
520 level you are attempting to authenticate with is higher than the maxi‐
521 mum allowed for this user. Please try again with a lower privilege. It
522 may also be possible the maximum privilege level allowed for a user is
523 not configured properly on the remote BMC.
524 "authentication type unavailable for attempted privilege level" - The
526 authentication type you wish to authenticate with is not available for
527 this privilege level. Please try again with an alternate authentication
528 type or alternate privilege level. It may also be possible the avail‐
529 able authentication types you can authenticate with are not correctly
530 configured on the remote BMC.
531 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
533 ticate with is not available on the remote BMC. Please try again with
534 an alternate cipher suite id. It may also be possible the available
535 cipher suite ids are not correctly configured on the remote BMC.
536 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
538 machine. Please try to use IPMI 1.5 instead.
539 "connection timeout" - Initial IPMI communication failed. A number of
541 potential errors are possible, including an invalid hostname specified,
542 an IPMI IP address cannot be resolved, IPMI is not enabled on the
543 remote server, the network connection is bad, etc. Please verify con‐
544 figuration and connectivity.
545 "session timeout" - The IPMI session has timed out. Please reconnect.
547 If this error occurs often, you may wish to increase the retransmission
548 timeout. Some remote BMCs are considerably slower than others.
549 "device not found" - The specified device could not be found. Please
551 check configuration or inputs and try again.
552 "driver timeout" - Communication with the driver or device has timed
554 out. Please try again.
555 "message timeout" - Communication with the driver or device has timed
557 out. Please try again.
558 "BMC busy" - The BMC is currently busy. It may be processing informa‐
560 tion or have too many simultaneous sessions to manage. Please wait and
561 try again.
562 "could not find inband device" - An inband device could not be found.
564 Please check configuration or specify specific device or driver on the
565 command line.
566 "driver timeout" - The inband driver has timed out communicating to the
568 local BMC or service processor. The BMC or service processor may be
569 busy or (worst case) possibly non-functioning.
570 "internal IPMI error" - An IPMI error has occurred that FreeIPMI does
572 not know how to handle. Please e-mail <freeipmi-users@gnu.org> to
573 report the issue.
574 "sensor config file parse error" - A parse error was found in the sen‐
576 sor interpretation configuration file. Please see freeipmi_inter‐
577 pret_sensor.conf(5).
578
580 With so many different vendors implementing their own IPMI solutions,
581 different vendors may implement their IPMI protocols incorrectly. The
582 following describes a number of workarounds currently available to han‐
583 dle discovered compliance issues. When possible, workarounds have been
584 implemented so they will be transparent to the user. However, some will
585 require the user to specify a workaround be used via the -W option.
586 The hardware listed below may only indicate the hardware that a problem
588 was discovered on. Newer versions of hardware may fix the problems
589 indicated below. Similar machines from vendors may or may not exhibit
590 the same problems. Different vendors may license their firmware from
591 the same IPMI firmware developer, so it may be worthwhile to try work‐
592 arounds listed below even if your motherboard is not listed.
593 If you believe your hardware has an additional compliance issue that
595 needs a workaround to be implemented, please contact the FreeIPMI main‐
596 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
597 assumeio - This workaround flag will assume inband interfaces communi‐
599 cate with system I/O rather than being memory-mapped. This will work
600 around systems that report invalid base addresses. Those hitting this
601 issue may see "device not supported" or "could not find inband device"
602 errors. Issue observed on HP ProLiant DL145 G1.
603 spinpoll - This workaround flag will inform some inband drivers (most
605 notably the KCS driver) to spin while polling rather than putting the
606 process to sleep. This may significantly improve the wall clock running
607 time of tools because an operating system scheduler's granularity may
608 be much larger than the time it takes to perform a single IPMI message
609 transaction. However, by spinning, your system may be performing less
610 useful work by not contexting out the tool for a more useful task.
611 authcap - This workaround flag will skip early checks for username
613 capabilities, authentication capabilities, and K_g support and allow
614 IPMI authentication to succeed. It works around multiple issues in
615 which the remote system does not properly report username capabilities,
616 authentication capabilities, or K_g status. Those hitting this issue
617 may see "username invalid", "authentication type unavailable for
618 attempted privilege level", or "k_g invalid" errors. Issue observed on
619 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
620 2200/4150/4450 with ELOM.
621 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
623 the checksums returned from IPMI command responses. It works around
624 systems that return invalid checksums due to implementation errors, but
625 the packet is otherwise valid. Users are cautioned on the use of this
626 option, as it removes validation of packet integrity in a number of
627 circumstances. However, it is unlikely to be an issue in most situa‐
628 tions. Those hitting this issue may see "connection timeout", "session
629 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
630 nections, the "noauthcodecheck" workaround may also needed too. Issue
631 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
632 X9DRFR.
633 idzero - This workaround flag will allow empty session IDs to be
635 accepted by the client. It works around IPMI sessions that report empty
636 session IDs to the client. Those hitting this issue may see "session
637 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
638 unexpectedauth - This workaround flag will allow unexpected non-null
640 authcodes to be checked as though they were expected. It works around
641 an issue when packets contain non-null authentication data when they
642 should be null due to disabled per-message authentication. Those hit‐
643 ting this issue may see "session timeout" errors. Issue observed on
644 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
645 forcepermsg - This workaround flag will force per-message authentica‐
647 tion to be used no matter what is advertised by the remote system. It
648 works around an issue when per-message authentication is advertised as
649 disabled on the remote system, but it is actually required for the pro‐
650 tocol. Those hitting this issue may see "session timeout" errors.
651 Issue observed on IBM eServer 325.
652 endianseq - This workaround flag will flip the endian of the session
654 sequence numbers to allow the session to continue properly. It works
655 around IPMI 1.5 session sequence numbers that are the wrong endian.
656 Those hitting this issue may see "session timeout" errors. Issue
657 observed on some Sun ILOM 1.0/2.0 (depends on service processor
658 endian).
659 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
661 the authentication codes returned from IPMI 1.5 command responses. It
662 works around systems that return invalid authentication codes due to
663 hashing or implementation errors. Users are cautioned on the use of
664 this option, as it removes an authentication check verifying the valid‐
665 ity of a packet. However, in most organizations, this is unlikely to be
666 a security issue. Those hitting this issue may see "connection time‐
667 out", "session timeout", or "password verification timeout" errors.
668 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
669 fell, and Wiwynn Windmill.
670 intel20 - This workaround flag will work around several Intel IPMI 2.0
672 authentication issues. The issues covered include padding of usernames,
673 and password truncation if the authentication algorithm is HMAC-
674 MD5-128. Those hitting this issue may see "username invalid", "password
675 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
676 with Intel Server Management Module (Professional Edition).
677 supermicro20 - This workaround flag will work around several Supermicro
679 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
680 firmware. The issues covered include handling invalid length authenti‐
681 cation codes. Those hitting this issue may see "password invalid"
682 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
683 Confirmed fixed on newerver firmware.
684 sun20 - This workaround flag will work work around several Sun IPMI 2.0
686 authentication issues. The issues covered include invalid lengthed hash
687 keys, improperly hashed keys, and invalid cipher suite records. Those
688 hitting this issue may see "password invalid" or "bmc error" errors.
689 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
690 automatically includes the "opensesspriv" workaround.
691 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
693 2.0 connection protocol to workaround an invalid hashing algorithm used
694 by the remote system. The privilege level sent during the Open Session
695 stage of an IPMI 2.0 connection is used for hashing keys instead of the
696 privilege level sent during the RAKP1 connection stage. Those hitting
697 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
698 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
699 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
700 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
701 QSSC-S4R/Appro GB812X-CN. This workaround is automatically triggered
702 with the "sun20" workaround.
703 integritycheckvalue - This workaround flag will work around an invalid
705 integrity check value during an IPMI 2.0 session establishment when
706 using Cipher Suite ID 0. The integrity check value should be 0 length,
707 however the remote motherboard responds with a non-empty field. Those
708 hitting this issue may see "k_g invalid" errors. Issue observed on
709 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
710 700, and Intel S2600JF/Appro 512X.
711 assumemaxsdrrecordcount - This workaround will inform SDR reading to
713 stop reading after a known maximum numer of SDR records have been read.
714 This will work around systems that have mis-implemented SDR reading
715 functions that. Those hitting this issue may see "SDR record count
716 invalid" errors. Issue observed on unspecified Inspur motherboard.
717 discretereading - This workaround option will allow analog sensor read‐
719 ings (i.e. rpm, degrees, etc.) to be read even if the event/reading
720 type code for the sensor is for a discrete sensor (i.e. assert vs.
721 deassert). This option works around poorly defined (and arguably ille‐
722 gal) SDR records that expect analog sensor readings to be read along‐
723 side discrete sensors. This option is confirmed to work around issues
724 on HP Proliant DL380 G7 and HP ProLiant ML310 G5 motherboards.
725 ignorescanningdisabled - This workaround option will allow sensor read‐
727 ings to be read even if the sensor scanning bit indicates a sensor is
728 disabled. This option works around motherboards that incorrectly indi‐
729 cate sensors as disabled. This may problem may exist on your mother‐
730 board if sensors are listed as "N/A" even if they should be available.
731 This option is confirmed to work around issues on Dell Poweredge 2900,
732 Dell Poweredge 2950, Dell Poweredge R410, Dell Poweredge R610, and HP
733 Integrity rx3600 motherboards.
734 assumebmcowner - This workaround option will allow sensor readings to
736 be read if the sensor owner is the BMC, but the reported sensor owner
737 is not the BMC. Typically, sensors owned by a non-BMC sensor owner must
738 be bridged (e.g. with the --bridge-sensors option), however if the non-
739 BMC sensor owner is invalid, bridging fails. This option works around
740 motherboards that incorrectly report an non-BMC sensor owner by always
741 assuming the sensor owner is the BMC. This problem may exist on your
742 motherboard if sensors are listed as "N/A" even if they should be
743 available. This option is confirmed to work around issues on Fujitsu
744 RX300 and Fujitsu RX300S2 motherboards.
745 ignoreauthcode - This workaround option will allow sensor readings to
747 be read if the remote machine is invalidly calculating authentication
748 codes (i.e. authentication hashes) when communicating over LAN. This
749 problem may exist on your system if the error "session timeout" errors
750 or there is an appearance of a hang. Users are cautioned on the use of
751 this option, as it removes an authentication check verifying the valid‐
752 ity of a packet. However, in most organizations, this is unlikely to be
753 a security issue. The ignoring of authentication packets is only lim‐
754 ited to the period in which sensor readings are done, and not for any
755 portion of the session authentication or session teardown. This option
756 is confirmed to work on Inventec 5441/Dell Xanadu II and Inventec
757 5442/Dell Xanadu III. (Note: On the above systems, this issue has only
758 been observed when the --bridge-sensors is used.)
759 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
761 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
762 2.0 unavailable" or "connection timeout" errors. This issue can be
763 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
764 --driver-type=LAN_2_0. Issue observed on HP Proliant DL 145.
765
767 The following motherboards are confirmed to have atleast some support
768 by the --interpret-oem-data option. While highly probable the OEM data
769 interpretations would work across other motherboards by the same manu‐
770 facturer, there are no guarantees. Some of the motherboards below may
771 be rebranded by vendors/distributors.
772 Dell Poweredge R210, Dell Poweredge R610, Dell Poweredge R710, Dell
774 Poweredge R720, Fujitsu iRMC S1 and iRMC S2 systems, HP Proliant DL160
775 G8, Intel S5500WB/Penguin Computing Relion 700, Intel S2600JF/Appro
776 512X, Intel S5000PAL, Intel Windmill, Quanta Winterfell, Supermicro
777 X7DBR-3, Supermicro X7DB8, Supermicro X8DTN, Supermicro X7SBI-LN4,
778 Supermicro X8DTH, Supermicro X8DTG, Supermicro X8DTU, Supermicro
779 X8DT3-LN4F, Supermicro X8DTU-6+, Supermicro X8DTL, Supermicro X8DTL-3F,
780 Supermicro X8SIL-F, Supermicro X9SCL, Supermicro X9SCM, Supermicro
781 X8DTN+-F, Supermicro X8SIE, Supermicro X9SCA-F-O, Supermicro H8DGU-F,
782 Supermicro X9DRi-F, Supermicro X9DRI-LN4F+, Supermicro X9SPU-F-O,
783 Supermicro X9SCM-iiF, Wiwynn Windmill, Wistron/Dell Poweredge C6220.
784
786 # ipmi-sensors
787 Show all sensors and readings on the local machine.
789 # ipmi-sensors --verbose
791 Show verbose sensors and readings on the local machine.
793 # ipmi-sensors --record-ids="7,11,102"
795 Show sensor record ids 7, 11, and 102 on the local machine.
797 # ipmi-sensors --sensor-types=fan
799 Show all sensors of type fan on the local machine.
801 # ipmi-sensors -h ahost -u myusername -p mypassword
803 Show all sensors on a remote machine using IPMI over LAN.
805 # ipmi-sensors -h mycluster[0-127] -u myusername -p mypassword
807 Show all sensors across a cluster using IPMI over LAN.
809
811 Upon successful execution, exit status is 0. On error, exit status is
812 1.
813 If multiple hosts are specified for communication, the exit status is 0
815 if and only if all targets successfully execute. Otherwise the exit
816 status is 1.
817
819 On older operating systems, if you input your username, password, and
820 other potentially security relevant information on the command line,
821 this information may be discovered by other users when using tools like
822 the ps(1) command or looking in the /proc file system. It is generally
823 more secure to input password information with options like the -P or
824 -K options. Configuring security relevant information in the FreeIPMI
825 configuration file would also be an appropriate way to hide this infor‐
826 mation.
827 In order to prevent brute force attacks, some BMCs will temporarily
829 "lock up" after a number of remote authentication errors. You may need
830 to wait awhile in order to this temporary "lock up" to pass before you
831 may authenticate again.
832 Some sensors may be output as not available (i.e. N/A) because the
834 owner of the sensor is not the BMC. To attempt to bridge sensors and
835 access sensors not on the BMC, users may wish to try the -b or
836 --bridge-sensors options.
837
839 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
840
842 Copyright © 2003-2015 FreeIPMI Core Team.
843 This program is free software; you can redistribute it and/or modify it
845 under the terms of the GNU General Public License as published by the
846 Free Software Foundation; either version 3 of the License, or (at your
847 option) any later version.
848
850 freeipmi(7), bmc-device(8), ipmi-config(8), freeipmi_interpret_sen‐
851 sor.conf(5)
852 http://www.gnu.org/software/freeipmi/
854IPMI Sensors version 1.5.7 2018-04-11 IPMI-SENSORS(8)