summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-capacity-mgmt.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-capacity-mgmt.txt64
1 files changed, 64 insertions, 0 deletions
diff --git a/Documentation/nvme-capacity-mgmt.txt b/Documentation/nvme-capacity-mgmt.txt
new file mode 100644
index 0000000..a20561f
--- /dev/null
+++ b/Documentation/nvme-capacity-mgmt.txt
@@ -0,0 +1,64 @@
+nvme-capacity-mgmt(1)
+=====================
+
+NAME
+----
+nvme-capacity-mgmt - Send capacity management command to configure/create/delete
+Endurance Groups or NVM Sets, returns results.
+
+SYNOPSIS
+--------
+[verse]
+'nvme capacity-mgmt' <device> [--operation=<operation> | -O <operation>]
+ [--element-id=<element-id> | -i <element-id>]
+ [--cap-lower=<cap-lower> | -l <cap-lower>]
+ [--cap-upper=<cap-upper> | -u <cap-upper>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends a capacity management command to
+configure/create/delete the Endurance Groups or NVM Sets with the requested
+operation and element_id. On success, if the Operation is Create Endurance
+group or NVM Set, CQE CDW0 contains Created element identifier else CQE CDW0 is
+reserved.
+
+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
+-------
+-O <operation>::
+--operation=<operation>::
+ Operation to be performed by the controller
+
+-i <element-id>::
+--element-id=<element-id>::
+ Value specific to the value of the Operation field.
+
+-l <cap-lower>::
+--cap-lower=<cap-lower>::
+ Least significant 32 bits of the capacity in bytes of the Endurance Group or
+ NVM Set to be created
+
+-u <cap-upper>::
+--cap-upper=<cap-upper>::
+ Most significant 32 bits of the capacity in bytes of the Endurance Group or
+ NVM Set to be created
+
+-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 provided yet.
+
+NVME
+----
+Part of the nvme-user suite \ No newline at end of file