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 2001–3000 of 3,130

        <listitem><para>Takes a boolean. Configures whether
        packets should be prepended with four extra bytes (two flag
        bytes and two protocol bytes). If disabled, it indicates that
        the packets will be pure IP packets. Defaults to
        <literal>no</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>VNetHeader=</varname></term>
        <listitem><para>Takes a boolean. Configures
        IFF_VNET_HDR flag for a tun or tap device. It allows sending
        and receiving larger Generic Segmentation Offload (GSO)
        packets. This may increase throughput significantly.
        Defaults to
        <literal>no</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>User=</varname></term>
        <listitem><para>User to grant access to the <filename>/dev/net/tun</filename> device.
        Note that the user must be resolvable during early boot. Using non-system users
        is deprecated.</para>
 
        <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Group=</varname></term>
        <listitem><para>Group to grant access to the <filename>/dev/net/tun</filename> device.
        Note that the group must be resolvable during early boot. Using non-system groups
        is deprecated.</para>
 
        <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>KeepCarrier=</varname></term>
        <listitem>
          <para>Takes a boolean. If enabled, to make the interface maintain its carrier status, the file
          descriptor of the interface is kept open. This may be useful to keep the interface in running
          state, for example while the backing process is temporarily shutdown. Defaults to
          <literal>no</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v252"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Tap] Section Options</title>
 
    <para>The [Tap] section only applies for
    netdevs of kind <literal>tap</literal>, and accepts the same keys
    as the [Tun] section.</para>
  </refsect1>
 
  <refsect1>
    <title>[WireGuard] Section Options</title>
 
    <para>The [WireGuard] section accepts the following
    keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>PrivateKey=</varname></term>
        <listitem>
          <para>The Base64 encoded private key for the interface. It can be generated using
          the <command>wg genkey</command> command
          (see <citerefentry project='man-pages'><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
          Specially, if the specified key is prefixed with <literal>@</literal>, it is interpreted as
          the name of the credential from which the actual key shall be read.
          <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          automatically imports credentials matching <literal>network.wireguard.*</literal>. For more details
          on credentials, refer to
          <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
          A private key is mandatory to use WireGuard. If not set, the credential
          <literal>network.wireguard.private.<replaceable>netdev</replaceable></literal> is used if exists.
          I.e. for <filename>50-foobar.netdev</filename>, <literal>network.wireguard.private.50-foobar</literal>
          is tried.</para>
 
          <para>Note that because this information is secret, it is strongly recommended to use an (encrypted)
          credential. Alternatively, you may want to set the permissions of the .netdev file to be owned
          by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PrivateKeyFile=</varname></term>
        <listitem>
          <para>Takes an absolute path to a file which contains the Base64 encoded private key for the
          interface.  When this option is specified, then <varname>PrivateKey=</varname> is ignored.  Note
          that the file must be readable by the user <literal>systemd-network</literal>, so it should be,
          e.g., owned by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode. If
          the path refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is
          made to it and the key read from it.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ListenPort=</varname></term>
        <listitem>
          <para>Sets UDP port for listening. Takes either value between 1 and 65535
          or <literal>auto</literal>. If <literal>auto</literal> is specified,
          the port is automatically generated based on interface name.
          Defaults to <literal>auto</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FirewallMark=</varname></term>
        <listitem>
          <para>Sets a firewall mark on outgoing WireGuard packets from this interface. Takes a number between 1 and 4294967295.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RouteTable=</varname></term>
        <listitem>
          <para>The table identifier for the routes to the addresses specified in the
          <varname>AllowedIPs=</varname>. Takes a negative boolean value, one of the predefined names
          <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, names
          defined in <varname>RouteTable=</varname> in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
          or a number in the range 1…4294967295. When <literal>off</literal> the routes to the
          addresses specified in the <varname>AllowedIPs=</varname> setting will not be configured.
          Defaults to false. This setting will be ignored when the same setting is specified in the
          [WireGuardPeer] section.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RouteMetric=</varname></term>
        <listitem>
          <para>The priority of the routes to the addresses specified in the
          <varname>AllowedIPs=</varname>. Takes an integer in the range 0…4294967295. Defaults to 0
          for IPv4 addresses, and 1024 for IPv6 addresses. This setting will be ignored when the same
          setting is specified in the [WireGuardPeer] section.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[WireGuardPeer] Section Options</title>
 
    <para>The [WireGuardPeer] section accepts the following
    keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>PublicKey=</varname></term>
        <listitem>
          <para>Sets a Base64 encoded public key calculated by <command>wg pubkey</command>
          (see <citerefentry project='man-pages'><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
          from a private key, and usually transmitted out of band to the author of the configuration file.
          This option honors the <literal>@</literal> prefix in the same way as the <option>PrivateKey=</option>
          setting of the <option>[WireGuard]</option> section. This option is mandatory for this section.</para>
 
        <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PublicKeyFile=</varname></term>
        <listitem>
          <para>Takes an absolute path to a file which contains the Base64 encoded public key for the peer.
          When this option is specified, then <varname>PublicKey=</varname> will be ignored. Note that the
          file must be readable by the user <literal>systemd-network</literal>, so it should be, e.g., owned
          by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode. If the path
          refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is made to
          it and the key read from it.</para>
 
          <xi:include href="version-info.xml" xpointer="v257"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PresharedKey=</varname></term>
        <listitem>
          <para>Optional preshared key for the interface. It can be generated by the <command>wg genpsk</command>
          command. This option adds an additional layer of symmetric-key cryptography to be mixed into the
          already existing public-key cryptography, for post-quantum resistance.
          This option honors the <literal>@</literal> prefix in the same way as the <option>PrivateKey=</option>
          setting of the <option>[WireGuard]</option> section.</para>
 
          <para>Note that because this information is secret, it is strongly recommended to use an (encrypted)
          credential. Alternatively, you may want to set the permissions of the .netdev file to be owned
          by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PresharedKeyFile=</varname></term>
        <listitem>
          <para>Takes an absolute path to a file which contains the Base64 encoded preshared key for the
          peer. When this option is specified, then <varname>PresharedKey=</varname> is ignored.  Note that
          the file must be readable by the user <literal>systemd-network</literal>, so it should be, e.g.,
          owned by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode. If the
          path refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is
          made to it and the key read from it.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AllowedIPs=</varname></term>
        <listitem>
          <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks from which this peer
          is allowed to send incoming traffic and to which outgoing traffic for this peer is directed. This
          setting can be specified multiple times. If an empty string is assigned, then the all previous
          assignments are cleared.</para>
 
          <para>The catch-all 0.0.0.0/0 may be specified for matching all IPv4 addresses,
          and ::/0 may be specified for matching all IPv6 addresses.</para>
 
          <para>Note that this only affects <emphasis>routing inside the network interface itself</emphasis>,
          i.e. the packets that pass through the tunnel itself. To cause packets to be sent via the tunnel in
          the first place, an appropriate route needs to be added as well — either in the
          <literal>[Routes]</literal> section on the <literal>.network</literal> matching the wireguard
          interface, or externally to <command>systemd-networkd</command>.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Endpoint=</varname></term>
        <listitem>
          <para>Sets an endpoint IP address or hostname, followed by a colon, and then a port number.
          IPv6 address must be in the square brackets. For example, <literal>111.222.333.444:51820</literal>
          for IPv4 and <literal>[1111:2222::3333]:51820</literal> for IPv6 address. This endpoint will be
          updated automatically once to the most recent source IP address and port of correctly
          authenticated packets from the peer at configuration time.</para>
 
          <para>This option honors the <literal>@</literal> prefix in the same way as the <option>PrivateKey=</option>
          setting of the <option>[WireGuard]</option> section.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PersistentKeepalive=</varname></term>
        <listitem>
          <para>Sets a seconds interval, between 1 and 65535 inclusive, of how often
          to send an authenticated empty packet to the peer for the purpose
          of keeping a stateful firewall or NAT mapping valid persistently.
          For example, if the interface very rarely sends traffic, but it
          might at anytime receive traffic from a peer, and it is behind NAT,
          the interface might benefit from having a persistent keepalive
          interval of 25 seconds. If set to 0 or "off", this option is
          disabled. By default or when unspecified, this option is off.
          Most users will not need this.</para>
 
          <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RouteTable=</varname></term>
        <listitem>
          <para>The table identifier for the routes to the addresses specified in the
          <varname>AllowedIPs=</varname>. Takes a negative boolean value, one of the predefined names
          <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, names
          defined in <varname>RouteTable=</varname> in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
          or a number in the range 1…4294967295. Defaults to unset, and the value specified in the
          same setting in the [WireGuard] section will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RouteMetric=</varname></term>
        <listitem>
          <para>The priority of the routes to the addresses specified in the
          <varname>AllowedIPs=</varname>. Takes an integer in the range 0…4294967295. Defaults to
          unset, and the value specified in the same setting in the [WireGuard] section will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Bond] Section Options</title>
 
    <para>The [Bond] section accepts the following
    key:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Mode=</varname></term>
        <listitem>
          <para>Specifies one of the bonding policies. The default is
          <literal>balance-rr</literal> (round robin). Possible values are
          <literal>balance-rr</literal>,
          <literal>active-backup</literal>,
          <literal>balance-xor</literal>,
          <literal>broadcast</literal>,
          <literal>802.3ad</literal>,
          <literal>balance-tlb</literal>, and
          <literal>balance-alb</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TransmitHashPolicy=</varname></term>
        <listitem>
          <para>Selects the transmit hash policy to use for slave
          selection in balance-xor, 802.3ad, and tlb modes. Possible
          values are
          <literal>layer2</literal>,
          <literal>layer3+4</literal>,
          <literal>layer2+3</literal>,
          <literal>encap2+3</literal>, and
          <literal>encap3+4</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LACPTransmitRate=</varname></term>
        <listitem>
          <para>Specifies the rate with which link partner transmits
          Link Aggregation Control Protocol Data Unit packets in
          802.3ad mode. Possible values are <literal>slow</literal>,
          which requests partner to transmit LACPDUs every 30 seconds,
          and <literal>fast</literal>, which requests partner to
          transmit LACPDUs every second. The default value is
          <literal>slow</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MIIMonitorSec=</varname></term>
        <listitem>
          <para>Specifies the frequency that Media Independent
          Interface link monitoring will occur. A value of zero
          disables MII link monitoring. This value is rounded down to
          the nearest millisecond. The default value is 0.</para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PeerNotifyDelaySec=</varname></term>
        <listitem>
          <para>Specifies the number of seconds the delay between each peer notification
          (gratuitous ARP and unsolicited IPv6 Neighbor Advertisement) when they are issued
          after a failover event. This delay should be a multiple of the MII link monitor
          interval (miimon). The valid range is 0...300s. The default value is 0,
          which means to match the value of the <varname>MIIMonitorSec=</varname>.</para>
 
           <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>UpDelaySec=</varname></term>
        <listitem>
          <para>Specifies the delay before a link is enabled after a
          link up status has been detected. This value is rounded down
          to a multiple of <varname>MIIMonitorSec=</varname>. The default value is
          0.</para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DownDelaySec=</varname></term>
        <listitem>
          <para>Specifies the delay before a link is disabled after a
          link down status has been detected. This value is rounded
          down to a multiple of <varname>MIIMonitorSec=</varname>. The default value is
          0.</para>
 
          <xi:include href="version-info.xml" xpointer="v216"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LearnPacketIntervalSec=</varname></term>
        <listitem>
          <para>Specifies the number of seconds between instances where the bonding
          driver sends learning packets to each slave peer switch.
          The valid range is 1…0x7fffffff; the default value is 1. This option
          has an effect only for the balance-tlb and balance-alb modes.</para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AdSelect=</varname></term>
        <listitem>
          <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are
          <literal>stable</literal>,
          <literal>bandwidth</literal> and
          <literal>count</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AdActorSystemPriority=</varname></term>
        <listitem>
          <para>Specifies the 802.3ad actor system priority. Takes a number in the range 1…65535.</para>
 
        <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AdUserPortKey=</varname></term>
        <listitem>
          <para>Specifies the 802.3ad user defined portion of the port key. Takes a number in the range
          0…1023.</para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AdActorSystem=</varname></term>
        <listitem>
          <para>Specifies the 802.3ad system MAC address. This cannot be a null or multicast address.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>FailOverMACPolicy=</varname></term>
        <listitem>
          <para>Specifies whether the active-backup mode should set all slaves to
          the same MAC address at the time of enslavement or, when enabled, to perform special handling of the
          bond's MAC address in accordance with the selected policy. The default policy is none.
          Possible values are
          <literal>none</literal>,
          <literal>active</literal> and
          <literal>follow</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ARPValidate=</varname></term>
        <listitem>
          <para>Specifies whether or not ARP probes and replies should be
          validated in any mode that supports ARP monitoring, or whether
          non-ARP traffic should be filtered (disregarded) for link
          monitoring purposes. Possible values are
          <literal>none</literal>,
          <literal>active</literal>,
          <literal>backup</literal> and
          <literal>all</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ARPIntervalSec=</varname></term>
        <listitem>
          <para>Specifies the ARP link monitoring frequency. A value of 0 disables ARP monitoring. The
          default value is 0, and the default unit seconds.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ARPIPTargets=</varname></term>
        <listitem>
          <para>Specifies the IP addresses to use as ARP monitoring peers when
          <varname>ARPIntervalSec=</varname> is greater than 0. These are the targets of the ARP
          request sent to determine the health of the link to the targets.
          Specify these values in IPv4 dotted decimal format. At least one IP
          address must be given for ARP monitoring to function. The
          maximum number of targets that can be specified is 16. The
          default value is no IP addresses.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ARPAllTargets=</varname></term>
        <listitem>
          <para>Specifies the quantity of <varname>ARPIPTargets=</varname> that must be reachable
          in order for the ARP monitor to consider a slave as being up.
          This option affects only active-backup mode for slaves with
          ARPValidate enabled. Possible values are
          <literal>any</literal> and
          <literal>all</literal>.
          </para>
 
        <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PrimaryReselectPolicy=</varname></term>
        <listitem>
          <para>Specifies the reselection policy for the primary slave.  This
          affects how the primary slave is chosen to become the active slave
          when failure of the active slave or recovery of the primary slave
          occurs. This option is designed to prevent flip-flopping between
          the primary slave and other slaves.  Possible values are
          <literal>always</literal>,
          <literal>better</literal> and
          <literal>failure</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ResendIGMP=</varname></term>
        <listitem>
          <para>Specifies the number of IGMP membership reports to be issued after
          a failover event. One membership report is issued immediately after
          the failover, subsequent packets are sent in each 200ms interval.
          The valid range is 0…255. Defaults to 1. A value of 0
          prevents the IGMP membership report from being issued in response
          to the failover event.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>PacketsPerSlave=</varname></term>
        <listitem>
          <para>Specify the number of packets to transmit through a slave before
          moving to the next one. When set to 0, then a slave is chosen at
          random. The valid range is 0…65535. Defaults to 1. This option
          only has effect when in balance-rr mode.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>GratuitousARP=</varname></term>
        <listitem>
          <para>Specify the number of peer notifications (gratuitous ARPs and
          unsolicited IPv6 Neighbor Advertisements) to be issued after a
          failover event.  As soon as the link is up on the new slave,
          a peer notification is sent on the  bonding device and each
          VLAN sub-device.  This is repeated at each link monitor interval
          (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is
          greater than 1. The valid range is 0…255. The default value is 1.
          These options affect only the active-backup mode.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>AllSlavesActive=</varname></term>
        <listitem>
          <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
          should be dropped when false, or delivered when true. Normally, bonding will drop
          duplicate frames (received on inactive ports), which is desirable for
          most users. But there are some cases where it is nice to allow duplicate
          frames to be delivered. The default value is false (drop duplicate frames
          received on inactive ports).
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>DynamicTransmitLoadBalancing=</varname></term>
        <listitem>
          <para>Takes a boolean. Specifies if dynamic shuffling of flows is enabled. Applies only
          for balance-tlb mode. Defaults to unset.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MinLinks=</varname></term>
        <listitem>
          <para>Specifies the minimum number of links that must be active before
          asserting carrier. The default value is 0.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v220"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>ARPMissedMax=</varname></term>
        <listitem>
          <para>Specify the maximum number of arp interval monitor cycle
          for missed ARP replies. If this number is exceeded, link is reported as
          down. Defaults to unset.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
    </variablelist>
 
    <para>For more detail information see
    <ulink url="https://docs.kernel.org/networking/bonding.html">
    Linux Ethernet Bonding Driver HOWTO</ulink></para>
  </refsect1>
 
  <refsect1>
    <title>[Xfrm] Section Options</title>
 
    <para>The [Xfrm] section accepts the following
    keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>InterfaceId=</varname></term>
        <listitem>
          <para>Sets the ID/key of the xfrm interface which needs to be associated with a SA/policy.
          Can be decimal or hexadecimal, valid range is 1-0xffffffff. This is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Independent=</varname></term>
        <listitem>
          <para>Takes a boolean. If false (the default), the xfrm interface must have an underlying device
          which can be used for hardware offloading.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
 
    <para>For more detail information see
      <ulink url="https://lwn.net/Articles/757391">Virtual XFRM Interfaces</ulink>.</para>
  </refsect1>
 
  <refsect1>
    <title>[VRF] Section Options</title>
    <para>The [VRF] section only applies for
    netdevs of kind <literal>vrf</literal> and accepts the
    following key:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Table=</varname></term>
        <listitem>
          <para>The routing table identifier. Takes a route table name or number. Route table names
          may be predefined or configured with <varname>RouteTable=</varname> in
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
          This setting is compulsory.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BatmanAdvanced] Section Options</title>
 
    <para>The [BatmanAdvanced] section only applies for netdevs of kind <literal>batadv</literal> and accepts
    the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>GatewayMode=</varname></term>
        <listitem>
          <para>Takes one of <literal>off</literal>, <literal>server</literal>, or <literal>client</literal>.
          A batman-adv node can either run in server mode (sharing its internet
          connection with the mesh) or in client mode (searching for the most suitable internet connection
          in the mesh) or having the gateway support turned off entirely (which is the default setting).
          </para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Aggregation=</varname></term>
        <listitem>
          <para>Takes a boolean value. Enables or disables aggregation of originator messages. Defaults to
           true.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>BridgeLoopAvoidance=</varname></term>
        <listitem>
          <para>Takes a boolean value. Enables or disables avoidance of loops on bridges. Defaults to true.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DistributedArpTable=</varname></term>
        <listitem>
          <para>Takes a boolean value. Enables or disables the distributed ARP table. Defaults to true.</para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Fragmentation=</varname></term>
        <listitem>
          <para>Takes a boolean value. Enables or disables fragmentation. Defaults to true.</para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>HopPenalty=</varname></term>
        <listitem>
          <para>The hop penalty setting allows one to modify
          <citerefentry project='mankier'><refentrytitle>batctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          preference for multihop routes vs. short routes. This integer value is applied to the
          TQ (Transmit Quality) of each forwarded OGM (Originator Message), thereby propagating the
          cost of an extra hop (the packet has to be received and retransmitted which costs airtime).
          A higher hop penalty will make it more unlikely that other nodes will choose this node as
          intermediate hop towards any given destination. The default hop penalty of '15' is a reasonable
          value for most setups and probably does not need to be changed. However, mobile nodes could
          choose a value of 255 (maximum value) to avoid being chosen as a router by other nodes.
          The minimum value is 0.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>OriginatorIntervalSec=</varname></term>
        <listitem>
          <para>The value specifies the interval in seconds, unless another time unit is specified in which
          batman-adv floods the network with its protocol information.
          See <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>
          for more information.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GatewayBandwidthDown=</varname></term>
        <listitem>
          <para>If the node is a server, this
          parameter is used to inform other nodes in the network about
          this node's internet connection download bandwidth in bits per second. Just enter any number
          suffixed with K, M, G or T (base 1000) and the batman-adv
          module will propagate the entered value in the mesh.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GatewayBandwidthUp=</varname></term>
        <listitem>
          <para>If the node is a server, this
          parameter is used to inform other nodes in the network about
          this node's internet connection upload bandwidth in bits per second. Just enter any number
          suffixed with K, M, G or T (base 1000) and the batman-adv
          module will propagate the entered value in the mesh.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RoutingAlgorithm=</varname></term>
        <listitem>
          <para>This can be either <literal>batman-v</literal> or <literal>batman-iv</literal> and describes which routing_algo
          of <citerefentry project='mankier'><refentrytitle>batctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> to use. The algorithm
          cannot be changed after interface creation. Defaults to <literal>batman-v</literal>.
          </para>
 
        <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[IPoIB] Section Options</title>
    <para>The [IPoIB] section only applies for netdevs of kind <literal>ipoib</literal> and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>PartitionKey=</varname></term>
        <listitem>
          <para>Takes an integer in the range 1…0xffff, except for 0x8000. Defaults to unset, and the
          kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry id='ipoib_mode'>
        <term><varname>Mode=</varname></term>
        <listitem>
          <para>Takes one of the special values <literal>datagram</literal> or
          <literal>connected</literal>. Defaults to unset, and the kernel's default is used.</para>
 
          <para>When <literal>datagram</literal>, the Infiniband unreliable datagram (UD) transport is
          used, and so the interface MTU is equal to the IB L2 MTU minus the IPoIB encapsulation
          header (4 bytes). For example, in a typical IB fabric with a 2K MTU, the IPoIB MTU will be
          2048 - 4 = 2044 bytes.</para>
 
          <para>When <literal>connected</literal>, the Infiniband reliable connected (RC) transport is
          used. Connected mode takes advantage of the connected nature of the IB transport and allows
          an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed
          for handling large UDP datagrams, TCP segments, etc and increases the performance for large
          messages.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry id='ipoib_umcast'>
        <term><varname>IgnoreUserspaceMulticastGroups=</varname></term>
        <listitem>
          <para>Takes a boolean value. When true, the kernel ignores multicast groups handled by
          userspace. Defaults to unset, and the kernel's default is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[WLAN] Section Options</title>
    <para>The [WLAN] section only applies to WLAN interfaces, and accepts the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>PhysicalDevice=</varname></term>
        <listitem>
          <para>Specifies the name or index of the physical WLAN device (e.g. <literal>0</literal> or
          <literal>phy0</literal>). The list of the physical WLAN devices that exist on the host can be
          obtained by <command>iw phy</command> command. This option is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Type=</varname></term>
        <listitem>
          <para>Specifies the type of the interface. Takes one of the <literal>ad-hoc</literal>,
          <literal>station</literal>, <literal>ap</literal>, <literal>ap-vlan</literal>,
          <literal>wds</literal>, <literal>monitor</literal>, <literal>mesh-point</literal>,
          <literal>p2p-client</literal>, <literal>p2p-go</literal>, <literal>p2p-device</literal>,
          <literal>ocb</literal>, <literal>nan</literal>, <literal>nan-data</literal> and
          <literal>pd</literal>. This option is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>WDS=</varname></term>
        <listitem>
          <para>Enables the Wireless Distribution System (WDS) mode on the interface. The mode is also
          known as the <literal>4 address mode</literal>. Takes a boolean value. Defaults to unset, and
          the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <example>
      <title>/etc/systemd/network/25-bridge.netdev</title>
 
      <programlisting>[NetDev]
Name=bridge0
Kind=bridge</programlisting>
    </example>
 
    <example>
      <title>/etc/systemd/network/25-vlan1.netdev</title>
 
      <programlisting>[Match]
Virtualization=no
 
[NetDev]
Name=vlan1
Kind=vlan
 
[VLAN]
Id=1</programlisting>
    </example>
    <example>
      <title>/etc/systemd/network/25-ipip.netdev</title>
      <programlisting>[NetDev]
Name=ipip-tun
Kind=ipip
MTUBytes=1480
 
[Tunnel]
Local=192.168.223.238
Remote=192.169.224.239
TTL=64</programlisting>
    </example>
    <example>
      <title>/etc/systemd/network/1-fou-tunnel.netdev</title>
      <programlisting>[NetDev]
Name=fou-tun
Kind=fou
 
[FooOverUDP]
Port=5555
Protocol=4
</programlisting>
    </example>
    <example>
      <title>/etc/systemd/network/25-fou-ipip.netdev</title>
      <programlisting>[NetDev]
Name=ipip-tun
Kind=ipip
 
[Tunnel]
Independent=yes
Local=10.65.208.212
Remote=10.65.208.211
FooOverUDP=yes
FOUDestinationPort=5555
</programlisting>
    </example>
    <example>
      <title>/etc/systemd/network/25-tap.netdev</title>
      <programlisting>[NetDev]
Name=tap-test
Kind=tap
 
[Tap]
MultiQueue=yes
PacketInfo=yes</programlisting> </example>
 
    <example>
      <title>/etc/systemd/network/25-sit.netdev</title>
      <programlisting>[NetDev]
Name=sit-tun
Kind=sit
MTUBytes=1480
 
[Tunnel]
Local=10.65.223.238
Remote=10.65.223.239</programlisting>
    </example>
 
    <example>
      <title>/etc/systemd/network/25-6rd.netdev</title>
      <programlisting>[NetDev]
Name=6rd-tun
Kind=sit
MTUBytes=1480