summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-attach-ns.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-attach-ns.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/Documentation/nvme-attach-ns.txt b/Documentation/nvme-attach-ns.txt
new file mode 100644
index 0000000..a5d3471
--- /dev/null
+++ b/Documentation/nvme-attach-ns.txt
@@ -0,0 +1,39 @@
+nvme-attach-ns(1)
+=================
+
+NAME
+----
+nvme-attach-ns - Send NVMe attach namespace, return result.
+
+SYNOPSIS
+--------
+[verse]
+'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the nvme namespace attach command for
+the provided namespace identifier, attaching to the provided list of
+controller identifiers.
+
+OPTIONS
+-------
+-n <nsid>::
+--namespace-id=<nsid>::
+ The namespace identifier to attach.
+
+-c <ctrl-list,>::
+-controllers=<ctrl-list,>::
+ The comma separated list of controller identifiers to attach
+ the namesapce too.
+
+EXAMPLES
+--------
+ Attach namspace to the controller:
+
+ # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21
+
+NVME
+----
+Part of the nvme-user suite