summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-zns-id-ns.txt
blob: c22b5c7bce02c095f78995e95b95f3cda891e4c4 (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
nvme-zns-id-ns(1)
=================

NAME
----
nvme-zns-id-ns - Send NVMe Zoned Command Set Identify namespace, return result
and structure

SYNOPSIS
--------
[verse]
'nvme zns id-ns' <device> [--namespace-id=<NUM> | -n <NUM>]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
For the NVMe device given, sends the zoned command set's identify namespace
command and provides the result and returned structure.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

On success, the data structure returned by the device will be decoded and
displayed in one of several ways. 

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.

-v::
--verbose::
	Increase the information detail in the output.

-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json', or
	'binary'. Only one output format can be used at a time.

EXAMPLES
--------
* Has the program interpret the returned buffer and display the known
fields in a human readable format:
+
------------
# nvme zns id-ns /dev/nvme0 -n 1
------------
+

* Show the output in json format with extra details
+
------------
# nvme zns id-ns /dev/nvme0 -o json -v
------------

NVME
----
Part of nvme-cli