1ISENSOR(8)                  System Manager's Manual                 ISENSOR(8)
2
3
4

NAME

6       ipmiutil_sensor - show Sensor Data Records
7

SYNOPSIS

9       ipmiutil  sensor  [-abcdefgjkmpqrstuvwxL  -i id -n snum -h tval -l tval
10       -NUPREFJTVYZ]
11
12

DESCRIPTION

14       ipmiutil sensor is a program that uses IPMI commands to show and decode
15       Sensor  Data Records and current sensor readings for all sensors in the
16       system.  This  utility  can  use  either  the  /dev/ipmi0  driver  from
17       OpenIPMI,  the /dev/imb driver from Intel, the /dev/ipmikcs driver from
18       valinux, direct user-space IOs, or the IPMI LAN interface if -N.
19
20       Note that this utility by default only  displays  Sensor  Data  Records
21       reported  by from the Baseboard Management Controller.  To show sensors
22       for other controllers, see options -b and -m below.
23
24

OPTIONS

26       Command line options are described below.
27
28       -a snum
29              ReArms the sensor number for events
30
31       -b     Shows SDRs for Bladed (PICMG or ATCA) systems by traversing  the
32              child MCs (same as -e).
33
34       -c     Show  sensor list in a simpler/Canonical format without uninter‐
35              preted binary values.  Only the user-friendly interpreted sensor
36              information is shown.  (same as -s).
37
38       -d <file>
39              Dump the SDRs to a specified binary file.  This file can be used
40              with -j to jumpstart getting the sensor readings.
41
42       -e     Show Every SDR in a bladed system by traversing  the  child  MCs
43              (same as -b).
44
45       -f <file>
46              Restore  the  SDRs from the specified binary File.  This is nor‐
47              mally only done with the initial factory provisioning.
48
49       -g sens_type
50              Shows only those SDRs matching the given sensor type group.  The
51              sens_type  string can be "fan", "temp", "voltage", or any string
52              or substring matching those in the IPMI 2.0 Table 42-3 for  Sen‐
53              sor  Types.   Multiple types can be listed, separated by a comma
54              (,) but no spaces.
55
56       -h tval
57              Highest threshold value to set for the specified  sensor.   This
58              tval  can  be  in decimal, or of the form 0x1a, to match the raw
59              reading value shown by sensor following the " =  ".   The  value
60              passed is set as the non-critical threshold value, with the more
61              critical ones set by the utility as incrementally  lower.   This
62              simplifies  the  interface and ensures that the threshold values
63              do not get out of order.  This requires  specifying  the  sensor
64              number via -n.
65
66       -i ID  Show  or set only the sensor Index corresponding to ID, where ID
67              is the hex ID of the SDR as shown in  the  sensor  output  under
68              "_ID_".   The  ID  argument  can be one hex number (e.g. 0x0e or
69              0e), or  a  range  of  hex  numbers  (e.g.  0e-1a  or  1a,2a  or
70              0x0e-0x2a).  This is useful to repeatedly view just a few sensor
71              readings for changes, or to set just one sensor quickly  without
72              reading all of the SDRs.
73
74       -j file
75              Jump-start  by  caching  the SDRs from a file.  This uses an SDR
76              binary file to read the SDRs, so that only the  sensor  readings
77              need  to be read from the firmware.  This avoids getting the SDR
78              reservation and reading each SDR, so it makes getting the sensor
79              readings  more  efficient.   The  SDR binary file can be created
80              using the -d option to dump the SDRs to a file, or -j  will  try
81              to create the file if not there.
82
83       -k K   When  looping with -L, wait K seconds between loops.  Default is
84              1 second.
85
86       -l tval
87              Lowest threshold value to set for the  specified  sensor.   This
88              tval  can  be  in decimal, or of the form 0x1a, to match the raw
89              reading value shown by sensor following the " =  ".   The  value
90              passed is set as the non-critical threshold value, with the more
91              critical ones set by the utility as incrementally higher.   This
92              simplifies  the  interface and ensures that the threshold values
93              do not get out of order.  This requires  specifying  the  sensor
94              number via -n.
95
96       -m 002000s
97              Show  SDRs for a specific MC (e.g. bus 00, sa 20, lun 00).  This
98              could be used for PICMG or ATCA  blade  systems.   The  trailing
99              character,  if present, indicates SMI addressing if 's', or IPMB
100              addressing if 'i' or not present.
101
102       -n snum
103              Number of the sensor to set.  This num can be in decimal, or  of
104              the  form 0x1a, to match the value shown by sensor following the
105              "snum" tag.  This is required if setting  hi/lo  thresholds  via
106              -h/-l.
107
108       -o     Output  the memory DIMM information from SMBIOS, including size.
109              Not available if using IPMI LAN via -N.  Sample output:
110              Memory Device (0,0): DIMM_A1 : size=2048MB
111              Memory Device (0,1): DIMM_A2 : not present
112
113       -p     Persist the threshold being set (as specified  via  -l  or  -h).
114              This   writes   a   "sensor   -i"   script   line  to  the  file
115              /usr/share/ipmiutil/thresholds.sh, which can then be executed at
116              each  reboot  by  starting the /etc/init.d/ipmi_port service for
117              the desired runlevels.  For Windows,  the  filename  is  thresh‐
118              olds.cmd.
119
120       -q     Show threshold values in d:d:d format.  Thresholds are shown for
121              each sensor in short format with ':' delimiters, which is useful
122              as an example for setting thresholds with '-u'.
123
124       -r     Show Raw SDR bytes also.
125
126       -s     Show  sensor list in a simpler/canonical format without uninter‐
127              preted binary values.  Only the user-friendly interpreted sensor
128              information is shown.  (same as -c).
129
130       -t     Show any Thresholds for each sensor also, in text format.
131
132       -u     Set  unique  threshold  values.   The  values are specified in a
133              string of threshold values.  It can be in raw hex characters  or
134              in  float  values.  All 6 possible thresholds must be specified,
135              but only the ones  that  are  valid  for  this  sensor  will  be
136              applied. These values are validated for ordering.  For example:
137                -u 6:5:4:60:65:69 (float) or
138                -u 0x0605043c4145 (raw hex)
139               would   mean   0x06=noncrit_lo,  0x05=crit_lo,  0x04=nonrec_lo,
140              0x3c=noncrit_hi, 0x41=crit_hi, 0x45=nonrec_hi.
141
142       -v     Show Verbose output, including volatile thresholds, SDR  thresh‐
143              olds, max/min, hysteresis, and BMC_TAM decoding.
144
145       -w     Wrap  the threshold data onto the same line as the sensor.  This
146              may be convenient for scripting.
147
148       -x     Causes eXtra debug messages to be displayed.
149
150       -L n   Loop n times every K seconds. Default is one loop and K defaults
151              to  1  second.   See  option  -k to change K seconds if desired.
152              This is useful along with -i or -g to read some sensors as  they
153              change.  Using -j with this option makes run it quicker.
154
155       -N nodename
156              Nodename  or IP address of the remote target system.  If a node‐
157              name is specified, IPMI LAN interface is  used.   Otherwise  the
158              local system management interface is used.
159
160       -P/-R rmt_pswd
161              Remote  password  for the nodename given.  The default is a null
162              password.
163
164       -U rmt_user
165              Remote username for the nodename given.  The default is  a  null
166              username.
167
168       -E     Use the remote password from Environment variable IPMI_PASSWORD.
169
170       -F drv_t
171              Force  the  driver  type  to one of the followng: imb, va, open,
172              gnu, landesk, lan, lan2, lan2i, kcs, smb.  Note that lan2i means
173              lan2  with  intelplus.   The  default is to detect any available
174              driver type and use it.
175
176       -J     Use  the  specified  LanPlus   cipher   suite   (0   thru   17):
177              0=none/none/none,       1=sha1/none/none,      2=sha1/sha1/none,
178              3=sha1/sha1/cbc128,  4=sha1/sha1/xrc4_128,  5=sha1/sha1/xrc4_40,
179              6=md5/none/none, ... 14=md5/md5/xrc4_40.  Default is 3.
180
181       -T     Use  a  specified  IPMI  LAN Authentication Type: 0=None, 1=MD2,
182              2=MD5, 4=Straight Password, 5=OEM.
183
184       -V     Use a specified IPMI  LAN  privilege  level.  1=Callback  level,
185              2=User level, 3=Operator level, 4=Administrator level (default),
186              5=OEM level.
187
188       -Y     Yes, do prompt the  user  for  the  IPMI  LAN  remote  password.
189              Alternatives for the password are -E or -P.
190
191       -Z     Set the slave address for a local MC
192
193

EXAMPLES

195       ipmiutil sensor sample output is below.
196       ipmiutil ver 2.21
197       sensor: version 2.21
198       -- BMC version 0.17, IPMI version 2.0
199       _ID_ SDR_Type_xx ET Own Typ S_Num Sens_Description   Hex & Interp Read‐
200       ing
201       000b SDR Full 01 01 20 a 01 snum 30 Baseboard Temp   =  2e  OK    46.00
202       degrees C
203       000e  SDR Full 01 01 20 m 04 snum 50 Fan 1A           = 6f OK   7659.00
204       RPM
205       0042 SDR Comp 02 6f 20 a 21 snum e0 DIMM 1A           =  00  c0  04  00
206       Present
207       004e SDR FRU  11 1b dev: 20 03 80 00 0a 01 Pwr Supply 1 FRU
208       0050 SDR IPMB 12 1b dev: 20 00 bf 07 01 Basbrd Mgmt Ctlr
209       0051 SDR OEM  c0 09 Intel: 02 02 00 01 70 71
210       0065 SDR OEM  c0 11 Intel: SDR Package 17
211       [...]
212
213       Output Columns:
214       _ID_:  This  is  an SDR ID or index number, in hex.  This may vary from
215       chassis to chassis.
216       SDR_Type_xx: This shows the SDR Type and its hex representation.   Some
217       SDR types have a custom display.  The OEM SDRs only show the OEM vendor
218       by IANA number and then usually the data is listed in hex.
219       ET: For Full or Comp SDRs, this shows the Event Type.  For other  SDRs,
220       this shows the size of the SDR entry in hex (Sz).
221       Own: This is the hex slave address of the SDR Owner, usually 20 if BMC.
222       a/m: This indicates whether this sensor is either automatically or man‐
223       ually rearmed, respectively.
224       Typ: This is the Sensor Type as defined in Table 42-3 of the  IPMI  2.0
225       spec.  (01 = Temperature, 02 = Voltage, 03 = Current, 04 = Fan, etc.)
226       S_Num:  This  is  the  sensor  number  in hex.  This remains consistent
227       across baseboards of the same type.  The output can be parsed with  the
228       "snum" delimiter to extract this value.
229       Sens_Description:  This  is  the text description of this SDR, which is
230       stored within the SDR on the BMC.
231       Hex & Interp Reading: This is the raw hex value returned by  GetSensor‐
232       Reading, and its interpreted meaning.
233
234
235

SEE ALSO

237       ipmiutil(8)   ialarms(8)  iconfig(8)  icmd(8)  idiscover(8)  ievents(8)
238       ifru(8) igetevent(8) ihealth(8) ilan(8)  ireset(8)  isel(8)  iserial(8)
239       isol(8) iwdt(8)
240
241

WARNINGS

243       See http://ipmiutil.sourceforge.net/ for the latest version of ipmiutil
244       and any bug fix list.
245
246
248       Copyright (C) 2009  Kontron America, Inc.
249
250       See the file COPYING in the distribution  for  more  details  regarding
251       redistribution.
252
253       This  utility  is  distributed  in the hope that it will be useful, but
254       WITHOUT ANY WARRANTY.
255
256

AUTHOR

258       Andy Cress <arcress at users.sourceforge.net>
259
260
261
262
263                           Version 1.6: 09 Nov 2011                 ISENSOR(8)
Impressum