1NVME-TELEMETRY-LOG(1)             NVMe Manual            NVME-TELEMETRY-LOG(1)
2
3
4

NAME

6       nvme-telemetry-log - Retrieves a Telemetry Host-Initiated log page from
7       an NVMe device
8

SYNOPSIS

10       nvme telemetry-log <device> [--output-file=<file> | -o <file>]
11                             [--host-generate=<gen> | -g <gen>]
12

DESCRIPTION

14       Retrieves an Telemetry Host-Initiated log page from an NVMe device and
15       provides the returned structure.
16
17       The <device> parameter is mandatory and may be either the NVMe
18       character device (ex: /dev/nvme0), or a namespace block device (ex:
19       /dev/nvme0n1).
20
21       On success, the returned log structure will be in raw binary format
22       only with --output-file option which is mandatory.
23

OPTIONS

25       -o <file>, --output-file=<file>
26           File name to which raw binary data will be saved to.
27
28       -g <gen>, --host-generate=<gen>
29           If set to 1, controller shall capture the Telemetry Host-Initiated
30           data representing the internal state of the controller at the time
31           the associated Get Log Page command is processed. If cleated to 0,
32           controller shall not update this data.
33
34       -d <da>, --data-area=<da>
35           Retrieves the specific data area requested. Valid inputs are
36           1,2,3,4. If this option is not specified, the default value is 3,
37           since data area 4 may not be supported.
38

EXAMPLES

40       •   Retrieve Telemetry Host-Initiated data to telemetry_log.bin
41
42               # nvme telemetry-log /dev/nvme0 --output-file=telemetry_log.bin
43

NVME

45       Part of the nvme-user suite
46
47
48
49NVMe                              09/29/2023             NVME-TELEMETRY-LOG(1)