diff options
Diffstat (limited to 'Documentation/nvme-create-ns.1')
-rw-r--r-- | Documentation/nvme-create-ns.1 | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 new file mode 100644 index 0000000..7f358c1 --- /dev/null +++ b/Documentation/nvme-create-ns.1 @@ -0,0 +1,102 @@ +'\" t +.\" Title: nvme-create-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\-CREATE\-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-create-ns \- Send NVMe Namespace management command to create namespace, returns results\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme create\-ns\fR <device> [\-\-nsze=<nsze> | \-s <nsze>] + [\-\-ncap=<ncap> | \-c <ncap>] + [\-\-flbas=<flbas> | \-f <flbas>] + [\-\-dps=<dps> | \-d <dps>] + [\-\-nmic=<nmic> | \-m <nmic>] + [\-\-anagrp\-id=<anagrpid> | \-a <anagrpid>] + [\-\-nvmset\-id=<nvmsetid> | \-i <nvmsetid>] + [\-\-block\-size=<block\-size> | \-b <block\-size>] + [\-\-timeout=<timeout> | \-t <timeout>] +DESCRIPTION +.fi +.sp +.nf +For the NVMe device given, sends a namespace management command to create +the namespace with the requested settings\&. On success, the namespace +identifier assigned by the controller is returned\&. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. + +OPTIONS +.fi +.PP +\-s, \-\-nsze +.RS 4 +The namespace size\&. +.RE +.PP +\-c, \-\-ncap +.RS 4 +The namespace capacity\&. +.RE +.PP +\-f, \-\-flbas +.RS 4 +The namespace formatted logical block size setting\&. Conflicts with \-\-block\-size argument\&. +.RE +.PP +\-d, \-\-dps +.RS 4 +The data protection settings\&. +.RE +.PP +\-m, \-\-nmic +.RS 4 +Namespace multipath and sharing capabilities\&. +.RE +.PP +\-a, \-\-anagrp\-id +.RS 4 +ANA Gorup Identifier\&. If this value is 0h specifies that the controller determines the value to use +.RE +.PP +\-i <nvmsetid>, \-\-nvmset\-id=<nvmsetid> +.RS 4 +This field specifies the identifier of the NVM Set\&. +.RE +.PP +\-b, \-\-block\-size +.RS 4 +Target block size the new namespace should be formatted as\&. Potential FLBAS values will be values will be scanned and the lowest numbered will be selected for the create\-ns operation\&. Conflicts with \-\-flbas argument\&. +.RE +.SH "EXAMPLES" +.sp +No examples provided yet\&. +.SH "NVME" +.sp +Part of the nvme\-user suite |