xref: /linux/Documentation/ABI/testing/sysfs-class-net (revision c0c914eca7f251c70facc37dfebeaf176601918d)
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/<bridge iface>/bridge/group_fwd_mask
43Date:		January 2012
44KernelVersion:	3.2
45Contact:	netdev@vger.kernel.org
46Description:
47		Bitmask to allow forwarding of link local frames with address
48		01-80-C2-00-00-0X on a bridge device. Only values that set bits
49		not matching BR_GROUPFWD_RESTRICTED in net/bridge/br_private.h
50		allowed.
51		Default value 0 does not forward any link local frames.
52
53		Restricted bits:
54		0: 01-80-C2-00-00-00 Bridge Group Address used for STP
55		1: 01-80-C2-00-00-01 (MAC Control) 802.3 used for MAC PAUSE
56		2: 01-80-C2-00-00-02 (Link Aggregation) 802.3ad
57
58		Any values not setting these bits can be used. Take special
59		care when forwarding control frames e.g. 802.1X-PAE or LLDP.
60
61What:		/sys/class/net/<iface>/broadcast
62Date:		April 2005
63KernelVersion:	2.6.12
64Contact:	netdev@vger.kernel.org
65Description:
66		Hardware broadcast address for this interface. Format is a
67		string, e.g: ff:ff:ff:ff:ff:ff for an Ethernet broadcast MAC
68		address.
69
70What:		/sys/class/net/<iface>/carrier
71Date:		April 2005
72KernelVersion:	2.6.12
73Contact:	netdev@vger.kernel.org
74Description:
75		Indicates the current physical link state of the interface.
76		Posssible values are:
77		0: physical link is down
78		1: physical link is up
79
80		Note: some special devices, e.g: bonding and team drivers will
81		allow this attribute to be written to force a link state for
82		operating correctly and designating another fallback interface.
83
84What:		/sys/class/net/<iface>/dev_id
85Date:		April 2008
86KernelVersion:	2.6.26
87Contact:	netdev@vger.kernel.org
88Description:
89		Indicates the device unique identifier. Format is an hexadecimal
90		value. This is used to disambiguate interfaces which might be
91		stacked (e.g: VLAN interfaces) but still have the same MAC
92		address as their parent device.
93
94What:		/sys/class/net/<iface>/dormant
95Date:		March 2006
96KernelVersion:	2.6.17
97Contact:	netdev@vger.kernel.org
98Description:
99		Indicates whether the interface is in dormant state. Possible
100		values are:
101		0: interface is not dormant
102		1: interface is dormant
103
104		This attribute can be used by supplicant software to signal that
105		the device is not usable unless some supplicant-based
106		authentication is performed (e.g: 802.1x). 'link_mode' attribute
107		will also reflect the dormant state.
108
109What:		/sys/clas/net/<iface>/duplex
110Date:		October 2009
111KernelVersion:	2.6.33
112Contact:	netdev@vger.kernel.org
113Description:
114		Indicates the interface latest or current duplex value. Possible
115		values are:
116		half: half duplex
117		full: full duplex
118
119		Note: This attribute is only valid for interfaces that implement
120		the ethtool get_settings method (mostly Ethernet).
121
122What:		/sys/class/net/<iface>/flags
123Date:		April 2005
124KernelVersion:	2.6.12
125Contact:	netdev@vger.kernel.org
126Description:
127		Indicates the interface flags as a bitmask in hexadecimal. See
128		include/uapi/linux/if.h for a list of all possible values and
129		the flags semantics.
130
131What:		/sys/class/net/<iface>/ifalias
132Date:		September 2008
133KernelVersion:	2.6.28
134Contact:	netdev@vger.kernel.org
135Description:
136		Indicates/stores an interface alias name as a string. This can
137		be used for system management purposes.
138
139What:		/sys/class/net/<iface>/ifindex
140Date:		April 2005
141KernelVersion:	2.6.12
142Contact:	netdev@vger.kernel.org
143Description:
144		Indicates the system-wide interface unique index identifier as a
145		decimal number. This attribute is used for mapping an interface
146		identifier to an interface name. It is used throughout the
147		networking stack for specifying the interface specific
148		requests/events.
149
150What:		/sys/class/net/<iface>/iflink
151Date:		April 2005
152KernelVersion:	2.6.12
153Contact:	netdev@vger.kernel.org
154Description:
155		Indicates the system-wide interface unique index identifier a
156		the interface is linked to. Format is decimal. This attribute is
157		used to resolve interfaces chaining, linking and stacking.
158		Physical interfaces have the same 'ifindex' and 'iflink' values.
159
160What:		/sys/class/net/<iface>/link_mode
161Date:		March 2006
162KernelVersion:	2.6.17
163Contact:	netdev@vger.kernel.org
164Description:
165		Indicates the interface link mode, as a decimal number. This
166		attribute should be used in conjunction with 'dormant' attribute
167		to determine the interface usability. Possible values:
168		0: default link mode
169		1: dormant link mode
170
171What:		/sys/class/net/<iface>/mtu
172Date:		April 2005
173KernelVersion:	2.6.12
174Contact:	netdev@vger.kernel.org
175Description:
176		Indicates the interface currently configured MTU value, in
177		bytes, and in decimal format. Specific values depends on the
178		lower-level interface protocol used. Ethernet devices will show
179		a 'mtu' attribute value of 1500 unless changed.
180
181What:		/sys/class/net/<iface>/netdev_group
182Date:		January 2011
183KernelVersion:	2.6.39
184Contact:	netdev@vger.kernel.org
185Description:
186		Indicates the interface network device group, as a decimal
187		integer. Default value is 0 which corresponds to the initial
188		network devices group. The group can be changed to affect
189		routing decisions (see: net/ipv4/fib_rules and
190		net/ipv6/fib6_rules.c).
191
192What:		/sys/class/net/<iface>/operstate
193Date:		March 2006
194KernelVersion:	2.6.17
195Contact:	netdev@vger.kernel.org
196Description:
197		Indicates the interface RFC2863 operational state as a string.
198		Possible values are:
199		"unknown", "notpresent", "down", "lowerlayerdown", "testing",
200		"dormant", "up".
201
202What:		/sys/class/net/<iface>/phys_port_id
203Date:		July 2013
204KernelVersion:	3.12
205Contact:	netdev@vger.kernel.org
206Description:
207		Indicates the interface unique physical port identifier within
208		the NIC, as a string.
209
210What:		/sys/class/net/<iface>/phys_port_name
211Date:		March 2015
212KernelVersion:	4.0
213Contact:	netdev@vger.kernel.org
214Description:
215		Indicates the interface physical port name within the NIC,
216		as a string.
217
218What:		/sys/class/net/<iface>/speed
219Date:		October 2009
220KernelVersion:	2.6.33
221Contact:	netdev@vger.kernel.org
222Description:
223		Indicates the interface latest or current speed value. Value is
224		an integer representing the link speed in Mbits/sec.
225
226		Note: this attribute is only valid for interfaces that implement
227		the ethtool get_settings method (mostly Ethernet ).
228
229What:		/sys/class/net/<iface>/tx_queue_len
230Date:		April 2005
231KernelVersion:	2.6.12
232Contact:	netdev@vger.kernel.org
233Description:
234		Indicates the interface transmit queue len in number of packets,
235		as an integer value. Value depend on the type of interface,
236		Ethernet network adapters have a default value of 1000 unless
237		configured otherwise
238
239What:		/sys/class/net/<iface>/type
240Date:		April 2005
241KernelVersion:	2.6.12
242Contact:	netdev@vger.kernel.org
243Description:
244		Indicates the interface protocol type as a decimal value. See
245		include/uapi/linux/if_arp.h for all possible values.
246
247What:		/sys/class/net/<iface>/phys_switch_id
248Date:		November 2014
249KernelVersion:	3.19
250Contact:	netdev@vger.kernel.org
251Description:
252		Indicates the unique physical switch identifier of a switch this
253		port belongs to, as a string.
254