1NVME-ZNS-REPORT-Z(1)              NVMe Manual             NVME-ZNS-REPORT-Z(1)
2
3
4

NAME

6       nvme-zns-report-zones - Retrieve and display the Report Zones data
7       structure
8

SYNOPSIS

10       nvme zns report-zones <device> [--namespace-id=<NUM> | -n <NUM>]
11                                        [--start-lba=<IONUM> | -s <IONUM>]
12                                        [--descs=<NUM> | -d <NUM>]
13                                        [--state=<NUM> | -S <NUM>]
14                                        [--extended | -e]
15                                        [--partial | -p]
16                                        [--verbose | -v]
17                                        [--output-format=<FMT> | -o <FMT>]
18

DESCRIPTION

20       For the NVMe device given, sends the Zone Management Receive command
21       with the Zone Receive Action set to either Report Zones or Extended
22       Report Zones, depending on the extended option.
23
24       The <device> parameter is mandatory and may be either the NVMe
25       character device (ex: /dev/nvme0), or a namespace block device (ex:
26       /dev/nvme0n1).
27
28       On success, the data structure returned by the device will be decoded
29       and displayed in one of several ways.
30

OPTIONS

32       -n <NUM>, --namespace-id=<NUM>
33           Use the provided namespace id for the command. If not provided, the
34           namespace id of the block device will be used. If the command is
35           issued to a non-block device, the parameter is required.
36
37       -s <lba>, --start-lba=<lba>
38           The starting LBA of the zone to begin the report
39
40       -d <NUM>, --descs=<NUM>
41           The number of descriptors to request in the report.
42
43       -S <NUM>, --state=<NUM>
44           The state of zones to request in the report. Known values include:
45
46           ┌──────┬──────────────────────────┐
47           │Value │ Definition               │
48           ├──────┼──────────────────────────┤
49           │0     │ List all zones (default) │
50           ├──────┼──────────────────────────┤
51           │1     │ Empty State              │
52           ├──────┼──────────────────────────┤
53           │2     │ Implicitly Opened State  │
54           ├──────┼──────────────────────────┤
55           │3     │ Explicitly Opened State  │
56           ├──────┼──────────────────────────┤
57           │4     │ Closed State             │
58           ├──────┼──────────────────────────┤
59           │5     │ Full State               │
60           ├──────┼──────────────────────────┤
61           │6     │ Read Only State          │
62           ├──────┼──────────────────────────┤
63           │7     │ Offline State            │
64           └──────┴──────────────────────────┘
65
66       -e, --extended
67           Request to use the Extended Report Zones option. The extended data
68           is not decoded.
69
70       -p, --partial
71           If set, the device will return the number of zones that match the
72           state rather than the number of zones returned in the report.
73
74       -v, --verbose
75           Increase the information detail in the output.
76
77       -o <format>, --output-format=<format>
78           Set the reporting format to normal, json, or binary. Only one
79           output format can be used at a time.
80

EXAMPLES

82       •   Has the program interpret the report for 16 zones, and display the
83           known fields in a human readable format:
84
85               # nvme zns report-zones /dev/nvme0 -n 1 -d 16
86
87       •   Show the output in json format with extra details
88
89               # nvme zns report-zones /dev/nvme0 -n 1 -d 16 -o json
90

NVME

92       Part of nvme-cli
93
94
95
96NVMe                              09/29/2023              NVME-ZNS-REPORT-Z(1)
Impressum