summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-intel-temp-stats.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
commitdc597ce8df5ae6efd2728a2d7ba7d92486028f79 (patch)
tree55b9e9257eba4579667f9522368aa29f5be6754a /Documentation/nvme-intel-temp-stats.txt
parentInitial commit. (diff)
downloadnvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.tar.xz
nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.zip
Adding upstream version 1.12.upstream/1.12
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-intel-temp-stats.txt')
-rw-r--r--Documentation/nvme-intel-temp-stats.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/Documentation/nvme-intel-temp-stats.txt b/Documentation/nvme-intel-temp-stats.txt
new file mode 100644
index 0000000..656422f
--- /dev/null
+++ b/Documentation/nvme-intel-temp-stats.txt
@@ -0,0 +1,51 @@
+nvme-intel-temp-stats(1)
+========================
+
+NAME
+----
+nvme-intel-temp-stats - Send NVMe SMART log page request, returns result and log
+
+SYNOPSIS
+--------
+[verse]
+'nvme intel temp-stats' <device> [--raw-binary | -b]
+
+DESCRIPTION
+-----------
+Retrieves the NVMe Intel Additional SMART log page from the device and
+provides the returned structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the returned smart log structure may be returned in one of
+several ways depending on the option flags; the structure may parsed by
+the program and printed in a readable format or the raw buffer may be
+printed to stdout for another program to parse.
+
+OPTIONS
+-------
+-b::
+--raw-binary::
+ Print the raw temperature stats log buffer to stdout.
+
+EXAMPLES
+--------
+* Print the temperature stats log page in a human readable format:
++
+------------
+# nvme intel temp-stats /dev/nvme0
+------------
++
+
+* Print the raw SMART log to a file:
++
+------------
+# nvme intel temp-stats /dev/nvme0 --raw-binary > temp_stats_log.raw
+------------
++
+It is probably a bad idea to not redirect stdout when using this mode.
+
+NVME
+----
+Part of the nvme-user suite