summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_identify_uuid.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_identify_uuid.2')
-rw-r--r--doc/man/nvme_identify_uuid.220
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/nvme_identify_uuid.2 b/doc/man/nvme_identify_uuid.2
new file mode 100644
index 0000000..4e131c6
--- /dev/null
+++ b/doc/man/nvme_identify_uuid.2
@@ -0,0 +1,20 @@
+.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_identify_uuid \- Retrieves device's UUIDs
+.SH SYNOPSIS
+.B "int" nvme_identify_uuid
+.BI "(int fd " ","
+.BI "struct nvme_id_uuid_list *uuid_list " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "uuid_list" 12
+User space destination address to transfer the data
+.SH "DESCRIPTION"
+Each UUID List entry is either 0h, the NVMe Invalid UUID, or a valid UUID.
+Valid UUIDs are those which are non-zero and are not the NVMe Invalid UUID.
+
+See \fIstruct nvme_id_uuid_list\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.