summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_ana_groups.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_get_log_ana_groups.2')
-rw-r--r--doc/man/nvme_get_log_ana_groups.223
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/man/nvme_get_log_ana_groups.2 b/doc/man/nvme_get_log_ana_groups.2
new file mode 100644
index 0000000..466d7e4
--- /dev/null
+++ b/doc/man/nvme_get_log_ana_groups.2
@@ -0,0 +1,23 @@
+.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_log_ana_groups \- Retrieve Asymmetric Namespace Access groups only log page
+.SH SYNOPSIS
+.B "int" nvme_get_log_ana_groups
+.BI "(int fd " ","
+.BI "bool rae " ","
+.BI "__u32 len " ","
+.BI "struct nvme_ana_group_desc *log " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "rae" 12
+Retain asynchronous events
+.IP "len" 12
+The allocated length of the log page
+.IP "log" 12
+User address to store the ana group log
+.SH "DESCRIPTION"
+See \fIstruct nvme_ana_group_desc\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.