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 1001–2000 of 3,130

          port of 6081 is used.</para>
 
          <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FlowLabel=</varname></term>
        <listitem>
          <para>Specifies the flow label to use in outgoing packets.</para>
 
        <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IPDoNotFragment=</varname></term>
        <listitem>
          <para>Accepts the same key as in [VXLAN] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>InheritInnerProtocol=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, inner Layer 3 protocol is set as Protocol Type in the GENEVE
          header instead of Ethernet. Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v254"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[HSR] Section Options</title>
 
    <para>The [HSR] section only applies for
    netdevs of kind <literal>hsr</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Ports=</varname></term>
        <listitem>
          <para>Specifies the underlying interfaces. This field is mandatory and must contain exactly two
          interface names separated by space. This option can be specified multiples times, hence the two cases below have the same result:
          <programlisting>Ports=eth1 eth2</programlisting>
          <programlisting>Ports=eth1
Ports=eth2</programlisting>
          All the previous assignments are cleared when an empty string is specified.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Protocol=</varname></term>
        <listitem>
          <para>Specifies the protocol used by the interface. Takes one of <literal>hsr</literal> or
          <literal>prp</literal>. Defaults to <literal>hsr</literal>.</para>
 
          <para>Both protocols work by sending two copies of every outgoing frame, one for each of the two
          ports. The destination node receives the two frames and keeps only the first one. If a link
          fails, only one of the two frames is received. HSR uses a ring topology where the two outgoing
          frames are sent in opposite directions in the ring. PRP doesn't need a specific topology, but it
          requires two completely redundant networks attached to the two ports.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Supervision=</varname></term>
        <listitem>
          <para>Specifies the last byte of the destination MAC address of supervision frames. Takes a number
          between 0 and 255. Defaults to 0. Supervision frames are used by the HSR and the PRP protocols to
          monitor the integrity of the network and the presence of nodes. The first 5 bytes of the
          destination MAC are always 01:15:4E:00:01 while the last byte is configurable.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[BareUDP] Section Options</title>
 
    <para>The [BareUDP] section only applies for
    netdevs of kind <literal>bareudp</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>DestinationPort=</varname></term>
        <listitem>
          <para>Specifies the destination UDP port (in range 1…65535). This is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v247"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>EtherType=</varname></term>
        <listitem>
          <para>Specifies the L3 protocol. Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>mpls-uc</literal>
          or <literal>mpls-mc</literal>. This is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v247"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MinSourcePort=</varname></term>
        <listitem>
          <para>Specifies the lowest value of the UDP tunnel source port (in range 1…65535).
          Defaults to unset.</para>
 
        <xi:include href="version-info.xml" xpointer="v257"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[L2TP] Section Options</title>
 
    <para>The [L2TP] section only applies for
    netdevs of kind <literal>l2tp</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>TunnelId=</varname></term>
        <listitem>
          <para>Specifies the tunnel identifier. Takes a number in the range 1…4294967295. The value used
          must match the <literal>PeerTunnelId=</literal> value being used at the peer. This setting is
          compulsory.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PeerTunnelId=</varname></term>
        <listitem>
          <para>Specifies the peer tunnel id. Takes a number in the range 1…4294967295. The value used must
          match the <literal>TunnelId=</literal> value being used at the peer. This setting is compulsory.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Remote=</varname></term>
        <listitem>
          <para>Specifies the IP address of the remote peer. This setting is compulsory.</para>
 
        <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Local=</varname></term>
        <listitem>
          <para>Specifies the IP address of a local interface. Takes an IP address, or the special
          values <literal>auto</literal>, <literal>static</literal>, or <literal>dynamic</literal>.
          Optionally a name of a local interface can be specified after <literal>@</literal>, e.g.
          <literal>192.168.0.1@eth0</literal> or <literal>auto@eth0</literal>. When an address is
          specified, then a local or specified interface must have the address, and the remote address
          must be accessible through the local address. If <literal>auto</literal>, then one of the
          addresses on a local or specified interface which is accessible to the remote address will be
          used. Similarly, if <literal>static</literal> or <literal>dynamic</literal> is set, then one
          of the static or dynamic addresses will be used. Defaults to <literal>auto</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>EncapsulationType=</varname></term>
        <listitem>
          <para>Specifies the encapsulation type of the tunnel. Takes one of <literal>udp</literal> or
          <literal>ip</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDPSourcePort=</varname></term>
        <listitem>
          <para>Specifies the UDP source port to be used for the tunnel. When UDP encapsulation is selected
          it is mandatory. Ignored when IP encapsulation is selected.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDPDestinationPort=</varname></term>
        <listitem>
          <para>Specifies destination port. When UDP encapsulation is selected it is mandatory. Ignored when IP
          encapsulation is selected.</para>
 
          <xi:include href="version-info.xml" xpointer="v245"/>
        </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="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDP6ChecksumTx=</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="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UDP6ChecksumRx=</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="v242"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[L2TPSession] Section Options</title>
 
    <para>The [L2TPSession] section only applies for
    netdevs of kind <literal>l2tp</literal>, and accepts the
    following keys:</para>
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Name=</varname></term>
        <listitem>
          <para>Specifies the name of the session. This setting is compulsory.</para>
 
        <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>SessionId=</varname></term>
        <listitem>
          <para>Specifies the session identifier. Takes a number in the range 1…4294967295. The value used
          must match the <literal>SessionId=</literal> value being used at the peer. This setting is
          compulsory.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PeerSessionId=</varname></term>
        <listitem>
          <para>Specifies the peer session identifier. Takes a number in the range 1…4294967295.
          The value used must match the <literal>PeerSessionId=</literal> value being used at the peer.
          This setting is compulsory.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Layer2SpecificHeader=</varname></term>
        <listitem>
          <para>Specifies the layer 2 specific header type of the session. One of <literal>none</literal> or
          <literal>default</literal>. Defaults to <literal>default</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v242"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MACsec] Section Options</title>
 
    <para>The [MACsec] section only applies for network devices of kind
    <literal>macsec</literal>, and accepts the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Port=</varname></term>
        <listitem>
          <para>Specifies the port to be used for the MACsec transmit channel. The port is used to make
          secure channel identifier (SCI). Takes a value between 1 and 65535. Defaults to unset.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Encrypt=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, enable encryption. Defaults to unset.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MACsecReceiveChannel] Section Options</title>
    <para>The [MACsecReceiveChannel] section only applies for network devices of
    kind <literal>macsec</literal>, and accepts the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Port=</varname></term>
        <listitem>
          <para>Specifies the port to be used for the MACsec receive channel. The port is used to make
          secure channel identifier (SCI). Takes a value between 1 and 65535. This option is
          compulsory, and is not set by default.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
        <listitem>
          <para>Specifies the MAC address to be used for the MACsec receive channel. The MAC address
          used to make secure channel identifier (SCI). This setting is compulsory, and is not set by
          default.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MACsecTransmitAssociation] Section Options</title>
 
    <para>The [MACsecTransmitAssociation] section only applies for network devices
    of kind <literal>macsec</literal>, and accepts the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>PacketNumber=</varname></term>
        <listitem>
          <para>Specifies the packet number to be used for replay protection and the construction of
          the initialization vector (along with the secure channel identifier [SCI]). Takes a value
          between 1-4,294,967,295. Defaults to unset.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>KeyId=</varname></term>
        <listitem>
          <para>Specifies the identification for the key. Takes a number between 0-255. This option
          is compulsory, and is not set by default.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Key=</varname></term>
        <listitem>
          <para>Specifies the encryption key used in the transmission channel. The same key must be
          configured on the peer’s matching receive channel. This setting is compulsory, and is not set
          by default. Takes a 128-bit key encoded in a hexadecimal string, for example
          <literal>dffafc8d7b9a43d5b9a3dfbbf6a30c16</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>KeyFile=</varname></term>
        <listitem>
          <para>Takes an absolute path to a file which contains a 128-bit key encoded in a hexadecimal string,
          which will be used in the transmission channel. When this option is specified,
          <varname>Key=</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="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Activate=</varname></term>
        <listitem>
          <para>Takes a boolean. If enabled, then the security association is activated. Defaults to
          unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UseForEncoding=</varname></term>
        <listitem>
          <para>Takes a boolean. If enabled, then the security association is used for encoding. Only
          one [MACsecTransmitAssociation] section can enable this option. When enabled,
          <varname>Activate=yes</varname> is implied. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[MACsecReceiveAssociation] Section Options</title>
 
    <para>The [MACsecReceiveAssociation] section only applies for
    network devices of kind <literal>macsec</literal>, and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Port=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecReceiveChannel] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecReceiveChannel] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PacketNumber=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>KeyId=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Key=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>KeyFile=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Activate=</varname></term>
        <listitem>
          <para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Tunnel] Section Options</title>
 
    <para>The [Tunnel] section only applies for
    netdevs of kind
    <literal>ipip</literal>,
    <literal>sit</literal>,
    <literal>gre</literal>,
    <literal>gretap</literal>,
    <literal>ip6gre</literal>,
    <literal>ip6gretap</literal>,
    <literal>vti</literal>,
    <literal>vti6</literal>,
    <literal>ip6tnl</literal>, and
    <literal>erspan</literal> and accepts
    the following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>External=</varname></term>
        <listitem>
          <para>Takes a boolean value. When true, then the tunnel is externally controlled, which is
          also known as collect metadata mode, and most settings below like <varname>Local=</varname>
          or <varname>Remote=</varname> are ignored. This implies <varname>Independent=</varname>.
          Defaults to false.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Local=</varname></term>
        <listitem>
          <para>A static local address for tunneled packets. It must be an address on another interface
          of this host, or one of the special values <literal>any</literal>,
          <literal>ipv4_link_local</literal>, <literal>ipv6_link_local</literal>,
          <literal>dhcp4</literal>, <literal>dhcp6</literal>, <literal>dhcp_pd</literal>, and <literal>slaac</literal>. If one
          of the special values except for <literal>any</literal> is specified, an address which
          matches the corresponding type on the underlying interface will be used. Defaults to
          <literal>any</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Remote=</varname></term>
        <listitem>
          <para>The remote endpoint of the tunnel. Takes an IP address or the special value
          <literal>any</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TOS=</varname></term>
        <listitem>
          <para>The Type Of Service byte value for a tunnel interface.
          For details about the TOS, see the
          <ulink url="http://tools.ietf.org/html/rfc1349"> Type of
          Service in the Internet Protocol Suite </ulink> document.
          </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 tunneled packets. N is a
          number in the range 1…255. 0 is a special value meaning that
          packets inherit the TTL value. The default value for IPv4
          tunnels is 0 (inherit). The default value for IPv6 tunnels is
          64.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>DiscoverPathMTU=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, enables Path MTU Discovery on
          the tunnel.
          When <varname>IgnoreDontFragment=</varname> is enabled,
          defaults to false. Otherwise, defaults to true.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IgnoreDontFragment=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, enables IPv4 Don't Fragment (DF) suppression on
          the tunnel. Defaults to false.
          Note that if <varname>IgnoreDontFragment=</varname> is set to true,
          <varname>DiscoverPathMTU=</varname> cannot be set to true.
          Only applicable to GRE, GRETAP, and ERSPAN tunnels.</para>
 
          <xi:include href="version-info.xml" xpointer="v254"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IPv6FlowLabel=</varname></term>
        <listitem>
          <para>Configures the 20-bit flow label (see <ulink url="https://tools.ietf.org/html/rfc6437">
          RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460">
          RFC 2460</ulink>), which is used by a node to label packets of a flow.
          It is only used for IPv6 tunnels.
          A flow label of zero is used to indicate packets that have
          not been labeled.
          It can be configured to a value in the range 0…0xFFFFF, or be
          set to <literal>inherit</literal>, in which case the original flowlabel is used.</para>
 
        <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>CopyDSCP=</varname></term>
        <listitem>
          <para>Takes a boolean. When true, the Differentiated Service Code
          Point (DSCP) field will be copied to the inner header from
          outer header during the decapsulation of an IPv6 tunnel
          packet. DSCP is a field in an IP packet that enables different
          levels of service to be assigned to network traffic.
          Defaults to <literal>no</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v223"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>EncapsulationLimit=</varname></term>
        <listitem>
          <para>The Tunnel Encapsulation Limit option specifies how many additional
          levels of encapsulation are permitted to be prepended to the packet.
          For example, a Tunnel Encapsulation Limit option containing a limit
          value of zero means that a packet carrying that option may not enter
          another tunnel before exiting the current tunnel.
          (see <ulink url="https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC 2473</ulink>).
          The valid range is 0…255 and <literal>none</literal>. Defaults to 4.
        </para>
 
          <xi:include href="version-info.xml" xpointer="v226"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Key=</varname></term>
        <listitem>
          <para>The <varname>Key=</varname> parameter specifies the same key to use in
          both directions (<varname>InputKey=</varname> and <varname>OutputKey=</varname>).
          The <varname>Key=</varname> is either a number or an IPv4 address-like dotted quad.
          It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data
          and control path) in IP XFRM (framework used to implement IPsec protocol).
          See <ulink url="https://man7.org/linux/man-pages/man8/ip-xfrm.8.html">
          ip-xfrm — transform configuration</ulink> for details. It is only used for VTI/VTI6,
          GRE, GRETAP, and ERSPAN tunnels.</para>
 
        <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>InputKey=</varname></term>
        <listitem>
          <para>The <varname>InputKey=</varname> parameter specifies the key to use for input.
          The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
          and ERSPAN tunnels.</para>
 
        <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>OutputKey=</varname></term>
        <listitem>
          <para>The <varname>OutputKey=</varname> parameter specifies the key to use for output.
          The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6, GRE, GRETAP,
          and ERSPAN tunnels.</para>
 
        <xi:include href="version-info.xml" xpointer="v231"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Mode=</varname></term>
        <listitem>
          <para>Specifies the tunnel mode. Acceptable values depend on the tunnel kind.</para>
 
          <table>
            <title>Supported tunnel modes</title>
 
            <tgroup cols='3'>
              <colspec colname='kind' />
              <colspec colname='mode' />
              <colspec colname='explanation' />
              <thead>
                <row>
                  <entry>Kind</entry>
                  <entry>Mode</entry>
                  <entry>Description</entry>
                </row>
              </thead>
              <tbody>
                <row>
                  <entry morerows="1"><literal>ipip</literal></entry>
                  <entry><literal>ipip</literal></entry>
                  <entry>IPv4 over IPv4 (default)</entry>
                </row>
                <row>
                  <entry><literal>any</literal></entry>
                  <entry>both IPv4 and IPv6 over IPv4</entry>
                </row>
                <row>
                  <entry morerows="2"><literal>sit</literal></entry>
                  <entry><literal>ipip</literal></entry>
                  <entry>IPv4 over IPv4</entry>
                </row>
                <row>
                  <entry><literal>ip6ip</literal></entry>
                  <entry>IPv6 over IPv4 (default)</entry>
                </row>
                <row>
                  <entry><literal>any</literal></entry>
                  <entry>both IPv4 and IPv6 over IPv4</entry>
                </row>
                <row>
                  <entry morerows="2"><literal>ip6tnl</literal></entry>
                  <entry><literal>ipip6</literal></entry>
                  <entry>IPv4 over IPv6</entry>
                </row>
                <row>
                  <entry><literal>ip6ip6</literal></entry>
                  <entry>IPv6 over IPv6</entry>
                </row>
                <row>
                  <entry><literal>any</literal></entry>
                  <entry>both IPv4 and IPv6 over IPv6 (default)</entry>
                </row>
              </tbody>
            </tgroup>
          </table>
 
        <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Independent=</varname></term>
        <listitem>
          <para>Takes a boolean. When false (the default), the tunnel is always created over some network
          device, and a .network file that requests this tunnel using <varname>Tunnel=</varname> is required
          for the tunnel to be created. When true, the tunnel is created independently of any network as
          "tunnel@NONE".</para>
 
          <xi:include href="version-info.xml" xpointer="v235"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AssignToLoopback=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to <literal>yes</literal>, the loopback interface <literal>lo</literal>
          is used as the underlying device of the tunnel interface. Defaults to <literal>no</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AllowLocalRemote=</varname></term>
        <listitem>
          <para>Takes a boolean. When true allows tunnel traffic on <varname>ip6tnl</varname> devices where the remote endpoint is a local host address.
          When unset, the kernel's default will be used.
          </para>
 
        <xi:include href="version-info.xml" xpointer="v237"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FooOverUDP=</varname></term>
        <listitem>
          <para>Takes a boolean. Specifies whether <varname>FooOverUDP=</varname> tunnel is to be configured.
          Defaults to false. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels.
          For more detail information see
          <ulink url="https://lwn.net/Articles/614348">Foo over UDP</ulink></para>
 
        <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FOUDestinationPort=</varname></term>
        <listitem>
          <para>This setting specifies the UDP destination port for encapsulation.
          This field is mandatory when <varname>FooOverUDP=yes</varname>, and is not set by default.</para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>FOUSourcePort=</varname></term>
        <listitem>
          <para>This setting specifies the UDP source port for encapsulation. Defaults to <constant>0</constant>
          — that is, the source port for packets is left to the network stack to decide.</para>
 
        <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Encapsulation=</varname></term>
        <listitem>
          <para>Accepts the same key as in the [FooOverUDP] section.</para>
 
        <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IPv6RapidDeploymentPrefix=</varname></term>
        <listitem>
          <para>Reconfigure the tunnel for <ulink url="https://tools.ietf.org/html/rfc5569">IPv6 Rapid
          Deployment</ulink>, also known as 6rd. The value is an ISP-specific IPv6 prefix with a non-zero length. Only
          applicable to SIT tunnels.</para>
 
        <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ISATAP=</varname></term>
        <listitem>
          <para>Takes a boolean. If set, configures the tunnel as Intra-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel.
          Only applicable to SIT tunnels. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>SerializeTunneledPackets=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to yes, then packets are serialized. Only applies for GRE,
          GRETAP, and ERSPAN tunnels. When unset, the kernel's default will be used.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ERSPANVersion=</varname></term>
        <listitem>
          <para>Specifies the ERSPAN version number. Takes 0 for version 0 (a.k.a. type I), 1 for version 1
          (a.k.a. type II), or 2 for version 2 (a.k.a. type III). Defaults to 1.</para>
 
          <xi:include href="version-info.xml" xpointer="v252"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ERSPANIndex=</varname></term>
        <listitem>
          <para>Specifies the ERSPAN v1 index field for the interface. Takes an integer in the range
          0…1048575, which is associated with the ERSPAN traffic's source port and direction. Only used when
          <varname>ERSPANVersion=1</varname>. Defaults to 0.</para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ERSPANDirection=</varname></term>
        <listitem>
          <para>Specifies the ERSPAN v2 mirrored traffic's direction. Takes <literal>ingress</literal> or
          <literal>egress</literal>. Only used when <varname>ERSPANVersion=2</varname>. Defaults to
          <literal>ingress</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v252"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ERSPANHardwareId=</varname></term>
        <listitem>
          <para>Specifies a unique identifier of the ERSPAN v2 engine. Takes an integer in the range 0…63.
          Only used when <varname>ERSPANVersion=2</varname>. Defaults to 0.</para>
 
          <xi:include href="version-info.xml" xpointer="v252"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[FooOverUDP] Section Options</title>
 
    <para>The [FooOverUDP] section only applies for
    netdevs of kind <literal>fou</literal> and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Encapsulation=</varname></term>
        <listitem>
          <para>Specifies the encapsulation mechanism used to store networking packets of various protocols
          inside the UDP packets. Supports the following values:
 
          <literal>FooOverUDP</literal> provides the simplest no-frills model of UDP encapsulation, it simply
          encapsulates packets directly in the UDP payload. <literal>GenericUDPEncapsulation</literal> is a
          generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and
          optional data as part of the encapsulation. For more detailed information see <ulink
          url="https://lwn.net/Articles/615044">Generic UDP Encapsulation</ulink>. Defaults to
          <literal>FooOverUDP</literal>.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Port=</varname></term>
        <listitem>
          <para>Specifies the port number where the encapsulated packets will arrive. Those packets will be
          removed and manually fed back into the network stack with the encapsulation removed to be sent to
          the real destination. This option is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PeerPort=</varname></term>
        <listitem>
          <para>Specifies the peer port number. Defaults to unset. Note that when peer port is set
          <literal>Peer=</literal> address is mandatory.</para>
 
          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Protocol=</varname></term>
        <listitem>
          <para>The <varname>Protocol=</varname> specifies the protocol number of the packets arriving
          at the UDP port. When <varname>Encapsulation=FooOverUDP</varname>, this field is mandatory
          and is not set by default. Takes an IP protocol name such as <literal>gre</literal> or
          <literal>ipip</literal>, or an integer within the range 1…255. When
          <varname>Encapsulation=GenericUDPEncapsulation</varname>, this must not be specified.</para>
 
        <xi:include href="version-info.xml" xpointer="v240"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Peer=</varname></term>
        <listitem>
          <para>Configures peer IP address. Note that when peer address is set <literal>PeerPort=</literal>
          is mandatory.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>Local=</varname></term>
        <listitem>
          <para>Configures local IP address.</para>
 
        <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Peer] Section Options</title>
 
    <para>The [Peer] section only applies for
    netdevs of kind <literal>veth</literal> and accepts the
    following keys:</para>
 
    <variablelist class='network-directives'>
      <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="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
        <listitem>
          <para>The peer MACAddress, if not set, it is generated in
          the same way as the MAC address of the main
          interface.</para>
 
          <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[VXCAN] Section Options</title>
 
    <para>The [VXCAN] section only applies for
    netdevs of kind <literal>vxcan</literal> and accepts the
    following key:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Peer=</varname></term>
        <listitem>
          <para>The peer interface name used when creating the netdev.
          This setting is compulsory.</para>
 
          <xi:include href="version-info.xml" xpointer="v236"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[Tun] Section Options</title>
 
    <para>The [Tun] section only applies for
    netdevs of kind <literal>tun</literal>, and accepts the following
    keys:</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>MultiQueue=</varname></term>
        <listitem><para>Takes a boolean. Configures whether
        to use multiple file descriptors (queues) to parallelize
        packets sending and receiving. Defaults to
        <literal>no</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v215"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PacketInfo=</varname></term>