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