xref: /linux/Documentation/ABI/testing/sysfs-class-net (revision 4949009eb8d40a441dcddcd96e101e77d31cf1b2)
1What:		/sys/class/net/<iface>/name_assign_type
2Date:		July 2014
3KernelVersion:	3.17
4Contact:	netdev@vger.kernel.org
5Description:
6		Indicates the name assignment type. Possible values are:
7		1: enumerated by the kernel, possibly in an unpredictable way
8		2: predictably named by the kernel
9		3: named by userspace
10		4: renamed
11
12What:		/sys/class/net/<iface>/addr_assign_type
13Date:		July 2010
14KernelVersion:	3.2
15Contact:	netdev@vger.kernel.org
16Description:
17		Indicates the address assignment type. Possible values are:
18		0: permanent address
19		1: randomly generated
20		2: stolen from another device
21		3: set using dev_set_mac_address
22
23What:		/sys/class/net/<iface>/addr_len
24Date:		April 2005
25KernelVersion:	2.6.12
26Contact:	netdev@vger.kernel.org
27Description:
28		Indicates the hardware address size in bytes.
29		Values vary based on the lower-level protocol used by the
30		interface (Ethernet, FDDI, ATM, IEEE 802.15.4...). See
31		include/uapi/linux/if_*.h for actual values.
32
33What:		/sys/class/net/<iface>/address
34Date:		April 2005
35KernelVersion:	2.6.12
36Contact:	netdev@vger.kernel.org
37Description:
38		Hardware address currently assigned to this interface.
39		Format is a string, e.g: 00:11:22:33:44:55 for an Ethernet MAC
40		address.
41
42What:		/sys/class/net/<iface>/broadcast
43Date:		April 2005
44KernelVersion:	2.6.12
45Contact:	netdev@vger.kernel.org
46Description:
47		Hardware broadcast address for this interface. Format is a
48		string, e.g: ff:ff:ff:ff:ff:ff for an Ethernet broadcast MAC
49		address.
50
51What:		/sys/class/net/<iface>/carrier
52Date:		April 2005
53KernelVersion:	2.6.12
54Contact:	netdev@vger.kernel.org
55Description:
56		Indicates the current physical link state of the interface.
57		Posssible values are:
58		0: physical link is down
59		1: physical link is up
60
61		Note: some special devices, e.g: bonding and team drivers will
62		allow this attribute to be written to force a link state for
63		operating correctly and designating another fallback interface.
64
65What:		/sys/class/net/<iface>/dev_id
66Date:		April 2008
67KernelVersion:	2.6.26
68Contact:	netdev@vger.kernel.org
69Description:
70		Indicates the device unique identifier. Format is an hexadecimal
71		value. This is used to disambiguate interfaces which might be
72		stacked (e.g: VLAN interfaces) but still have the same MAC
73		address as their parent device.
74
75What:		/sys/class/net/<iface>/dormant
76Date:		March 2006
77KernelVersion:	2.6.17
78Contact:	netdev@vger.kernel.org
79Description:
80		Indicates whether the interface is in dormant state. Possible
81		values are:
82		0: interface is not dormant
83		1: interface is dormant
84
85		This attribute can be used by supplicant software to signal that
86		the device is not usable unless some supplicant-based
87		authentication is performed (e.g: 802.1x). 'link_mode' attribute
88		will also reflect the dormant state.
89
90What:		/sys/clas/net/<iface>/duplex
91Date:		October 2009
92KernelVersion:	2.6.33
93Contact:	netdev@vger.kernel.org
94Description:
95		Indicates the interface latest or current duplex value. Possible
96		values are:
97		half: half duplex
98		full: full duplex
99
100		Note: This attribute is only valid for interfaces that implement
101		the ethtool get_settings method (mostly Ethernet).
102
103What:		/sys/class/net/<iface>/flags
104Date:		April 2005
105KernelVersion:	2.6.12
106Contact:	netdev@vger.kernel.org
107Description:
108		Indicates the interface flags as a bitmask in hexadecimal. See
109		include/uapi/linux/if.h for a list of all possible values and
110		the flags semantics.
111
112What:		/sys/class/net/<iface>/ifalias
113Date:		September 2008
114KernelVersion:	2.6.28
115Contact:	netdev@vger.kernel.org
116Description:
117		Indicates/stores an interface alias name as a string. This can
118		be used for system management purposes.
119
120What:		/sys/class/net/<iface>/ifindex
121Date:		April 2005
122KernelVersion:	2.6.12
123Contact:	netdev@vger.kernel.org
124Description:
125		Indicates the system-wide interface unique index identifier as a
126		decimal number. This attribute is used for mapping an interface
127		identifier to an interface name. It is used throughout the
128		networking stack for specifying the interface specific
129		requests/events.
130
131What:		/sys/class/net/<iface>/iflink
132Date:		April 2005
133KernelVersion:	2.6.12
134Contact:	netdev@vger.kernel.org
135Description:
136		Indicates the system-wide interface unique index identifier a
137		the interface is linked to. Format is decimal. This attribute is
138		used to resolve interfaces chaining, linking and stacking.
139		Physical interfaces have the same 'ifindex' and 'iflink' values.
140
141What:		/sys/class/net/<iface>/link_mode
142Date:		March 2006
143KernelVersion:	2.6.17
144Contact:	netdev@vger.kernel.org
145Description:
146		Indicates the interface link mode, as a decimal number. This
147		attribute should be used in conjunction with 'dormant' attribute
148		to determine the interface usability. Possible values:
149		0: default link mode
150		1: dormant link mode
151
152What:		/sys/class/net/<iface>/mtu
153Date:		April 2005
154KernelVersion:	2.6.12
155Contact:	netdev@vger.kernel.org
156Description:
157		Indicates the interface currently configured MTU value, in
158		bytes, and in decimal format. Specific values depends on the
159		lower-level interface protocol used. Ethernet devices will show
160		a 'mtu' attribute value of 1500 unless changed.
161
162What:		/sys/class/net/<iface>/netdev_group
163Date:		January 2011
164KernelVersion:	2.6.39
165Contact:	netdev@vger.kernel.org
166Description:
167		Indicates the interface network device group, as a decimal
168		integer. Default value is 0 which corresponds to the initial
169		network devices group. The group can be changed to affect
170		routing decisions (see: net/ipv4/fib_rules and
171		net/ipv6/fib6_rules.c).
172
173What:		/sys/class/net/<iface>/operstate
174Date:		March 2006
175KernelVersion:	2.6.17
176Contact:	netdev@vger.kernel.org
177Description:
178		Indicates the interface RFC2863 operational state as a string.
179		Possible values are:
180		"unknown", "notpresent", "down", "lowerlayerdown", "testing",
181		"dormant", "up".
182
183What:		/sys/class/net/<iface>/phys_port_id
184Date:		July 2013
185KernelVersion:	3.12
186Contact:	netdev@vger.kernel.org
187Description:
188		Indicates the interface unique physical port identifier within
189		the NIC, as a string.
190
191What:		/sys/class/net/<iface>/speed
192Date:		October 2009
193KernelVersion:	2.6.33
194Contact:	netdev@vger.kernel.org
195Description:
196		Indicates the interface latest or current speed value. Value is
197		an integer representing the link speed in Mbits/sec.
198
199		Note: this attribute is only valid for interfaces that implement
200		the ethtool get_settings method (mostly Ethernet ).
201
202What:		/sys/class/net/<iface>/tx_queue_len
203Date:		April 2005
204KernelVersion:	2.6.12
205Contact:	netdev@vger.kernel.org
206Description:
207		Indicates the interface transmit queue len in number of packets,
208		as an integer value. Value depend on the type of interface,
209		Ethernet network adapters have a default value of 1000 unless
210		configured otherwise
211
212What:		/sys/class/net/<iface>/type
213Date:		April 2005
214KernelVersion:	2.6.12
215Contact:	netdev@vger.kernel.org
216Description:
217		Indicates the interface protocol type as a decimal value. See
218		include/uapi/linux/if_arp.h for all possible values.
219
220What:		/sys/class/net/<iface>/phys_switch_id
221Date:		November 2014
222KernelVersion:	3.19
223Contact:	netdev@vger.kernel.org
224Description:
225		Indicates the unique physical switch identifier of a switch this
226		port belongs to, as a string.
227