man/networkd.conf.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1-or-later
   7
   8   Copyright © 2014 Vinay Kulkarni
   9 -->
  10
  11 <refentry id="networkd.conf" conditional='ENABLE_NETWORKD'
  12     xmlns:xi="http://www.w3.org/2001/XInclude">
  13   <refentryinfo>
  14     <title>networkd.conf</title>
  15     <productname>systemd</productname>
  16   </refentryinfo>
  17
  18   <refmeta>
  19     <refentrytitle>networkd.conf</refentrytitle>
  20     <manvolnum>5</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>networkd.conf</refname>
  25     <refname>networkd.conf.d</refname>
  26     <refpurpose>Global Network configuration files</refpurpose>
  27   </refnamediv>
  28
  29   <refsynopsisdiv>
  30     <para><filename>/etc/systemd/networkd.conf</filename></para>
  31     <para><filename>/etc/systemd/networkd.conf.d/*.conf</filename></para>
  32     <para><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></para>
  33   </refsynopsisdiv>
  34
  35   <refsect1>
  36     <title>Description</title>
  37
  38     <para>These configuration files control global network parameters.
  39     Currently the DHCP Unique Identifier (DUID).</para>
  40
  41   </refsect1>
  42
  43   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  44
  45   <refsect1>
  46     <title>[Network] Section Options</title>
  47
  48     <para>The following options are available in the [Network] section:</para>
  49
  50     <variablelist class='network-directives'>
  51       <varlistentry>
  52         <term><varname>SpeedMeter=</varname></term>
  53         <listitem><para>Takes a boolean. If set to yes, then <command>systemd-networkd</command>
  54         measures the traffic of each interface, and
  55         <command>networkctl status <replaceable>INTERFACE</replaceable></command> shows the measured speed.
  56         Defaults to no.</para>
  57
  58         <xi:include href="version-info.xml" xpointer="v244"/></listitem>
  59       </varlistentry>
  60
  61       <varlistentry>
  62         <term><varname>SpeedMeterIntervalSec=</varname></term>
  63         <listitem><para>Specifies the time interval to calculate the traffic speed of each interface.
  64         If <varname>SpeedMeter=no</varname>, the value is ignored. Defaults to 10sec.</para>
  65
  66         <xi:include href="version-info.xml" xpointer="v244"/></listitem>
  67       </varlistentry>
  68
  69       <varlistentry>
  70         <term><varname>ManageForeignRoutingPolicyRules=</varname></term>
  71         <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove rules
  72         that are not configured in .network files (except for rules with protocol
  73         <literal>kernel</literal>). When false, it will not remove any foreign rules, keeping them even
  74         if they are not configured in a .network file. Defaults to yes.
  75         </para>
  76
  77         <xi:include href="version-info.xml" xpointer="v249"/></listitem>
  78       </varlistentry>
  79
  80       <varlistentry>
  81         <term><varname>ManageForeignRoutes=</varname></term>
  82         <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove routes
  83         that are not configured in .network files (except for routes with protocol
  84         <literal>kernel</literal>, <literal>dhcp</literal> when <varname>KeepConfiguration=</varname>
  85         is true or <literal>dhcp</literal>, and <literal>static</literal> when
  86         <varname>KeepConfiguration=</varname> is true or <literal>static</literal>). When false, it will
  87         not remove any foreign routes, keeping them even if they are not configured in a .network file.
  88         Defaults to yes.</para>
  89
  90         <xi:include href="version-info.xml" xpointer="v246"/></listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94         <term><varname>ManageForeignNextHops=</varname></term>
  95         <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove nexthops
  96         that are not configured in .network files (except for routes with protocol
  97         <literal>kernel</literal>). When false, it will
  98         not remove any foreign nexthops, keeping them even if they are not configured in a .network file.
  99         Defaults to yes.</para>
 100
 101         <xi:include href="version-info.xml" xpointer="v256"/></listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><varname>RouteTable=</varname></term>
 106         <listitem><para>Defines the route table name. Takes a whitespace-separated list of the pairs of
 107         route table name and number. The route table name and number in each pair are separated with a
 108         colon, i.e., <literal><replaceable>name</replaceable>:<replaceable>number</replaceable></literal>.
 109         The route table name must not be <literal>default</literal>, <literal>main</literal>, or
 110         <literal>local</literal>, as these route table names are predefined with route table number 253,
 111         254, and 255, respectively. The route table number must be an integer in the range 1…4294967295,
 112         except for predefined numbers 253, 254, and 255. This setting can be specified multiple times.
 113         If an empty string is specified, then the list specified earlier are cleared. Defaults to unset.
 114         </para>
 115
 116         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
 117       </varlistentry>
 118
 119       <varlistentry>
 120         <term><varname>IPv6PrivacyExtensions=</varname></term>
 121         <listitem>
 122           <para>Specifies the default value for per-network <varname>IPv6PrivacyExtensions=</varname>.
 123           Takes a boolean or the special values <literal>prefer-public</literal> and
 124           <literal>kernel</literal>. See for details in
 125           <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 126           Defaults to <literal>no</literal>.</para>
 127
 128         <xi:include href="version-info.xml" xpointer="v254"/>
 129         </listitem>
 130       </varlistentry>
 131     </variablelist>
 132   </refsect1>
 133
 134   <refsect1>
 135     <title>[DHCPv4] Section Options</title>
 136
 137     <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCP protocol. DHCPv4
 138     client protocol sends IAID and DUID to the DHCP server when acquiring a dynamic IPv4 address if
 139     <option>ClientIdentifier=duid</option>. IAID and DUID allows a DHCP server to uniquely identify the
 140     machine and the interface requesting a DHCP IP address. To configure IAID and ClientIdentifier, see
 141     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 142     </para>
 143
 144     <para>The following options are understood:</para>
 145
 146     <variablelist class='network-directives'>
 147       <varlistentry>
 148         <term><varname>DUIDType=</varname></term>
 149         <listitem><para>Specifies how the DUID should be generated. See
 150         <ulink url="https://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>
 151         for a description of all the options.</para>
 152
 153         <para>This takes an integer in the range 0…65535, or one of the following string values:
 154         <variablelist>
 155           <varlistentry>
 156             <term><option>vendor</option></term>
 157             <listitem><para>If <literal>DUIDType=vendor</literal>, then the DUID value will be generated using
 158             <literal>43793</literal> as the vendor identifier (systemd) and hashed contents of
 159             <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 160             This is the default if <varname>DUIDType=</varname> is not specified.
 161             </para>
 162
 163             <xi:include href="version-info.xml" xpointer="v230"/></listitem>
 164           </varlistentry>
 165
 166           <varlistentry>
 167             <term><option>uuid</option></term>
 168             <listitem><para>If <literal>DUIDType=uuid</literal>, and <varname>DUIDRawData=</varname> is not set,
 169             then the product UUID is used as a DUID value. If a system does not have valid product UUID, then
 170             an application-specific
 171             <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 172             is used as a DUID value. About the application-specific machine ID, see
 173             <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 174             </para>
 175
 176             <xi:include href="version-info.xml" xpointer="v230"/></listitem>
 177           </varlistentry>
 178
 179           <varlistentry>
 180             <term><option>link-layer-time[:<replaceable>TIME</replaceable>]</option></term>
 181             <term><option>link-layer</option></term>
 182             <listitem><para>If <literal>link-layer-time</literal> or <literal>link-layer</literal> is specified,
 183             then the MAC address of the interface is used as a DUID value. The value <literal>link-layer-time</literal>
 184             can take additional time value after a colon, e.g. <literal>link-layer-time:2018-01-23 12:34:56 UTC</literal>.
 185             The default time value is <literal>2000-01-01 00:00:00 UTC</literal>.
 186             </para>
 187
 188             <xi:include href="version-info.xml" xpointer="v240"/></listitem>
 189           </varlistentry>
 190         </variablelist>
 191         </para>
 192
 193         <para>In all cases, <varname>DUIDRawData=</varname> can be used to override the
 194         actual DUID value that is used.</para>
 195
 196         <xi:include href="version-info.xml" xpointer="v230"/></listitem>
 197       </varlistentry>
 198
 199       <varlistentry>
 200         <term><varname>DUIDRawData=</varname></term>
 201         <listitem><para>Specifies the DHCP DUID value as a single newline-terminated, hexadecimal string, with each
 202         byte separated by <literal>:</literal>. The DUID that is sent is composed of the DUID type specified by
 203         <varname>DUIDType=</varname> and the value configured here.</para>
 204
 205         <para>The DUID value specified here overrides the DUID that
 206         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 207         generates from the machine ID. To configure DUID per-network, see
 208         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 209         The configured DHCP DUID should conform to the specification in
 210         <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>,
 211         <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see
 212         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
 213         </citerefentry>.</para>
 214
 215         <example>
 216           <title>A <option>DUIDType=vendor</option> with a custom value</title>
 217
 218           <programlisting>DUIDType=vendor
 219 DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting>
 220
 221           <para>This specifies a 14 byte DUID, with the type DUID-EN (<literal>00:02</literal>), enterprise number
 222           43793 (<literal>00:00:ab:11</literal>), and identifier value <literal>f9:2a:c2:77:29:f9:5c:00</literal>.
 223           </para>
 224         </example>
 225
 226           <xi:include href="version-info.xml" xpointer="v230"/>
 227         </listitem>
 228       </varlistentry>
 229     </variablelist>
 230   </refsect1>
 231
 232   <refsect1>
 233     <title>[DHCPv6] Section Options</title>
 234
 235     <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCPv6 protocol.
 236     DHCPv6 client protocol sends the DHCP Unique Identifier and the interface Identity Association
 237     Identifier (IAID) to a DHCPv6 server when acquiring a dynamic IPv6 address. IAID and DUID allows a
 238     DHCPv6 server to uniquely identify the machine and the interface requesting a DHCP IP address. To
 239     configure IAID, see
 240     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 241     </para>
 242
 243     <para>The following options are understood:</para>
 244
 245     <variablelist class='network-directives'>
 246       <varlistentry>
 247         <term><varname>DUIDType=</varname></term>
 248         <term><varname>DUIDRawData=</varname></term>
 249         <listitem><para>As in the [DHCPv4] section.</para>
 250
 251         <xi:include href="version-info.xml" xpointer="v249"/></listitem>
 252       </varlistentry>
 253     </variablelist>
 254   </refsect1>
 255
 256   <refsect1>
 257       <title>See Also</title>
 258       <para>
 259       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 260       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 261       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 262       <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 263       <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 264       </para>
 265   </refsect1>
 266
 267 </refentry>