1PERSISTENT-EVENT-L(1)             NVMe Manual            PERSISTENT-EVENT-L(1)
2
3
4

NAME

6       nvme-persistent-event-log - Send NVMe persistent event log page
7       request, returns result and log
8

SYNOPSIS

10       nvme persistent-event-log <device> [--action=<action> | -a <action>]
11                   [--log-len=<log-len> | -l <log-len>]
12                   [--raw-binary | -b]
13                   [--output-format=<fmt> | -o <fmt>]
14

DESCRIPTION

16       Retrieves the NVMe persistent event log page from an NVMe device and
17       provides the returned structure.
18
19       The <device> parameter is mandatory and may be either the NVMe
20       character device (ex: /dev/nvme0), or a namespace block device (ex:
21       /dev/nvme0n1).
22
23       On success, the returned persistent event log structure may be returned
24       in one of several ways depending on the option flags; the structure may
25       parsed by the program and printed in a readable format or the raw
26       buffer may be printed to stdout for another program to parse.
27

OPTIONS

29       -a <action>, --action=<action>
30           While try to retrieve this log action the controller shall take
31           during processing this persistent log page command. This mandatory
32           field, based on the value issued it may Read Log Data, Establish
33           Context and Read Log Data or Release Context can occur. For More
34           details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent
35           Event Log (Log Identifier 0Dh)
36
37       -l <log-len>, --log-len=<log-len>
38           Allocates a buffer of <log-len> bytes size and requests this many
39           bytes be returned in the constructed NVMe command. This param is
40           mandatory. If <log-len> given is 0 and action is 0, it will read
41           the Total Log Length(TLL) of the page.
42
43       -b, --raw-binary
44           Print the raw persistent event log buffer to stdout.
45
46       -o <format>, --output-format=<format>
47           Set the reporting format to normal, json, or binary. Only one
48           output format can be used at a time.
49

EXAMPLES

51       •   Print the persistent event log page in a human readable format:
52
53               # nvme persistent-event-log /dev/nvme0
54
55       •   Print the raw persistent event log to a file:
56
57               # nvme persistent-event-log /dev/nvme0 --raw-binary > persistent_log.raw
58
59           It is probably a bad idea to not redirect stdout when using this
60           mode.
61

NVME

63       Part of the nvme-user suite
64
65
66
67NVMe                              09/29/2023             PERSISTENT-EVENT-L(1)
Impressum