summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-attach-ns.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-attach-ns.175
1 files changed, 75 insertions, 0 deletions
diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1
new file mode 100644
index 0000000..0af22ae
--- /dev/null
+++ b/Documentation/nvme-attach-ns.1
@@ -0,0 +1,75 @@
+'\" t
+.\" Title: nvme-attach-ns
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 04/24/2020
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "NVME\-ATTACH\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-attach-ns \- Send NVMe attach namespace, return result\&.
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme attach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, sends the nvme namespace attach command for the provided namespace identifier, attaching to the provided list of controller identifiers\&.
+.SH "OPTIONS"
+.PP
+\-n <nsid>, \-\-namespace\-id=<nsid>
+.RS 4
+The namespace identifier to attach\&.
+.RE
+.PP
+\-c <ctrl\-list,>, \-controllers=<ctrl\-list,>
+.RS 4
+The comma separated list of controller identifiers to attach the namesapce too\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Attach namspace to the controller:
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21
+.fi
+.if n \{\
+.RE
+.\}
+.SH "NVME"
+.sp
+Part of the nvme\-user suite