Documentation/ABI/testing/sysfs-class-net

   1 What:           /sys/class/net/<iface>/name_assign_type
   2 Date:           July 2014
   3 KernelVersion:  3.17
   4 Contact:        netdev@vger.kernel.org
   5 Description:
   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
  12 What:           /sys/class/net/<iface>/addr_assign_type
  13 Date:           July 2010
  14 KernelVersion:  3.2
  15 Contact:        netdev@vger.kernel.org
  16 Description:
  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
  23 What:           /sys/class/net/<iface>/addr_len
  24 Date:           April 2005
  25 KernelVersion:  2.6.12
  26 Contact:        netdev@vger.kernel.org
  27 Description:
  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
  33 What:           /sys/class/net/<iface>/address
  34 Date:           April 2005
  35 KernelVersion:  2.6.12
  36 Contact:        netdev@vger.kernel.org
  37 Description:
  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
  42 What:           /sys/class/net/<bridge iface>/bridge/group_fwd_mask
  43 Date:           January 2012
  44 KernelVersion:  3.2
  45 Contact:        netdev@vger.kernel.org
  46 Description:
  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
  61 What:           /sys/class/net/<iface>/broadcast
  62 Date:           April 2005
  63 KernelVersion:  2.6.12
  64 Contact:        netdev@vger.kernel.org
  65 Description:
  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
  70 What:           /sys/class/net/<iface>/carrier
  71 Date:           April 2005
  72 KernelVersion:  2.6.12
  73 Contact:        netdev@vger.kernel.org
  74 Description:
  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
  84 What:           /sys/class/net/<iface>/dev_id
  85 Date:           April 2008
  86 KernelVersion:  2.6.26
  87 Contact:        netdev@vger.kernel.org
  88 Description:
  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
  94 What:           /sys/class/net/<iface>/dormant
  95 Date:           March 2006
  96 KernelVersion:  2.6.17
  97 Contact:        netdev@vger.kernel.org
  98 Description:
  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
 109 What:           /sys/clas/net/<iface>/duplex
 110 Date:           October 2009
 111 KernelVersion:  2.6.33
 112 Contact:        netdev@vger.kernel.org
 113 Description:
 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
 122 What:           /sys/class/net/<iface>/flags
 123 Date:           April 2005
 124 KernelVersion:  2.6.12
 125 Contact:        netdev@vger.kernel.org
 126 Description:
 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
 131 What:           /sys/class/net/<iface>/ifalias
 132 Date:           September 2008
 133 KernelVersion:  2.6.28
 134 Contact:        netdev@vger.kernel.org
 135 Description:
 136                 Indicates/stores an interface alias name as a string. This can
 137                 be used for system management purposes.
 138
 139 What:           /sys/class/net/<iface>/ifindex
 140 Date:           April 2005
 141 KernelVersion:  2.6.12
 142 Contact:        netdev@vger.kernel.org
 143 Description:
 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
 150 What:           /sys/class/net/<iface>/iflink
 151 Date:           April 2005
 152 KernelVersion:  2.6.12
 153 Contact:        netdev@vger.kernel.org
 154 Description:
 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
 160 What:           /sys/class/net/<iface>/link_mode
 161 Date:           March 2006
 162 KernelVersion:  2.6.17
 163 Contact:        netdev@vger.kernel.org
 164 Description:
 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
 171 What:           /sys/class/net/<iface>/mtu
 172 Date:           April 2005
 173 KernelVersion:  2.6.12
 174 Contact:        netdev@vger.kernel.org
 175 Description:
 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
 181 What:           /sys/class/net/<iface>/netdev_group
 182 Date:           January 2011
 183 KernelVersion:  2.6.39
 184 Contact:        netdev@vger.kernel.org
 185 Description:
 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
 192 What:           /sys/class/net/<iface>/operstate
 193 Date:           March 2006
 194 KernelVersion:  2.6.17
 195 Contact:        netdev@vger.kernel.org
 196 Description:
 197                 Indicates the interface RFC2863 operational state as a string.
 198                 Possible values are:
 199                 "unknown", "notpresent", "down", "lowerlayerdown", "testing",
 200                 "dormant", "up".
 201
 202 What:           /sys/class/net/<iface>/phys_port_id
 203 Date:           July 2013
 204 KernelVersion:  3.12
 205 Contact:        netdev@vger.kernel.org
 206 Description:
 207                 Indicates the interface unique physical port identifier within
 208                 the NIC, as a string.
 209
 210 What:           /sys/class/net/<iface>/phys_port_name
 211 Date:           March 2015
 212 KernelVersion:  4.0
 213 Contact:        netdev@vger.kernel.org
 214 Description:
 215                 Indicates the interface physical port name within the NIC,
 216                 as a string.
 217
 218 What:           /sys/class/net/<iface>/speed
 219 Date:           October 2009
 220 KernelVersion:  2.6.33
 221 Contact:        netdev@vger.kernel.org
 222 Description:
 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
 229 What:           /sys/class/net/<iface>/tx_queue_len
 230 Date:           April 2005
 231 KernelVersion:  2.6.12
 232 Contact:        netdev@vger.kernel.org
 233 Description:
 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
 239 What:           /sys/class/net/<iface>/type
 240 Date:           April 2005
 241 KernelVersion:  2.6.12
 242 Contact:        netdev@vger.kernel.org
 243 Description:
 244                 Indicates the interface protocol type as a decimal value. See
 245                 include/uapi/linux/if_arp.h for all possible values.
 246
 247 What:           /sys/class/net/<iface>/phys_switch_id
 248 Date:           November 2014
 249 KernelVersion:  3.19
 250 Contact:        netdev@vger.kernel.org
 251 Description:
 252                 Indicates the unique physical switch identifier of a switch this
 253                 port belongs to, as a string.
 254
 255 What:           /sys/class/net/<iface>/phydev
 256 Date:           May 2017
 257 KernelVersion:  4.13
 258 Contact:        netdev@vger.kernel.org
 259 Description:
 260                 Symbolic link to the PHY device this network device is attached
 261                 to.
 262
 263 What:           /sys/class/net/<iface>/carrier_changes
 264 Date:           Mar 2014
 265 KernelVersion:  3.15
 266 Contact:        netdev@vger.kernel.org
 267 Description:
 268                 32-bit unsigned integer counting the number of times the link has
 269                 seen a change from UP to DOWN and vice versa
 270
 271 What:           /sys/class/net/<iface>/carrier_up_count
 272 Date:           Jan 2018
 273 KernelVersion:  4.16
 274 Contact:        netdev@vger.kernel.org
 275 Description:
 276                 32-bit unsigned integer counting the number of times the link has
 277                 been up
 278
 279 What:           /sys/class/net/<iface>/carrier_down_count
 280 Date:           Jan 2018
 281 KernelVersion:  4.16
 282 Contact:        netdev@vger.kernel.org
 283 Description:
 284                 32-bit unsigned integer counting the number of times the link has
 285                 been down