| 1 |
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nbft_info_subsystem_ns \- Subsystem Namespace (SSNS) info |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nbft_info_subsystem_ns { |
| 6 |
.br |
| 7 |
.BI " int index;" |
| 8 |
.br |
| 9 |
.BI " struct nbft_info_discovery *discovery;" |
| 10 |
.br |
| 11 |
.BI " struct nbft_info_security *security;" |
| 12 |
.br |
| 13 |
.BI " int num_hfis;" |
| 14 |
.br |
| 15 |
.BI " struct nbft_info_hfi **hfis;" |
| 16 |
.br |
| 17 |
.BI " char transport[8];" |
| 18 |
.br |
| 19 |
.BI " char traddr[40];" |
| 20 |
.br |
| 21 |
.BI " char *trsvcid;" |
| 22 |
.br |
| 23 |
.BI " __u16 subsys_port_id;" |
| 24 |
.br |
| 25 |
.BI " __u32 nsid;" |
| 26 |
.br |
| 27 |
.BI " enum nbft_info_nid_type nid_type;" |
| 28 |
.br |
| 29 |
.BI " __u8 *nid;" |
| 30 |
.br |
| 31 |
.BI " char *subsys_nqn;" |
| 32 |
.br |
| 33 |
.BI " bool pdu_header_digest_required;" |
| 34 |
.br |
| 35 |
.BI " bool data_digest_required;" |
| 36 |
.br |
| 37 |
.BI " int controller_id;" |
| 38 |
.br |
| 39 |
.BI " int asqsz;" |
| 40 |
.br |
| 41 |
.BI " char *dhcp_root_path_string;" |
| 42 |
.br |
| 43 |
.BI " bool discovered;" |
| 44 |
.br |
| 45 |
.BI " bool unavailable;" |
| 46 |
.br |
| 47 |
.BI " |
| 48 |
}; |
| 49 |
.br |
| 50 |
|
| 51 |
.SH Members |
| 52 |
.IP "index" 12 |
| 53 |
SSNS Descriptor Index in the descriptor list. |
| 54 |
.IP "discovery" 12 |
| 55 |
Primary Discovery Controller associated with |
| 56 |
this SSNS Descriptor. |
| 57 |
.IP "security" 12 |
| 58 |
Security Profile Descriptor associated with |
| 59 |
this namespace. |
| 60 |
.IP "num_hfis" 12 |
| 61 |
Number of HFIs. |
| 62 |
.IP "hfis" 12 |
| 63 |
List of HFIs associated with this namespace. |
| 64 |
Includes the primary HFI at the first position |
| 65 |
and all secondary HFIs. This array is null-terminated. |
| 66 |
.IP "transport" 12 |
| 67 |
Transport Type string (e.g. 'tcp'). |
| 68 |
.IP "traddr" 12 |
| 69 |
Subsystem Transport Address. |
| 70 |
.IP "trsvcid" 12 |
| 71 |
Subsystem Transport Service Identifier. |
| 72 |
.IP "subsys_port_id" 12 |
| 73 |
The Subsystem Port ID. |
| 74 |
.IP "nsid" 12 |
| 75 |
The Namespace ID of this descriptor or when \fInid\fP |
| 76 |
should be used instead. |
| 77 |
.IP "nid_type" 12 |
| 78 |
Namespace Identifier Type, see \fIenum nbft_info_nid_type\fP. |
| 79 |
.IP "nid" 12 |
| 80 |
The Namespace Identifier value. |
| 81 |
.IP "subsys_nqn" 12 |
| 82 |
Subsystem and Namespace NQN. |
| 83 |
.IP "pdu_header_digest_required" 12 |
| 84 |
PDU Header Digest (HDGST) Flag: the use of NVM Header |
| 85 |
Digest Enabled is required. |
| 86 |
.IP "data_digest_required" 12 |
| 87 |
Data Digest (DDGST) Flag: the use of NVM Data Digest |
| 88 |
Enabled is required. |
| 89 |
.IP "controller_id" 12 |
| 90 |
Controller ID (SSNS Extended Information Descriptor): |
| 91 |
The controller ID associated with the Admin Queue |
| 92 |
or 0 if not supported. |
| 93 |
.IP "asqsz" 12 |
| 94 |
Admin Submission Queue Size (SSNS Extended Information |
| 95 |
Descriptor) or 0 if not supported. |
| 96 |
.IP "dhcp_root_path_string" 12 |
| 97 |
DHCP Root Path Override string (SSNS Extended |
| 98 |
Information Descriptor). |
| 99 |
.IP "discovered" 12 |
| 100 |
Indicates that this namespace was acquired |
| 101 |
through discovery. |
| 102 |
.IP "unavailable" 12 |
| 103 |
Namespace is unavailable as indicated by |
| 104 |
the pre-OS driver. |