{ "mode": "man", "parameter": "SYSTEMD.NETDEV", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/SYSTEMD.NETDEV/5/json", "generated": "2026-06-02T19:34:26Z", "synopsis": "netdev.netdev", "sections": { "NAME": { "content": "systemd.netdev - Virtual Network Device configuration\n", "subsections": [] }, "SYNOPSIS": { "content": "netdev.netdev\n", "subsections": [] }, "DESCRIPTION": { "content": "A plain ini-style text file that encodes configuration about a virtual network device, used\nby systemd-networkd(8). See systemd.syntax(7) for a general description of the syntax.\n\nThe main Virtual Network Device file must have the extension .netdev; other extensions are\nignored. Virtual network devices are created as soon as networkd is started. If a netdev with\nthe specified name already exists, networkd will use that as-is rather than create its own.\nNote that the settings of the pre-existing netdev will not be changed by networkd.\n\nThe .netdev files are read from the files located in the system network directory\n/lib/systemd/network, the volatile runtime network directory /run/systemd/network and the\nlocal administration network directory /etc/systemd/network. All configuration files are\ncollectively sorted and processed in lexical order, regardless of the directories in which\nthey live. However, files with identical filenames replace each other. Files in /etc/ have\nthe highest priority, files in /run/ take precedence over files with the same name in /lib/.\nThis can be used to override a system-supplied configuration file with a local file if\nneeded. As a special case, an empty file (file size 0) or symlink with the same name pointing\nto /dev/null disables the configuration file entirely (it is \"masked\").\n\nAlong with the netdev file foo.netdev, a \"drop-in\" directory foo.netdev.d/ may exist. All\nfiles with the suffix \".conf\" from this directory will be merged in the alphanumeric order\nand parsed after the main file itself has been parsed. This is useful to alter or add\nconfiguration settings, without having to modify the main configuration file. Each drop-in\nfile must have appropriate section headers.\n\nIn addition to /etc/systemd/network, drop-in \".d\" directories can be placed in\n/lib/systemd/network or /run/systemd/network directories. Drop-in files in /etc/ take\nprecedence over those in /run/ which in turn take precedence over those in /lib/. Drop-in\nfiles under any of these directories take precedence over the main netdev file wherever\nlocated. (Of course, since /run/ is temporary and /usr/lib/ is for vendors, it is unlikely\ndrop-ins should be used in either of those places.)\n", "subsections": [] }, "SUPPORTED NETDEV KINDS": { "content": "The following kinds of virtual network devices may be configured in .netdev files:\n", "subsections": [ { "name": "Table 1. Supported kinds of virtual network devices", "content": "┌──────────┬───────────────────────────────────┐\n│Kind │ Description │\n├──────────┼───────────────────────────────────┤\n│bond │ A bond device is an aggregation │\n│ │ of all its slave devices. See │\n│ │ Linux Ethernet Bonding Driver │\n│ │ HOWTO[1] for details. │\n├──────────┼───────────────────────────────────┤\n│bridge │ A bridge device is a software │\n│ │ switch, and each of its slave │\n│ │ devices and the bridge itself are │\n│ │ ports of the switch. │\n├──────────┼───────────────────────────────────┤\n│dummy │ A dummy device drops all packets │\n│ │ sent to it. │\n├──────────┼───────────────────────────────────┤\n│gre │ A Level 3 GRE tunnel over IPv4. │\n│ │ See RFC 2784[2] for details. │\n├──────────┼───────────────────────────────────┤\n│gretap │ A Level 2 GRE tunnel over IPv4. │\n├──────────┼───────────────────────────────────┤\n│erspan │ ERSPAN mirrors traffic on one or │\n│ │ more source ports and delivers │\n│ │ the mirrored traffic to one or │\n│ │ more destination ports on another │\n│ │ switch. The traffic is │\n│ │ encapsulated in generic routing │\n│ │ encapsulation (GRE) and is │\n│ │ therefore routable across a layer │\n│ │ 3 network between the source │\n│ │ switch and the destination │\n│ │ switch. │\n├──────────┼───────────────────────────────────┤\n│ip6gre │ A Level 3 GRE tunnel over IPv6. │\n├──────────┼───────────────────────────────────┤\n│ip6tnl │ An IPv4 or IPv6 tunnel over IPv6 │\n├──────────┼───────────────────────────────────┤\n│ip6gretap │ A Level 2 GRE tunnel over IPv6. │\n├──────────┼───────────────────────────────────┤\n│ipip │ An IPv4 over IPv4 tunnel. │\n├──────────┼───────────────────────────────────┤\n│ipvlan │ An IPVLAN device is a stacked │\n│ │ device which receives packets │\n│ │ from its underlying device based │\n│ │ on IP address filtering. │\n├──────────┼───────────────────────────────────┤\n│ipvtap │ An IPVTAP device is a stacked │\n│ │ device which receives packets │\n│ │ from its underlying device based │\n│ │ on IP address filtering and can │\n│ │ be accessed using the tap user │\n│ │ space interface. │\n├──────────┼───────────────────────────────────┤\n│macvlan │ A macvlan device is a stacked │\n│ │ device which receives packets │\n│ │ from its underlying device based │\n│ │ on MAC address filtering. │\n├──────────┼───────────────────────────────────┤\n│macvtap │ A macvtap device is a stacked │\n│ │ device which receives packets │\n│ │ from its underlying device based │\n│ │ on MAC address filtering. │\n├──────────┼───────────────────────────────────┤\n│sit │ An IPv6 over IPv4 tunnel. │\n├──────────┼───────────────────────────────────┤\n│tap │ A persistent Level 2 tunnel │\n│ │ between a network device and a │\n│ │ device node. │\n├──────────┼───────────────────────────────────┤\n│tun │ A persistent Level 3 tunnel │\n│ │ between a network device and a │\n│ │ device node. │\n├──────────┼───────────────────────────────────┤\n│veth │ An Ethernet tunnel between a pair │\n│ │ of network devices. │\n├──────────┼───────────────────────────────────┤\n│vlan │ A VLAN is a stacked device which │\n│ │ receives packets from its │\n│ │ underlying device based on VLAN │\n│ │ tagging. See IEEE 802.1Q[3] for │\n│ │ details. │\n├──────────┼───────────────────────────────────┤\n│vti │ An IPv4 over IPSec tunnel. │\n├──────────┼───────────────────────────────────┤\n│vti6 │ An IPv6 over IPSec tunnel. │\n├──────────┼───────────────────────────────────┤\n│vxlan │ A virtual extensible LAN (vxlan), │\n│ │ for connecting Cloud computing │\n│ │ deployments. │\n├──────────┼───────────────────────────────────┤\n│geneve │ A GEneric NEtwork Virtualization │\n│ │ Encapsulation (GENEVE) netdev │\n│ │ driver. │\n├──────────┼───────────────────────────────────┤\n│l2tp │ A Layer 2 Tunneling Protocol │\n│ │ (L2TP) is a tunneling protocol │\n│ │ used to support virtual private │\n│ │ networks (VPNs) or as part of the │\n│ │ delivery of services by ISPs. It │\n│ │ does not provide any encryption │\n│ │ or confidentiality by itself │\n├──────────┼───────────────────────────────────┤\n│macsec │ Media Access Control Security │\n│ │ (MACsec) is an 802.1AE IEEE │\n│ │ industry-standard security │\n│ │ technology that provides secure │\n│ │ communication for all traffic on │\n│ │ Ethernet links. MACsec provides │\n│ │ point-to-point security on │\n│ │ Ethernet links between directly │\n│ │ connected nodes and is capable of │\n│ │ identifying and preventing most │\n│ │ security threats. │\n├──────────┼───────────────────────────────────┤\n│vrf │ A Virtual Routing and Forwarding │\n│ │ (VRF[4]) interface to create │\n│ │ separate routing and forwarding │\n│ │ domains. │\n├──────────┼───────────────────────────────────┤\n│vcan │ The virtual CAN driver (vcan). │\n│ │ Similar to the network loopback │\n│ │ devices, vcan offers a virtual │\n│ │ local CAN interface. │\n├──────────┼───────────────────────────────────┤\n│vxcan │ The virtual CAN tunnel driver │\n│ │ (vxcan). Similar to the virtual │\n│ │ ethernet driver veth, vxcan │\n│ │ implements a local CAN traffic │\n│ │ tunnel between two virtual CAN │\n│ │ network devices. When creating a │\n│ │ vxcan, two vxcan devices are │\n│ │ created as pair. When one end │\n│ │ receives the packet it appears on │\n│ │ its pair and vice versa. The │\n│ │ vxcan can be used for cross │\n│ │ namespace communication. │\n├──────────┼───────────────────────────────────┤\n│wireguard │ WireGuard Secure Network Tunnel. │\n├──────────┼───────────────────────────────────┤\n│nlmon │ A Netlink monitor device. Use an │\n│ │ nlmon device when you want to │\n│ │ monitor system Netlink messages. │\n├──────────┼───────────────────────────────────┤\n│fou │ Foo-over-UDP tunneling. │\n├──────────┼───────────────────────────────────┤\n│xfrm │ A virtual tunnel interface like │\n│ │ vti/vti6 but with several │\n│ │ advantages. │\n├──────────┼───────────────────────────────────┤\n│ifb │ The Intermediate Functional Block │\n│ │ (ifb) pseudo network interface │\n│ │ acts as a QoS concentrator for │\n│ │ multiple different sources of │\n│ │ traffic. │\n├──────────┼───────────────────────────────────┤\n│bareudp │ Bare UDP tunnels provide a │\n│ │ generic L3 encapsulation support │\n│ │ for tunnelling different L3 │\n│ │ protocols like MPLS, IP etc. │\n│ │ inside of an UDP tunnel. │\n├──────────┼───────────────────────────────────┤\n│batadv │ B.A.T.M.A.N. Advanced[5] is a │\n│ │ routing protocol for multi-hop │\n│ │ mobile ad-hoc networks which │\n│ │ operates on layer 2. │\n└──────────┴───────────────────────────────────┘\n" }, { "name": "[MATCH] SECTION OPTIONS", "content": "A virtual network device is only created if the [Match] section matches the current\nenvironment, or if the section is empty. The following keys are accepted:\n\nHost=\nMatches against the hostname or machine ID of the host. See \"ConditionHost=\" in\nsystemd.unit(5) for details. When prefixed with an exclamation mark (\"!\"), the result is\nnegated. If an empty string is assigned, then previously assigned value is cleared.\n\nVirtualization=\nChecks whether the system is executed in a virtualized environment and optionally test\nwhether it is a specific implementation. See \"ConditionVirtualization=\" in\nsystemd.unit(5) for details. When prefixed with an exclamation mark (\"!\"), the result is\nnegated. If an empty string is assigned, then previously assigned value is cleared.\n\nKernelCommandLine=\nChecks whether a specific kernel command line option is set. See\n\"ConditionKernelCommandLine=\" in systemd.unit(5) for details. When prefixed with an\nexclamation mark (\"!\"), the result is negated. If an empty string is assigned, then\npreviously assigned value is cleared.\n\nKernelVersion=\nChecks whether the kernel version (as reported by uname -r) matches a certain expression.\nSee \"ConditionKernelVersion=\" in systemd.unit(5) for details. When prefixed with an\nexclamation mark (\"!\"), the result is negated. If an empty string is assigned, then\npreviously assigned value is cleared.\n\nArchitecture=\nChecks whether the system is running on a specific architecture. See\n\"ConditionArchitecture=\" in systemd.unit(5) for details. When prefixed with an\nexclamation mark (\"!\"), the result is negated. If an empty string is assigned, then\npreviously assigned value is cleared.\n\nFirmware=\nChecks whether the system is running on a machine with the specified firmware. See\n\"ConditionFirmware=\" in systemd.unit(5) for details. When prefixed with an exclamation\nmark (\"!\"), the result is negated. If an empty string is assigned, then previously\nassigned value is cleared.\n" }, { "name": "[NETDEV] SECTION OPTIONS", "content": "The [NetDev] section accepts the following keys:\n\nDescription=\nA free-form description of the netdev.\n\nName=\nThe interface name used when creating the netdev. This setting is compulsory.\n\nKind=\nThe netdev kind. This setting is compulsory. See the \"Supported netdev kinds\" section for\nthe valid keys.\n\nMTUBytes=\nThe maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G\nare supported and are understood to the base of 1024. For \"tun\" or \"tap\" devices,\nMTUBytes= setting is not currently supported in [NetDev] section. Please specify it in\n[Link] section of corresponding systemd.network(5) files.\n\nMACAddress=\nThe MAC address to use for the device. For \"tun\" or \"tap\" devices, setting MACAddress= in\nthe [NetDev] section is not supported. Please specify it in [Link] section of the\ncorresponding systemd.network(5) file. If this option is not set, \"vlan\" devices inherit\nthe MAC address of the physical interface. For other kind of netdevs, if this option is\nnot set, then MAC address is generated based on the interface name and the machine-id(5).\n" }, { "name": "[BRIDGE] SECTION OPTIONS", "content": "The [Bridge] section only applies for netdevs of kind \"bridge\", and accepts the following\nkeys:\n\nHelloTimeSec=\nHelloTimeSec specifies the number of seconds between two hello packets sent out by the\nroot bridge and the designated bridges. Hello packets are used to communicate information\nabout the topology throughout the entire bridged local area network.\n\nMaxAgeSec=\nMaxAgeSec specifies the number of seconds of maximum message age. If the last seen\n(received) hello packet is more than this number of seconds old, the bridge in question\nwill start the takeover procedure in attempt to become the Root Bridge itself.\n\nForwardDelaySec=\nForwardDelaySec specifies the number of seconds spent in each of the Listening and\nLearning states before the Forwarding state is entered.\n\nAgeingTimeSec=\nThis specifies the number of seconds a MAC Address will be kept in the forwarding\ndatabase after having a packet received from this MAC Address.\n\nPriority=\nThe priority of the bridge. An integer between 0 and 65535. A lower value means higher\npriority. The bridge having the lowest priority will be elected as root bridge.\n\nGroupForwardMask=\nA 16-bit bitmask represented as an integer which allows forwarding of link local frames\nwith 802.1D reserved addresses (01:80:C2:00:00:0X). A logical AND is performed between\nthe specified bitmask and the exponentiation of 2^X, the lower nibble of the last octet\nof the MAC address. For example, a value of 8 would allow forwarding of frames addressed\nto 01:80:C2:00:00:03 (802.1X PAE).\n\nDefaultPVID=\nThis specifies the default port VLAN ID of a newly attached bridge port. Set this to an\ninteger in the range 1...4094 or \"none\" to disable the PVID.\n\nMulticastQuerier=\nTakes a boolean. This setting controls the IFLABRMCASTQUERIER option in the kernel. If\nenabled, the kernel will send general ICMP queries from a zero source address. This\nfeature should allow faster convergence on startup, but it causes some multicast-aware\nswitches to misbehave and disrupt forwarding of multicast packets. When unset, the\nkernel's default will be used.\n\nMulticastSnooping=\nTakes a boolean. This setting controls the IFLABRMCASTSNOOPING option in the kernel.\nIf enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic\nbetween hosts and multicast routers. When unset, the kernel's default will be used.\n\nVLANFiltering=\nTakes a boolean. This setting controls the IFLABRVLANFILTERING option in the kernel.\nIf enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's\ndefault will be used.\n\nVLANProtocol=\nAllows setting the protocol used for VLAN filtering. Takes 802.1q or, 802.1ad, and\ndefaults to unset and kernel's default is used.\n\nSTP=\nTakes a boolean. This enables the bridge's Spanning Tree Protocol (STP). When unset, the\nkernel's default will be used.\n\nMulticastIGMPVersion=\nAllows changing bridge's multicast Internet Group Management Protocol (IGMP) version.\nTakes an integer 2 or 3. When unset, the kernel's default will be used.\n" }, { "name": "[VLAN] SECTION OPTIONS", "content": "The [VLAN] section only applies for netdevs of kind \"vlan\", and accepts the following key:\n\nId=\nThe VLAN ID to use. An integer in the range 0...4094. This setting is compulsory.\n\nProtocol=\nAllows setting the protocol used for the VLAN interface. Takes \"802.1q\" or, \"802.1ad\",\nand defaults to unset and kernel's default is used.\n\nGVRP=\nTakes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that allows\nautomatic learning of VLANs on a network. When unset, the kernel's default will be used.\n\nMVRP=\nTakes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN\nRegistration Protocol (GVRP) is a standards-based Layer 2 network protocol, for automatic\nconfiguration of VLAN information on switches. It was defined in the 802.1ak amendment to\n802.1Q-2005. When unset, the kernel's default will be used.\n\nLooseBinding=\nTakes a boolean. The VLAN loose binding mode, in which only the operational state is\npassed from the parent to the associated VLANs, but the VLAN device state is not changed.\nWhen unset, the kernel's default will be used.\n\nReorderHeader=\nTakes a boolean. When enabled, the VLAN reorder header is used and VLAN interfaces behave\nlike physical interfaces. When unset, the kernel's default will be used.\n\nEgressQOSMaps=\nDefines a mapping of Linux internal packet priority (SOPRIORITY) to VLAN header PCP\nfield for outgoing frames. Takes a whitespace-separated list of unsigned integer pairs in\nthe format \"from\"-\"to\", e.g., \"21-7 45-5\" ranges 1–4294967294. Note that \"from\" must be\ngreater than or equal to \"to\". When unset, the kernel's default will be used.\n\nIngressQOSMaps=\nDefines a mapping of Linux internal packet priority (SOPRIORITY) to VLAN header PCP\nfield for incoming frames. Takes a whitespace-separated list of unsigned integer pairs in\nthe format \"from\"-\"to\", e.g., \"21-7 45-5\" ranges 1–4294967294. Note that \"from\" must be\ngreater than or equal to \"to\". When unset, the kernel's default will be used.\n" }, { "name": "[MACVLAN] SECTION OPTIONS", "content": "The [MACVLAN] section only applies for netdevs of kind \"macvlan\", and accepts the following\nkey:\n\nMode=\nThe MACVLAN mode to use. The supported options are \"private\", \"vepa\", \"bridge\",\n\"passthru\", and \"source\".\n\nSourceMACAddress=\nA whitespace-separated list of remote hardware addresses allowed on the MACVLAN. This\noption only has an effect in source mode. Use full colon-, hyphen- or dot-delimited\nhexadecimal. This option may appear more than once, in which case the lists are merged.\nIf the empty string is assigned to this option, the list of hardware addresses defined\nprior to this is reset. Defaults to unset.\n\nBroadcastMulticastQueueLength=\nSpecifies the length of the receive queue for broadcast/multicast packets. An unsigned\ninteger in the range 0...4294967294. Defaults to unset.\n" }, { "name": "[MACVTAP] SECTION OPTIONS", "content": "The [MACVTAP] section applies for netdevs of kind \"macvtap\" and accepts the same keys as\n[MACVLAN].\n" }, { "name": "[IPVLAN] SECTION OPTIONS", "content": "The [IPVLAN] section only applies for netdevs of kind \"ipvlan\", and accepts the following\nkey:\n\nMode=\nThe IPVLAN mode to use. The supported options are \"L2\",\"L3\" and \"L3S\".\n\nFlags=\nThe IPVLAN flags to use. The supported options are \"bridge\",\"private\" and \"vepa\".\n" }, { "name": "[IPVTAP] SECTION OPTIONS", "content": "The [IPVTAP] section only applies for netdevs of kind \"ipvtap\" and accepts the same keys as\n[IPVLAN].\n" }, { "name": "[VXLAN] SECTION OPTIONS", "content": "The [VXLAN] section only applies for netdevs of kind \"vxlan\", and accepts the following keys:\n\nVNI=\nThe VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range\n1...16777215.\n\nRemote=\nConfigures destination IP address.\n\nLocal=\nConfigures local IP address.\n\nGroup=\nConfigures VXLAN multicast group IP address. All members of a VXLAN must use the same\nmulticast group address.\n\nTOS=\nThe Type Of Service byte value for a vxlan interface.\n\nTTL=\nA fixed Time To Live N on Virtual eXtensible Local Area Network packets. Takes \"inherit\"\nor a number in the range 0...255. 0 is a special value meaning inherit the inner\nprotocol's TTL value. \"inherit\" means that it will inherit the outer protocol's TTL\nvalue.\n\nMacLearning=\nTakes a boolean. When true, enables dynamic MAC learning to discover remote MAC\naddresses.\n\nFDBAgeingSec=\nThe lifetime of Forwarding Database entry learnt by the kernel, in seconds.\n\nMaximumFDBEntries=\nConfigures maximum number of FDB entries.\n\nReduceARPProxy=\nTakes a boolean. When true, bridge-connected VXLAN tunnel endpoint answers ARP requests\nfrom the local bridge on behalf of remote Distributed Overlay Virtual Ethernet (DVOE)[6]\nclients. Defaults to false.\n\nL2MissNotification=\nTakes a boolean. When true, enables netlink LLADDR miss notifications.\n\nL3MissNotification=\nTakes a boolean. When true, enables netlink IP address miss notifications.\n\nRouteShortCircuit=\nTakes a boolean. When true, route short circuiting is turned on.\n\nUDPChecksum=\nTakes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned\non.\n\nUDP6ZeroChecksumTx=\nTakes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.\n\nUDP6ZeroChecksumRx=\nTakes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.\n\nRemoteChecksumTx=\nTakes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.\n\nRemoteChecksumRx=\nTakes a boolean. When true, remote receive checksum offload in VXLAN is turned on.\n\nGroupPolicyExtension=\nTakes a boolean. When true, it enables Group Policy VXLAN extension security label\nmechanism across network peers based on VXLAN. For details about the Group Policy VXLAN,\nsee the VXLAN Group Policy[7] document. Defaults to false.\n\nGenericProtocolExtension=\nTakes a boolean. When true, Generic Protocol Extension extends the existing VXLAN\nprotocol to provide protocol typing, OAM, and versioning capabilities. For details about\nthe VXLAN GPE Header, see the Generic Protocol Extension for VXLAN[8] document. If\ndestination port is not specified and Generic Protocol Extension is set then default port\nof 4790 is used. Defaults to false.\n\nDestinationPort=\nConfigures the default destination UDP port. If the destination port is not specified\nthen Linux kernel default will be used. Set to 4789 to get the IANA assigned value.\n\nPortRange=\nConfigures the source port range for the VXLAN. The kernel assigns the source UDP port\nbased on the flow to help the receiver to do load balancing. When this option is not set,\nthe normal range of local UDP ports is used.\n\nFlowLabel=\nSpecifies the flow label to use in outgoing packets. The valid range is 0-1048575.\n\nIPDoNotFragment=\nAllows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its\nvalue from the IPv4 inner header. Takes a boolean value, or \"inherit\". Set to \"inherit\"\nif the encapsulated protocol is IPv6. When unset, the kernel's default will be used.\n" }, { "name": "[GENEVE] SECTION OPTIONS", "content": "The [GENEVE] section only applies for netdevs of kind \"geneve\", and accepts the following\nkeys:\n\nId=\nSpecifies the Virtual Network Identifier (VNI) to use, a number between 0 and 16777215.\nThis field is mandatory.\n\nRemote=\nSpecifies the unicast destination IP address to use in outgoing packets.\n\nTOS=\nSpecifies the TOS value to use in outgoing packets. Takes a number between 1 and 255.\n\nTTL=\nAccepts the same values as in the [VXLAN] section, except that when unset or set to 0,\nthe kernel's default will be used, meaning that packet TTL will be set from\n/proc/sys/net/ipv4/ipdefaultttl.\n\nUDPChecksum=\nTakes a boolean. When true, specifies that UDP checksum is calculated for transmitted\npackets over IPv4.\n\nUDP6ZeroChecksumTx=\nTakes a boolean. When true, skip UDP checksum calculation for transmitted packets over\nIPv6.\n\nUDP6ZeroChecksumRx=\nTakes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum\nfield.\n\nDestinationPort=\nSpecifies destination port. Defaults to 6081. If not set or assigned the empty string,\nthe default port of 6081 is used.\n\nFlowLabel=\nSpecifies the flow label to use in outgoing packets.\n\nIPDoNotFragment=\nAccepts the same key as in [VXLAN] section.\n\nIndependent=\nTakes a boolean. When true, the vxlan interface is created without any underlying network\ninterface. Defaults to false, which means that a .network file that requests this tunnel\nusing Tunnel= is required for the tunnel to be created.\n" }, { "name": "[BAREUDP] SECTION OPTIONS", "content": "The [BareUDP] section only applies for netdevs of kind \"bareudp\", and accepts the following\nkeys:\n\nDestinationPort=\nSpecifies the destination UDP port (in range 1...65535). This is mandatory.\n\nEtherType=\nSpecifies the L3 protocol. Takes one of \"ipv4\", \"ipv6\", \"mpls-uc\" or \"mpls-mc\". This is\nmandatory.\n" }, { "name": "[L2TP] SECTION OPTIONS", "content": "The [L2TP] section only applies for netdevs of kind \"l2tp\", and accepts the following keys:\n\nTunnelId=\nSpecifies the tunnel identifier. Takes an number in the range 1...4294967295. The value\nused must match the \"PeerTunnelId=\" value being used at the peer. This setting is\ncompulsory.\n\nPeerTunnelId=\nSpecifies the peer tunnel id. Takes a number in the range 1...4294967295. The value used\nmust match the \"TunnelId=\" value being used at the peer. This setting is compulsory.\n\nRemote=\nSpecifies the IP address of the remote peer. This setting is compulsory.\n\nLocal=\nSpecifies the IP address of the local interface. Takes an IP address, or the special\nvalues \"auto\", \"static\", or \"dynamic\". When an address is set, then the local interface\nmust have the address. If \"auto\", then one of the addresses on the local interface is\nused. Similarly, if \"static\" or \"dynamic\" is set, then one of the static or dynamic\naddresses on the local interface is used. Defaults to \"auto\".\n\nEncapsulationType=\nSpecifies the encapsulation type of the tunnel. Takes one of \"udp\" or \"ip\".\n\nUDPSourcePort=\nSpecifies the UDP source port to be used for the tunnel. When UDP encapsulation is\nselected it's mandatory. Ignored when IP encapsulation is selected.\n\nUDPDestinationPort=\nSpecifies destination port. When UDP encapsulation is selected it's mandatory. Ignored\nwhen IP encapsulation is selected.\n\nUDPChecksum=\nTakes a boolean. When true, specifies that UDP checksum is calculated for transmitted\npackets over IPv4.\n\nUDP6ZeroChecksumTx=\nTakes a boolean. When true, skip UDP checksum calculation for transmitted packets over\nIPv6.\n\nUDP6ZeroChecksumRx=\nTakes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum\nfield.\n" }, { "name": "[L2TPSESSION] SECTION OPTIONS", "content": "The [L2TPSession] section only applies for netdevs of kind \"l2tp\", and accepts the following\nkeys:\n\nName=\nSpecifies the name of the session. This setting is compulsory.\n\nSessionId=\nSpecifies the session identifier. Takes an number in the range 1...4294967295. The value\nused must match the \"SessionId=\" value being used at the peer. This setting is\ncompulsory.\n\nPeerSessionId=\nSpecifies the peer session identifier. Takes an number in the range 1...4294967295. The\nvalue used must match the \"PeerSessionId=\" value being used at the peer. This setting is\ncompulsory.\n\nLayer2SpecificHeader=\nSpecifies layer2specific header type of the session. One of \"none\" or \"default\". Defaults\nto \"default\".\n" }, { "name": "[MACSEC] SECTION OPTIONS", "content": "The [MACsec] section only applies for network devices of kind \"macsec\", and accepts the\nfollowing keys:\n\nPort=\nSpecifies the port to be used for the MACsec transmit channel. The port is used to make\nsecure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.\n\nEncrypt=\nTakes a boolean. When true, enable encryption. Defaults to unset.\n" }, { "name": "[MACSECRECEIVECHANNEL] SECTION OPTIONS", "content": "The [MACsecReceiveChannel] section only applies for network devices of kind \"macsec\", and\naccepts the following keys:\n\nPort=\nSpecifies the port to be used for the MACsec receive channel. The port is used to make\nsecure channel identifier (SCI). Takes a value between 1 and 65535. This option is\ncompulsory, and is not set by default.\n\nMACAddress=\nSpecifies the MAC address to be used for the MACsec receive channel. The MAC address used\nto make secure channel identifier (SCI). This setting is compulsory, and is not set by\ndefault.\n" }, { "name": "[MACSECTRANSMITASSOCIATION] SECTION OPTIONS", "content": "The [MACsecTransmitAssociation] section only applies for network devices of kind \"macsec\",\nand accepts the following keys:\n\nPacketNumber=\nSpecifies the packet number to be used for replay protection and the construction of the\ninitialization vector (along with the secure channel identifier [SCI]). Takes a value\nbetween 1-4,294,967,295. Defaults to unset.\n\nKeyId=\nSpecifies the identification for the key. Takes a number between 0-255. This option is\ncompulsory, and is not set by default.\n\nKey=\nSpecifies the encryption key used in the transmission channel. The same key must be\nconfigured on the peer’s matching receive channel. This setting is compulsory, and is not\nset by default. Takes a 128-bit key encoded in a hexadecimal string, for example\n\"dffafc8d7b9a43d5b9a3dfbbf6a30c16\".\n\nKeyFile=\nTakes an absolute path to a file which contains a 128-bit key encoded in a hexadecimal\nstring, which will be used in the transmission channel. When this option is specified,\nKey= is ignored. Note that the file must be readable by the user \"systemd-network\", so it\nshould be, e.g., owned by \"root:systemd-network\" with a \"0640\" file mode. If the path\nrefers to an AFUNIX stream socket in the file system a connection is made to it and the\nkey read from it.\n\nActivate=\nTakes a boolean. If enabled, then the security association is activated. Defaults to\nunset.\n\nUseForEncoding=\nTakes a boolean. If enabled, then the security association is used for encoding. Only one\n[MACsecTransmitAssociation] section can enable this option. When enabled, Activate=yes is\nimplied. Defaults to unset.\n" }, { "name": "[MACSECRECEIVEASSOCIATION] SECTION OPTIONS", "content": "The [MACsecReceiveAssociation] section only applies for network devices of kind \"macsec\", and\naccepts the following keys:\n\nPort=\nAccepts the same key as in [MACsecReceiveChannel] section.\n\nMACAddress=\nAccepts the same key as in [MACsecReceiveChannel] section.\n\nPacketNumber=\nAccepts the same key as in [MACsecTransmitAssociation] section.\n\nKeyId=\nAccepts the same key as in [MACsecTransmitAssociation] section.\n\nKey=\nAccepts the same key as in [MACsecTransmitAssociation] section.\n\nKeyFile=\nAccepts the same key as in [MACsecTransmitAssociation] section.\n\nActivate=\nAccepts the same key as in [MACsecTransmitAssociation] section.\n" }, { "name": "[TUNNEL] SECTION OPTIONS", "content": "The [Tunnel] section only applies for netdevs of kind \"ipip\", \"sit\", \"gre\", \"gretap\",\n\"ip6gre\", \"ip6gretap\", \"vti\", \"vti6\", \"ip6tnl\", and \"erspan\" and accepts the following keys:\n\nLocal=\nA static local address for tunneled packets. It must be an address on another interface\nof this host, or the special value \"any\".\n\nRemote=\nThe remote endpoint of the tunnel. Takes an IP address or the special value \"any\".\n\nTOS=\nThe Type Of Service byte value for a tunnel interface. For details about the TOS, see the\nType of Service in the Internet Protocol Suite[9] document.\n\nTTL=\nA fixed Time To Live N on tunneled packets. N is a number in the range 1...255. 0 is a\nspecial value meaning that packets inherit the TTL value. The default value for IPv4\ntunnels is 0 (inherit). The default value for IPv6 tunnels is 64.\n\nDiscoverPathMTU=\nTakes a boolean. When true, enables Path MTU Discovery on the tunnel.\n\nIPv6FlowLabel=\nConfigures the 20-bit flow label (see RFC 6437[10]) field in the IPv6 header (see RFC\n2460[11]), which is used by a node to label packets of a flow. It is only used for IPv6\ntunnels. A flow label of zero is used to indicate packets that have not been labeled. It\ncan be configured to a value in the range 0...0xFFFFF, or be set to \"inherit\", in which\ncase the original flowlabel is used.\n\nCopyDSCP=\nTakes a boolean. When true, the Differentiated Service Code Point (DSCP) field will be\ncopied to the inner header from outer header during the decapsulation of an IPv6 tunnel\npacket. DSCP is a field in an IP packet that enables different levels of service to be\nassigned to network traffic. Defaults to \"no\".\n\nEncapsulationLimit=\nThe Tunnel Encapsulation Limit option specifies how many additional levels of\nencapsulation are permitted to be prepended to the packet. For example, a Tunnel\nEncapsulation Limit option containing a limit value of zero means that a packet carrying\nthat option may not enter another tunnel before exiting the current tunnel. (see RFC\n2473[12]). The valid range is 0–255 and \"none\". Defaults to 4.\n\nKey=\nThe Key= parameter specifies the same key to use in both directions (InputKey= and\nOutputKey=). The Key= is either a number or an IPv4 address-like dotted quad. It is used\nas mark-configured SAD/SPD entry as part of the lookup key (both in data and control\npath) in IP XFRM (framework used to implement IPsec protocol). See ip-xfrm —— transform\nconfiguration[13] for details. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN\ntunnels.\n\nInputKey=\nThe InputKey= parameter specifies the key to use for input. The format is same as Key=.\nIt is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels.\n\nOutputKey=\nThe OutputKey= parameter specifies the key to use for output. The format is same as Key=.\nIt is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels.\n\nMode=\nAn \"ip6tnl\" tunnel can be in one of three modes \"ip6ip6\" for IPv6 over IPv6, \"ipip6\" for\nIPv4 over IPv6 or \"any\" for either.\n\nIndependent=\nTakes a boolean. When false (the default), the tunnel is always created over some network\ndevice, and a .network file that requests this tunnel using Tunnel= is required for the\ntunnel to be created. When true, the tunnel is created independently of any network as\n\"tunnel@NONE\".\n\nAssignToLoopback=\nTakes a boolean. If set to \"yes\", the loopback interface \"lo\" is used as the underlying\ndevice of the tunnel interface. Defaults to \"no\".\n\nAllowLocalRemote=\nTakes a boolean. When true allows tunnel traffic on ip6tnl devices where the remote\nendpoint is a local host address. When unset, the kernel's default will be used.\n\nFooOverUDP=\nTakes a boolean. Specifies whether FooOverUDP= tunnel is to be configured. Defaults to\nfalse. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels. For more detail\ninformation see Foo over UDP[14]\n\nFOUDestinationPort=\nThis setting specifies the UDP destination port for encapsulation. This field is\nmandatory when FooOverUDP=yes, and is not set by default.\n\nFOUSourcePort=\nThis setting specifies the UDP source port for encapsulation. Defaults to 0 — that is,\nthe source port for packets is left to the network stack to decide.\n\nEncapsulation=\nAccepts the same key as in the [FooOverUDP] section.\n\nIPv6RapidDeploymentPrefix=\nReconfigure the tunnel for IPv6 Rapid Deployment[15], also known as 6rd. The value is an\nISP-specific IPv6 prefix with a non-zero length. Only applicable to SIT tunnels.\n\nISATAP=\nTakes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing\nProtocol (ISATAP) tunnel. Only applicable to SIT tunnels. When unset, the kernel's\ndefault will be used.\n\nSerializeTunneledPackets=\nTakes a boolean. If set to yes, then packets are serialized. Only applies for GRE,\nGRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.\n\nERSPANIndex=\nSpecifies the ERSPAN index field for the interface, an integer in the range 1...1048575\nassociated with the ERSPAN traffic's source port and direction. This field is mandatory.\n" }, { "name": "[FOOOVERUDP] SECTION OPTIONS", "content": "The [FooOverUDP] section only applies for netdevs of kind \"fou\" and accepts the following\nkeys:\n\nEncapsulation=\nSpecifies the encapsulation mechanism used to store networking packets of various\nprotocols inside the UDP packets. Supports the following values: \"FooOverUDP\" provides\nthe simplest no-frills model of UDP encapsulation, it simply encapsulates packets\ndirectly in the UDP payload. \"GenericUDPEncapsulation\" is a generic and extensible\nencapsulation, it allows encapsulation of packets for any IP protocol and optional data\nas part of the encapsulation. For more detailed information see Generic UDP\nEncapsulation[16]. Defaults to \"FooOverUDP\".\n\nPort=\nSpecifies the port number where the encapsulated packets will arrive. Those packets will\nbe removed and manually fed back into the network stack with the encapsulation removed to\nbe sent to the real destination. This option is mandatory.\n\nPeerPort=\nSpecifies the peer port number. Defaults to unset. Note that when peer port is set\n\"Peer=\" address is mandatory.\n\nProtocol=\nThe Protocol= specifies the protocol number of the packets arriving at the UDP port. When\nEncapsulation=FooOverUDP, this field is mandatory and is not set by default. Takes an IP\nprotocol name such as \"gre\" or \"ipip\", or an integer within the range 1...255. When\nEncapsulation=GenericUDPEncapsulation, this must not be specified.\n\nPeer=\nConfigures peer IP address. Note that when peer address is set \"PeerPort=\" is mandatory.\n\nLocal=\nConfigures local IP address.\n" }, { "name": "[PEER] SECTION OPTIONS", "content": "The [Peer] section only applies for netdevs of kind \"veth\" and accepts the following keys:\n\nName=\nThe interface name used when creating the netdev. This setting is compulsory.\n\nMACAddress=\nThe peer MACAddress, if not set, it is generated in the same way as the MAC address of\nthe main interface.\n" }, { "name": "[VXCAN] SECTION OPTIONS", "content": "The [VXCAN] section only applies for netdevs of kind \"vxcan\" and accepts the following key:\n\nPeer=\nThe peer interface name used when creating the netdev. This setting is compulsory.\n" }, { "name": "[TUN] SECTION OPTIONS", "content": "The [Tun] section only applies for netdevs of kind \"tun\", and accepts the following keys:\n\nMultiQueue=\nTakes a boolean. Configures whether to use multiple file descriptors (queues) to\nparallelize packets sending and receiving. Defaults to \"no\".\n\nPacketInfo=\nTakes a boolean. Configures whether packets should be prepended with four extra bytes\n(two flag bytes and two protocol bytes). If disabled, it indicates that the packets will\nbe pure IP packets. Defaults to \"no\".\n\nVNetHeader=\nTakes a boolean. Configures IFFVNETHDR flag for a tun or tap device. It allows sending\nand receiving larger Generic Segmentation Offload (GSO) packets. This may increase\nthroughput significantly. Defaults to \"no\".\n\nUser=\nUser to grant access to the /dev/net/tun device.\n\nGroup=\nGroup to grant access to the /dev/net/tun device.\n" }, { "name": "[TAP] SECTION OPTIONS", "content": "The [Tap] section only applies for netdevs of kind \"tap\", and accepts the same keys as the\n[Tun] section.\n" }, { "name": "[WIREGUARD] SECTION OPTIONS", "content": "The [WireGuard] section accepts the following keys:\n\nPrivateKey=\nThe Base64 encoded private key for the interface. It can be generated using the wg genkey\ncommand (see wg(8)). This option or PrivateKeyFile= is mandatory to use WireGuard. Note\nthat because this information is secret, you may want to set the permissions of the\n.netdev file to be owned by \"root:systemd-network\" with a \"0640\" file mode.\n\nPrivateKeyFile=\nTakes an absolute path to a file which contains the Base64 encoded private key for the\ninterface. When this option is specified, then PrivateKey= is ignored. Note that the file\nmust be readable by the user \"systemd-network\", so it should be, e.g., owned by\n\"root:systemd-network\" with a \"0640\" file mode. If the path refers to an AFUNIX stream\nsocket in the file system a connection is made to it and the key read from it.\n\nListenPort=\nSets UDP port for listening. Takes either value between 1 and 65535 or \"auto\". If \"auto\"\nis specified, the port is automatically generated based on interface name. Defaults to\n\"auto\".\n\nFirewallMark=\nSets a firewall mark on outgoing WireGuard packets from this interface. Takes a number\nbetween 1 and 4294967295.\n" }, { "name": "[WIREGUARDPEER] SECTION OPTIONS", "content": "The [WireGuardPeer] section accepts the following keys:\n\nPublicKey=\nSets a Base64 encoded public key calculated by wg pubkey (see wg(8)) from a private key,\nand usually transmitted out of band to the author of the configuration file. This option\nis mandatory for this section.\n\nPresharedKey=\nOptional preshared key for the interface. It can be generated by the wg genpsk command.\nThis option adds an additional layer of symmetric-key cryptography to be mixed into the\nalready existing public-key cryptography, for post-quantum resistance. Note that because\nthis information is secret, you may want to set the permissions of the .netdev file to be\nowned by \"root:systemd-network\" with a \"0640\" file mode.\n\nPresharedKeyFile=\nTakes an absolute path to a file which contains the Base64 encoded preshared key for the\npeer. When this option is specified, then PresharedKey= is ignored. Note that the file\nmust be readable by the user \"systemd-network\", so it should be, e.g., owned by\n\"root:systemd-network\" with a \"0640\" file mode. If the path refers to an AFUNIX stream\nsocket in the file system a connection is made to it and the key read from it.\n\nAllowedIPs=\nSets a comma-separated list of IP (v4 or v6) addresses with CIDR masks from which this\npeer is allowed to send incoming traffic and to which outgoing traffic for this peer is\ndirected.\n\nThe catch-all 0.0.0.0/0 may be specified for matching all IPv4 addresses, and ::/0 may be\nspecified for matching all IPv6 addresses.\n\nNote that this only affects routing inside the network interface itself, i.e. the packets\nthat pass through the tunnel itself. To cause packets to be sent via the tunnel in the\nfirst place, an appropriate route needs to be added as well — either in the \"[Routes]\"\nsection on the \".network\" matching the wireguard interface, or externally to\nsystemd-networkd.\n\nEndpoint=\nSets an endpoint IP address or hostname, followed by a colon, and then a port number.\nThis endpoint will be updated automatically once to the most recent source IP address and\nport of correctly authenticated packets from the peer at configuration time.\n\nPersistentKeepalive=\nSets a seconds interval, between 1 and 65535 inclusive, of how often to send an\nauthenticated empty packet to the peer for the purpose of keeping a stateful firewall or\nNAT mapping valid persistently. For example, if the interface very rarely sends traffic,\nbut it might at anytime receive traffic from a peer, and it is behind NAT, the interface\nmight benefit from having a persistent keepalive interval of 25 seconds. If set to 0 or\n\"off\", this option is disabled. By default or when unspecified, this option is off. Most\nusers will not need this.\n" }, { "name": "[BOND] SECTION OPTIONS", "content": "The [Bond] section accepts the following key:\n\nMode=\nSpecifies one of the bonding policies. The default is \"balance-rr\" (round robin).\nPossible values are \"balance-rr\", \"active-backup\", \"balance-xor\", \"broadcast\", \"802.3ad\",\n\"balance-tlb\", and \"balance-alb\".\n\nTransmitHashPolicy=\nSelects the transmit hash policy to use for slave selection in balance-xor, 802.3ad, and\ntlb modes. Possible values are \"layer2\", \"layer3+4\", \"layer2+3\", \"encap2+3\", and\n\"encap3+4\".\n\nLACPTransmitRate=\nSpecifies the rate with which link partner transmits Link Aggregation Control Protocol\nData Unit packets in 802.3ad mode. Possible values are \"slow\", which requests partner to\ntransmit LACPDUs every 30 seconds, and \"fast\", which requests partner to transmit LACPDUs\nevery second. The default value is \"slow\".\n\nMIIMonitorSec=\nSpecifies the frequency that Media Independent Interface link monitoring will occur. A\nvalue of zero disables MII link monitoring. This value is rounded down to the nearest\nmillisecond. The default value is 0.\n\nUpDelaySec=\nSpecifies the delay before a link is enabled after a link up status has been detected.\nThis value is rounded down to a multiple of MIIMonitorSec. The default value is 0.\n\nDownDelaySec=\nSpecifies the delay before a link is disabled after a link down status has been detected.\nThis value is rounded down to a multiple of MIIMonitorSec. The default value is 0.\n\nLearnPacketIntervalSec=\nSpecifies the number of seconds between instances where the bonding driver sends learning\npackets to each slave peer switch. The valid range is 1–0x7fffffff; the default value is\n1. This option has an effect only for the balance-tlb and balance-alb modes.\n\nAdSelect=\nSpecifies the 802.3ad aggregation selection logic to use. Possible values are \"stable\",\n\"bandwidth\" and \"count\".\n\nAdActorSystemPriority=\nSpecifies the 802.3ad actor system priority. Takes a number in the range 1...65535.\n\nAdUserPortKey=\nSpecifies the 802.3ad user defined portion of the port key. Takes a number in the range\n0...1023.\n\nAdActorSystem=\nSpecifies the 802.3ad system MAC address. This cannot be a null or multicast address.\n\nFailOverMACPolicy=\nSpecifies whether the active-backup mode should set all slaves to the same MAC address at\nthe time of enslavement or, when enabled, to perform special handling of the bond's MAC\naddress in accordance with the selected policy. The default policy is none. Possible\nvalues are \"none\", \"active\" and \"follow\".\n\nARPValidate=\nSpecifies whether or not ARP probes and replies should be validated in any mode that\nsupports ARP monitoring, or whether non-ARP traffic should be filtered (disregarded) for\nlink monitoring purposes. Possible values are \"none\", \"active\", \"backup\" and \"all\".\n\nARPIntervalSec=\nSpecifies the ARP link monitoring frequency. A value of 0 disables ARP monitoring. The\ndefault value is 0, and the default unit seconds.\n\nARPIPTargets=\nSpecifies the IP addresses to use as ARP monitoring peers when ARPIntervalSec is greater\nthan 0. These are the targets of the ARP request sent to determine the health of the link\nto the targets. Specify these values in IPv4 dotted decimal format. At least one IP\naddress must be given for ARP monitoring to function. The maximum number of targets that\ncan be specified is 16. The default value is no IP addresses.\n\nARPAllTargets=\nSpecifies the quantity of ARPIPTargets that must be reachable in order for the ARP\nmonitor to consider a slave as being up. This option affects only active-backup mode for\nslaves with ARPValidate enabled. Possible values are \"any\" and \"all\".\n\nPrimaryReselectPolicy=\nSpecifies the reselection policy for the primary slave. This affects how the primary\nslave is chosen to become the active slave when failure of the active slave or recovery\nof the primary slave occurs. This option is designed to prevent flip-flopping between the\nprimary slave and other slaves. Possible values are \"always\", \"better\" and \"failure\".\n\nResendIGMP=\nSpecifies the number of IGMP membership reports to be issued after a failover event. One\nmembership report is issued immediately after the failover, subsequent packets are sent\nin each 200ms interval. The valid range is 0–255. Defaults to 1. A value of 0 prevents\nthe IGMP membership report from being issued in response to the failover event.\n\nPacketsPerSlave=\nSpecify the number of packets to transmit through a slave before moving to the next one.\nWhen set to 0, then a slave is chosen at random. The valid range is 0–65535. Defaults to\n1. This option only has effect when in balance-rr mode.\n\nGratuitousARP=\nSpecify the number of peer notifications (gratuitous ARPs and unsolicited IPv6 Neighbor\nAdvertisements) to be issued after a failover event. As soon as the link is up on the new\nslave, a peer notification is sent on the bonding device and each VLAN sub-device. This\nis repeated at each link monitor interval (ARPIntervalSec or MIIMonitorSec, whichever is\nactive) if the number is greater than 1. The valid range is 0–255. The default value is\n1. These options affect only the active-backup mode.\n\nAllSlavesActive=\nTakes a boolean. Specifies that duplicate frames (received on inactive ports) should be\ndropped when false, or delivered when true. Normally, bonding will drop duplicate frames\n(received on inactive ports), which is desirable for most users. But there are some times\nit is nice to allow duplicate frames to be delivered. The default value is false (drop\nduplicate frames received on inactive ports).\n\nDynamicTransmitLoadBalancing=\nTakes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only for\nbalance-tlb mode. Defaults to unset.\n\nMinLinks=\nSpecifies the minimum number of links that must be active before asserting carrier. The\ndefault value is 0.\n\nFor more detail information see Linux Ethernet Bonding Driver HOWTO[1]\n" }, { "name": "[XFRM] SECTION OPTIONS", "content": "The [Xfrm] section accepts the following keys:\n\nInterfaceId=\nSets the ID/key of the xfrm interface which needs to be associated with a SA/policy. Can\nbe decimal or hexadecimal, valid range is 1-0xffffffff. This is mandatory.\n\nIndependent=\nTakes a boolean. If false (the default), the xfrm interface must have an underlying\ndevice which can be used for hardware offloading.\n\nFor more detail information see Virtual XFRM Interfaces[17].\n" }, { "name": "[VRF] SECTION OPTIONS", "content": "The [VRF] section only applies for netdevs of kind \"vrf\" and accepts the following key:\n\nTable=\nThe numeric routing table identifier. This setting is compulsory.\n" }, { "name": "[BATMANADVANCED] SECTION OPTIONS", "content": "The [BatmanAdvanced] section only applies for netdevs of kind \"batadv\" and accepts the\nfollowing keys:\n\nGatewayMode=\nTakes one of \"off\", \"server\", or \"client\". A batman-adv node can either run in server\nmode (sharing its internet connection with the mesh) or in client mode (searching for the\nmost suitable internet connection in the mesh) or having the gateway support turned off\nentirely (which is the default setting).\n\nAggregation=\nTakes a boolean value. Enables or disables aggregation of originator messages. Defaults\nto true.\n\nBridgeLoopAvoidance=\nTakes a boolean value. Enables or disables avoidance of loops on bridges. Defaults to\ntrue.\n\nDistributedArpTable=\nTakes a boolean value. Enables or disables the distributed ARP table. Defaults to true.\n\nFragmentation=\nTakes a boolean value. Enables or disables fragmentation. Defaults to true.\n\nHopPenalty=\nThe hop penalty setting allows to modify batctl(8) preference for multihop routes vs.\nshort routes. This integer value is applied to the TQ (Transmit Quality) of each\nforwarded OGM (Originator Message), thereby propagating the cost of an extra hop (the\npacket has to be received and retransmitted which costs airtime). A higher hop penalty\nwill make it more unlikely that other nodes will choose this node as intermediate hop\ntowards any given destination. The default hop penalty of '15' is a reasonable value for\nmost setups and probably does not need to be changed. However, mobile nodes could choose\na value of 255 (maximum value) to avoid being chosen as a router by other nodes. The\nminimum value is 0.\n\nOriginatorIntervalSec=\nThe value specifies the interval in seconds, unless another time unit is specified in\nwhich batman-adv floods the network with its protocol information. See systemd.time(7)\nfor more information.\n\nGatewayBandwidthDown=\nIf the node is a server, this parameter is used to inform other nodes in the network\nabout this node's internet connection download bandwidth in bits per second. Just enter\nany number suffixed with K, M, G or T (base 1000) and the batman-adv module will\npropagate the entered value in the mesh.\n\nGatewayBandwidthUp=\nIf the node is a server, this parameter is used to inform other nodes in the network\nabout this node's internet connection upload bandwidth in bits per second. Just enter any\nnumber suffixed with K, M, G or T (base 1000) and the batman-adv module will propagate\nthe entered value in the mesh.\n\nRoutingAlgorithm=\nThis can be either \"batman-v\" or \"batman-iv\" and describes which routingalgo of\nbatctl(8) to use. The algorithm cannot be changed after interface creation. Defaults to\n\"batman-v\".\n" } ] }, "EXAMPLES": { "content": "", "subsections": [ { "name": "Example 1. /etc/systemd/network/25-bridge.netdev", "content": "[NetDev]\nName=bridge0\nKind=bridge\n" }, { "name": "Example 2. /etc/systemd/network/25-vlan1.netdev", "content": "[Match]\nVirtualization=no\n\n[NetDev]\nName=vlan1\nKind=vlan\n\n[VLAN]\nId=1\n" }, { "name": "Example 3. /etc/systemd/network/25-ipip.netdev", "content": "[NetDev]\nName=ipip-tun\nKind=ipip\nMTUBytes=1480\n\n[Tunnel]\nLocal=192.168.223.238\nRemote=192.169.224.239\nTTL=64\n" }, { "name": "Example 4. /etc/systemd/network/1-fou-tunnel.netdev", "content": "[NetDev]\nName=fou-tun\nKind=fou\n\n[FooOverUDP]\nPort=5555\nProtocol=4\n\n" }, { "name": "Example 5. /etc/systemd/network/25-fou-ipip.netdev", "content": "[NetDev]\nName=ipip-tun\nKind=ipip\n\n[Tunnel]\nIndependent=yes\nLocal=10.65.208.212\nRemote=10.65.208.211\nFooOverUDP=yes\nFOUDestinationPort=5555\n\n" }, { "name": "Example 6. /etc/systemd/network/25-tap.netdev", "content": "[NetDev]\nName=tap-test\nKind=tap\n\n[Tap]\nMultiQueue=yes\nPacketInfo=yes\n" }, { "name": "Example 7. /etc/systemd/network/25-sit.netdev", "content": "[NetDev]\nName=sit-tun\nKind=sit\nMTUBytes=1480\n\n[Tunnel]\nLocal=10.65.223.238\nRemote=10.65.223.239\n" }, { "name": "Example 8. /etc/systemd/network/25-6rd.netdev", "content": "[NetDev]\nName=6rd-tun\nKind=sit\nMTUBytes=1480\n\n[Tunnel]\nLocal=10.65.223.238\nIPv6RapidDeploymentPrefix=2602::/24\n" }, { "name": "Example 9. /etc/systemd/network/25-gre.netdev", "content": "[NetDev]\nName=gre-tun\nKind=gre\nMTUBytes=1480\n\n[Tunnel]\nLocal=10.65.223.238\nRemote=10.65.223.239\n" }, { "name": "Example 10. /etc/systemd/network/25-ip6gre.netdev", "content": "[NetDev]\nName=ip6gre-tun\nKind=ip6gre\n\n[Tunnel]\nKey=123\n" }, { "name": "Example 11. /etc/systemd/network/25-vti.netdev", "content": "[NetDev]\nName=vti-tun\nKind=vti\nMTUBytes=1480\n\n[Tunnel]\nLocal=10.65.223.238\nRemote=10.65.223.239\n" }, { "name": "Example 12. /etc/systemd/network/25-veth.netdev", "content": "[NetDev]\nName=veth-test\nKind=veth\n\n[Peer]\nName=veth-peer\n" }, { "name": "Example 13. /etc/systemd/network/25-bond.netdev", "content": "[NetDev]\nName=bond1\nKind=bond\n\n[Bond]\nMode=802.3ad\nTransmitHashPolicy=layer3+4\nMIIMonitorSec=1s\nLACPTransmitRate=fast\n" }, { "name": "Example 14. /etc/systemd/network/25-dummy.netdev", "content": "[NetDev]\nName=dummy-test\nKind=dummy\nMACAddress=12:34:56:78:9a:bc\n" }, { "name": "Example 15. /etc/systemd/network/25-vrf.netdev", "content": "Create a VRF interface with table 42.\n\n[NetDev]\nName=vrf-test\nKind=vrf\n\n[VRF]\nTable=42\n" }, { "name": "Example 16. /etc/systemd/network/25-macvtap.netdev", "content": "Create a MacVTap device.\n\n[NetDev]\nName=macvtap-test\nKind=macvtap\n\n" }, { "name": "Example 17. /etc/systemd/network/25-wireguard.netdev", "content": "[NetDev]\nName=wg0\nKind=wireguard\n\n[WireGuard]\nPrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=\nListenPort=51820\n\n[WireGuardPeer]\nPublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=\nAllowedIPs=fd31:bf08:57cb::/48,192.168.26.0/24\nEndpoint=wireguard.example.com:51820\n" }, { "name": "Example 18. /etc/systemd/network/27-xfrm.netdev", "content": "[NetDev]\nName=xfrm0\nKind=xfrm\n\n[Xfrm]\nIndependent=yes\n" } ] }, "SEE ALSO": { "content": "systemd(1), systemd-networkd(8), systemd.link(5), systemd.network(5)\n", "subsections": [] }, "NOTES": { "content": "1. Linux Ethernet Bonding Driver HOWTO\nhttps://www.kernel.org/doc/Documentation/networking/bonding.txt\n\n2. RFC 2784\nhttps://tools.ietf.org/html/rfc2784\n\n3. IEEE 802.1Q\nhttp://www.ieee802.org/1/pages/802.1Q.html\n\n4. VRF\nhttps://www.kernel.org/doc/Documentation/networking/vrf.txt\n\n5. B.A.T.M.A.N. Advanced\nhttps://www.open-mesh.org/projects/open-mesh/wiki\n\n6. (DVOE)\nhttps://en.wikipedia.org/wiki/DistributedOverlayVirtualEthernet\n\n7. VXLAN Group Policy\nhttps://tools.ietf.org/html/draft-smith-vxlan-group-policy\n\n8. Generic Protocol Extension for VXLAN\nhttps://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07\n\n9. Type of Service in the Internet Protocol Suite\nhttp://tools.ietf.org/html/rfc1349\n\n10. RFC 6437\nhttps://tools.ietf.org/html/rfc6437\n\n11. RFC 2460\nhttps://tools.ietf.org/html/rfc2460\n\n12. RFC 2473\nhttps://tools.ietf.org/html/rfc2473#section-4.1.1\n\n13. ip-xfrm — transform configuration\nhttp://man7.org/linux/man-pages/man8/ip-xfrm.8.html\n\n14. Foo over UDP\nhttps://lwn.net/Articles/614348\n\n15. IPv6 Rapid Deployment\nhttps://tools.ietf.org/html/rfc5569\n\n16. Generic UDP Encapsulation\nhttps://lwn.net/Articles/615044\n\n17. Virtual XFRM Interfaces\nhttps://lwn.net/Articles/757391\n\n\n\nsystemd 249 SYSTEMD.NETDEV(5)", "subsections": [] } }, "summary": "systemd.netdev - Virtual Network Device configuration", "flags": [], "examples": [ "[NetDev]", "Name=bridge0", "Kind=bridge", "[Match]", "Virtualization=no", "[NetDev]", "Name=vlan1", "Kind=vlan", "[VLAN]", "Id=1", "[NetDev]", "Name=ipip-tun", "Kind=ipip", "MTUBytes=1480", "[Tunnel]", "Local=192.168.223.238", "Remote=192.169.224.239", "TTL=64", "[NetDev]", "Name=fou-tun", "Kind=fou", "[FooOverUDP]", "Port=5555", "Protocol=4", "[NetDev]", "Name=ipip-tun", "Kind=ipip", "[Tunnel]", "Independent=yes", "Local=10.65.208.212", "Remote=10.65.208.211", "FooOverUDP=yes", "FOUDestinationPort=5555", "[NetDev]", "Name=tap-test", "Kind=tap", "[Tap]", "MultiQueue=yes", "PacketInfo=yes", "[NetDev]", "Name=sit-tun", "Kind=sit", "MTUBytes=1480", "[Tunnel]", "Local=10.65.223.238", "Remote=10.65.223.239", "[NetDev]", "Name=6rd-tun", "Kind=sit", "MTUBytes=1480", "[Tunnel]", "Local=10.65.223.238", "IPv6RapidDeploymentPrefix=2602::/24", "[NetDev]", "Name=gre-tun", "Kind=gre", "MTUBytes=1480", "[Tunnel]", "Local=10.65.223.238", "Remote=10.65.223.239", "[NetDev]", "Name=ip6gre-tun", "Kind=ip6gre", "[Tunnel]", "Key=123", "[NetDev]", "Name=vti-tun", "Kind=vti", "MTUBytes=1480", "[Tunnel]", "Local=10.65.223.238", "Remote=10.65.223.239", "[NetDev]", "Name=veth-test", "Kind=veth", "[Peer]", "Name=veth-peer", "[NetDev]", "Name=bond1", "Kind=bond", "[Bond]", "Mode=802.3ad", "TransmitHashPolicy=layer3+4", "MIIMonitorSec=1s", "LACPTransmitRate=fast", "[NetDev]", "Name=dummy-test", "Kind=dummy", "MACAddress=12:34:56:78:9a:bc", "Create a VRF interface with table 42.", "[NetDev]", "Name=vrf-test", "Kind=vrf", "[VRF]", "Table=42", "Create a MacVTap device.", "[NetDev]", "Name=macvtap-test", "Kind=macvtap", "[NetDev]", "Name=wg0", "Kind=wireguard", "[WireGuard]", "PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=", "ListenPort=51820", "[WireGuardPeer]", "PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=", "AllowedIPs=fd31:bf08:57cb::/48,192.168.26.0/24", "Endpoint=wireguard.example.com:51820", "[NetDev]", "Name=xfrm0", "Kind=xfrm", "[Xfrm]", "Independent=yes" ], "see_also": [ { "name": "systemd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/systemd/1/json" }, { "name": "systemd-networkd", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/systemd-networkd/8/json" }, { "name": "systemd.link", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/systemd.link/5/json" }, { "name": "systemd.network", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/systemd.network/5/json" } ] }