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></listitem>
  57       </varlistentry>
  58
  59       <varlistentry>
  60         <term><varname>SpeedMeterIntervalSec=</varname></term>
  61         <listitem><para>Specifies the time interval to calculate the traffic speed of each interface.
  62         If <varname>SpeedMeter=no</varname>, the value is ignored. Defaults to 10sec.</para></listitem>
  63       </varlistentry>
  64
  65       <varlistentry>
  66         <term><varname>ManageForeignRoutes=</varname></term>
  67         <listitem><para>A boolean. When true, <command>systemd-networkd</command> will store any routes
  68         configured by other tools in its memory. When false, <command>systemd-networkd</command> will
  69         not manage the foreign routes, thus they are kept even if <varname>KeepConfiguration=</varname>
  70         is false. Defaults to yes.</para></listitem>
  71       </varlistentry>
  72
  73       <varlistentry>
  74         <term><varname>RouteTable=</varname></term>
  75         <listitem><para>Defines the route table name. Takes a whitespace-separated list of the pairs of
  76         route table name and number. The route table name and number in each pair are separated with a
  77         colon, i.e., <literal><replaceable>name</replaceable>:<replaceable>number</replaceable></literal>.
  78         The route table name must not be <literal>default</literal>, <literal>main</literal>, or
  79         <literal>local</literal>, as these route table names are predefined with route table number 253,
  80         254, and 255, respectively. The route table number must be an integer in the range 1…4294967295.
  81         This setting can be specified multiple times. If an empty string is specified, then the list
  82         specified earlier are cleared. Defaults to unset.</para></listitem>
  83       </varlistentry>
  84
  85     </variablelist>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>[DHCP] Section Options</title>
  90
  91     <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCP
  92     protocol. DHCPv6 client protocol sends the DHCP Unique Identifier and the interface
  93     Identity Association Identifier (IAID) to a DHCP server when acquiring a dynamic IPv6
  94     address. DHCPv4 client protocol sends IAID and DUID to the DHCP server when acquiring
  95     a dynamic IPv4 address if <option>ClientIdentifier=duid</option>. IAID and DUID allows
  96     a DHCP server to uniquely identify the machine and the interface requesting a DHCP IP.
  97     To configure IAID and ClientIdentifier, see
  98     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  99     </para>
 100
 101     <para>The following options are understood:</para>
 102
 103     <variablelist class='network-directives'>
 104       <varlistentry>
 105         <term><varname>DUIDType=</varname></term>
 106         <listitem><para>Specifies how the DUID should be generated. See
 107         <ulink url="https://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>
 108         for a description of all the options.</para>
 109
 110         <para>The following values are understood:
 111         <variablelist>
 112           <varlistentry>
 113             <term><option>vendor</option></term>
 114             <listitem><para>If <literal>DUIDType=vendor</literal>, then the DUID value will be generated using
 115             <literal>43793</literal> as the vendor identifier (systemd) and hashed contents of
 116             <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 117             This is the default if <varname>DUIDType=</varname> is not specified.
 118             </para></listitem>
 119           </varlistentry>
 120
 121           <varlistentry>
 122             <term><option>uuid</option></term>
 123             <listitem><para>If <literal>DUIDType=uuid</literal>, and <varname>DUIDRawData=</varname> is not set,
 124             then the product UUID is used as a DUID value. If a system does not have valid product UUID, then
 125             an application-specific
 126             <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 127             is used as a DUID value. About the application-specific machine ID, see
 128             <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 129             </para></listitem>
 130           </varlistentry>
 131
 132           <varlistentry>
 133             <term><option>link-layer-time[:<replaceable>TIME</replaceable>]</option></term>
 134             <term><option>link-layer</option></term>
 135             <listitem><para>If <literal>link-layer-time</literal> or <literal>link-layer</literal> is specified,
 136             then the MAC address of the interface is used as a DUID value. The value <literal>link-layer-time</literal>
 137             can take additional time value after a colon, e.g. <literal>link-layer-time:2018-01-23 12:34:56 UTC</literal>.
 138             The default time value is <literal>2000-01-01 00:00:00 UTC</literal>.
 139             </para></listitem>
 140           </varlistentry>
 141         </variablelist>
 142         </para>
 143
 144         <para>In all cases, <varname>DUIDRawData=</varname> can be used to override the
 145         actual DUID value that is used.</para></listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term><varname>DUIDRawData=</varname></term>
 150         <listitem><para>Specifies the DHCP DUID value as a single newline-terminated, hexadecimal string, with each
 151         byte separated by <literal>:</literal>. The DUID that is sent is composed of the DUID type specified by
 152         <varname>DUIDType=</varname> and the value configured here.</para>
 153
 154         <para>The DUID value specified here overrides the DUID that
 155         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 156         generates from the machine ID. To configure DUID per-network, see
 157         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 158         The configured DHCP DUID should conform to the specification in
 159         <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>,
 160         <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see
 161         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
 162         </citerefentry>.</para>
 163
 164         <example>
 165           <title>A <option>DUIDType=vendor</option> with a custom value</title>
 166
 167           <programlisting>DUIDType=vendor
 168 DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting>
 169
 170           <para>This specifies a 14 byte DUID, with the type DUID-EN (<literal>00:02</literal>), enterprise number
 171           43793 (<literal>00:00:ab:11</literal>), and identifier value <literal>f9:2a:c2:77:29:f9:5c:00</literal>.
 172           </para>
 173         </example>
 174         </listitem>
 175       </varlistentry>
 176     </variablelist>
 177   </refsect1>
 178
 179   <refsect1>
 180       <title>See Also</title>
 181       <para>
 182       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 183       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 184       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 185       <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 186       <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 187       </para>
 188   </refsect1>
 189
 190 </refentry>