summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-subsystem-reset.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-subsystem-reset.txt')
-rw-r--r--Documentation/nvme-subsystem-reset.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/nvme-subsystem-reset.txt b/Documentation/nvme-subsystem-reset.txt
new file mode 100644
index 0000000..cc3a139
--- /dev/null
+++ b/Documentation/nvme-subsystem-reset.txt
@@ -0,0 +1,40 @@
+nvme-subsystem-reset(1)
+=======================
+
+NAME
+----
+nvme-subsystem-reset - Reset the nvme subsystem.
+
+SYNOPSIS
+--------
+[verse]
+'nvme subsystem-reset' <device>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Requests NVMe subsystem 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 subsystem.
++
+------------
+# nvme subsystem-reset /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite