summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ana-log.txt
blob: b6dc9c5861aaf1a50084d22ae880a46efca75af9 (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
nvme-ana-log(1)
===============

NAME
----
nvme-ana-log - Send NVMe ANA log page request, returns result and log

SYNOPSIS
--------
[verse]
'nvme ana-log' <device> [-o <fmt> | --output-format=<fmt>] 

DESCRIPTION
-----------
Retrieves the NVMe Asymmetric Namespace Access log page from an NVMe device
and provides the returned structure.

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

On success, the returned ANA log structure may be returned in one of
several ways depending on the option flags; the structure may parsed by
the program and printed in a readable format or the raw buffer may be
printed to stdout for another program to parse.

OPTIONS
-------
-g::
--groups::
              Return the list of ANA groups without the namespace listing.

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

EXAMPLES
--------
* Print the ANA log page in a human readable format:
------------
# nvme ana-log /dev/nvme0
------------

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