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

NAME
----
nvme-id-uuid - Send a Identify UUID List command to the specified device

SYNOPSIS
--------
[verse]
'nvme id-uuid' <device> [--raw-binary | -b] [--human-readable | -H]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
Send a Identify UUID List command command to the specified device, return
results.

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

On success it returns 0, error code otherwise.

OPTIONS
-------
-b::
--raw-binary::
	Print the raw buffer to stdout. Structure is not parsed by
	program. This overrides the vendor specific and human readable options.

-H::
--human-readable::
	This option will parse and format many of the bit fields
	into human-readable formats.

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

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

EXAMPLES
--------
* Has the program issue a id-uuid to display structure.
+
------------
# nvme id-uuid /dev/nvme0
------------

NVME
----
Part of the nvme-user suite.