summaryrefslogtreecommitdiffstats
path: root/doc/man/nbft_info_hfi_info_tcp.2
blob: 295841b8468f0ab9ea4dae5c0ec871630bbee762 (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "December 2023" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP
.SH SYNOPSIS
struct nbft_info_hfi_info_tcp {
.br
.BI "    __u32 pci_sbdf;"
.br
.BI "    __u8 mac_addr[6];"
.br
.BI "    __u16 vlan;"
.br
.BI "    __u8 ip_origin;"
.br
.BI "    char ipaddr[40];"
.br
.BI "    __u8 subnet_mask_prefix;"
.br
.BI "    char gateway_ipaddr[40];"
.br
.BI "    __u16 route_metric;"
.br
.BI "    char primary_dns_ipaddr[40];"
.br
.BI "    char secondary_dns_ipaddr[40];"
.br
.BI "    char dhcp_server_ipaddr[40];"
.br
.BI "    char *host_name;"
.br
.BI "    bool this_hfi_is_default_route;"
.br
.BI "    bool dhcp_override;"
.br
.BI "
};
.br

.SH Members
.IP "pci_sbdf" 12
PCI Express Routing ID for the HFI Transport Function.
.IP "mac_addr" 12
MAC Address: The MAC address of this HFI,
in EUI-48TM format.
.IP "vlan" 12
The VLAN identifier if the VLAN is associated with
this HFI, as defined in IEEE 802.1q-2018 or zeroes
if no VLAN is associated with this HFI.
.IP "ip_origin" 12
The source of Ethernet L3 configuration information
used by the driver or 0 if not used.
.IP "ipaddr" 12
The IPv4 or IPv6 address of this HFI.
.IP "subnet_mask_prefix" 12
The IPv4 or IPv6 subnet mask in CIDR routing prefix
notation.
.IP "gateway_ipaddr" 12
The IPv4 or IPv6 address of the IP gateway for this
HFI or zeroes if no IP gateway is specified.
.IP "route_metric" 12
The cost value for the route indicated by this HFI.
.IP "primary_dns_ipaddr" 12
The IPv4 or IPv6 address of the Primary DNS server
for this HFI.
.IP "secondary_dns_ipaddr" 12
The IPv4 or IPv6 address of the Secondary DNS server
for this HFI.
.IP "dhcp_server_ipaddr" 12
The IPv4 or IPv6 address of the DHCP server used
to assign this HFI address.
.IP "host_name" 12
The Host Name string.
.IP "this_hfi_is_default_route" 12
If True, then the BIOS utilized this interface
described by HFI to be the default route with highest
priority. If False, then routes are local to their
own scope.
.IP "dhcp_override" 12
If True, then HFI information was populated
by consuming the DHCP on this interface. If False,
then the HFI information was set administratively
by a configuration interface to the driver and
pre-OS envrionment.