networkd: make metric of routes configurable

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

diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index 349ccc5dc91a8537291289c6e9114a9c0d433082..738977ee8dfde98c7d6c6c8f2ac755429a8f0fe7 100644 (file)
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -78,6 +78,11 @@
                 <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
                 disables the configuration file entirely.</para>
 
                 <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
                 disables the configuration file entirely.</para>
 

+        </refsect1>
+
+        <refsect1>
+                <title>[Match] Section Options</title>
+

                         <para>The network file contains a <literal>[Match]</literal> section,
                         which determines if a given network file may be applied to a given device;
                         and a <literal>[Network]</literal> section specifying how the device should
                         <para>The network file contains a <literal>[Match]</literal> section,
                         which determines if a given network file may be applied to a given device;
                         and a <literal>[Network]</literal> section specifying how the device should


@@ -172,6 +177,11 @@
                                 </varlistentry>
                         </variablelist>
 
                                 </varlistentry>
                         </variablelist>
 

+        </refsect1>
+
+        <refsect1>
+                <title>[Network] Section Options</title>
+

                         <para>The <literal>[Network]</literal> section accepts the following keys:</para>
 
                         <variablelist class='network-directives'>
                         <para>The <literal>[Network]</literal> section accepts the following keys:</para>
 
                         <variablelist class='network-directives'>


@@ -185,7 +195,17 @@
                                 <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>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>


@@ -214,7 +234,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


@@ -227,14 +247,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


@@ -266,6 +286,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>


@@ -292,8 +313,27 @@
                                                 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>
 
                         </variablelist>
 

+        </refsect1>
+
+        <refsect1>
+                <title>[Address] Section Options</title>
+

                         <para>An <literal>[Address]</literal> section accepts the following keys.
                         Specify several <literal>[Address]</literal> sections to configure several
                         addresses.</para>
                         <para>An <literal>[Address]</literal> section accepts the following keys.
                         Specify several <literal>[Address]</literal> sections to configure several
                         addresses.</para>


@@ -305,6 +345,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>


@@ -321,7 +368,10 @@
                                         </listitem>
                                 </varlistentry>
                         </variablelist>
                                         </listitem>
                                 </varlistentry>
                         </variablelist>

+        </refsect1>

 
 

+        <refsect1>
+                <title>[Route] Section Options</title>

                         <para>The <literal>[Route]</literal> section accepts the following keys. Specify
                         several <literal>[Route]</literal> sections to configure several routes.</para>
 
                         <para>The <literal>[Route]</literal> section accepts the following keys. Specify
                         several <literal>[Route]</literal> sections to configure several routes.</para>
 


@@ -339,9 +389,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>
                         </variablelist>

+        </refsect1>

 
 

-                        <para>The <literal>[DHCPv4]</literal> section accepts the following keys:</para>
+        <refsect1>
+                <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>


@@ -358,6 +417,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>


@@ -365,6 +431,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>


@@ -421,6 +494,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>