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

NAME
----
nvme-resv-notif-log - Send NVMe Reservation Notification log page request,
                      return result and log

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

DESCRIPTION
-----------
Retrieves NVMe Reservation Notification log page from an NVMe device and
provides the 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 returned Reservation Notification 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
-------
-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
--------
* Get the Reservation Notification log and print it in a human readable format:
+
------------
# nvme resv-notif-log /dev/nvme0
------------
+

* Print the output in json format:
+
------------
# nvme resv-notif-log /dev/nvme0 -o json
------------

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