summaryrefslogtreecommitdiff
path: root/doc/isensor.8
diff options
context:
space:
mode:
Diffstat (limited to 'doc/isensor.8')
-rw-r--r--doc/isensor.818
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/isensor.8 b/doc/isensor.8
index dcfdd1a..1345f58 100644
--- a/doc/isensor.8
+++ b/doc/isensor.8
@@ -2,7 +2,7 @@
.SH NAME
ipmiutil_sensor \- show Sensor Data Records
.SH SYNOPSIS
-.B "ipmiutil sensor [-abcdefgmpqrstuvwx -i id -n snum -h tval -l tval -NUPREFJTVY]"
+.B "ipmiutil sensor [-abcdefgjkmpqrstuvwxL -i id -n snum -h tval -l tval -NUPREFJTVY]"
.SH DESCRIPTION
.I ipmiutil sensor
@@ -29,7 +29,8 @@ Show sensor list in a simpler/Canonical format without uninterpreted binary
values. Only the user-friendly interpreted sensor information is shown.
(same as \-s).
.IP "-d <file>"
-Dump the SDRs to a specified binary file.
+Dump the SDRs to a specified binary file. This file can be used with -j to
+jumpstart getting the sensor readings.
.IP "-e"
Show Every SDR in a bladed system by traversing the child MCs (same as \-b).
.IP "-f <file>"
@@ -56,6 +57,15 @@ The ID argument can be one hex number (e.g. 0x0e or 0e), or a range of
hex numbers (e.g. 0e-1a or 1a,2a or 0x0e-0x2a).
This is useful to repeatedly view just a few sensor readings for changes,
or to set just one sensor quickly without reading all of the SDRs.
+.IP "-j file"
+Jump-start by caching the SDRs from a file. This uses an SDR binary file to
+read the SDRs, so that only the sensor readings need to be read from the
+firmware. This avoids getting the SDR reservation and reading each SDR, so
+it makes getting the sensor readings more efficient.
+The SDR binary file can be created using the \-d option to dump the SDRs
+to a file, or -j will try to create the file if not there.
+.IP "-k K"
+When looping with \-L, wait K seconds between loops. Default is 1 second.
.IP "-l tval"
Lowest threshold value to set for the specified sensor.
This tval can be in decimal, or of the form 0x1a,
@@ -86,7 +96,7 @@ Persist the threshold being set (as specified via \-l or \-h). This writes
a "sensor \-i" script line to the file /usr/share/ipmiutil/thresholds.sh,
which can then be executed at each reboot by starting the /etc/init.d/ipmi_port service for the desired runlevels. For Windows, the filename is thresholds.cmd.
.IP "-q"
-Show any thresholds for each sensor in short format with ':' delimiters, useful as an example for setting thresholds with '\-u'.
+Show threshold values in d:d:d format. Thresholds are shown for each sensor in short format with ':' delimiters, which is useful as an example for setting thresholds with '\-u'.
.IP "-r"
Show Raw SDR bytes also.
.IP "-s"
@@ -112,7 +122,7 @@ This may be convenient for scripting.
.IP "-x"
Causes eXtra debug messages to be displayed.
.IP "-L n"
-Loop n times. This is useful along with \-i. Default is one loop.
+Loop n times every K seconds. Default is one loop and K defaults to 1 second. See option \-k to change K seconds if desired. This is useful along with \-i or \-g to read some sensors as they change. Using \-j with this option makes run it quicker.
.IP "-N nodename"
Nodename or IP address of the remote target system. If a nodename is
specified, IPMI LAN interface is used. Otherwise the local system