summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2
blob: 9773676b582ffb8245a552f17f39fc75c2727204 (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
.TH "nvme_mi_admin_identify_secondary_ctrl_list" 9 "nvme_mi_admin_identify_secondary_ctrl_list" "October 2022" "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 "__u32 nsid "  ","
.BI "__u16 cntid "  ","
.BI "struct nvme_secondary_ctrl_list *list "  ");"
.SH ARGUMENTS
.IP "ctrl" 12
Controller to process identify command
.IP "nsid" 12
Namespace ID to specify list start
.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