summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-seagate-vs-pcie-stats.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-seagate-vs-pcie-stats.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/nvme-seagate-vs-pcie-stats.txt b/Documentation/nvme-seagate-vs-pcie-stats.txt
new file mode 100644
index 0000000..86f87a3
--- /dev/null
+++ b/Documentation/nvme-seagate-vs-pcie-stats.txt
@@ -0,0 +1,38 @@
+nvme-seagate-vs-pcie-stats(1)
+=============================
+
+NAME
+----
+nvme-seagate-vs-pcie-stats - Retrieve Seagate vendor specific PCIe error
+statistics
+
+SYNOPSIS
+--------
+[verse]
+'nvme seagate vs-pcie-stats <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 it may be either an NVMe character device (ex: /dev/nvme0) or an
+nvme block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-o <fmt>::
+--output-format=<fmt>::
+ Output in binary format
+
+EXAMPLES
+--------
+Get the vendor specific PCIe error statistics for the specified device.
+
+------------
+# nvme seagate vs-pcie-stats /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite