Debian Codegraph @

doc/man/nvme_get_ctrl_telemetry.2

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