Debian Codegraph @

doc/man/nvme_get_telemetry_log.2

raw
1 .TH "nvme_get_telemetry_log" 9 "nvme_get_telemetry_log" "November 2025" "libnvme API manual" LINUX
2 .SH NAME
3 nvme_get_telemetry_log \- Get specified telemetry log
4 .SH SYNOPSIS
5 .B "int" nvme_get_telemetry_log
6 .BI "(int fd " ","
7 .BI "bool create " ","
8 .BI "bool ctrl " ","
9 .BI "bool rae " ","
10 .BI "size_t max_data_tx " ","
11 .BI "enum nvme_telemetry_da da " ","
12 .BI "struct nvme_telemetry_log **log " ","
13 .BI "size_t *size " ");"
14 .SH ARGUMENTS
15 .IP "fd" 12
16 File descriptor of nvme device
17 .IP "create" 12
18 Generate new host initated telemetry capture
19 .IP "ctrl" 12
20 Get controller Initiated log
21 .IP "rae" 12
22 Retain asynchronous events
23 .IP "max_data_tx" 12
24 Set the max data transfer size to be used retrieving telemetry.
25 .IP "da" 12
26 Log page data area, valid values: \fIenum nvme_telemetry_da\fP.
27 .IP "log" 12
28 On success, set to the value of the allocated and retrieved log.
29 .IP "size" 12
30 Ptr to the telemetry log size, so it can be returned
31 .SH "DESCRIPTION"
32 The total size allocated can be calculated as:
33 (nvme_telemetry_log da size + 1) * NVME_LOG_TELEM_BLOCK_SIZE.
34 .SH "RETURN"
35 The nvme command status if a response was received (see
36 \fIenum nvme_status_field\fP) or -1 with errno set otherwise.