| 1 |
.TH "libnvme" 9 "struct nvmf_disc_log_entry" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvmf_disc_log_entry \- Discovery Log Page entry |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvmf_disc_log_entry { |
| 6 |
.br |
| 7 |
.BI " __u8 trtype;" |
| 8 |
.br |
| 9 |
.BI " __u8 adrfam;" |
| 10 |
.br |
| 11 |
.BI " __u8 subtype;" |
| 12 |
.br |
| 13 |
.BI " __u8 treq;" |
| 14 |
.br |
| 15 |
.BI " __le16 portid;" |
| 16 |
.br |
| 17 |
.BI " __le16 cntlid;" |
| 18 |
.br |
| 19 |
.BI " __le16 asqsz;" |
| 20 |
.br |
| 21 |
.BI " __le16 eflags;" |
| 22 |
.br |
| 23 |
.BI " __u8 rsvd12[20];" |
| 24 |
.br |
| 25 |
.BI " char trsvcid[NVMF_TRSVCID_SIZE];" |
| 26 |
.br |
| 27 |
.BI " __u8 rsvd64[192];" |
| 28 |
.br |
| 29 |
.BI " char subnqn[NVME_NQN_LENGTH];" |
| 30 |
.br |
| 31 |
.BI " char traddr[NVMF_TRADDR_SIZE];" |
| 32 |
.br |
| 33 |
.BI " union nvmf_tsas tsas;" |
| 34 |
.br |
| 35 |
.BI " |
| 36 |
}; |
| 37 |
.br |
| 38 |
|
| 39 |
.SH Members |
| 40 |
.IP "trtype" 12 |
| 41 |
Transport Type (TRTYPE): Specifies the NVMe Transport type. |
| 42 |
See \fIenum nvmf_trtype\fP. |
| 43 |
.IP "adrfam" 12 |
| 44 |
Address Family (ADRFAM): Specifies the address family. |
| 45 |
See \fIenum nvmf_addr_family\fP. |
| 46 |
.IP "subtype" 12 |
| 47 |
Subsystem Type (SUBTYPE): Specifies the type of the NVM subsystem |
| 48 |
that is indicated in this entry. See \fIenum nvme_subsys_type\fP. |
| 49 |
.IP "treq" 12 |
| 50 |
Transport Requirements (TREQ): Indicates requirements for the NVMe |
| 51 |
Transport. See \fIenum nvmf_treq\fP. |
| 52 |
.IP "portid" 12 |
| 53 |
Port ID (PORTID): Specifies a particular NVM subsystem port. |
| 54 |
Different NVMe Transports or address families may utilize the same |
| 55 |
Port ID value (e.g. a Port ID may support both iWARP and RoCE). |
| 56 |
.IP "cntlid" 12 |
| 57 |
Controller ID (CNTLID): Specifies the controller ID. If the NVM |
| 58 |
subsystem uses a dynamic controller model, then this field shall |
| 59 |
be set to FFFFh. If the NVM subsystem uses a static controller model, |
| 60 |
then this field may be set to a specific controller ID (values 0h |
| 61 |
to FFEFh are valid). If the NVM subsystem uses a static controller |
| 62 |
model and the value indicated is FFFEh, then the host should remember |
| 63 |
the Controller ID returned as part of the Fabrics Connect command |
| 64 |
in order to re-establish an association in the future with the same |
| 65 |
controller. |
| 66 |
.IP "asqsz" 12 |
| 67 |
Admin Max SQ Size (ASQSZ): Specifies the maximum size of an Admin |
| 68 |
Submission Queue. This applies to all controllers in the NVM |
| 69 |
subsystem. The value shall be a minimum of 32 entries. |
| 70 |
.IP "eflags" 12 |
| 71 |
Entry Flags (EFLAGS): Indicates additional information related to |
| 72 |
the current entry. See \fIenum nvmf_disc_eflags\fP. |
| 73 |
.IP "rsvd12" 12 |
| 74 |
Reserved |
| 75 |
.IP "trsvcid" 12 |
| 76 |
Transport Service Identifier (TRSVCID): Specifies the NVMe Transport |
| 77 |
service identifier as an ASCII string. The NVMe Transport service |
| 78 |
identifier is specified by the associated NVMe Transport binding |
| 79 |
specification. |
| 80 |
.IP "rsvd64" 12 |
| 81 |
Reserved |
| 82 |
.IP "subnqn" 12 |
| 83 |
NVM Subsystem Qualified Name (SUBNQN): NVMe Qualified Name (NQN) |
| 84 |
that uniquely identifies the NVM subsystem. For a subsystem, if that |
| 85 |
Discovery subsystem has a unique NQN (i.e., the NVM Subsystem NVMe |
| 86 |
Qualified Name (SUBNQN) field in that Discovery subsystem's Identify |
| 87 |
Controller data structure contains a unique NQN value), then the |
| 88 |
value returned shall be that unique NQN. If the Discovery subsystem |
| 89 |
does not have a unique NQN, then the value returned shall be the |
| 90 |
well-known Discovery Service NQN (nqn.2014-08.org.nvmexpress.discovery). |
| 91 |
.IP "traddr" 12 |
| 92 |
Transport Address (TRADDR): Specifies the address of the NVM subsystem |
| 93 |
that may be used for a Connect command as an ASCII string. The |
| 94 |
Address Family field describes the reference for parsing this field. |
| 95 |
.IP "tsas" 12 |
| 96 |
Transport specific attribute settings |