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