man: fix outdated example in systemd.network

[elogind.git] / man / systemd.network.xml

diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index 8b2dd2f1de55180a05384592a38a818a93033ba8..c01bffd52cc4cc3e8ead483c6134bc753d53e214 100644 (file)
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -195,16 +195,32 @@
                                 <varlistentry>
                                         <term><varname>DHCP=</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>DHCP=</varname></term>
                                         <listitem>

-                                                <para>A boolean. When true, enables basic DHCPv4 support.</para>
+                                                <para>Enables DHCPv4 and/or DHCPv6 support. Accepts
+                                                <literal>both</literal>, <literal>none</literal>,
+                                                <literal>v4</literal> or <literal>v6</literal>.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>DHCPServer=</varname></term>
+                                        <listitem>
+                                                <para>A boolean. Enables a basic DHCPv4 server on the
+                                                device. Mostly useful for handing out leases to container
+                                                instances.</para>

                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>IPv4LL=</varname></term>
                                         <listitem>
                                                 <para>A boolean. When true, enables IPv4 link-local support.
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>IPv4LL=</varname></term>
                                         <listitem>
                                                 <para>A boolean. When true, enables IPv4 link-local support.

-                                                If <literal>DHCP=</literal> is also true, acquiring DHCP address
-                                                will deprecate previously acquired IPv4 link-local address or
-                                                stop acquiring process if one has not been acquired before.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>IPv4LLRoute=</varname></term>
+                                        <listitem>
+                                                <para>A boolean. When true, sets up the route needed for
+                                                non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
+                                                to true.

                                                 </para>
                                         </listitem>
                                 </varlistentry>
                                                 </para>
                                         </listitem>
                                 </varlistentry>


@@ -224,7 +240,7 @@
                                                 <para>If the specified
                                                 address is 0.0.0.0
                                                 (for IPv4) or [::]
                                                 <para>If the specified
                                                 address is 0.0.0.0
                                                 (for IPv4) or [::]

-                                                (for IPv6) a new
+                                                (for IPv6), a new

                                                 address range of the
                                                 requested size is
                                                 automatically
                                                 address range of the
                                                 requested size is
                                                 automatically


@@ -237,14 +253,14 @@
                                                 interfaces and all
                                                 known network
                                                 configuration files to
                                                 interfaces and all
                                                 known network
                                                 configuration files to

-                                                avoid IP range
+                                                avoid address range

                                                 conflicts. The default
                                                 system-wide pool
                                                 consists of
                                                 192.168.0.0/16,
                                                 172.16.0.0/12 and
                                                 10.0.0.0/8 for IPv4,
                                                 conflicts. The default
                                                 system-wide pool
                                                 consists of
                                                 192.168.0.0/16,
                                                 172.16.0.0/12 and
                                                 10.0.0.0/8 for IPv4,

-                                                and [fc00::] for
+                                                and fc00::/7 for

                                                 IPv6. This
                                                 functionality is
                                                 useful to manage a
                                                 IPv6. This
                                                 functionality is
                                                 useful to manage a


@@ -276,6 +292,7 @@
                                                 This option may be specified more than once.</para>
                                         </listitem>
                                 </varlistentry>
                                                 This option may be specified more than once.</para>
                                         </listitem>
                                 </varlistentry>

+<!-- TODO: document NTP= option when it is actually used somewhere -->

                                 <varlistentry>
                                         <term><varname>Bridge=</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>Bridge=</varname></term>
                                         <listitem>


@@ -302,6 +319,20 @@
                                                 may be specified more than once.</para>
                                         </listitem>
                                 </varlistentry>
                                                 may be specified more than once.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>VXLAN=</varname></term>
+                                        <listitem>
+                                                <para>The name of a VXLAN to create on the link. This option
+                                                may be specified more than once.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Tunnel=</varname></term>
+                                        <listitem>
+                                                <para>The name of a Tunnel to create on the link. This option
+                                                may be specified more than once.</para>
+                                        </listitem>
+                                </varlistentry>

                         </variablelist>
 
         </refsect1>
                         </variablelist>
 
         </refsect1>


@@ -320,6 +351,13 @@
                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
                                         </listitem>
                                 </varlistentry>
                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>Peer=</varname></term>
+                                        <listitem>
+                                                <para>The peer address in a point-to-point connection. Accepts the same format as
+                                                the <literal>Address</literal> key.</para>
+                                        </listitem>
+                                </varlistentry>

                                 <varlistentry>
                                         <term><varname>Broadcast=</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>Broadcast=</varname></term>
                                         <listitem>


@@ -357,12 +395,18 @@
                                                 prefixlength. If ommitted, a full-length host route is assumed.</para>
                                         </listitem>
                                 </varlistentry>
                                                 prefixlength. If ommitted, a full-length host route is assumed.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>Metric=</varname></term>
+                                        <listitem>
+                                                <para>The metric of the route. An unsigned integer</para>
+                                        </listitem>
+                                </varlistentry>

                         </variablelist>
         </refsect1>
 
         <refsect1>
                         </variablelist>
         </refsect1>
 
         <refsect1>

-                <title>[DHCPv4] Section Options</title>
-                        <para>The <literal>[DHCPv4]</literal> section accepts the following keys:</para>
+                <title>[DHCP] Section Options</title>
+                        <para>The <literal>[DHCP]</literal> section accepts the following keys:</para>

 
                         <variablelist class='network-directives'>
                                 <varlistentry>
 
                         <variablelist class='network-directives'>
                                 <varlistentry>


@@ -379,6 +423,13 @@
                                                 be used on the current link. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>
                                                 be used on the current link. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>SendHostname=</varname></term>
+                                        <listitem>
+                                                <para>When true (the default), the machine's hostname will be sent to the DHCP
+                                                server</para>
+                                        </listitem>
+                                </varlistentry>

                                 <varlistentry>
                                         <term><varname>UseHostname=</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>UseHostname=</varname></term>
                                         <listitem>


@@ -386,6 +437,13 @@
                                                 will be used as the transient hostname.</para>
                                         </listitem>
                                 </varlistentry>
                                                 will be used as the transient hostname.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>UseRoutes=</varname></term>
+                                        <listitem>
+                                                <para>When true (the default), the static routes will be requested from the DHCP server
+                                                and added to the routing table with metric of 1024.</para>
+                                        </listitem>
+                                </varlistentry>

                                 <varlistentry>
                                         <term><varname>CriticalConnection=</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>CriticalConnection=</varname></term>
                                         <listitem>


@@ -394,6 +452,21 @@
                                                 if, say, the root filesystem relies on this connection. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>
                                                 if, say, the root filesystem relies on this connection. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>VendorClassIdentifier=</varname></term>
+                                        <listitem>
+                                                <para>The vendor class identifier used to identify vendor type and configuration.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>RequestBroadcast=</varname></term>
+                                        <listitem>
+                                                <para>Request the server to use broadcast messages before the IP address has been
+                                                configured. This is necessary for devices that cannot receive RAW packets, or that
+                                                cannot receive packets at all before an IP address has been configured. On the other
+                                                hand, this must not be enabled on networks where broadcasts are filtered out.</para>
+                                        </listitem>
+                                </varlistentry>

                        </variablelist>
 
         </refsect1>
                        </variablelist>
 
         </refsect1>


@@ -418,7 +491,7 @@ Gateway=192.168.0.1</programlisting>
 Name=en*
 
 [Network]
 Name=en*
 
 [Network]

-DHCP=yes</programlisting>
+DHCP=both</programlisting>

                 </example>
 
                 <example>
                 </example>
 
                 <example>


@@ -442,6 +515,45 @@ Name=enp2s0
 [Network]
 Bridge=bridge0</programlisting>
                 </example>
 [Network]
 Bridge=bridge0</programlisting>
                 </example>

+                <example>
+                        <title>/etc/systemd/network/ipip.network</title>
+
+                        <programlisting>[Match]
+Name=em1
+
+[Network]
+Tunnel=ipip-tun</programlisting>
+                </example>
+
+                <example>
+                        <title>/etc/systemd/network/sit.network</title>
+
+                        <programlisting>[Match]
+Name=em1
+
+[Network]
+Tunnel=sit-tun</programlisting>
+                </example>
+
+                <example>
+                        <title>/etc/systemd/network/gre.network</title>
+
+                        <programlisting>[Match]
+Name=em1
+
+[Network]
+Tunnel=gre-tun</programlisting>
+                </example>
+
+                <example>
+                        <title>/etc/systemd/network/vti.network</title>
+
+                        <programlisting>[Match]
+Name=em1
+
+[Network]
+Tunnel=vti-tun</programlisting>
+                </example>

         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>