summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-zns-set-zone-desc.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-zns-set-zone-desc.txt')
-rw-r--r--Documentation/nvme-zns-set-zone-desc.txt59
1 files changed, 59 insertions, 0 deletions
diff --git a/Documentation/nvme-zns-set-zone-desc.txt b/Documentation/nvme-zns-set-zone-desc.txt
new file mode 100644
index 0000000..3df8c4b
--- /dev/null
+++ b/Documentation/nvme-zns-set-zone-desc.txt
@@ -0,0 +1,59 @@
+nvme-zns-set-zone-desc(1)
+=========================
+
+NAME
+----
+nvme-zns-set-zone-desc - Set extended descriptor data for a zone
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns set-zone-desc' <device> [--namespace-id=<NUM> | -n <NUM>]
+ [--start-lba=<IONUM>, -s <IONUM>]
+ [--zrwaa | -r]
+ [--data=<FILE>, -d <FILE>]
+ [--timeout=<timeout> | -t <timeout>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+Set Zone Descriptor Extensions action. The input will default to stdin.
+Alternatively, the data may come from a file that can be specified. The data
+length will automatically be calculated from the zns identify namespace.
+
+OPTIONS
+-------
+-n <NUM>::
+--namespace-id=<NUM>::
+ Use the provided namespace id for the command. If not provided, the
+ namespace id of the block device will be used. If the command is issued
+ to a non-block device, the parameter is required.
+
+-s <lba>::
+--start-lba=<lba>::
+ The starting LBA of the zone to manage send.
+
+-r::
+--zrwaa::
+ Allocate Zone Random Write Area to zone.
+
+-d <FILE>::
+--data=<FILE>::
+ Optional file for data (default stdin)
+
+-t <timeout>::
+--timeout=<timeout>::
+ Override default timeout value. In milliseconds.
+
+EXAMPLES
+--------
+* Write "hello world" into the zone descriptor for namespace 1's first zone
+ (requires device supports a large enough zone extended data)
++
+------------
+# echo "hello world" | nvme zns set-zone-desc /dev/nvme0 -n 1 -s 0
+------------
+
+NVME
+----
+Part of nvme-cli