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     For e.g. DHCP Unique Identifier (DUID).</para>
  62
  63   </refsect1>
  64
  65   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  66
  67   <refsect1>
  68     <title>[DUID] Section Options</title>
  69
  70     <para>This section configures the DHCP Unique Idendifier (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 <citerefentry><refentrytitle>systemd.network
  77     </refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  78
  79     <para>The DUID value specified here overrides the DUID that systemd-networkd
  80     generates using the machine-id from the <filename>/etc/machine-id</filename> file.
  81     To configure DUID per-network, see <citerefentry><refentrytitle>systemd.network
  82     </refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  83
  84     <para>The configured DHCP DUID should conform to the specification in
  85     <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>,
  86     <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see
  87     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
  88     </citerefentry>.</para>
  89
  90     <para>The following options are available in <literal>[DUID]</literal> section:</para>
  91
  92     <variablelist class='network-directives'>
  93
  94       <varlistentry>
  95         <term><varname>Type=</varname></term>
  96         <listitem><para>The type of DUID specified in this section. The following values are
  97         supported:</para>
  98         <para>raw : If <literal>Type=raw</literal>, then <literal>RawData=</literal> specifies
  99         the entire DUID. For e.g: <literal>RawData=00:02:00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</literal>
 100         specifies a 14 byte long DUID-EN ("00:02"), with enterprise number 43793 ("00:00:ab:11"),
 101         and identifier value "f9:2a:c2:77:29:f9:5c:00".</para><para>If Type is not specified and
 102         RawData is specified, Type defaults to 'raw'.</para>
 103         <para>Type will support the following values in the future:</para>
 104         <para>link-layer-and-time : If <literal>Type=link-layer-and-time</literal>, then
 105         <literal>MACAddress=</literal> and <literal>TimeStamp=</literal> specify the hardware
 106         address and time-stamp for DUID-LLT.</para>
 107         <para>vendor : If <literal>Type=vendor</literal>, then <literal>EnterpriseNumber=</literal>
 108         and <literal>RawData=</literal> specify the enterprise number and identifier for DUID-EN.</para>
 109         <para>link-layer : If <literal>Type=link-layer</literal>, then <literal>MACAddress=</literal>
 110         specifies the hardware address for DUID-LL.</para>
 111         <para>uuid : If <literal>Type=uuid</literal>, then <literal>UUID=</literal> specifies DUID-UUID.
 112         </para></listitem>
 113       </varlistentry>
 114
 115       <varlistentry>
 116         <term><varname>RawData=</varname></term>
 117         <listitem><para>Specifies the DUID bytes as a single newline-terminated, hexadecimal
 118         string, with each byte separated by a ':'.</para></listitem>
 119       </varlistentry>
 120     </variablelist>
 121   </refsect1>
 122
 123   <refsect1>
 124     <para>The following options will be supported in the future:
 125     </para>
 126     <variablelist>
 127       <varlistentry>
 128         <term><varname>MACAddress=</varname></term>
 129         <listitem><para>Specifies the link-layer address for DUID Type <option>link-layer
 130         </option> or <option>link-layer-and-time</option>.</para></listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><varname>TimeStamp=</varname></term>
 134         <listitem><para>Specifies the DUID generation time for DUID Type <option>
 135         link-layer-and-time</option>.</para></listitem>
 136       </varlistentry>
 137       <varlistentry>
 138         <term><varname>EnterpriseNumber=</varname></term>
 139         <listitem><para>Specifies the enterprise number for DUID Type
 140         <option>vendor</option>.</para></listitem>
 141       </varlistentry>
 142       <varlistentry>
 143         <term><varname>UUID=</varname></term>
 144         <listitem><para>Specifies the UUID for DUID Type <option>uuid</option>.</para>
 145         </listitem>
 146       </varlistentry>
 147     </variablelist>
 148   </refsect1>
 149
 150   <refsect1>
 151       <title>See Also</title>
 152       <para>
 153       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 154       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 155       <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 156       </para>
 157   </refsect1>
 158
 159 </refentry>