summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-zns-zone-mgmt-send.txt
blob: 3803d27e90ad5900528774348128fc7b7499a396 (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
nvme-zns-zone-mgmt-send(1)
==========================

NAME
----
nvme-zns-zone-mgmt-send - Zone Management Send command

SYNOPSIS
--------
[verse]
'nvme zns zone-mgmt-send' <device> [--namespace-id=<NUM> | -n <NUM>]
			[--start-lba=<IONUM>, -s <IONUM>] [--zsaso, -o]
			[--select-all, -a] [--zsa=<NUM>, -z <NUM>]
			[--data-len=<IONUM>, -l <IONUM>]
			[--data=<FILE>, -d <FILE>]
			[--timeout=<timeout> | -t <timeout>]

DESCRIPTION
-----------
For the NVMe device given, issues the Zone Management Send command with the
requested send action. If the send requires additional data, you may specify
the data length. If data is required, the input will default to stdin.
Alternatively, the data may come from a file that can be specified.

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.

-l <NUM>::
--data-len=<NUM>::
	Send data buffer length

-o::
--zsaso::
	Zone Send Action Specific Option

-a::
--select-all::
	Send command to all zones

-z <NUM>::
--zsa=<NUM>::
	Zone send action.

-l <IONUM>::
--data-len=<IONUM>::
	Buffer length if data required

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

-t <timeout>::
--timeout=<timeout>::
	Override default timeout value. In milliseconds.

EXAMPLES
--------
* Send a zone management command with action set to 1 (close zone) to namespace
  1's first zone:
+
------------
# nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 1
------------
+

* 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 zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 0x10
------------

NVME
----
Part of nvme-cli