summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-zns-set-zone-desc.txt
blob: 5df3ecbe9e24e75b012a321db5b6e528d2e7afaa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
nvme-zns-set-zone-desc(1)
=========================

NAME
----
nvme-zns-set-zone-desc - Set extended descriptor data for a zone

SYNOPSIS
--------
[verse]
'nvme zns setzone-desc' <device> [--namespace-id=<NUM> | -n <NUM>]
				 [--start-lba=<IONUM>, -s <IONUM>]
				 [-data=<FILE>, -d <FILE>]

DESCRIPTION
-----------
For the NVMe device given, issues the Zone Management Send command with the
Set Zone Descriptor Extenions 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 namesapce.

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.

-d <FILE::
-data=<FILE>::
	Optional file for data (default stdin)


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