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 is‐
34 sues. 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 re‐
72 quests 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. If specifying an IPv6 address and port,
81 use the format [ADDRESS]:PORT.
82 -u USERNAME, --username=USERNAME
84 Specify the username to use when authenticating with the remote
85 host. If not specified, a null (i.e. anonymous) username is as‐
86 sumed. The user must have atleast OPERATOR privileges in order
87 for this tool to operate fully.
88 -p PASSWORD, --password=PASSWORD
90 Specify the password to use when authenticationg with the remote
91 host. If not specified, a null password is assumed. Maximum
92 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
93 -P, --password-prompt
95 Prompt for password to avoid possibility of listing it in
96 process lists.
97 -k K_G, --k-g=K_G
99 Specify the K_g BMC key to use when authenticating with the re‐
100 mote host for IPMI 2.0. If not specified, a null key is assumed.
101 To input the key in hexadecimal form, prefix the string with
102 '0x'. E.g., the key 'abc' can be entered with the either the
103 string 'abc' or the string '0x616263'
104 -K, --k-g-prompt
106 Prompt for k-g to avoid possibility of listing it in process
107 lists.
108 --session-timeout=MILLISECONDS
110 Specify the session timeout in milliseconds. Defaults to 20000
111 milliseconds (20 seconds) if not specified.
112 --retransmission-timeout=MILLISECONDS
114 Specify the packet retransmission timeout in milliseconds. De‐
115 faults to 1000 milliseconds (1 second) if not specified. The re‐
116 transmission timeout cannot be larger than the session timeout.
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 OP‐
173 ERATOR 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 de‐
223 faults).
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 ex‐
229 cluded (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 en‐
263 tries shared by a SDR entry. By setting this option, each sensor
264 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 ig‐
282 nored 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 de‐
293 termined by the configuration file /etc/freeipmi//freeipmi_in‐
294 terpret_sensor.conf. See freeipmi_interpret_sensor.conf(5) for
295 more information. This option gives identical output to the
296 sensor state previously output by ipmimonitoring(8).
297 --sensor-state-config-file=FILE
299 Specify an alternate sensor state configuration file. Option ig‐
300 nored if --output-sensor-state not specified.
301 --entity-sensor-names
303 Output sensor names prefixed with their entity id and instance
304 number when appropriate. This may be necessary on some mother‐
305 boards to help identify what sensors are referencing. For exam‐
306 ple, a motherboard may have multiple sensors named 'TEMP'. The
307 entity id and instance number may help clarify which sensor
308 refers to "Processor 1" vs. "Processor 2".
309 --output-sensor-thresholds
311 Output sensor thresholds in output. This will add columns to the
312 default output for lower non-recoverable, lower critical, lower
313 non-critical, upper non-critical, upper critical, and upper non-
314 recoverable thresholds.
315 --no-sensor-type-output
317 Do not show sensor type output for each entry. On many systems,
318 the sensor type is redundant to the name of the sensor. This can
319 especially be true if --entity-sensor-names is specified. If
320 the sensor name is sufficient, or if the sensor type is of no
321 interest to the user, this option can be specified to condense
322 output.
323 --comma-separated-output
325 Output fields in comma separated format.
326 --no-header-output
328 Do not output column headers. May be useful in scripting.
329 --non-abbreviated-units
331 Output non-abbreviated units (e.g. 'Amps' instead of 'A'). May
332 aid in disambiguation of units (e.g. 'C' for Celsius or
333 Coulombs).
334 --legacy-output
336 Output in legacy format. Newer options may not be applicable to
337 legacy output.
338 --ipmimonitoring-legacy-output
340 Output legacy format of legacy ipmimonitoring tool. Newer op‐
341 tions may not be applicable to legacy output.
342
344 This tool requires access to the sensor data repository (SDR) cache for
345 general operation. By default, SDR data will be downloaded and cached
346 on the local machine. The following options apply to the SDR cache.
347 --flush-cache
349 Flush a cached version of the sensor data repository (SDR)
350 cache. The SDR is typically cached for faster subsequent access.
351 However, it may need to be flushed and re-generated if the SDR
352 has been updated on a system.
353 --quiet-cache
355 Do not output information about cache creation/deletion. May be
356 useful in scripting.
357 --sdr-cache-recreate
359 If the SDR cache is out of date or invalid, automatically recre‐
360 ate the sensor data repository (SDR) cache. This option may be
361 useful for scripting purposes.
362 --sdr-cache-file=FILE
364 Specify a specific sensor data repository (SDR) cache file to be
365 stored or read from. If this option is used when multiple hosts
366 are specified, the same SDR cache file will be used for all
367 hosts.
368 --sdr-cache-directory=DIRECTORY
370 Specify an alternate directory for sensor data repository (SDR)
371 caches to be stored or read from. Defaults to the home directory
372 if not specified.
373
375 By IPMI definition, all IPMI times and timestamps are stored in local‐
376 time. However, in many situations, the timestamps will not be stored in
377 localtime. Whether or not a system truly stored the timestamps in lo‐
378 caltime varies on many factors, such as the vendor, BIOS, and operating
379 system. The following options will allow the user to adjust the inter‐
380 pretation of the stored timestamps and how they should be output.
381 --utc-to-localtime
383 Assume all times are reported in UTC time and convert the time
384 to localtime before being output.
385 --localtime-to-utc
387 Convert all localtime timestamps to UTC before being output.
388 --utc-offset=SECONDS
390 Specify a specific UTC offset in seconds to be added to time‐
391 stamps. Value can range from -86400 to 86400 seconds. Defaults
392 to 0.
393
395 The following options manipulate hostranged output. See HOSTRANGED SUP‐
396 PORT below for additional information on hostranges.
397 -B, --buffer-output
399 Buffer hostranged output. For each node, buffer standard output
400 until the node has completed its IPMI operation. When specifying
401 this option, data may appear to output slower to the user since
402 the the entire IPMI operation must complete before any data can
403 be output. See HOSTRANGED SUPPORT below for additional informa‐
404 tion.
405 -C, --consolidate-output
407 Consolidate hostranged output. The complete standard output from
408 every node specified will be consolidated so that nodes with
409 identical output are not output twice. A header will list those
410 nodes with the consolidated output. When this option is speci‐
411 fied, no output can be seen until the IPMI operations to all
412 nodes has completed. If the user breaks out of the program
413 early, all currently consolidated output will be dumped. See
414 HOSTRANGED SUPPORT below for additional information.
415 -F NUM, --fanout=NUM
417 Specify multiple host fanout. A "sliding window" (or fanout) al‐
418 gorithm is used for parallel IPMI communication so that slower
419 nodes or timed out nodes will not impede parallel communication.
420 The maximum number of threads available at the same time is lim‐
421 ited by the fanout. The default is 64.
422 -E, --eliminate
424 Eliminate hosts determined as undetected by ipmidetect. This
425 attempts to remove the common issue of hostranged execution tim‐
426 ing out due to several nodes being removed from service in a
427 large cluster. The ipmidetectd daemon must be running on the
428 node executing the command.
429 --always-prefix
431 Always prefix output, even if only one host is specified or com‐
432 municating in-band. This option is primarily useful for script‐
433 ing purposes. Option will be ignored if specified with the -C
434 option.
435
437 Multiple hosts can be input either as an explicit comma separated lists
438 of hosts or a range of hostnames in the general form: prefix[n-m,l-
439 k,...], where n < m and l < k, etc. The later form should not be con‐
440 fused with regular expression character classes (also denoted by []).
441 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
442 sents a degenerate range: foo19.
443 This range syntax is meant only as a convenience on clusters with a
445 prefixNN naming convention and specification of ranges should not be
446 considered necessary -- the list foo1,foo9 could be specified as such,
447 or by the range foo[1,9].
448 Some examples of range usage follow:
450 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
451 foo[7,9-10] instead of foo7,foo9,foo10
452 foo[0-3] instead of foo0,foo1,foo2,foo3
453 As a reminder to the reader, some shells will interpret brackets ([ and
455 ]) for pattern matching. Depending on your shell, it may be necessary
456 to enclose ranged lists within quotes.
457 When multiple hosts are specified by the user, a thread will be exe‐
459 cuted for each host in parallel up to the configured fanout (which can
460 be adjusted via the -F option). This will allow communication to large
461 numbers of nodes far more quickly than if done in serial.
462 By default, standard output from each node specified will be output
464 with the hostname prepended to each line. Although this output is read‐
465 able in many situations, it may be difficult to read in other situa‐
466 tions. For example, output from multiple nodes may be mixed together.
467 The -B and -C options can be used to change this default.
468 In-band IPMI Communication will be used when the host "localhost" is
470 specified. This allows the user to add the localhost into the hos‐
471 tranged output.
472
474 Most often, IPMI problems are due to configuration problems.
475 IPMI over LAN problems involve a misconfiguration of the remote ma‐
477 chine's BMC. Double check to make sure the following are configured
478 properly in the remote machine's BMC: IP address, MAC address, subnet
479 mask, username, user enablement, user privilege, password, LAN privi‐
480 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
481 connections, double check to make sure the cipher suite privilege(s)
482 and K_g key are configured properly. The ipmi-config(8) tool can be
483 used to check and/or change these configuration settings.
484 Inband IPMI problems are typically caused by improperly configured
486 drivers or non-standard BMCs.
487 In addition to the troubleshooting tips below, please see WORKAROUNDS
489 below to also if there are any vendor specific bugs that have been dis‐
490 covered and worked around.
491 Listed below are many of the common issues for error messages. For ad‐
493 ditional support, please e-mail the <freeipmi-users@gnu.org> mailing
494 list.
495 "username invalid" - The username entered (or a NULL username if none
497 was entered) is not available on the remote machine. It may also be
498 possible the remote BMC's username configuration is incorrect.
499 "password invalid" - The password entered (or a NULL password if none
501 was entered) is not correct. It may also be possible the password for
502 the user is not correctly configured on the remote BMC.
503 "password verification timeout" - Password verification has timed out.
505 A "password invalid" error (described above) or a generic "session
506 timeout" (described below) occurred. During this point in the protocol
507 it cannot be differentiated which occurred.
508 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was en‐
510 tered) is not correct. It may also be possible the K_g key is not cor‐
511 rectly configured on the remote BMC.
512 "privilege level insufficient" - An IPMI command requires a higher user
514 privilege than the one authenticated with. Please try to authenticate
515 with a higher privilege. This may require authenticating to a different
516 user which has a higher maximum privilege.
517 "privilege level cannot be obtained for this user" - The privilege
519 level you are attempting to authenticate with is higher than the maxi‐
520 mum allowed for this user. Please try again with a lower privilege. It
521 may also be possible the maximum privilege level allowed for a user is
522 not configured properly on the remote BMC.
523 "authentication type unavailable for attempted privilege level" - The
525 authentication type you wish to authenticate with is not available for
526 this privilege level. Please try again with an alternate authentication
527 type or alternate privilege level. It may also be possible the avail‐
528 able authentication types you can authenticate with are not correctly
529 configured on the remote BMC.
530 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
532 ticate with is not available on the remote BMC. Please try again with
533 an alternate cipher suite id. It may also be possible the available ci‐
534 pher suite ids are not correctly configured on the remote BMC.
535 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote ma‐
537 chine. Please try to use IPMI 1.5 instead.
538 "connection timeout" - Initial IPMI communication failed. A number of
540 potential errors are possible, including an invalid hostname specified,
541 an IPMI IP address cannot be resolved, IPMI is not enabled on the re‐
542 mote server, the network connection is bad, etc. Please verify configu‐
543 ration and connectivity.
544 "session timeout" - The IPMI session has timed out. Please reconnect.
546 If this error occurs often, you may wish to increase the retransmission
547 timeout. Some remote BMCs are considerably slower than others.
548 "device not found" - The specified device could not be found. Please
550 check configuration or inputs and try again.
551 "driver timeout" - Communication with the driver or device has timed
553 out. Please try again.
554 "message timeout" - Communication with the driver or device has timed
556 out. Please try again.
557 "BMC busy" - The BMC is currently busy. It may be processing informa‐
559 tion or have too many simultaneous sessions to manage. Please wait and
560 try again.
561 "could not find inband device" - An inband device could not be found.
563 Please check configuration or specify specific device or driver on the
564 command line.
565 "driver timeout" - The inband driver has timed out communicating to the
567 local BMC or service processor. The BMC or service processor may be
568 busy or (worst case) possibly non-functioning.
569 "internal IPMI error" - An IPMI error has occurred that FreeIPMI does
571 not know how to handle. Please e-mail <freeipmi-users@gnu.org> to re‐
572 port the issue.
573 "sensor config file parse error" - A parse error was found in the sen‐
575 sor interpretation configuration file. Please see freeipmi_inter‐
576 pret_sensor.conf(5).
577
579 With so many different vendors implementing their own IPMI solutions,
580 different vendors may implement their IPMI protocols incorrectly. The
581 following describes a number of workarounds currently available to han‐
582 dle discovered compliance issues. When possible, workarounds have been
583 implemented so they will be transparent to the user. However, some will
584 require the user to specify a workaround be used via the -W option.
585 The hardware listed below may only indicate the hardware that a problem
587 was discovered on. Newer versions of hardware may fix the problems in‐
588 dicated below. Similar machines from vendors may or may not exhibit the
589 same problems. Different vendors may license their firmware from the
590 same IPMI firmware developer, so it may be worthwhile to try work‐
591 arounds listed below even if your motherboard is not listed.
592 If you believe your hardware has an additional compliance issue that
594 needs a workaround to be implemented, please contact the FreeIPMI main‐
595 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
596 assumeio - This workaround flag will assume inband interfaces communi‐
598 cate with system I/O rather than being memory-mapped. This will work
599 around systems that report invalid base addresses. Those hitting this
600 issue may see "device not supported" or "could not find inband device"
601 errors. Issue observed on HP ProLiant DL145 G1.
602 spinpoll - This workaround flag will inform some inband drivers (most
604 notably the KCS driver) to spin while polling rather than putting the
605 process to sleep. This may significantly improve the wall clock running
606 time of tools because an operating system scheduler's granularity may
607 be much larger than the time it takes to perform a single IPMI message
608 transaction. However, by spinning, your system may be performing less
609 useful work by not contexting out the tool for a more useful task.
610 authcap - This workaround flag will skip early checks for username ca‐
612 pabilities, authentication capabilities, and K_g support and allow IPMI
613 authentication to succeed. It works around multiple issues in which the
614 remote system does not properly report username capabilities, authenti‐
615 cation capabilities, or K_g status. Those hitting this issue may see
616 "username invalid", "authentication type unavailable for attempted
617 privilege level", or "k_g invalid" errors. Issue observed on Asus
618 P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
619 2200/4150/4450 with ELOM.
620 nochecksumcheck - This workaround flag will tell FreeIPMI to not check
622 the checksums returned from IPMI command responses. It works around
623 systems that return invalid checksums due to implementation errors, but
624 the packet is otherwise valid. Users are cautioned on the use of this
625 option, as it removes validation of packet integrity in a number of
626 circumstances. However, it is unlikely to be an issue in most situa‐
627 tions. Those hitting this issue may see "connection timeout", "session
628 timeout", or "password verification timeout" errors. On IPMI 1.5 con‐
629 nections, the "noauthcodecheck" workaround may also needed too. Issue
630 observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro
631 X9DRFR.
632 idzero - This workaround flag will allow empty session IDs to be ac‐
634 cepted by the client. It works around IPMI sessions that report empty
635 session IDs to the client. Those hitting this issue may see "session
636 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
637 unexpectedauth - This workaround flag will allow unexpected non-null
639 authcodes to be checked as though they were expected. It works around
640 an issue when packets contain non-null authentication data when they
641 should be null due to disabled per-message authentication. Those hit‐
642 ting this issue may see "session timeout" errors. Issue observed on
643 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
644 forcepermsg - This workaround flag will force per-message authentica‐
646 tion to be used no matter what is advertised by the remote system. It
647 works around an issue when per-message authentication is advertised as
648 disabled on the remote system, but it is actually required for the pro‐
649 tocol. Those hitting this issue may see "session timeout" errors. Is‐
650 sue observed on IBM eServer 325.
651 endianseq - This workaround flag will flip the endian of the session
653 sequence numbers to allow the session to continue properly. It works
654 around IPMI 1.5 session sequence numbers that are the wrong endian.
655 Those hitting this issue may see "session timeout" errors. Issue ob‐
656 served on some Sun ILOM 1.0/2.0 (depends on service processor endian).
657 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
659 the authentication codes returned from IPMI 1.5 command responses. It
660 works around systems that return invalid authentication codes due to
661 hashing or implementation errors. Users are cautioned on the use of
662 this option, as it removes an authentication check verifying the valid‐
663 ity of a packet. However, in most organizations, this is unlikely to be
664 a security issue. Those hitting this issue may see "connection time‐
665 out", "session timeout", or "password verification timeout" errors.
666 Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winter‐
667 fell, and Wiwynn Windmill.
668 intel20 - This workaround flag will work around several Intel IPMI 2.0
670 authentication issues. The issues covered include padding of usernames,
671 and password truncation if the authentication algorithm is HMAC-
672 MD5-128. Those hitting this issue may see "username invalid", "password
673 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
674 with Intel Server Management Module (Professional Edition).
675 supermicro20 - This workaround flag will work around several Supermicro
677 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
678 firmware. The issues covered include handling invalid length authenti‐
679 cation codes. Those hitting this issue may see "password invalid" er‐
680 rors. Issue observed on Supermicro H8QME with SIMSO daughter card.
681 Confirmed fixed on newerver firmware.
682 sun20 - This workaround flag will work work around several Sun IPMI 2.0
684 authentication issues. The issues covered include invalid lengthed hash
685 keys, improperly hashed keys, and invalid cipher suite records. Those
686 hitting this issue may see "password invalid" or "bmc error" errors.
687 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
688 automatically includes the "opensesspriv" workaround.
689 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
691 2.0 connection protocol to workaround an invalid hashing algorithm used
692 by the remote system. The privilege level sent during the Open Session
693 stage of an IPMI 2.0 connection is used for hashing keys instead of the
694 privilege level sent during the RAKP1 connection stage. Those hitting
695 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
696 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
697 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
698 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta
699 QSSC-S4R/Appro GB812X-CN, and Dell C5220. This workaround is automati‐
700 cally triggered with the "sun20" workaround.
701 integritycheckvalue - This workaround flag will work around an invalid
703 integrity check value during an IPMI 2.0 session establishment when us‐
704 ing Cipher Suite ID 0. The integrity check value should be 0 length,
705 however the remote motherboard responds with a non-empty field. Those
706 hitting this issue may see "k_g invalid" errors. Issue observed on Su‐
707 permicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
708 700, and Intel S2600JF/Appro 512X.
709 assumemaxsdrrecordcount - This workaround will inform SDR reading to
711 stop reading after a known maximum number of SDR records have been
712 read. This will work around systems that have miss-implemented SDR
713 reading functions. Those hitting this issue may see "SDR record count
714 invalid" errors. Issue observed on unspecified Inspur motherboard.
715 discretereading - This workaround option will allow analog sensor read‐
717 ings (i.e. rpm, degrees, etc.) to be read even if the event/reading
718 type code for the sensor is for a discrete sensor (i.e. assert vs. de‐
719 assert). This option works around poorly defined (and arguably illegal)
720 SDR records that expect analog sensor readings to be read alongside
721 discrete sensors. This option is confirmed to work around issues on HP
722 Proliant DL380 G7 and HP ProLiant ML310 G5 motherboards.
723 ignorescanningdisabled - This workaround option will allow sensor read‐
725 ings to be read even if the sensor scanning bit indicates a sensor is
726 disabled. This option works around motherboards that incorrectly indi‐
727 cate sensors as disabled. This may problem may exist on your mother‐
728 board if sensors are listed as "N/A" even if they should be available.
729 This option is confirmed to work around issues on Dell Poweredge 2900,
730 Dell Poweredge 2950, Dell Poweredge R410, Dell Poweredge R610, and HP
731 Integrity rx3600 motherboards.
732 assumebmcowner - This workaround option will allow sensor readings to
734 be read if the sensor owner is the BMC, but the reported sensor owner
735 is not the BMC. Typically, sensors owned by a non-BMC sensor owner must
736 be bridged (e.g. with the --bridge-sensors option), however if the non-
737 BMC sensor owner is invalid, bridging fails. This option works around
738 motherboards that incorrectly report an non-BMC sensor owner by always
739 assuming the sensor owner is the BMC. This problem may exist on your
740 motherboard if sensors are listed as "N/A" even if they should be
741 available. This option is confirmed to work around issues on Fujitsu
742 RX300 and Fujitsu RX300S2 motherboards.
743 ignoreauthcode - This workaround option will allow sensor readings to
745 be read if the remote machine is invalidly calculating authentication
746 codes (i.e. authentication hashes) when communicating over LAN. This
747 problem may exist on your system if the error "session timeout" errors
748 or there is an appearance of a hang. Users are cautioned on the use of
749 this option, as it removes an authentication check verifying the valid‐
750 ity of a packet. However, in most organizations, this is unlikely to be
751 a security issue. The ignoring of authentication packets is only lim‐
752 ited to the period in which sensor readings are done, and not for any
753 portion of the session authentication or session teardown. This option
754 is confirmed to work on Inventec 5441/Dell Xanadu II and Inventec
755 5442/Dell Xanadu III. (Note: On the above systems, this issue has only
756 been observed when the --bridge-sensors is used.)
757 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
759 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
760 2.0 unavailable" or "connection timeout" errors. This issue can be
761 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
762 --driver-type=LAN_2_0. Issue observed on a number of HP and Supermicro
763 motherboards.
764
766 The following motherboards are confirmed to have atleast some support
767 by the --interpret-oem-data option. While highly probable the OEM data
768 interpretations would work across other motherboards by the same manu‐
769 facturer, there are no guarantees. Some of the motherboards below may
770 be rebranded by vendors/distributors.
771 Dell Poweredge R210, Dell Poweredge R610, Dell Poweredge R710, Dell
773 Poweredge R720, Fujitsu iRMC S1 and iRMC S2 systems, HP Proliant DL160
774 G8, Intel S5500WB/Penguin Computing Relion 700, Intel S2600JF/Appro
775 512X, Intel S2600GZ, Intel S2600WP, Intel S5000PAL, Intel Windmill,
776 Quanta Winterfell, Supermicro X7DBR-3, Supermicro X7DB8, Supermicro
777 X8DTN, Supermicro X7SBI-LN4, Supermicro X8DTH, Supermicro X8DTG, Super‐
778 micro X8DTU, Supermicro X8DT3-LN4F, Supermicro X8DTU-6+, Supermicro
779 X8DTL, Supermicro X8DTL-3F, Supermicro X8SIL-F, Supermicro X9SCL, Su‐
780 permicro X9SCM, Supermicro X8DTN+-F, Supermicro X8SIE, Supermicro
781 X9SCA-F-O, Supermicro H8DGU-F, Supermicro X9DRi-F, Supermicro X9DRI-
782 LN4F+, Supermicro X9SPU-F-O, Supermicro X9SCM-iiF, Wiwynn Windmill,
783 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.6.11 2023-06-07 IPMI-SENSORS(8)