summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-zns-zone-mgmt-recv.txt
blob: 07cd98e9c3e321c2b1022d4c61d03e4e43bbc45b (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
nvme-zns-zone-mgmt-recv(1)
==========================

NAME
----
nvme-zns-zone-mgmt-recv - Zone Management Receive command

SYNOPSIS
--------
[verse]
'nvme zns zone-mgmt-recv' <device> [--namespace-id=<NUM> | -n <NUM>]
				   [--start-lba=<LBA> | -s <LBA>]
				   [--data-len=<IONUM>, -l <IONUM>]
				   [--zra=<NUM>, -z <NUM>]
				   [--zrasf=<NUM>, -a <NUM>]
				   [--zra-spec-feat, -f]
				   [--output-format=<FMT>, -o <FMT>]

DESCRIPTION
-----------
For the NVMe device given, issues the Zone Management Receive command with the
requested receive action and additional action specific parameters. This is the
generic interface provided for forward compatibility as new actions are created
that this program isn't aware of at the time of its development. As such, this
is a generic command that does not do any additional decoding for specific
types of data received. This will only report the data as a hex dump, or
binary. 

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 receive.

--data-len=<NUM>
-l <NUM>
	Received data buffer length

-z <NUM>::
--zra=<NUM>::
	Zone Receive Action

-a <NUM>
--zrasf=<NUM>
	Zone Receive Action Specific field

-f::
--zra-spec-feat::
	Enable Zone Receive Action Specific features

-o <FMT>::
--output-format=<FMT>::
	Output format: normal|json|binary

EXAMPLES
--------
* Hex dump of a report all zones
+
------------
# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -l 4k
------------
+

* Binary dump of a report all zones
+
------------
# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -o -l 4k binary > report.out
------------

NVME
----
Part of nvme-cli