man/networkd.conf.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   This file is part of systemd.
   9
  10   Copyright 2014 Vinay Kulkarni
  11
  12   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="networkd.conf" conditional='ENABLE_NETWORKD'
  27     xmlns:xi="http://www.w3.org/2001/XInclude">
  28   <refentryinfo>
  29     <title>networkd.conf</title>
  30     <productname>systemd</productname>
  31
  32     <authorgroup>
  33       <author>
  34         <contrib>Developer</contrib>
  35         <firstname>Vinay</firstname>
  36         <surname>Kulkarni</surname>
  37         <email>kulkarniv@vmware.com</email>
  38       </author>
  39     </authorgroup>
  40   </refentryinfo>
  41
  42   <refmeta>
  43     <refentrytitle>networkd.conf</refentrytitle>
  44     <manvolnum>5</manvolnum>
  45   </refmeta>
  46
  47   <refnamediv>
  48     <refname>networkd.conf</refname>
  49     <refname>networkd.conf.d</refname>
  50     <refpurpose>Global Network configuration files</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <para><filename>/etc/systemd/networkd.conf</filename></para>
  55     <para><filename>/etc/systemd/networkd.conf.d/*.conf</filename></para>
  56     <para><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></para>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para>These configuration files control global network parameters.
  63     Currently the DHCP Unique Identifier (DUID).</para>
  64
  65   </refsect1>
  66
  67   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  68
  69   <refsect1>
  70     <title>[DHCP] Section Options</title>
  71
  72     <para>This section configures the DHCP Unique Identifier (DUID) value used by DHCP
  73     protocol. DHCPv6 client protocol sends the DHCP Unique Identifier and the interface
  74     Identity Association Identifier (IAID) to a DHCP server when acquiring a dynamic IPv6
  75     address. DHCPv4 client protocol sends IAID and DUID to the DHCP server when acquiring
  76     a dynamic IPv4 address if <option>ClientIdentifier=duid</option>. IAID and DUID allows
  77     a DHCP server to uniquely identify the machine and the interface requesting a DHCP IP.
  78     To configure IAID and ClientIdentifier, see
  79     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  80     </para>
  81
  82     <para>The following options are understood:</para>
  83
  84     <variablelist class='network-directives'>
  85       <varlistentry>
  86         <term><varname>DUIDType=</varname></term>
  87         <listitem><para>Specifies how the DUID should be generated. See
  88         <ulink url="https://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>
  89         for a description of all the options.</para>
  90
  91         <para>The following values are understood:
  92         <variablelist>
  93           <varlistentry>
  94             <term><option>vendor</option> </term>
  95             <listitem><para>If <literal>DUIDType=vendor</literal>, then the DUID value will be generated using
  96             <literal>43793</literal> as the vendor identifier (systemd) and hashed contents of
  97             <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  98             This is the default if <varname>DUIDType=</varname> is not specified.
  99             </para></listitem>
 100           </varlistentry>
 101
 102           <varlistentry>
 103             <term><option>link-layer-time</option> </term>
 104             <term><option>link-layer</option> </term>
 105             <term><option>uuid</option> </term>
 106             <listitem><para>Those values are parsed and can be used to set the DUID type
 107             field, but DUID contents must be provided using <varname>DUIDRawData=</varname>.
 108             </para></listitem>
 109           </varlistentry>
 110         </variablelist>
 111         </para>
 112
 113         <para>In all cases, <varname>DUIDRawData=</varname> can be used to override the
 114         actual DUID value that is used.</para></listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term><varname>DUIDRawData=</varname></term>
 119         <listitem><para>Specifies the DHCP DUID value as a single newline-terminated, hexadecimal string, with each
 120         byte separated by <literal>:</literal>. The DUID that is sent is composed of the DUID type specified by
 121         <varname>DUIDType=</varname> and the value configured here.</para>
 122
 123         <para>The DUID value specified here overrides the DUID that systemd-networkd generates using the machine-id
 124         from the <filename>/etc/machine-id</filename> file. To configure DUID per-network, see
 125         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 126         The configured DHCP DUID should conform to the specification in
 127         <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>,
 128         <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see
 129         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
 130         </citerefentry>.</para>
 131
 132         <example>
 133           <title>A <option>DUIDType=vendor</option> with a custom value</title>
 134
 135           <programlisting>DUIDType=vendor
 136 DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting>
 137
 138           <para>This specifies a 14 byte DUID, with the type DUID-EN (<literal>00:02</literal>), enterprise number
 139           43793 (<literal>00:00:ab:11</literal>), and identifier value <literal>f9:2a:c2:77:29:f9:5c:00</literal>.
 140           </para>
 141         </example>
 142         </listitem>
 143       </varlistentry>
 144     </variablelist>
 145   </refsect1>
 146
 147   <refsect1>
 148       <title>See Also</title>
 149       <para>
 150       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 151       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 152       <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 153       </para>
 154   </refsect1>
 155
 156 </refentry>