summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_get_nsid_log.2
blob: afaafb186ddf69803eb792d397fe6c27aeac33eb (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
.TH "nvme_mi_admin_get_nsid_log" 9 "nvme_mi_admin_get_nsid_log" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_nsid_log \- Helper for Get Log Page functions
.SH SYNOPSIS
.B "int" nvme_mi_admin_get_nsid_log
.BI "(nvme_mi_ctrl_t ctrl "  ","
.BI "bool rae "  ","
.BI "enum nvme_cmd_get_log_lid lid "  ","
.BI "__u32 nsid "  ","
.BI "__u32 len "  ","
.BI "void *log "  ");"
.SH ARGUMENTS
.IP "ctrl" 12
Controller to query
.IP "rae" 12
Retain Asynchronous Events
.IP "lid" 12
Log identifier
.IP "nsid" 12
Namespace ID
.IP "len" 12
length of log buffer
.IP "log" 12
pointer for resulting log data
.SH "DESCRIPTION"
Performs a Get Log Page Admin command for a specific log ID \fIlid\fP and
namespace ID \fInsid\fP. Log data is expected to be \fIlen\fP bytes, and is stored
in \fIlog\fP on success. The \fIrae\fP flag is passed as-is to the Get Log Page
command, and is specific to the Log Page requested.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.