summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-detach-ns.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-detach-ns.txt')
-rw-r--r--Documentation/nvme-detach-ns.txt47
1 files changed, 47 insertions, 0 deletions
diff --git a/Documentation/nvme-detach-ns.txt b/Documentation/nvme-detach-ns.txt
new file mode 100644
index 0000000..842889c
--- /dev/null
+++ b/Documentation/nvme-detach-ns.txt
@@ -0,0 +1,47 @@
+nvme-detach-ns(1)
+=================
+
+NAME
+----
+nvme-detach-ns - Send NVMe detach namespace, return result.
+
+SYNOPSIS
+--------
+[verse]
+'nvme detach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the nvme namespace detach command for
+the provided namespace identifier, attaching to the provided list of
+controller identifiers.
+
+OPTIONS
+-------
+-n <nsid>::
+--namespace-id=<nsid>::
+ The namespace identifier to detach.
+
+-c <ctrl-list,>::
+--controllers=<ctrl-list,>::
+ The comma separated list of controller identifiers to detach
+ the namespace from.
+
+-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
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite