HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/systemd.netdev.xml

133,001 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: 923ab57586638a40be63021707dd6677d072938e

Lines 1–1000 of 3,130

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
<refentry id="systemd.netdev" conditional='ENABLE_NETWORKD'
          xmlns:xi="http://www.w3.org/2001/XInclude">
 
  <refentryinfo>
    <title>systemd.network</title>
    <productname>systemd</productname>
  </refentryinfo>
 
  <refmeta>
    <refentrytitle>systemd.netdev</refentrytitle>
    <manvolnum>5</manvolnum>
  </refmeta>
 
  <refnamediv>
    <refname>systemd.netdev</refname>
    <refpurpose>Virtual Network Device configuration</refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>
    <para><filename><replaceable>netdev</replaceable>.netdev</filename></para>
  </refsynopsisdiv>
 
  <refsect1>
    <title>Description</title>
 
    <para>A plain ini-style text file that encodes configuration about a virtual network device, used by
    <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
    See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
    for a general description of the syntax.</para>
 
    <para>The main Virtual Network Device file must have the extension <filename>.netdev</filename>;
    other extensions are ignored. Virtual network devices are created as soon as
    <command>systemd-networkd</command> is started if possible. If a netdev with the specified name already
    exists, <command>systemd-networkd</command> will try to update the config if the kind of the existing
    netdev is equivalent to the requested one, otherwise (e.g. when bridge device <filename>foo</filename>
    exists but bonding device with the same name is configured in a .netdev file) use the existing netdev
    as-is rather than replacing with the requested netdev. Note, several settings (e.g. vlan ID) cannot be
    changed after the netdev is created. To change such settings, it is necessary to first remove the
    existing netdev, and then run <command>networkctl reload</command> command or restart
    <command>systemd-networkd</command>. See also
    <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
 
    <para>The <filename>.netdev</filename> files are read from the files located in the system network
    directory <filename>/usr/lib/systemd/network</filename> and
    <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
    <filename>/run/systemd/network</filename> and the local administration network directory
    <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and
    processed in alphanumeric order, regardless of the directories in which they live. However, files
    with identical filenames replace each other. It is recommended that each filename is prefixed with
    a number smaller than <literal>70</literal> (e.g. <filename>10-vlan.netdev</filename>). Otherwise,
    <filename>.netdev</filename> files generated by
    <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    may take precedence over user configured files. Files in <filename>/etc/</filename> have the
    highest priority, files in <filename>/run/</filename> take precedence over files with the same name
    in <filename>/usr/lib/</filename>. This can be used to override a system-supplied 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 <filename>/dev/null</filename> disables the configuration file entirely
    (it is "masked").</para>
 
    <para>Along with the netdev file <filename>foo.netdev</filename>, a "drop-in" directory
    <filename>foo.netdev.d/</filename> may exist. All files with the suffix <literal>.conf</literal>
    from this directory will be merged in the alphanumeric order and parsed after the main file itself
    has been parsed. This is useful to alter or add configuration settings, without having to modify
    the main configuration file. Each drop-in file must have appropriate section headers.</para>
 
    <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
    directories can be placed in <filename>/usr/lib/systemd/network</filename> or
    <filename>/run/systemd/network</filename> directories. Drop-in files in
    <filename>/etc/</filename> take precedence over those in <filename>/run/</filename> which in turn
    take precedence over those in <filename>/usr/lib/</filename>. Drop-in files under any of these
    directories take precedence over the main netdev file wherever located. (Of course, since
    <filename>/run/</filename> is temporary and <filename>/usr/lib/</filename> is for vendors, it is
    unlikely drop-ins should be used in either of those places.)</para>
  </refsect1>
 
  <refsect1>
    <title>Supported netdev kinds</title>
 
    <para>The following kinds of virtual network devices may be
    configured in <filename>.netdev</filename> files:</para>
 
    <table>
      <title>Supported kinds of virtual network devices</title>
 
      <tgroup cols='2'>
        <colspec colname='kind' />
        <colspec colname='explanation' />
        <thead><row>
          <entry>Kind</entry>
          <entry>Description</entry>
        </row></thead>
        <tbody>
          <row><entry><varname>bond</varname></entry>
          <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://docs.kernel.org/networking/bonding.html">Linux Ethernet Bonding Driver HOWTO</ulink> for details.</entry></row>
 
          <row><entry><varname>bridge</varname></entry>
          <entry>A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch.</entry></row>
 
          <row><entry><varname>dummy</varname></entry>
          <entry>A dummy device drops all packets sent to it.</entry></row>
 
          <row><entry><varname>gre</varname></entry>
          <entry>A Level 3 GRE tunnel over IPv4. See <ulink url="https://tools.ietf.org/html/rfc2784">RFC 2784</ulink> for details. Name <literal>gre0</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.</entry></row>
 
          <row><entry><varname>gretap</varname></entry>
          <entry>A Level 2 GRE tunnel over IPv4. Name <literal>gretap0</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.</entry></row>
 
          <row><entry><varname>erspan</varname></entry>
          <entry>ERSPAN mirrors traffic on one or more source ports and delivers the mirrored traffic to one or more destination ports on another switch. The traffic is encapsulated in generic routing encapsulation (GRE) and is therefore routable across a layer 3 network between the source switch and the destination switch. Name <literal>erspan0</literal> should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded.</entry></row>
 
          <row><entry><varname>ip6gre</varname></entry>
          <entry>A Level 3 GRE tunnel over IPv6.</entry></row>
 
          <row><entry><varname>ip6tnl</varname></entry>
          <entry>An IPv4 or IPv6 tunnel over IPv6</entry></row>
 
          <row><entry><varname>ip6gretap</varname></entry>
          <entry>A Level 2 GRE tunnel over IPv6.</entry></row>
 
          <row><entry><varname>ipip</varname></entry>
          <entry>An IPv4 over IPv4 tunnel.</entry></row>
 
          <row><entry><varname>ipvlan</varname></entry>
          <entry>An IPVLAN device is a stacked device which receives packets from its underlying device based on IP address filtering.</entry></row>
 
          <row><entry><varname>ipvtap</varname></entry>
          <entry>An IPVTAP device is a stacked device which receives packets from its underlying device based on IP address filtering and can be accessed using the tap user space interface.</entry></row>
 
          <row><entry><varname>macvlan</varname></entry>
          <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
 
          <row><entry><varname>macvtap</varname></entry>
          <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row>
 
          <row><entry><varname>sit</varname></entry>
          <entry>An IPv6 over IPv4 tunnel.</entry></row>
 
          <row><entry><varname>tap</varname></entry>
          <entry>A persistent Level 2 tunnel between a network device and a device node.</entry></row>
 
          <row><entry><varname>tun</varname></entry>
          <entry>A persistent Level 3 tunnel between a network device and a device node.</entry></row>
 
          <row><entry><varname>veth</varname></entry>
          <entry>An Ethernet tunnel between a pair of network devices.</entry></row>
 
          <row><entry><varname>vlan</varname></entry>
          <entry>A VLAN is a stacked device which receives packets from its underlying device based on VLAN tagging. See <ulink url="http://www.ieee802.org/1/pages/802.1Q.html">IEEE 802.1Q</ulink> for details.</entry></row>
 
          <row><entry><varname>vti</varname></entry>
          <entry>An IPv4 over IPSec tunnel.</entry></row>
 
          <row><entry><varname>vti6</varname></entry>
          <entry>An IPv6 over IPSec tunnel.</entry></row>
 
          <row><entry><varname>vxlan</varname></entry>
          <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row>
 
          <row><entry><varname>geneve</varname></entry>
          <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.</entry></row>
 
          <row><entry><varname>hsr</varname></entry>
          <entry>A High-availability Seamless Redundancy (HSR) or Parallel Redundancy Protocol (PRP) interface. HSR and PRP are two protocols defined by the IEC 62439-3 standard, providing seamless failover against failure of any single network component.</entry></row>
 
          <row><entry><varname>l2tp</varname></entry>
          <entry>A Layer 2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs) or as part of the delivery of services by ISPs. It does not provide any encryption or confidentiality by itself</entry></row>
 
          <row><entry><varname>macsec</varname></entry>
          <entry>Media Access Control Security (MACsec) is an 802.1AE IEEE industry-standard security technology that provides secure communication for all traffic on Ethernet links. MACsec provides point-to-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats.</entry></row>
 
          <row><entry><varname>vrf</varname></entry>
          <entry>A Virtual Routing and Forwarding (<ulink url="https://docs.kernel.org/networking/vrf.html">VRF</ulink>) interface to create separate routing and forwarding domains.</entry></row>
 
          <row><entry><varname>vcan</varname></entry>
          <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.</entry></row>
 
          <row><entry><varname>vxcan</varname></entry>
          <entry>The virtual CAN tunnel driver (vxcan). Similar to the virtual ethernet driver veth, vxcan implements a local CAN traffic tunnel between two virtual CAN network devices. When creating a vxcan, two vxcan devices are created as pair. When one end receives the packet it appears on its pair and vice versa. The vxcan can be used for cross namespace communication.
          </entry></row>
 
          <row><entry><varname>wireguard</varname></entry>
          <entry>WireGuard Secure Network Tunnel.</entry></row>
 
          <row><entry><varname>nlmon</varname></entry>
          <entry>A Netlink monitor device. Use an nlmon device when you want to monitor system Netlink messages.</entry></row>
 
          <row><entry><varname>fou</varname></entry>
          <entry>Foo-over-UDP tunneling.</entry></row>
 
          <row><entry><varname>xfrm</varname></entry>
          <entry>A virtual tunnel interface like vti/vti6 but with several advantages.</entry></row>
 
          <row><entry><varname>ifb</varname></entry>
          <entry>The Intermediate Functional Block (ifb) pseudo network interface acts as a QoS concentrator for multiple different sources of traffic.</entry></row>
 
          <row><entry><varname>bareudp</varname></entry>
          <entry>Bare UDP tunnels provide a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP etc. inside of a UDP tunnel.</entry></row>
 
          <row><entry><varname>batadv</varname></entry>
          <entry><ulink url="https://www.open-mesh.org/projects/open-mesh/wiki">B.A.T.M.A.N. Advanced</ulink> is a routing protocol for multi-hop mobile ad-hoc networks which operates on layer 2.</entry></row>
 
          <row><entry><varname>ipoib</varname></entry>
          <entry>An IP over Infiniband subinterface.</entry></row>
 
          <row><entry><varname>wlan</varname></entry>
          <entry>A virtual wireless network (WLAN) interface.</entry></row>
        </tbody>
      </tgroup>
    </table>
 
  </refsect1>
 
  <refsect1>
    <title>[Match] Section Options</title>
 
    <para>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:</para>
 
    <variablelist class='network-directives'>
      <xi:include href="systemd.link.xml" xpointer="host" />
      <xi:include href="systemd.link.xml" xpointer="virtualization" />
      <xi:include href="systemd.link.xml" xpointer="kernel-command-line" />
      <xi:include href="systemd.link.xml" xpointer="kernel-version" />
      <xi:include href="systemd.link.xml" xpointer="version" />
      <xi:include href="systemd.link.xml" xpointer="credential" />
      <xi:include href="systemd.link.xml" xpointer="architecture" />
      <xi:include href="systemd.link.xml" xpointer="firmware" />
      <xi:include href="systemd.link.xml" xpointer="machine-tag" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[NetDev] Section Options</title>
 
    <para>The [NetDev] section accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Description=</varname></term>
        <listitem>
          <para>A free-form description of the netdev.</para>
 
        <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Name=</varname></term>
        <listitem>
          <para>The interface name used when creating the netdev.
          This setting is compulsory.</para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Kind=</varname></term>
        <listitem>
          <para>The netdev kind. This setting is compulsory. See the
          <literal>Supported netdev kinds</literal> section for the
          valid keys.</para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MTUBytes=</varname></term>
        <listitem>
          <para>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 <literal>tun</literal> or
          <literal>tap</literal> devices, <varname>MTUBytes=</varname> setting is not currently supported in
          [NetDev] section. Please specify it in [Link] section of
          corresponding
          <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          files.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
        <listitem>
          <para>Specifies the MAC address to use for the device, or takes the special value
          <literal>none</literal>. When <literal>none</literal>, <command>systemd-networkd</command>
          does not request the MAC address for the device, and the kernel will assign a random MAC
          address. For <literal>tun</literal>, <literal>tap</literal>, or <literal>l2tp</literal>
          devices, the <varname>MACAddress=</varname> setting in the [NetDev] section is not
          supported and will be ignored. Please specify it in the [Link] section of the corresponding
          <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          file. If this option is not set, <literal>vlan</literal> device inherits the MAC address of
          the master interface. For other kind of netdevs, if this option is not set, then the MAC
          address is generated based on the interface name and the
          <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
          </para>
          <para>Note, even if <literal>none</literal> is specified, <command>systemd-udevd</command>
          will assign the persistent MAC address for the device, as <filename>99-default.link</filename>
          has <varname>MACAddressPolicy=persistent</varname>. So, it is also necessary to create a
          custom .link file for the device, if the MAC address assignment is not desired.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Bridge] Section Options</title>
 
    <para>The [Bridge] section only applies for
    netdevs of kind <literal>bridge</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>HelloTimeSec=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v227"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MaxAgeSec=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v227"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ForwardDelaySec=</varname></term>
        <listitem>
          <para>ForwardDelaySec specifies the number of seconds spent in each
          of the Listening and Learning states before the Forwarding state is entered.</para>
 
          <xi:include href="version-info.xml" xpointer="v227"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AgeingTimeSec=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Priority=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GroupForwardMask=</varname></term>
        <listitem>
          <para>A 16-bit 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).</para>
 
          <xi:include href="version-info.xml" xpointer="v235"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DefaultPVID=</varname></term>
        <listitem>
          <para>This specifies the default port VLAN ID of a newly attached bridge port.
          Set this to an integer in the range 1…4094 or <literal>none</literal> to disable the PVID.</para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MulticastQuerier=</varname></term>
        <listitem>
          <para>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-aware switches to misbehave and disrupt forwarding of multicast packets.
          When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v230"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MulticastSnooping=</varname></term>
        <listitem>
          <para>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.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v230"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VLANFiltering=</varname></term>
        <listitem>
          <para>Takes a boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
          If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VLANProtocol=</varname></term>
        <listitem>
          <para>Allows setting the protocol used for VLAN filtering. Takes
          <option>802.1q</option> or,
          <option>802.1ad</option>, and defaults to unset and kernel's default is used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>STP=</varname></term>
        <listitem>
          <para>Takes a boolean. This enables the bridge's Spanning Tree Protocol (STP).
          When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MulticastIGMPVersion=</varname></term>
        <listitem>
          <para>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.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FDBMaxLearned=</varname></term>
        <listitem>
          <para>Specifies the maximum number of learned Ethernet addresses for the bridge. When the limit is
          reached, no more addresses are learned. When unset, the kernel's default will be used. 0 disables the limit.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v257"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>LinkLocalLearning=</varname></term>
        <listitem>
          <para>Takes a boolean. This enables learning source addresses from link local frames. When unset, the
          kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[VLAN] Section Options</title>
 
    <para>The [VLAN] section only applies for
    netdevs of kind <literal>vlan</literal>, and accepts the
    following key:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Id=</varname></term>
        <listitem>
          <para>The VLAN ID to use. An integer in the range 0…4094.
          This setting is compulsory.</para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Protocol=</varname></term>
        <listitem>
          <para>Allows setting the protocol used for the VLAN interface. Takes <literal>802.1q</literal> or,
          <literal>802.1ad</literal>, and defaults to unset and kernel's default is used.</para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GVRP=</varname></term>
        <listitem>
          <para>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.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MVRP=</varname></term>
        <listitem>
          <para>Takes a boolean. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
          Registration Protocol (GVRP) is a standards-based Layer 2 network protocol,
          for automatic configuration of VLAN information on switches. It was defined
          in the 802.1ak amendment to 802.1Q-2005. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>LooseBinding=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReorderHeader=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>EgressQOSMaps=</varname></term>
        <term><varname>IngressQOSMaps=</varname></term>
        <listitem>
          <para>Defines a mapping of Linux internal packet priority (<constant>SO_PRIORITY</constant>)
          to VLAN header PCP field for outgoing and incoming frames, respectively. Takes a
          whitespace-separated list of integer pairs, where each integer must be in the range
          1…4294967294, in the format <literal>from</literal>-<literal>to</literal>, e.g.,
          <literal>21-7 45-5</literal>. Note that <literal>from</literal> must be greater than or equal
          to <literal>to</literal>. When unset, the kernel's default will be used.</para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MACVLAN] Section Options</title>
 
    <para>The [MACVLAN] section only applies for
    netdevs of kind <literal>macvlan</literal>, and accepts the
    following key:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Mode=</varname></term>
        <listitem>
          <para>The MACVLAN mode to use. The supported options are
          <literal>private</literal>,
          <literal>vepa</literal>,
          <literal>bridge</literal>,
          <literal>passthru</literal>, and
          <literal>source</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v211"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>SourceMACAddress=</varname></term>
        <listitem>
          <para>A whitespace-separated list of remote hardware addresses allowed on the MACVLAN. This
          option only has an effect in source mode. Use full colon-, hyphen- or dot-delimited
          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.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>BroadcastMulticastQueueLength=</varname></term>
        <listitem>
          <para>Specifies the length of the receive queue for broadcast/multicast packets. An unsigned
          integer in the range 0…4294967294. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>BroadcastQueueThreshold=</varname></term>
        <listitem>
          <para>Controls the threshold for broadcast queueing of the macvlan device. Takes the special value
          <literal>no</literal>, or an integer in the range 0…2147483647. When <literal>no</literal> is
          specified, the broadcast queueing is disabled altogether. When an integer is specified, a multicast
          address will be queued as broadcast if the number of devices using the macvlan is greater than the given
          value. Defaults to unset, and the kernel default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MACVTAP] Section Options</title>
 
    <para>The [MACVTAP] section applies for netdevs of kind <literal>macvtap</literal> and accepts the same
    keys as [MACVLAN].</para>
  </refsect1>
 
  <refsect1>
    <title>[IPVLAN] Section Options</title>
 
    <para>The [IPVLAN] section only applies for
    netdevs of kind <literal>ipvlan</literal>, and accepts the
    following key:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Mode=</varname></term>
        <listitem>
          <para>The IPVLAN mode to use. The supported options are
          <literal>L2</literal>,<literal>L3</literal> and <literal>L3S</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Flags=</varname></term>
        <listitem>
          <para>The IPVLAN flags to use. The supported options are
          <literal>bridge</literal>,<literal>private</literal> and <literal>vepa</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPVTAP] Section Options</title>
 
    <para>The [IPVTAP] section only applies for netdevs of kind <literal>ipvtap</literal> and accepts the
    same keys as [IPVLAN].</para>
  </refsect1>
 
  <refsect1>
    <title>[VXLAN] Section Options</title>
 
    <para>The [VXLAN] section only applies for
    netdevs of kind <literal>vxlan</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>VNI=</varname></term>
        <listitem>
          <para>The VXLAN Network Identifier (or VXLAN Segment ID). Takes a number in the range 1…16777215.
          Ignored if <varname>External=</varname> is set to true.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Remote=</varname></term>
        <listitem>
          <para>Configures destination IP address.</para>
 
        <xi:include href="version-info.xml" xpointer="v233"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Local=</varname></term>
        <listitem>
          <para>Configures local IP address. It must be an address on the underlying interface of the
          VXLAN interface, or one of the special values <literal>ipv4_link_local</literal>,
          <literal>ipv6_link_local</literal>, <literal>dhcp4</literal>, <literal>dhcp6</literal>, and
          <literal>slaac</literal>. If one of the special values is specified, an address which matches
          the corresponding type on the underlying interface will be used. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v233"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Group=</varname></term>
        <listitem>
          <para>Configures VXLAN multicast group IP address. All members of a VXLAN must use the same
          multicast group address.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TOS=</varname></term>
        <listitem>
          <para>The Type Of Service byte value for a vxlan interface.</para>
 
        <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TTL=</varname></term>
        <listitem>
          <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
          Takes <literal>inherit</literal> or a number in the range 0…255. 0 is a special
          value meaning inherit the inner protocol's TTL value. <literal>inherit</literal>
          means that it will inherit the outer protocol's TTL value.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MacLearning=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, enables dynamic MAC learning
          to discover remote MAC addresses.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FDBAgeingSec=</varname></term>
        <listitem>
          <para>The lifetime of Forwarding Database entry learnt by
          the kernel, in seconds.</para>
 
          <xi:include href="version-info.xml" xpointer="v218"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MaximumFDBEntries=</varname></term>
        <listitem>
          <para>Configures maximum number of FDB entries.</para>
 
        <xi:include href="version-info.xml" xpointer="v228"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReduceARPProxy=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, bridge-connected VXLAN tunnel endpoint answers ARP requests from
          the local bridge on behalf of remote
          <ulink url="https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet">
            Distributed Overlay Virtual Ethernet (DOVE)</ulink>
          clients. Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v233"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>L2MissNotification=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, enables netlink LLADDR miss
          notifications.</para>
 
          <xi:include href="version-info.xml" xpointer="v218"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>L3MissNotification=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, enables netlink IP address miss notifications.</para>
 
        <xi:include href="version-info.xml" xpointer="v218"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RouteShortCircuit=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, route short circuiting is turned
          on.</para>
 
          <xi:include href="version-info.xml" xpointer="v218"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDPChecksum=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para>
 
        <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDP6ZeroChecksumTx=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.</para>
 
        <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDP6ZeroChecksumRx=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.</para>
 
        <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RemoteChecksumTx=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on.</para>
 
        <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RemoteChecksumRx=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on.</para>
 
        <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GroupPolicyExtension=</varname></term>
        <listitem>
          <para>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
          <ulink url="https://tools.ietf.org/html/draft-smith-vxlan-group-policy">
          VXLAN Group Policy </ulink> document. Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v224"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericProtocolExtension=</varname></term>
        <listitem>
          <para>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 <ulink url="https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07">
          Generic Protocol Extension for VXLAN </ulink> document. If destination port is not specified and
          Generic Protocol Extension is set, the default port of 4790 is used. Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DestinationPort=</varname></term>
        <listitem>
          <para>Configures the default destination UDP port. If the destination port is not specified, the
          Linux kernel default will be used. Set to 4789 to get the IANA assigned value.</para>
 
          <xi:include href="version-info.xml" xpointer="v229"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PortRange=</varname></term>
        <listitem>
          <para>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.</para>
 
          <xi:include href="version-info.xml" xpointer="v229"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FlowLabel=</varname></term>
        <listitem>
          <para>Specifies the flow label to use in outgoing packets.
          The valid range is 0-1048575.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IPDoNotFragment=</varname></term>
        <listitem>
          <para>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 <literal>inherit</literal>. Set
          to <literal>inherit</literal> if the encapsulated protocol is IPv6. When unset, the kernel's
          default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Independent=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the vxlan interface is created without any underlying network
          interface. Defaults to false, which means that a .network file that requests this VXLAN interface
          using <varname>VXLAN=</varname> is required for the VXLAN to be created.</para>
 
          <xi:include href="version-info.xml" xpointer="v247"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>External=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the vxlan interface is externally controlled, for example by an
          EVPN control plane. Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VNIFilter=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the interface is capable of filtering VNI filtering.
          Ignored if <varname>External=</varname> is set to false. Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[GENEVE] Section Options</title>
 
    <para>The [GENEVE] section only applies for
    netdevs of kind <literal>geneve</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Id=</varname></term>
        <listitem>
          <para>Specifies the Virtual Network Identifier (VNI) to use, a number between 0 and 16777215. This
          field is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Remote=</varname></term>
        <listitem>
          <para>Specifies the unicast destination IP address to use in outgoing packets.</para>
 
        <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TOS=</varname></term>
        <listitem>
          <para>Specifies the TOS value to use in outgoing packets. Takes a number between 1 and 255.</para>
 
        <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TTL=</varname></term>
        <listitem>
          <para>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
          <filename>/proc/sys/net/ipv4/ip_default_ttl</filename>.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDPChecksum=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, specifies that UDP checksum is calculated for transmitted packets
          over IPv4.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDP6ZeroChecksumTx=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
 
        <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDP6ZeroChecksumRx=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
 
        <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DestinationPort=</varname></term>
        <listitem>
          <para>Specifies destination port. Defaults to 6081. If not set or assigned the empty string, the default