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