summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-reset.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-reset.txt')
-rw-r--r--Documentation/nvme-reset.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/Documentation/nvme-reset.txt b/Documentation/nvme-reset.txt
new file mode 100644
index 0000000..20fcbb1
--- /dev/null
+++ b/Documentation/nvme-reset.txt
@@ -0,0 +1,39 @@
+nvme-reset(1)
+=============
+
+NAME
+----
+nvme-reset - Reset the nvme controller.
+
+SYNOPSIS
+--------
+[verse]
+'nvme reset' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Requests NVMe controller reset. The <device> param is mandatory and must
+be an NVMe character device (ex: /dev/nvme0).
+
+OPTIONS
+-------
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Resets the controller.
++
+------------
+# nvme reset /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite