summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-create-ns.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
commitdc597ce8df5ae6efd2728a2d7ba7d92486028f79 (patch)
tree55b9e9257eba4579667f9522368aa29f5be6754a /Documentation/nvme-create-ns.txt
parentInitial commit. (diff)
downloadnvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.tar.xz
nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.zip
Adding upstream version 1.12.upstream/1.12
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-create-ns.txt')
-rw-r--r--Documentation/nvme-create-ns.txt74
1 files changed, 74 insertions, 0 deletions
diff --git a/Documentation/nvme-create-ns.txt b/Documentation/nvme-create-ns.txt
new file mode 100644
index 0000000..661b01b
--- /dev/null
+++ b/Documentation/nvme-create-ns.txt
@@ -0,0 +1,74 @@
+nvme-create-ns(1)
+=================
+
+NAME
+----
+nvme-create-ns - Send NVMe Namespace management command to create namespace, returns results.
+
+SYNOPSIS
+--------
+[verse]
+'nvme create-ns' <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
+-----------
+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
+-------
+-s::
+--nsze::
+ The namespace size.
+
+-c::
+--ncap::
+ The namespace capacity.
+
+-f::
+--flbas::
+ The namespace formatted logical block size setting.
+ Conflicts with --block-size argument.
+
+-d::
+--dps::
+ The data protection settings.
+
+-m::
+--nmic::
+ Namespace multipath and sharing capabilities.
+
+-a::
+--anagrp-id::
+ ANA Gorup Identifier. If this value is 0h specifies
+ that the controller determines the value to use
+
+-i <nvmsetid>::
+--nvmset-id=<nvmsetid>::
+ This field specifies the identifier of the NVM Set.
+
+-b::
+--block-size::
+ 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.
+
+
+EXAMPLES
+--------
+No examples provided yet.
+
+NVME
+----
+Part of the nvme-user suite