SYNOPSIS<\/a>
DESCRIPTION<\/a>
SUPPORTED NETDEV KINDS<\/a>
[MATCH] SECTION OPTIONS<\/a>
[NETDEV] SECTION OPTIONS<\/a>
[BRIDGE] SECTION OPTIONS<\/a>
[VLAN] SECTION OPTIONS<\/a>
[MACVLAN] SECTION OPTIONS<\/a>
[MACVTAP] SECTION OPTIONS<\/a>
[IPVLAN] SECTION OPTIONS<\/a>
[IPVTAP] SECTION OPTIONS<\/a>
[VXLAN] SECTION OPTIONS<\/a>
[GENEVE] SECTION OPTIONS<\/a>
[L2TP] SECTION OPTIONS<\/a>
[L2TPSESSION] SECTION OPTIONS<\/a>
[MACSEC] SECTION OPTIONS<\/a>
[MACSECRECEIVECHANNEL] SECTION OPTIONS<\/a>
[MACSECTRANSMITASSOCIATION] SECTION OPTIONS<\/a>
[MACSECRECEIVEASSOCIATION] SECTION OPTIONS<\/a>
[TUNNEL] SECTION OPTIONS<\/a>
[FOOOVERUDP] SECTION OPTIONS<\/a>
[PEER] SECTION OPTIONS<\/a>
[VXCAN] SECTION OPTIONS<\/a>
[TUN] SECTION OPTIONS<\/a>
[TAP] SECTION OPTIONS<\/a>
[WIREGUARD] SECTION OPTIONS<\/a>
[WIREGUARDPEER] SECTION OPTIONS<\/a>
[BOND] SECTION OPTIONS<\/a>
[XFRM] SECTION OPTIONS<\/a>
[VRF] SECTION OPTIONS<\/a>
EXAMPLES<\/a>
SEE ALSO<\/a>
NOTES<\/a> <\/p>\n
\n
NAME <\/a> <\/h2>\nsystemd.netdev \u2212 Virtual Network Device configuration<\/p>\n
SYNOPSIS <\/a> <\/h2>\nnetdev<\/i>.netdev<\/p>\nDESCRIPTION <\/a> <\/h2>\nA plain ini\u2212style text file that encodes configuration about a virtual network device, used by systemd-networkd<\/b>(8). See systemd.syntax<\/b>(7) for a general description of the syntax.<\/p>\n
The main Virtual Network Device file must have the extension .netdev; other extensions are ignored. Virtual network devices are created as soon as networkd is started. If a netdev with the specified name already exists, networkd will use that as\u2212is rather than create its own. Note that the settings of the pre\u2212existing netdev will not be changed by networkd.<\/p>\n
The .netdev files are read from the files located in the system network directory \/usr\/lib\/systemd\/network, the volatile runtime network directory \/run\/systemd\/network and the local administration network directory \/etc\/systemd\/network. All configuration files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in \/etc have the highest priority, files in \/run take precedence over files with the same name in \/usr\/lib. This can be used to override a system\u2212supplied configuration file with a local file if needed. As a special case, an empty file (file size 0) or symlink with the same name pointing to \/dev\/null disables the configuration file entirely (it is “masked”).<\/p>\n
Along with the netdev file foo.netdev, a “drop\u2212in” directory foo.netdev.d\/ may exist. All files with the suffix “.conf” from this directory will be parsed after the file itself is parsed. This is useful to alter or add configuration settings, without having to modify the main configuration file. Each drop\u2212in file must have appropriate section headers.<\/p>\n
In addition to \/etc\/systemd\/network, drop\u2212in “.d” directories can be placed in \/usr\/lib\/systemd\/network or \/run\/systemd\/network directories. Drop\u2212in files in \/etc take precedence over those in \/run which in turn take precedence over those in \/usr\/lib. Drop\u2212in files under any of these directories take precedence over the main netdev file wherever located. (Of course, since \/run is temporary and \/usr\/lib is for vendors, it is unlikely drop\u2212ins should be used in either of those places.)<\/p>\n
SUPPORTED NETDEV KINDS <\/a> <\/h2>\nThe following kinds of virtual network devices may be configured in .netdev files:<\/p>\n
Table\u00a01.\u00a0Supported kinds of virtual network devices<\/b><\/p>\n
![\"Image](\"grohtml-1228161.png\")
<\/b><\/p>\n[MATCH] SECTION OPTIONS <\/a> <\/h2>\nA virtual network device is only created if the [Match] section matches the current environment, or if the section is empty. The following keys are accepted:<\/p>\n
Host=<\/i><\/p>\n
Matches against the hostname or machine ID of the host. See “ConditionHost=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n
Virtualization=<\/i><\/p>\n
Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation. See “ConditionVirtualization=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n
KernelCommandLine=<\/i><\/p>\n
Checks whether a specific kernel command line option is set. See “ConditionKernelCommandLine=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n
KernelVersion=<\/i><\/p>\n
Checks whether the kernel version (as reported by uname \u2212r<\/b>) matches a certain expression. See “ConditionKernelVersion=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n
Architecture=<\/i><\/p>\n
Checks whether the system is running on a specific architecture. See “ConditionArchitecture=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n[NETDEV] SECTION OPTIONS <\/a> <\/h2>\nThe [NetDev] section accepts the following keys:<\/p>\n
Description=<\/i><\/p>\n
A free\u2212form description of the netdev.<\/p>\n
Name=<\/i><\/p>\n
The interface name used when creating the netdev. This setting is compulsory.<\/p>\n
Kind=<\/i><\/p>\n
The netdev kind. This setting is compulsory. See the “Supported netdev kinds” section for the valid keys.<\/p>\n
MTUBytes=<\/i><\/p>\n
The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G are supported and are understood to the base of 1024. For “tun” or “tap” devices, MTUBytes=<\/i> setting is not currently supported in [NetDev] section. Please specify it in [Link] section of corresponding systemd.network<\/b>(5) files.<\/p>\n
MACAddress=<\/i><\/p>\n
The MAC address to use for the device. For “tun” or “tap” devices, setting MACAddress=<\/i> in the [NetDev] section is not supported. Please specify it in [Link] section of the corresponding systemd.network<\/b>(5) file. If this option is not set, “vlan” devices inherit the MAC address of the physical interface. For other kind of netdevs, if this option is not set, then MAC address is generated based on the interface name and the machine-id<\/b>(5).<\/p>\n[BRIDGE] SECTION OPTIONS <\/a> <\/h2>\nThe [Bridge] section only applies for netdevs of kind “bridge”, and accepts the following keys:<\/p>\n
HelloTimeSec=<\/i><\/p>\n
HelloTimeSec specifies the number of seconds between two hello packets sent out by the root bridge and the designated bridges. Hello packets are used to communicate information about the topology throughout the entire bridged local area network.<\/p>\n
MaxAgeSec=<\/i><\/p>\n
MaxAgeSec specifies the number of seconds of maximum message age. If the last seen (received) hello packet is more than this number of seconds old, the bridge in question will start the takeover procedure in attempt to become the Root Bridge itself.<\/p>\n
ForwardDelaySec=<\/i><\/p>\n
ForwardDelaySec specifies the number of seconds spent in each of the Listening and Learning states before the Forwarding state is entered.<\/p>\n
AgeingTimeSec=<\/i><\/p>\n
This specifies the number of seconds a MAC Address will be kept in the forwarding database after having a packet received from this MAC Address.<\/p>\n
Priority=<\/i><\/p>\n
The priority of the bridge. An integer between 0 and 65535. A lower value means higher priority. The bridge having the lowest priority will be elected as root bridge.<\/p>\n
GroupForwardMask=<\/i><\/p>\n
A 16\u2212bit bitmask represented as an integer which allows forwarding of link local frames with 802.1D reserved addresses (01:80:C2:00:00:0X). A logical AND is performed between the specified bitmask and the exponentiation of 2^X, the lower nibble of the last octet of the MAC address. For example, a value of 8 would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802.1X PAE).<\/p>\n
DefaultPVID=<\/i><\/p>\n
This specifies the default port VLAN ID of a newly attached bridge port. Set this to an integer in the range 1\u20134094 or “none” to disable the PVID.<\/p>\n
MulticastQuerier=<\/i><\/p>\n
Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel. If enabled, the kernel will send general ICMP queries from a zero source address. This feature should allow faster convergence on startup, but it causes some multicast\u2212aware switches to misbehave and disrupt forwarding of multicast packets. When unset, the kernel’s default will be used.<\/p>\n
MulticastSnooping=<\/i><\/p>\n
Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel. If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic between hosts and multicast routers. When unset, the kernel’s default will be used.<\/p>\n
VLANFiltering=<\/i><\/p>\n
Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel. If enabled, the bridge will be started in VLAN\u2212filtering mode. When unset, the kernel’s default will be used.<\/p>\n
VLANProtocol=<\/i><\/p>\n
Allows setting the protocol used for VLAN filtering. Takes 802.1q<\/b> or, 802.1ad<\/b>, and defaults to unset and kernel’s default is used.<\/p>\n
STP=<\/i><\/p>\n
Takes a boolean. This enables the bridge’s Spanning Tree Protocol (STP). When unset, the kernel’s default will be used.<\/p>\n
MulticastIGMPVersion=<\/i><\/p>\n
Allows changing bridge’s multicast Internet Group Management Protocol (IGMP) version. Takes an integer 2 or 3. When unset, the kernel’s default will be used.<\/p>\n
[VLAN] SECTION OPTIONS <\/a> <\/h2>\nThe [VLAN] section only applies for netdevs of kind “vlan”, and accepts the following key:<\/p>\n
Id=<\/i><\/p>\n
The VLAN ID to use. An integer in the range 0\u20134094. This setting is compulsory.<\/p>\n
GVRP=<\/i><\/p>\n
Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that allows automatic learning of VLANs on a network. When unset, the kernel’s default will be used.<\/p>\n
MVRP=<\/i><\/p>\n
Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN Registration Protocol (GVRP) is a standards\u2212based Layer 2 network protocol, for automatic configuration of VLAN information on switches. It was defined in the 802.1ak amendment to 802.1Q\u22122005. When unset, the kernel’s default will be used.<\/p>\n
LooseBinding=<\/i><\/p>\n
Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed from the parent to the associated VLANs, but the VLAN device state is not changed. When unset, the kernel’s default will be used.<\/p>\n
ReorderHeader=<\/i><\/p>\n
Takes a boolean. When enabled, the VLAN reorder header is used and VLAN interfaces behave like physical interfaces. When unset, the kernel’s default will be used.<\/p>\n
[MACVLAN] SECTION OPTIONS <\/a> <\/h2>\nThe [MACVLAN] section only applies for netdevs of kind “macvlan”, and accepts the following key:<\/p>\n
Mode=<\/i><\/p>\n
The MACVLAN mode to use. The supported options are “private”, “vepa”, “bridge”, “passthru”, and “source”.<\/p>\n
SourceMACAddress=<\/i><\/p>\n
A whitespace\u2212separated list of remote hardware addresses allowed on the MACVLAN. This option only has an effect in source mode. Use full colon\u2212, hyphen\u2212 or dot\u2212delimited hexadecimal. This option may appear more than once, in which case the lists are merged. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset. Defaults to unset.<\/p>\n
[MACVTAP] SECTION OPTIONS <\/a> <\/h2>\nThe [MACVTAP] section applies for netdevs of kind “macvtap” and accepts the same key as [MACVLAN].<\/p>\n
[IPVLAN] SECTION OPTIONS <\/a> <\/h2>\nThe [IPVLAN] section only applies for netdevs of kind “ipvlan”, and accepts the following key:<\/p>\n
Mode=<\/i><\/p>\n
The IPVLAN mode to use. The supported options are “L2″,”L3” and “L3S”.<\/p>\n
Flags=<\/i><\/p>\n
The IPVLAN flags to use. The supported options are “bridge”,”private” and “vepa”.<\/p>\n
[IPVTAP] SECTION OPTIONS <\/a> <\/h2>\nThe [IPVTAP] section only applies for netdevs of kind “ipvtap” and accepts the same key as [IPVLAN].<\/p>\n
[VXLAN] SECTION OPTIONS <\/a> <\/h2>\nThe [VXLAN] section only applies for netdevs of kind “vxlan”, and accepts the following keys:<\/p>\n
VNI=<\/i><\/p>\n
The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range 1\u221216777215.<\/p>\n
Remote=<\/i><\/p>\n
Configures destination IP address.<\/p>\n
Local=<\/i><\/p>\n
Configures local IP address.<\/p>\n
Group=<\/i><\/p>\n
Configures VXLAN multicast group IP address. All members of a VXLAN must use the same multicast group address.<\/p>\n
TOS=<\/i><\/p>\n
The Type Of Service byte value for a vxlan interface.<\/p>\n
TTL=<\/i><\/p>\n
A fixed Time To Live N on Virtual eXtensible Local Area Network packets. Takes “inherit” or a number in the range 0\u2013255. 0 is a special value meaning inherit the inner protocol’s TTL value. “inherit” means that it will inherit the outer protocol’s TTL value.<\/p>\n
MacLearning=<\/i><\/p>\n
Takes a boolean. When true, enables dynamic MAC learning to discover remote MAC addresses.<\/p>\n
FDBAgeingSec=<\/i><\/p>\n
The lifetime of Forwarding Database entry learnt by the kernel, in seconds.<\/p>\n
MaximumFDBEntries=<\/i><\/p>\n
Configures maximum number of FDB entries.<\/p>\n
ReduceARPProxy=<\/i><\/p>\n
Takes a boolean. When true, bridge\u2212connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote Distributed Overlay Virtual Ethernet (DVOE)<\/font><\/b> [5]<\/font><\/small> clients. Defaults to false.<\/font><\/p>\nL2MissNotification=<\/i><\/font><\/p>\nTakes a boolean. When true, enables netlink LLADDR miss notifications.<\/font><\/p>\nL3MissNotification=<\/i><\/font><\/p>\nTakes a boolean. When true, enables netlink IP address miss notifications.<\/font><\/p>\nRouteShortCircuit=<\/i><\/font><\/p>\nTakes a boolean. When true, route short circuiting is turned on.<\/font><\/p>\nUDPChecksum=<\/i><\/font><\/p>\nTakes a boolean. When true, transmitting UDP checksums when doing VXLAN\/IPv4 is turned on.<\/font><\/p>\nUDP6ZeroChecksumTx=<\/i><\/font><\/p>\nTakes a boolean. When true, sending zero checksums in VXLAN\/IPv6 is turned on.<\/font><\/p>\nUDP6ZeroChecksumRx=<\/i><\/font><\/p>\nTakes a boolean. When true, receiving zero checksums in VXLAN\/IPv6 is turned on.<\/font><\/p>\nRemoteChecksumTx=<\/i><\/font><\/p>\nTakes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.<\/font><\/p>\nRemoteChecksumRx=<\/i><\/font><\/p>\nTakes a boolean. When true, remote receive checksum offload in VXLAN is turned on.<\/font><\/p>\nGroupPolicyExtension=<\/i><\/font><\/p>\nTakes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism across network peers based on VXLAN. For details about the Group Policy VXLAN, see the<\/font> VXLAN Group Policy<\/font><\/b> [6]<\/font><\/small> document. Defaults to false.<\/font><\/p>\nGenericProtocolExtension=<\/i><\/font><\/p>\nTakes a boolean. When true, Generic Protocol Extension extends the existing VXLAN protocol to provide protocol typing, OAM, and versioning capabilities. For details about the VXLAN GPE Header, see the<\/font> Generic Protocol Extension for VXLAN<\/font><\/b> [7]<\/font><\/small> document. If destination port is not specified and Generic Protocol Extension is set then default port of 4790 is used. Defaults to false.<\/font><\/p>\nDestinationPort=<\/i><\/font><\/p>\nConfigures the default destination UDP port. If the destination port is not specified then Linux kernel default will be used. Set to 4789 to get the IANA assigned value.<\/font><\/p>\nPortRange=<\/i><\/font><\/p>\nConfigures the source port range for the VXLAN. The kernel assigns the source UDP port based on the flow to help the receiver to do load balancing. When this option is not set, the normal range of local UDP ports is used.<\/font><\/p>\nFlowLabel=<\/i><\/font><\/p>\nSpecifies the flow label to use in outgoing packets. The valid range is 0\u22121048575.<\/font><\/p>\nIPDoNotFragment=<\/i><\/font><\/p>\nAllows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its value from the IPv4 inner header. Takes a boolean value, or “inherit”. Set to “inherit” if the encapsulated protocol is IPv6. When unset, the kernel’s default will be used.<\/font><\/p>\n[GENEVE] SECTION OPTIONS <\/a> <\/h2>\nThe [GENEVE] section only applies for netdevs of kind “geneve”, and accepts the following keys:<\/font><\/p>\nId=<\/i><\/font><\/p>\nSpecifies the Virtual Network Identifier (VNI) to use. Ranges [0\u221216777215]. This field is mandatory.<\/font><\/p>\nRemote=<\/i><\/font><\/p>\nSpecifies the unicast destination IP address to use in outgoing packets.<\/font><\/p>\nTOS=<\/i><\/font><\/p>\nSpecifies the TOS value to use in outgoing packets. Ranges [1\u2212255].<\/font><\/p>\nTTL=<\/i><\/font><\/p>\nAccepts the same values as in the [VXLAN] section, except that when unset or set to 0, the kernel’s default will be used, meaning that packet TTL will be set from \/proc\/sys\/net\/ipv4\/ip_default_ttl.<\/font><\/p>\nUDPChecksum=<\/i><\/font><\/p>\nTakes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4.<\/font><\/p>\nUDP6ZeroChecksumTx=<\/i><\/font><\/p>\nTakes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.<\/font><\/p>\nUDP6ZeroChecksumRx=<\/i><\/font><\/p>\nTakes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.<\/font><\/p>\nDestinationPort=<\/i><\/font><\/p>\nSpecifies destination port. Defaults to 6081. If not set or assigned the empty string, the default port of 6081 is used.<\/font><\/p>\nFlowLabel=<\/i><\/font><\/p>\nSpecifies the flow label to use in outgoing packets.<\/font><\/p>\nIPDoNotFragment=<\/i><\/font><\/p>\nAccepts the same key in [VXLAN] section.<\/font><\/p>\n[L2TP] SECTION OPTIONS <\/a> <\/h2>\nThe [L2TP] section only applies for netdevs of kind “l2tp”, and accepts the following keys:<\/font><\/p>\nTunnelId=<\/i><\/font><\/p>\nSpecifies the tunnel identifier. Takes an number in the range 1\u20134294967295. The value used must match the “PeerTunnelId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\nPeerTunnelId=<\/i><\/font><\/p>\nSpecifies the peer tunnel id. Takes a number in the range 1\u20144294967295. The value used must match the “PeerTunnelId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\nRemote=<\/i><\/font><\/p>\nSpecifies the IP address of the remote peer. This setting is compulsory.<\/font><\/p>\nLocal=<\/i><\/font><\/p>\nSpecifies the IP address of the local interface. Takes an IP address, or the special values “auto”, “static”, or “dynamic”. When an address is set, then the local interface must have the address. If “auto”, then one of the addresses on the local interface is used. Similarly, if “static” or “dynamic” is set, then one of the static or dynamic addresses on the local interface is used. Defaults to “auto”.<\/font><\/p>\nEncapsulationType=<\/i><\/font><\/p>\nSpecifies the encapsulation type of the tunnel. Takes one of “udp” or “ip”.<\/font><\/p>\nUDPSourcePort=<\/i><\/font><\/p>\nSpecifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected it’s mandatory. Ignored when IP encapsulation is selected.<\/font><\/p>\nUDPDestinationPort=<\/i><\/font><\/p>\nSpecifies destination port. When UDP encapsulation is selected it’s mandatory. Ignored when IP encapsulation is selected.<\/font><\/p>\nUDPChecksum=<\/i><\/font><\/p>\nTakes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4.<\/font><\/p>\nUDP6ZeroChecksumTx=<\/i><\/font><\/p>\nTakes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.<\/font><\/p>\nUDP6ZeroChecksumRx=<\/i><\/font><\/p>\nTakes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.<\/font><\/p>\n[L2TPSESSION] SECTION OPTIONS <\/a> <\/h2>\nThe [L2TPSession] section only applies for netdevs of kind “l2tp”, and accepts the following keys:<\/font><\/p>\nName=<\/i><\/font><\/p>\nSpecifies the name of the session. This setting is compulsory.<\/font><\/p>\nSessionId=<\/i><\/font><\/p>\nSpecifies the session identifier. Takes an number in the range 1\u20134294967295. The value used must match the “SessionId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\nPeerSessionId=<\/i><\/font><\/p>\nSpecifies the peer session identifier. Takes an number in the range 1\u20134294967295. The value used must match the “PeerSessionId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\nLayer2SpecificHeader=<\/i><\/font><\/p>\nSpecifies layer2specific header type of the session. One of “none” or “default”. Defaults to “default”.<\/font><\/p>\n[MACSEC] SECTION OPTIONS <\/a> <\/h2>\nThe [MACsec] section only applies for network devices of kind “macsec”, and accepts the following keys:<\/font><\/p>\nPort=<\/i><\/font><\/p>\nSpecifies the port to be used for the MACsec transmit channel. The port is used to make secure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.<\/font><\/p>\nEncrypt=<\/i><\/font><\/p>\nTakes a boolean. When true, enable encryption. Defaults to unset.<\/font><\/p>\n[MACSECRECEIVECHANNEL] SECTION OPTIONS <\/a> <\/h2>\nThe [MACsecReceiveChannel] section only applies for network devices of kind “macsec”, and accepts the following keys:<\/font><\/p>\nPort=<\/i><\/font><\/p>\nSpecifies the port to be used for the MACsec receive channel. The port is used to make secure channel identifier (SCI). Takes a value between 1 and 65535. This option is compulsory, and is not set by default.<\/font><\/p>\nMACAddress=<\/i><\/font><\/p>\nSpecifies the MAC address to be used for the MACsec receive channel. The MAC address used to make secure channel identifier (SCI). This setting is compulsory, and is not set by default.<\/font><\/p>\n[MACSECTRANSMITASSOCIATION] SECTION OPTIONS <\/a> <\/h2>\nThe [MACsecTransmitAssociation] section only applies for network devices of kind “macsec”, and accepts the following keys:<\/font><\/p>\nPacketNumber=<\/i><\/font><\/p>\nSpecifies the packet number to be used for replay protection and the construction of the initialization vector (along with the secure channel identifier [SCI]). Takes a value between 1\u22124,294,967,295. Defaults to unset.<\/font><\/p>\nKeyId=<\/i><\/font><\/p>\nSpecifies the identification for the key. Takes a number between 0\u2212255. This option is compulsory, and is not set by default.<\/font><\/p>\n
netdev<\/i>.netdev<\/p>\n A plain ini\u2212style text file that encodes configuration about a virtual network device, used by systemd-networkd<\/b>(8). See systemd.syntax<\/b>(7) for a general description of the syntax.<\/p>\n The main Virtual Network Device file must have the extension .netdev; other extensions are ignored. Virtual network devices are created as soon as networkd is started. If a netdev with the specified name already exists, networkd will use that as\u2212is rather than create its own. Note that the settings of the pre\u2212existing netdev will not be changed by networkd.<\/p>\n The .netdev files are read from the files located in the system network directory \/usr\/lib\/systemd\/network, the volatile runtime network directory \/run\/systemd\/network and the local administration network directory \/etc\/systemd\/network. All configuration files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. Files in \/etc have the highest priority, files in \/run take precedence over files with the same name in \/usr\/lib. This can be used to override a system\u2212supplied configuration file with a local file if needed. As a special case, an empty file (file size 0) or symlink with the same name pointing to \/dev\/null disables the configuration file entirely (it is “masked”).<\/p>\n Along with the netdev file foo.netdev, a “drop\u2212in” directory foo.netdev.d\/ may exist. All files with the suffix “.conf” from this directory will be parsed after the file itself is parsed. This is useful to alter or add configuration settings, without having to modify the main configuration file. Each drop\u2212in file must have appropriate section headers.<\/p>\n In addition to \/etc\/systemd\/network, drop\u2212in “.d” directories can be placed in \/usr\/lib\/systemd\/network or \/run\/systemd\/network directories. Drop\u2212in files in \/etc take precedence over those in \/run which in turn take precedence over those in \/usr\/lib. Drop\u2212in files under any of these directories take precedence over the main netdev file wherever located. (Of course, since \/run is temporary and \/usr\/lib is for vendors, it is unlikely drop\u2212ins should be used in either of those places.)<\/p>\n The following kinds of virtual network devices may be configured in .netdev files:<\/p>\n Table\u00a01.\u00a0Supported kinds of virtual network devices<\/b><\/p>\n A virtual network device is only created if the [Match] section matches the current environment, or if the section is empty. The following keys are accepted:<\/p>\n Host=<\/i><\/p>\n Matches against the hostname or machine ID of the host. See “ConditionHost=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n Virtualization=<\/i><\/p>\n Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation. See “ConditionVirtualization=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n KernelCommandLine=<\/i><\/p>\n Checks whether a specific kernel command line option is set. See “ConditionKernelCommandLine=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n KernelVersion=<\/i><\/p>\n Checks whether the kernel version (as reported by uname \u2212r<\/b>) matches a certain expression. See “ConditionKernelVersion=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n Architecture=<\/i><\/p>\n Checks whether the system is running on a specific architecture. See “ConditionArchitecture=” in systemd.unit<\/b>(5) for details. When prefixed with an exclamation mark (“!”), the result is negated. If an empty string is assigned, then previously assigned value is cleared.<\/p>\n The [NetDev] section accepts the following keys:<\/p>\n Description=<\/i><\/p>\n A free\u2212form description of the netdev.<\/p>\n Name=<\/i><\/p>\n The interface name used when creating the netdev. This setting is compulsory.<\/p>\n Kind=<\/i><\/p>\n The netdev kind. This setting is compulsory. See the “Supported netdev kinds” section for the valid keys.<\/p>\n MTUBytes=<\/i><\/p>\n The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G are supported and are understood to the base of 1024. For “tun” or “tap” devices, MTUBytes=<\/i> setting is not currently supported in [NetDev] section. Please specify it in [Link] section of corresponding systemd.network<\/b>(5) files.<\/p>\n MACAddress=<\/i><\/p>\n The MAC address to use for the device. For “tun” or “tap” devices, setting MACAddress=<\/i> in the [NetDev] section is not supported. Please specify it in [Link] section of the corresponding systemd.network<\/b>(5) file. If this option is not set, “vlan” devices inherit the MAC address of the physical interface. For other kind of netdevs, if this option is not set, then MAC address is generated based on the interface name and the machine-id<\/b>(5).<\/p>\n The [Bridge] section only applies for netdevs of kind “bridge”, and accepts the following keys:<\/p>\n HelloTimeSec=<\/i><\/p>\n HelloTimeSec specifies the number of seconds between two hello packets sent out by the root bridge and the designated bridges. Hello packets are used to communicate information about the topology throughout the entire bridged local area network.<\/p>\n MaxAgeSec=<\/i><\/p>\n MaxAgeSec specifies the number of seconds of maximum message age. If the last seen (received) hello packet is more than this number of seconds old, the bridge in question will start the takeover procedure in attempt to become the Root Bridge itself.<\/p>\n ForwardDelaySec=<\/i><\/p>\n ForwardDelaySec specifies the number of seconds spent in each of the Listening and Learning states before the Forwarding state is entered.<\/p>\n AgeingTimeSec=<\/i><\/p>\n This specifies the number of seconds a MAC Address will be kept in the forwarding database after having a packet received from this MAC Address.<\/p>\n Priority=<\/i><\/p>\n The priority of the bridge. An integer between 0 and 65535. A lower value means higher priority. The bridge having the lowest priority will be elected as root bridge.<\/p>\n GroupForwardMask=<\/i><\/p>\n A 16\u2212bit bitmask represented as an integer which allows forwarding of link local frames with 802.1D reserved addresses (01:80:C2:00:00:0X). A logical AND is performed between the specified bitmask and the exponentiation of 2^X, the lower nibble of the last octet of the MAC address. For example, a value of 8 would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802.1X PAE).<\/p>\n DefaultPVID=<\/i><\/p>\n This specifies the default port VLAN ID of a newly attached bridge port. Set this to an integer in the range 1\u20134094 or “none” to disable the PVID.<\/p>\n MulticastQuerier=<\/i><\/p>\n Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel. If enabled, the kernel will send general ICMP queries from a zero source address. This feature should allow faster convergence on startup, but it causes some multicast\u2212aware switches to misbehave and disrupt forwarding of multicast packets. When unset, the kernel’s default will be used.<\/p>\n MulticastSnooping=<\/i><\/p>\n Takes a boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel. If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic between hosts and multicast routers. When unset, the kernel’s default will be used.<\/p>\n VLANFiltering=<\/i><\/p>\n Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel. If enabled, the bridge will be started in VLAN\u2212filtering mode. When unset, the kernel’s default will be used.<\/p>\n VLANProtocol=<\/i><\/p>\n Allows setting the protocol used for VLAN filtering. Takes 802.1q<\/b> or, 802.1ad<\/b>, and defaults to unset and kernel’s default is used.<\/p>\n STP=<\/i><\/p>\n Takes a boolean. This enables the bridge’s Spanning Tree Protocol (STP). When unset, the kernel’s default will be used.<\/p>\n MulticastIGMPVersion=<\/i><\/p>\n Allows changing bridge’s multicast Internet Group Management Protocol (IGMP) version. Takes an integer 2 or 3. When unset, the kernel’s default will be used.<\/p>\n The [VLAN] section only applies for netdevs of kind “vlan”, and accepts the following key:<\/p>\n Id=<\/i><\/p>\n The VLAN ID to use. An integer in the range 0\u20134094. This setting is compulsory.<\/p>\n GVRP=<\/i><\/p>\n Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that allows automatic learning of VLANs on a network. When unset, the kernel’s default will be used.<\/p>\n MVRP=<\/i><\/p>\n Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN Registration Protocol (GVRP) is a standards\u2212based Layer 2 network protocol, for automatic configuration of VLAN information on switches. It was defined in the 802.1ak amendment to 802.1Q\u22122005. When unset, the kernel’s default will be used.<\/p>\n LooseBinding=<\/i><\/p>\n Takes a boolean. The VLAN loose binding mode, in which only the operational state is passed from the parent to the associated VLANs, but the VLAN device state is not changed. When unset, the kernel’s default will be used.<\/p>\n ReorderHeader=<\/i><\/p>\n Takes a boolean. When enabled, the VLAN reorder header is used and VLAN interfaces behave like physical interfaces. When unset, the kernel’s default will be used.<\/p>\n The [MACVLAN] section only applies for netdevs of kind “macvlan”, and accepts the following key:<\/p>\n Mode=<\/i><\/p>\n The MACVLAN mode to use. The supported options are “private”, “vepa”, “bridge”, “passthru”, and “source”.<\/p>\n SourceMACAddress=<\/i><\/p>\n A whitespace\u2212separated list of remote hardware addresses allowed on the MACVLAN. This option only has an effect in source mode. Use full colon\u2212, hyphen\u2212 or dot\u2212delimited hexadecimal. This option may appear more than once, in which case the lists are merged. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset. Defaults to unset.<\/p>\n The [MACVTAP] section applies for netdevs of kind “macvtap” and accepts the same key as [MACVLAN].<\/p>\n The [IPVLAN] section only applies for netdevs of kind “ipvlan”, and accepts the following key:<\/p>\n Mode=<\/i><\/p>\n The IPVLAN mode to use. The supported options are “L2″,”L3” and “L3S”.<\/p>\n Flags=<\/i><\/p>\n The IPVLAN flags to use. The supported options are “bridge”,”private” and “vepa”.<\/p>\n The [IPVTAP] section only applies for netdevs of kind “ipvtap” and accepts the same key as [IPVLAN].<\/p>\n The [VXLAN] section only applies for netdevs of kind “vxlan”, and accepts the following keys:<\/p>\n VNI=<\/i><\/p>\n The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range 1\u221216777215.<\/p>\n Remote=<\/i><\/p>\n Configures destination IP address.<\/p>\n Local=<\/i><\/p>\n Configures local IP address.<\/p>\n Group=<\/i><\/p>\n Configures VXLAN multicast group IP address. All members of a VXLAN must use the same multicast group address.<\/p>\n TOS=<\/i><\/p>\n The Type Of Service byte value for a vxlan interface.<\/p>\n TTL=<\/i><\/p>\n A fixed Time To Live N on Virtual eXtensible Local Area Network packets. Takes “inherit” or a number in the range 0\u2013255. 0 is a special value meaning inherit the inner protocol’s TTL value. “inherit” means that it will inherit the outer protocol’s TTL value.<\/p>\n MacLearning=<\/i><\/p>\n Takes a boolean. When true, enables dynamic MAC learning to discover remote MAC addresses.<\/p>\n FDBAgeingSec=<\/i><\/p>\n The lifetime of Forwarding Database entry learnt by the kernel, in seconds.<\/p>\n MaximumFDBEntries=<\/i><\/p>\n Configures maximum number of FDB entries.<\/p>\n ReduceARPProxy=<\/i><\/p>\n Takes a boolean. When true, bridge\u2212connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote Distributed Overlay Virtual Ethernet (DVOE)<\/font><\/b> [5]<\/font><\/small> clients. Defaults to false.<\/font><\/p>\n L2MissNotification=<\/i><\/font><\/p>\n Takes a boolean. When true, enables netlink LLADDR miss notifications.<\/font><\/p>\n L3MissNotification=<\/i><\/font><\/p>\n Takes a boolean. When true, enables netlink IP address miss notifications.<\/font><\/p>\n RouteShortCircuit=<\/i><\/font><\/p>\n Takes a boolean. When true, route short circuiting is turned on.<\/font><\/p>\n UDPChecksum=<\/i><\/font><\/p>\n Takes a boolean. When true, transmitting UDP checksums when doing VXLAN\/IPv4 is turned on.<\/font><\/p>\n UDP6ZeroChecksumTx=<\/i><\/font><\/p>\n Takes a boolean. When true, sending zero checksums in VXLAN\/IPv6 is turned on.<\/font><\/p>\n UDP6ZeroChecksumRx=<\/i><\/font><\/p>\n Takes a boolean. When true, receiving zero checksums in VXLAN\/IPv6 is turned on.<\/font><\/p>\n RemoteChecksumTx=<\/i><\/font><\/p>\n Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.<\/font><\/p>\n RemoteChecksumRx=<\/i><\/font><\/p>\n Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.<\/font><\/p>\n GroupPolicyExtension=<\/i><\/font><\/p>\n Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism across network peers based on VXLAN. For details about the Group Policy VXLAN, see the<\/font> VXLAN Group Policy<\/font><\/b> [6]<\/font><\/small> document. Defaults to false.<\/font><\/p>\n GenericProtocolExtension=<\/i><\/font><\/p>\n Takes a boolean. When true, Generic Protocol Extension extends the existing VXLAN protocol to provide protocol typing, OAM, and versioning capabilities. For details about the VXLAN GPE Header, see the<\/font> Generic Protocol Extension for VXLAN<\/font><\/b> [7]<\/font><\/small> document. If destination port is not specified and Generic Protocol Extension is set then default port of 4790 is used. Defaults to false.<\/font><\/p>\n DestinationPort=<\/i><\/font><\/p>\n Configures the default destination UDP port. If the destination port is not specified then Linux kernel default will be used. Set to 4789 to get the IANA assigned value.<\/font><\/p>\n PortRange=<\/i><\/font><\/p>\n Configures the source port range for the VXLAN. The kernel assigns the source UDP port based on the flow to help the receiver to do load balancing. When this option is not set, the normal range of local UDP ports is used.<\/font><\/p>\n FlowLabel=<\/i><\/font><\/p>\n Specifies the flow label to use in outgoing packets. The valid range is 0\u22121048575.<\/font><\/p>\n IPDoNotFragment=<\/i><\/font><\/p>\n Allows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its value from the IPv4 inner header. Takes a boolean value, or “inherit”. Set to “inherit” if the encapsulated protocol is IPv6. When unset, the kernel’s default will be used.<\/font><\/p>\n The [GENEVE] section only applies for netdevs of kind “geneve”, and accepts the following keys:<\/font><\/p>\n Id=<\/i><\/font><\/p>\n Specifies the Virtual Network Identifier (VNI) to use. Ranges [0\u221216777215]. This field is mandatory.<\/font><\/p>\n Remote=<\/i><\/font><\/p>\n Specifies the unicast destination IP address to use in outgoing packets.<\/font><\/p>\n TOS=<\/i><\/font><\/p>\n Specifies the TOS value to use in outgoing packets. Ranges [1\u2212255].<\/font><\/p>\n TTL=<\/i><\/font><\/p>\n Accepts the same values as in the [VXLAN] section, except that when unset or set to 0, the kernel’s default will be used, meaning that packet TTL will be set from \/proc\/sys\/net\/ipv4\/ip_default_ttl.<\/font><\/p>\n UDPChecksum=<\/i><\/font><\/p>\n Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4.<\/font><\/p>\n UDP6ZeroChecksumTx=<\/i><\/font><\/p>\n Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.<\/font><\/p>\n UDP6ZeroChecksumRx=<\/i><\/font><\/p>\n Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.<\/font><\/p>\n DestinationPort=<\/i><\/font><\/p>\n Specifies destination port. Defaults to 6081. If not set or assigned the empty string, the default port of 6081 is used.<\/font><\/p>\n FlowLabel=<\/i><\/font><\/p>\n Specifies the flow label to use in outgoing packets.<\/font><\/p>\n IPDoNotFragment=<\/i><\/font><\/p>\n Accepts the same key in [VXLAN] section.<\/font><\/p>\n The [L2TP] section only applies for netdevs of kind “l2tp”, and accepts the following keys:<\/font><\/p>\n TunnelId=<\/i><\/font><\/p>\n Specifies the tunnel identifier. Takes an number in the range 1\u20134294967295. The value used must match the “PeerTunnelId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\n PeerTunnelId=<\/i><\/font><\/p>\n Specifies the peer tunnel id. Takes a number in the range 1\u20144294967295. The value used must match the “PeerTunnelId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\n Remote=<\/i><\/font><\/p>\n Specifies the IP address of the remote peer. This setting is compulsory.<\/font><\/p>\n Local=<\/i><\/font><\/p>\n Specifies the IP address of the local interface. Takes an IP address, or the special values “auto”, “static”, or “dynamic”. When an address is set, then the local interface must have the address. If “auto”, then one of the addresses on the local interface is used. Similarly, if “static” or “dynamic” is set, then one of the static or dynamic addresses on the local interface is used. Defaults to “auto”.<\/font><\/p>\n EncapsulationType=<\/i><\/font><\/p>\n Specifies the encapsulation type of the tunnel. Takes one of “udp” or “ip”.<\/font><\/p>\n UDPSourcePort=<\/i><\/font><\/p>\n Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected it’s mandatory. Ignored when IP encapsulation is selected.<\/font><\/p>\n UDPDestinationPort=<\/i><\/font><\/p>\n Specifies destination port. When UDP encapsulation is selected it’s mandatory. Ignored when IP encapsulation is selected.<\/font><\/p>\n UDPChecksum=<\/i><\/font><\/p>\n Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4.<\/font><\/p>\n UDP6ZeroChecksumTx=<\/i><\/font><\/p>\n Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.<\/font><\/p>\n UDP6ZeroChecksumRx=<\/i><\/font><\/p>\n Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.<\/font><\/p>\n The [L2TPSession] section only applies for netdevs of kind “l2tp”, and accepts the following keys:<\/font><\/p>\n Name=<\/i><\/font><\/p>\n Specifies the name of the session. This setting is compulsory.<\/font><\/p>\n SessionId=<\/i><\/font><\/p>\n Specifies the session identifier. Takes an number in the range 1\u20134294967295. The value used must match the “SessionId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\n PeerSessionId=<\/i><\/font><\/p>\n Specifies the peer session identifier. Takes an number in the range 1\u20134294967295. The value used must match the “PeerSessionId=” value being used at the peer. This setting is compulsory.<\/font><\/p>\n Layer2SpecificHeader=<\/i><\/font><\/p>\n Specifies layer2specific header type of the session. One of “none” or “default”. Defaults to “default”.<\/font><\/p>\n The [MACsec] section only applies for network devices of kind “macsec”, and accepts the following keys:<\/font><\/p>\n Port=<\/i><\/font><\/p>\n Specifies the port to be used for the MACsec transmit channel. The port is used to make secure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.<\/font><\/p>\n Encrypt=<\/i><\/font><\/p>\n Takes a boolean. When true, enable encryption. Defaults to unset.<\/font><\/p>\n The [MACsecReceiveChannel] section only applies for network devices of kind “macsec”, and accepts the following keys:<\/font><\/p>\n Port=<\/i><\/font><\/p>\n Specifies the port to be used for the MACsec receive channel. The port is used to make secure channel identifier (SCI). Takes a value between 1 and 65535. This option is compulsory, and is not set by default.<\/font><\/p>\n MACAddress=<\/i><\/font><\/p>\n Specifies the MAC address to be used for the MACsec receive channel. The MAC address used to make secure channel identifier (SCI). This setting is compulsory, and is not set by default.<\/font><\/p>\n The [MACsecTransmitAssociation] section only applies for network devices of kind “macsec”, and accepts the following keys:<\/font><\/p>\n PacketNumber=<\/i><\/font><\/p>\n Specifies the packet number to be used for replay protection and the construction of the initialization vector (along with the secure channel identifier [SCI]). Takes a value between 1\u22124,294,967,295. Defaults to unset.<\/font><\/p>\n KeyId=<\/i><\/font><\/p>\n Specifies the identification for the key. Takes a number between 0\u2212255. This option is compulsory, and is not set by default.<\/font><\/p>\nDESCRIPTION <\/a> <\/h2>\n
SUPPORTED NETDEV KINDS <\/a> <\/h2>\n
<\/b><\/p>\n[MATCH] SECTION OPTIONS <\/a> <\/h2>\n
[NETDEV] SECTION OPTIONS <\/a> <\/h2>\n
[BRIDGE] SECTION OPTIONS <\/a> <\/h2>\n
[VLAN] SECTION OPTIONS <\/a> <\/h2>\n
[MACVLAN] SECTION OPTIONS <\/a> <\/h2>\n
[MACVTAP] SECTION OPTIONS <\/a> <\/h2>\n
[IPVLAN] SECTION OPTIONS <\/a> <\/h2>\n
[IPVTAP] SECTION OPTIONS <\/a> <\/h2>\n
[VXLAN] SECTION OPTIONS <\/a> <\/h2>\n
[GENEVE] SECTION OPTIONS <\/a> <\/h2>\n
[L2TP] SECTION OPTIONS <\/a> <\/h2>\n
[L2TPSESSION] SECTION OPTIONS <\/a> <\/h2>\n
[MACSEC] SECTION OPTIONS <\/a> <\/h2>\n
[MACSECRECEIVECHANNEL] SECTION OPTIONS <\/a> <\/h2>\n
[MACSECTRANSMITASSOCIATION] SECTION OPTIONS <\/a> <\/h2>\n