summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-seagate-vs-internal-log.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-seagate-vs-internal-log.txt')
-rw-r--r--Documentation/nvme-seagate-vs-internal-log.txt43
1 files changed, 43 insertions, 0 deletions
diff --git a/Documentation/nvme-seagate-vs-internal-log.txt b/Documentation/nvme-seagate-vs-internal-log.txt
new file mode 100644
index 0000000..4a895bc
--- /dev/null
+++ b/Documentation/nvme-seagate-vs-internal-log.txt
@@ -0,0 +1,43 @@
+nvme-seagate-vs-internal-log(1)
+===============================
+
+NAME
+----
+nvme-seagate-vs-internal-log - Retrieve Seagate vendor specific
+Controller-Initiated Telemetry in binary
+
+SYNOPSIS
+--------
+[verse]
+'nvme seagate vs-internal-log <device> [OPTIONS]'
+
+DESCRIPTION
+-----------
+This command will only work on Seagate devices supporting this feature. Not
+all commands work across all product families.
+
+The '<device>' parameter is mandatory and may be either an NVMe character device
+(ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-n <NUM>::
+--namespace-id=<NUM>::
+ Desired namespace
+
+-f <FILE>::
+--dump-file=<FILE>::
+ Dump file
+
+EXAMPLES
+--------
+Get the Seagate vendor specific Controller-Initiated telemetry log for the
+specified device.
+
+------------
+# nvme seagate vs-internal-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite