diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
commit | 0e75b5495117b9888b7a557fab1db40145a9a705 (patch) | |
tree | e294b5156b7a85197e4b3192b6fba291a26dd5c6 /doc/man/nvme_mi_admin_get_log_smart.2 | |
parent | Adding upstream version 1.1. (diff) | |
download | libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.tar.xz libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.zip |
Adding upstream version 1.2.upstream/1.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_get_log_smart.2')
-rw-r--r-- | doc/man/nvme_mi_admin_get_log_smart.2 | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_get_log_smart.2 b/doc/man/nvme_mi_admin_get_log_smart.2 new file mode 100644 index 0000000..4110313 --- /dev/null +++ b/doc/man/nvme_mi_admin_get_log_smart.2 @@ -0,0 +1,28 @@ +.TH "nvme_mi_admin_get_log_smart" 9 "nvme_mi_admin_get_log_smart" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_get_log_smart \- Retrieve nvme smart log +.SH SYNOPSIS +.B "int" nvme_mi_admin_get_log_smart +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "__u32 nsid " "," +.BI "bool rae " "," +.BI "struct nvme_smart_log *smart_log " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to query +.IP "nsid" 12 +Optional namespace identifier +.IP "rae" 12 +Retain asynchronous events +.IP "smart_log" 12 +User address to store the smart log +.SH "DESCRIPTION" +This log page provides SMART and general health information. The information +provided is over the life of the controller and is retained across power +cycles. To request the controller log page, the namespace identifier +specified is FFFFFFFFh. The controller may also support requesting the log +page on a per namespace basis, as indicated by bit 0 of the LPA field in the +Identify Controller data structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |