summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/networkd.conf.xml159
-rw-r--r--man/systemd.network.xml86
2 files changed, 245 insertions, 0 deletions
diff --git a/man/networkd.conf.xml b/man/networkd.conf.xml
new file mode 100644
index 0000000000..30674e12bc
--- /dev/null
+++ b/man/networkd.conf.xml
@@ -0,0 +1,159 @@
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+ This file is part of systemd.
+
+ Copyright 2014 Vinay Kulkarni
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="networkd.conf" conditional='ENABLE_NETWORKD'
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refentryinfo>
+ <title>networkd.conf</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Vinay</firstname>
+ <surname>Kulkarni</surname>
+ <email>kulkarniv@vmware.com</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>networkd.conf</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>networkd.conf</refname>
+ <refname>networkd.conf.d</refname>
+ <refpurpose>Global Network configuration files</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/etc/systemd/networkd.conf</filename></para>
+ <para><filename>/etc/systemd/networkd.conf.d/*.conf</filename></para>
+ <para><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>These configuration files control global network parameters.
+ For e.g. DHCP Unique Identifier (DUID).</para>
+
+ </refsect1>
+
+ <xi:include href="standard-conf.xml" xpointer="main-conf" />
+
+ <refsect1>
+ <title>[DUID] Section Options</title>
+
+ <para>This section configures the DHCP Unique Idendifier (DUID) value used by DHCP
+ protocol. DHCPv6 client protocol sends the DHCP Unique Identifier and the interface
+ Identity Association Identifier (IAID) to a DHCP server when acquiring a dynamic IPv6
+ address. DHCPv4 client protocol sends IAID and DUID to the DHCP server when acquiring
+ a dynamic IPv4 address if <option>ClientIdentifier=duid</option>. IAID and DUID allows
+ a DHCP server to uniquely identify the machine and the interface requesting a DHCP IP.
+ To configure IAID and ClientIdentifier, see <citerefentry><refentrytitle>systemd.network
+ </refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+ <para>The DUID value specified here overrides the DUID that systemd-networkd
+ generates using the machine-id from the <filename>/etc/machine-id</filename> file.
+ To configure DUID per-network, see <citerefentry><refentrytitle>systemd.network
+ </refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+ <para>The configured DHCP DUID should conform to the specification in
+ <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>,
+ <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>. To configure IAID, see
+ <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
+ </citerefentry>.</para>
+
+ <para>The following options are available in <literal>[DUID]</literal> section:</para>
+
+ <variablelist class='network-directives'>
+
+ <varlistentry>
+ <term><varname>Type=</varname></term>
+ <listitem><para>The type of DUID specified in this section. The following values are
+ supported:</para>
+ <para>raw : If <literal>Type=raw</literal>, then <literal>RawData=</literal> specifies
+ the entire DUID. For e.g: <literal>RawData=00:02:00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</literal>
+ specifies a 14 byte long DUID-EN ("00:02"), with enterprise number 43793 ("00:00:ab:11"),
+ and identifier value "f9:2a:c2:77:29:f9:5c:00".</para><para>If Type is not specified and
+ RawData is specified, Type defaults to 'raw'.</para>
+ <para>Type will support the following values in the future:</para>
+ <para>link-layer-and-time : If <literal>Type=link-layer-and-time</literal>, then
+ <literal>MACAddress=</literal> and <literal>TimeStamp=</literal> specify the hardware
+ address and time-stamp for DUID-LLT.</para>
+ <para>vendor : If <literal>Type=vendor</literal>, then <literal>EnterpriseNumber=</literal>
+ and <literal>RawData=</literal> specify the enterprise number and identifier for DUID-EN.</para>
+ <para>link-layer : If <literal>Type=link-layer</literal>, then <literal>MACAddress=</literal>
+ specifies the hardware address for DUID-LL.</para>
+ <para>uuid : If <literal>Type=uuid</literal>, then <literal>UUID=</literal> specifies DUID-UUID.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>RawData=</varname></term>
+ <listitem><para>Specifies the DUID bytes as a single newline-terminated, hexadecimal
+ string, with each byte separated by a ':'.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <para>The following options will be supported in the future:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><varname>MACAddress=</varname></term>
+ <listitem><para>Specifies the link-layer address for DUID Type <option>link-layer
+ </option> or <option>link-layer-and-time</option>.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname>TimeStamp=</varname></term>
+ <listitem><para>Specifies the DUID generation time for DUID Type <option>
+ link-layer-and-time</option>.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname>EnterpriseNumber=</varname></term>
+ <listitem><para>Specifies the enterprise number for DUID Type
+ <option>vendor</option>.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname>UUID=</varname></term>
+ <listitem><para>Specifies the UUID for DUID Type <option>uuid</option>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index f2e715cf6f..b2e1d40287 100644
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -204,6 +204,12 @@
understood to the base of 1024.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>IAID=</varname></term>
+ <listitem>
+ <para>Identity Association Identifier for the interface, a 32-bit unsigned integer.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
@@ -824,6 +830,86 @@
</refsect1>
<refsect1>
+ <title>[DUID] Section Options</title>
+
+ <para>This section configures the DHCP Unique Idendifier (DUID) value used by DHCP
+ protocol. DHCPv6 client protocol sends the DHCP Unique Identifier and the interface
+ Identity Association Identifier (IAID) to a DHCP server when acquiring a dynamic IPv6
+ address. DHCPv4 client protocol sends IAID and DUID to the DHCP server when acquiring
+ a dynamic IPv4 address if <option>ClientIdentifier=duid</option>. IAID and DUID allows a
+ DHCP server to uniquely identify the machine and the interface requesting a DHCP IP.</para>
+
+ <para>The DUID value specified here overrides the DUID that systemd-networkd generates
+ using the machine-id from the <filename>/etc/machine-id</filename> file, as well as the
+ global DUID that may be specified in <citerefentry><refentrytitle>networkd.conf
+ </refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+ <para>The configured DHCP DUID should conform to the specification in
+ <ulink url="http://tools.ietf.org/html/rfc3315#section-9">RFC 3315</ulink>,
+ <ulink url="http://tools.ietf.org/html/rfc6355">RFC 6355</ulink>.</para>
+
+ <para>The following options are available in <literal>[DUID]</literal> section:</para>
+
+ <variablelist class='network-directives'>
+
+ <varlistentry>
+ <term><varname>Type=</varname></term>
+ <listitem><para>The type of DUID specified in this section. The following values are
+ supported:</para>
+ <para>raw : If <literal>Type=raw</literal>, then <literal>RawData=</literal> specifies
+ the entire DUID. For e.g: <literal>RawData=00:02:00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</literal>
+ specifies a 14 byte long DUID-EN ("00:02"), with enterprise number 43793 ("00:00:ab:11"),
+ and identifier value "f9:2a:c2:77:29:f9:5c:00".</para><para>If Type is not specified and
+ RawData is specified, Type defaults to 'raw'.</para>
+ <para>Type will support the following values in the future:</para>
+ <para>link-layer-and-time : If <literal>Type=link-layer-and-time</literal>, then
+ <literal>MACAddress=</literal> and <literal>TimeStamp=</literal> specify the hardware
+ address and time-stamp for DUID-LLT.</para>
+ <para>vendor : If <literal>Type=vendor</literal>, then <literal>EnterpriseNumber=</literal>
+ and <literal>RawData=</literal> specify the enterprise number and identifier for DUID-EN.</para>
+ <para>link-layer : If <literal>Type=link-layer</literal>, then <literal>MACAddress=</literal>
+ specifies the hardware address for DUID-LL.</para>
+ <para>uuid : If <literal>Type=uuid</literal>, then <literal>UUID=</literal> specifies DUID-UUID.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>RawData=</varname></term>
+ <listitem><para>Specifies the DUID bytes as a single newline-terminated, hexadecimal
+ string, with each byte separated by a ':'.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <para>The following options will be supported in the future:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><varname>MACAddress=</varname></term>
+ <listitem><para>Specifies the link-layer address for DUID Type <option>link-layer
+ </option> or <option>link-layer-and-time</option>.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname>TimeStamp=</varname></term>
+ <listitem><para>Specifies the DUID generation time for DUID Type <option>
+ link-layer-and-time</option>.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname>EnterpriseNumber=</varname></term>
+ <listitem><para>Specifies the enterprise number for DUID Type <option>
+ vendor</option>.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><varname>UUID=</varname></term>
+ <listitem><para>Specifies the UUID for DUID Type <option>uuid</option>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
<title>[DHCPServer] Section Options</title>
<para>The <literal>[DHCPServer]</literal> section contains
settings for the DHCP server, if enabled via the