summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_ana.2
blob: 6822ff3499dd2643b7847456df48d0275dbd32b0 (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
33
.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_ana \- Retrieve Asymmetric Namespace Access log page
.SH SYNOPSIS
.B "int" nvme_get_log_ana
.BI "(int fd "  ","
.BI "enum nvme_log_ana_lsp lsp "  ","
.BI "bool rae "  ","
.BI "__u64 offset "  ","
.BI "__u32 len "  ","
.BI "void *log "  ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "lsp" 12
Log specific, see \fIenum nvme_get_log_ana_lsp\fP
.IP "rae" 12
Retain asynchronous events
.IP "offset" 12
Offset to the start of the log page
.IP "len" 12
The allocated length of the log page
.IP "log" 12
User address to store the ana log
.SH "DESCRIPTION"
This log consists of a header describing the log and descriptors containing
the asymmetric namespace access information for ANA Groups that contain
namespaces that are attached to the controller processing the command.

See \fIstruct nvme_ana_rsp_hdr\fP for the definition of the returned structure.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.