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