diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:22:29 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:22:29 +0000 |
commit | 068a45420f2c98887e220b45e946cc7074da550e (patch) | |
tree | c5b54e8b4b235232b057a9c534d9a16d2208463d /doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 | |
parent | Initial commit. (diff) | |
download | libnvme-068a45420f2c98887e220b45e946cc7074da550e.tar.xz libnvme-068a45420f2c98887e220b45e946cc7074da550e.zip |
Adding upstream version 1.8.upstream/1.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2')
-rw-r--r-- | doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 b/doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 new file mode 100644 index 0000000..21c76e7 --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 @@ -0,0 +1,27 @@ +.TH "nvme_mi_admin_identify_secondary_ctrl_list" 9 "nvme_mi_admin_identify_secondary_ctrl_list" "February 2024" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_secondary_ctrl_list \- Perform an Admin identify for a secondary controller list. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_secondary_ctrl_list +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "__u16 cntid " "," +.BI "struct nvme_secondary_ctrl_list *list " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "cntid" 12 +Controller ID to specify list start +.IP "list" 12 +List data to populate +.SH "DESCRIPTION" +Perform an Identify command, for the secondary controllers associated with +the current primary controller. Only entries with IDs greater than or +equal to \fIcntid\fP are returned. + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIlist\fP will be +be fully populated on success. + +See: \fIstruct nvme_secondary_ctrl_list\fP +.SH "RETURN" +0 on success, non-zero on failure |