man/systemd.network.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   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 2013 Tom Gundersen
   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="systemd.network" conditional='ENABLE_NETWORKD'>
  25
  26         <refentryinfo>
  27                 <title>systemd.network</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Tom</firstname>
  34                                 <surname>Gundersen</surname>
  35                                 <email>teg@jklm.no</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd.network</refentrytitle>
  42                 <manvolnum>5</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd.network</refname>
  47                 <refpurpose>Network configuration</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <para><filename><replaceable>network</replaceable>.network</filename></para>
  52         </refsynopsisdiv>
  53
  54         <refsect1>
  55                 <title>Description</title>
  56
  57                 <para>Network setup is performed by
  58                 <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  59                 </para>
  60
  61                 <para>Network files must have the extension <filename>.network</filename>;
  62                 other extensions are ignored. Networks are applied to links whenever the links
  63                 appear.</para>
  64
  65                 <para>The <filename>.network</filename> files are read from the files located in the
  66                 system network directory <filename>/usr/lib/systemd/network</filename>,
  67                 the volatile runtime network directory
  68                 <filename>/run/systemd/network</filename> and the local administration
  69                 network directory <filename>/etc/systemd/network</filename>.
  70                 All configuration files are collectively sorted and processed in lexical order,
  71                 regardless of the directories in which they live. However, files with
  72                 identical filenames replace each other. Files in
  73                 <filename>/etc</filename> have the highest priority, files in
  74                 <filename>/run</filename> take precedence over files with the same
  75                 name in <filename>/usr/lib</filename>. This can be used to override a
  76                 system-supplied configuration file with a local file if needed; a symlink in
  77                 <filename>/etc</filename> with the same name as a configuration file in
  78                 <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
  79                 disables the configuration file entirely.</para>
  80
  81         </refsect1>
  82
  83         <refsect1>
  84                 <title>[Match] Section Options</title>
  85
  86                         <para>The network file contains a <literal>[Match]</literal> section,
  87                         which determines if a given network file may be applied to a given device;
  88                         and a <literal>[Network]</literal> section specifying how the device should
  89                         be configured. The first (in lexical order) of the network files that
  90                         matches a given device is applied.</para>
  91
  92                         <para>A network file is said to match a device if each of the entries in the
  93                         <literal>[Match]</literal> section matches, or if the section is empty.
  94                         The following keys are accepted:</para>
  95
  96                         <variablelist class='network-directives'>
  97                                 <varlistentry>
  98                                         <term><varname>MACAddress=</varname></term>
  99                                         <listitem>
 100                                                 <para>The hardware address.</para>
 101                                         </listitem>
 102                                 </varlistentry>
 103                                 <varlistentry>
 104                                         <term><varname>Path=</varname></term>
 105                                         <listitem>
 106                                                 <para>The persistent path, as exposed by the udev
 107                                                 property <literal>ID_PATH</literal>. May contain shell
 108                                                 style globs.</para>
 109                                         </listitem>
 110                                 </varlistentry>
 111                                 <varlistentry>
 112                                         <term><varname>Driver=</varname></term>
 113                                         <listitem>
 114                                                 <para>The driver currently bound to the device, as
 115                                                 exposed by the udev property <literal>DRIVER</literal>
 116                                                 of its parent device, or if that is not set the driver
 117                                                 as exposed by <literal>ethtool -i</literal> of the
 118                                                 device itself.</para>
 119                                         </listitem>
 120                                 </varlistentry>
 121                                 <varlistentry>
 122                                         <term><varname>Type=</varname></term>
 123                                         <listitem>
 124                                                 <para>The device type, as exposed by the udev property
 125                                                 <literal>DEVTYPE</literal>.</para>
 126                                         </listitem>
 127                                 </varlistentry>
 128                                 <varlistentry>
 129                                         <term><varname>Name=</varname></term>
 130                                         <listitem>
 131                                                 <para>The device name, as exposed by the udev property
 132                                                 <literal>INTERFACE</literal>. May contain shell style
 133                                                 globs.</para>
 134                                         </listitem>
 135                                 </varlistentry>
 136                                 <varlistentry>
 137                                         <term><varname>Host=</varname></term>
 138                                         <listitem>
 139                                                 <para>Matches against the hostname or machine ID of the
 140                                                 host. See <literal>ConditionHost=</literal> in
 141                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 142                                                 for details.
 143                                                 </para>
 144                                         </listitem>
 145                                 </varlistentry>
 146                                 <varlistentry>
 147                                         <term><varname>Virtualization=</varname></term>
 148                                         <listitem>
 149                                                 <para>Checks whether the system is executed in a virtualized
 150                                                 environment and optionally test whether it is a specific
 151                                                 implementation. See <literal>ConditionVirtualization=</literal> in
 152                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 153                                                 for details.
 154                                                 </para>
 155                                         </listitem>
 156                                 </varlistentry>
 157                                 <varlistentry>
 158                                         <term><varname>KernelCommandLine=</varname></term>
 159                                         <listitem>
 160                                                 <para>Checks whether a specific kernel command line option is
 161                                                 set (or if prefixed with the exclamation mark unset). See
 162                                                 <literal>ConditionKernelCommandLine=</literal> in
 163                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 164                                                 for details.
 165                                                 </para>
 166                                         </listitem>
 167                                 </varlistentry>
 168                                 <varlistentry>
 169                                         <term><varname>Architecture=</varname></term>
 170                                         <listitem>
 171                                                 <para>Checks whether the system is running on a specific
 172                                                 architecture. See <literal>ConditionArchitecture=</literal> in
 173                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 174                                                 for details.
 175                                                 </para>
 176                                         </listitem>
 177                                 </varlistentry>
 178                         </variablelist>
 179
 180         </refsect1>
 181
 182         <refsect1>
 183                 <title>[Network] Section Options</title>
 184
 185                         <para>The <literal>[Network]</literal> section accepts the following keys:</para>
 186
 187                         <variablelist class='network-directives'>
 188                                 <varlistentry>
 189                                         <term><varname>Description=</varname></term>
 190                                         <listitem>
 191                                                 <para>A description of the device. This is only used for
 192                                                 presentation purposes.</para>
 193                                         </listitem>
 194                                 </varlistentry>
 195                                 <varlistentry>
 196                                         <term><varname>DHCP=</varname></term>
 197                                         <listitem>
 198                                                 <para>Enables DHCPv4 and/or DHCPv6 support. Accepts
 199                                                 <literal>both</literal>, <literal>none</literal>,
 200                                                 <literal>v4</literal> or <literal>v6</literal>.</para>
 201                                         </listitem>
 202                                 </varlistentry>
 203                                 <varlistentry>
 204                                         <term><varname>DHCPServer=</varname></term>
 205                                         <listitem>
 206                                                 <para>A boolean. Enables a basic DHCPv4 server on the
 207                                                 device. Mostly useful for handing out leases to container
 208                                                 instances.</para>
 209                                         </listitem>
 210                                 </varlistentry>
 211                                 <varlistentry>
 212                                         <term><varname>IPv4LL=</varname></term>
 213                                         <listitem>
 214                                                 <para>A boolean. When true, enables IPv4 link-local support.
 215                                                 </para>
 216                                         </listitem>
 217                                 </varlistentry>
 218                                 <varlistentry>
 219                                         <term><varname>IPv4LLRoute=</varname></term>
 220                                         <listitem>
 221                                                 <para>A boolean. When true, sets up the route needed for
 222                                                 non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
 223                                                 to true.
 224                                                 </para>
 225                                         </listitem>
 226                                 </varlistentry>
 227                                 <varlistentry>
 228                                         <term><varname>LLMNR=</varname></term>
 229                                         <listitem>
 230                                                 <para>A boolean or <literal>resolve</literal>. When true, enables
 231                                                 Link-Local Multicast Name Resolution on the link, when set to
 232                                                 <literal>resolve</literal> only resolution is enabled, but not
 233                                                 announcement. Defaults to true.</para>
 234                                         </listitem>
 235                                 </varlistentry>
 236                                 <varlistentry>
 237                                         <term><varname>Address=</varname></term>
 238                                         <listitem>
 239                                                 <para>A static IPv4 or IPv6 address and its prefix length,
 240                                                 separated by a <literal>/</literal> character. Specify this
 241                                                 key more than once to configure several addresses.
 242                                                 The format of the address must be as described in
 243                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 244                                                 This is a short-hand for an [Address] section only containing
 245                                                 an Address key (see below). This option may be specified
 246                                                 more than once.
 247                                                 </para>
 248
 249                                                 <para>If the specified
 250                                                 address is 0.0.0.0
 251                                                 (for IPv4) or [::]
 252                                                 (for IPv6), a new
 253                                                 address range of the
 254                                                 requested size is
 255                                                 automatically
 256                                                 allocated from a
 257                                                 system-wide pool of
 258                                                 unused ranges. The
 259                                                 allocated range is
 260                                                 checked against all
 261                                                 current network
 262                                                 interfaces and all
 263                                                 known network
 264                                                 configuration files to
 265                                                 avoid address range
 266                                                 conflicts. The default
 267                                                 system-wide pool
 268                                                 consists of
 269                                                 192.168.0.0/16,
 270                                                 172.16.0.0/12 and
 271                                                 10.0.0.0/8 for IPv4,
 272                                                 and fc00::/7 for
 273                                                 IPv6. This
 274                                                 functionality is
 275                                                 useful to manage a
 276                                                 large number of
 277                                                 dynamically created
 278                                                 network interfaces
 279                                                 with the same network
 280                                                 configuration and
 281                                                 automatic address
 282                                                 range
 283                                                 assignment.</para>
 284
 285                                         </listitem>
 286                                 </varlistentry>
 287                                 <varlistentry>
 288                                         <term><varname>Gateway=</varname></term>
 289                                         <listitem>
 290                                                 <para>The gateway address, which must be in the format described in
 291                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 292                                                 This is a short-hand for a [Route] section only containing a Gateway
 293                                                 key. This option may be specified more than once.</para>
 294                                         </listitem>
 295                                 </varlistentry>
 296                                 <varlistentry>
 297                                         <term><varname>DNS=</varname></term>
 298                                         <listitem>
 299                                                 <para>A DNS server address, which must be in the format described in
 300                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 301                                                 This option may be specified more than once.</para>
 302                                         </listitem>
 303                                 </varlistentry>
 304 <!-- TODO: document NTP= option when it is actually used somewhere -->
 305                                 <varlistentry>
 306                                         <term><varname>Bridge=</varname></term>
 307                                         <listitem>
 308                                                 <para>The name of the bridge to add the link to.</para>
 309                                         </listitem>
 310                                 </varlistentry>
 311                                 <varlistentry>
 312                                         <term><varname>Bond=</varname></term>
 313                                         <listitem>
 314                                                 <para>The name of the bond to add the link to.</para>
 315                                         </listitem>
 316                                 </varlistentry>
 317                                 <varlistentry>
 318                                         <term><varname>VLAN=</varname></term>
 319                                         <listitem>
 320                                                 <para>The name of a VLAN to create on the link. This option
 321                                                 may be specified more than once.</para>
 322                                         </listitem>
 323                                 </varlistentry>
 324                                 <varlistentry>
 325                                         <term><varname>MACVLAN=</varname></term>
 326                                         <listitem>
 327                                                 <para>The name of a MACVLAN to create on the link. This option
 328                                                 may be specified more than once.</para>
 329                                         </listitem>
 330                                 </varlistentry>
 331                                 <varlistentry>
 332                                         <term><varname>VXLAN=</varname></term>
 333                                         <listitem>
 334                                                 <para>The name of a VXLAN to create on the link. This option
 335                                                 may be specified more than once.</para>
 336                                         </listitem>
 337                                 </varlistentry>
 338                                 <varlistentry>
 339                                         <term><varname>Tunnel=</varname></term>
 340                                         <listitem>
 341                                                 <para>The name of a Tunnel to create on the link. This option
 342                                                 may be specified more than once.</para>
 343                                         </listitem>
 344                                 </varlistentry>
 345                         </variablelist>
 346
 347         </refsect1>
 348
 349         <refsect1>
 350                 <title>[Address] Section Options</title>
 351
 352                         <para>An <literal>[Address]</literal> section accepts the following keys.
 353                         Specify several <literal>[Address]</literal> sections to configure several
 354                         addresses.</para>
 355
 356                         <variablelist class='network-directives'>
 357                                 <varlistentry>
 358                                         <term><varname>Address=</varname></term>
 359                                         <listitem>
 360                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
 361                                         </listitem>
 362                                 </varlistentry>
 363                                 <varlistentry>
 364                                         <term><varname>Peer=</varname></term>
 365                                         <listitem>
 366                                                 <para>The peer address in a point-to-point connection. Accepts the same format as
 367                                                 the <literal>Address</literal> key.</para>
 368                                         </listitem>
 369                                 </varlistentry>
 370                                 <varlistentry>
 371                                         <term><varname>Broadcast=</varname></term>
 372                                         <listitem>
 373                                                 <para>The broadcast address, which must be in the format described in
 374                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
 375                                                 This key only applies to IPv4 addresses. If it is not given, it is
 376                                                 derived from the <literal>Address</literal> key.</para>
 377                                         </listitem>
 378                                 </varlistentry>
 379                                 <varlistentry>
 380                                         <term><varname>Label=</varname></term>
 381                                         <listitem>
 382                                                 <para>An address label.</para>
 383                                         </listitem>
 384                                 </varlistentry>
 385                         </variablelist>
 386         </refsect1>
 387
 388         <refsect1>
 389                 <title>[Route] Section Options</title>
 390                         <para>The <literal>[Route]</literal> section accepts the following keys. Specify
 391                         several <literal>[Route]</literal> sections to configure several routes.</para>
 392
 393                         <variablelist class='network-directives'>
 394                                 <varlistentry>
 395                                         <term><varname>Gateway=</varname></term>
 396                                         <listitem>
 397                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
 398                                         </listitem>
 399                                 </varlistentry>
 400                                 <varlistentry>
 401                                         <term><varname>Destination=</varname></term>
 402                                         <listitem>
 403                                                 <para>The destination prefix of the route. Possibly followed by a slash and the
 404                                                 prefixlength. If ommitted, a full-length host route is assumed.</para>
 405                                         </listitem>
 406                                 </varlistentry>
 407                                 <varlistentry>
 408                                         <term><varname>Metric=</varname></term>
 409                                         <listitem>
 410                                                 <para>The metric of the route. An unsigned integer</para>
 411                                         </listitem>
 412                                 </varlistentry>
 413                         </variablelist>
 414         </refsect1>
 415
 416         <refsect1>
 417                 <title>[DHCP] Section Options</title>
 418                         <para>The <literal>[DHCP]</literal> section accepts the following keys:</para>
 419
 420                         <variablelist class='network-directives'>
 421                                 <varlistentry>
 422                                         <term><varname>UseDNS=</varname></term>
 423                                         <listitem>
 424                                                 <para>When true (the default), the DNS servers received from the DHCP server will
 425                                                 be used and take precedence over any statically configured ones.</para>
 426                                         </listitem>
 427                                 </varlistentry>
 428                                 <varlistentry>
 429                                         <term><varname>UseMTU=</varname></term>
 430                                         <listitem>
 431                                                 <para>When true, the interface maximum transmission unit from the DHCP server will
 432                                                 be used on the current link. Defaults to false.</para>
 433                                         </listitem>
 434                                 </varlistentry>
 435                                 <varlistentry>
 436                                         <term><varname>SendHostname=</varname></term>
 437                                         <listitem>
 438                                                 <para>When true (the default), the machine's hostname will be sent to the DHCP
 439                                                 server</para>
 440                                         </listitem>
 441                                 </varlistentry>
 442                                 <varlistentry>
 443                                         <term><varname>UseHostname=</varname></term>
 444                                         <listitem>
 445                                                 <para>When true (the default), the hostname received from the DHCP server
 446                                                 will be used as the transient hostname.</para>
 447                                         </listitem>
 448                                 </varlistentry>
 449                                 <varlistentry>
 450                                         <term><varname>UseRoutes=</varname></term>
 451                                         <listitem>
 452                                                 <para>When true (the default), the static routes will be requested from the DHCP server
 453                                                 and added to the routing table with metric of 1024.</para>
 454                                         </listitem>
 455                                 </varlistentry>
 456                                 <varlistentry>
 457                                         <term><varname>CriticalConnection=</varname></term>
 458                                         <listitem>
 459                                                 <para>When true, the connection will never be torn down even if the DHCP lease
 460                                                 expires. This is contrary to the DHCP specification, but may be the best choice
 461                                                 if, say, the root filesystem relies on this connection. Defaults to false.</para>
 462                                         </listitem>
 463                                 </varlistentry>
 464                                 <varlistentry>
 465                                         <term><varname>VendorClassIdentifier=</varname></term>
 466                                         <listitem>
 467                                                 <para>The vendor class identifier used to identify vendor type and configuration.</para>
 468                                         </listitem>
 469                                 </varlistentry>
 470                                 <varlistentry>
 471                                         <term><varname>RequestBroadcast=</varname></term>
 472                                         <listitem>
 473                                                 <para>Request the server to use broadcast messages before the IP address has been
 474                                                 configured. This is necessary for devices that cannot receive RAW packets, or that
 475                                                 cannot receive packets at all before an IP address has been configured. On the other
 476                                                 hand, this must not be enabled on networks where broadcasts are filtered out.</para>
 477                                         </listitem>
 478                                 </varlistentry>
 479                        </variablelist>
 480
 481         </refsect1>
 482
 483         <refsect1>
 484                 <title>Example</title>
 485                 <example>
 486                         <title>/etc/systemd/network/50-static.network</title>
 487
 488                         <programlisting>[Match]
 489 Name=enp2s0
 490
 491 [Network]
 492 Address=192.168.0.15/24
 493 Gateway=192.168.0.1</programlisting>
 494                 </example>
 495
 496                 <example>
 497                         <title>/etc/systemd/network/80-dhcp.network</title>
 498
 499                         <programlisting>[Match]
 500 Name=en*
 501
 502 [Network]
 503 DHCP=both</programlisting>
 504                 </example>
 505
 506                 <example>
 507                         <title>/etc/systemd/network/bridge-static.network</title>
 508
 509                         <programlisting>[Match]
 510 Name=bridge0
 511
 512 [Network]
 513 Address=192.168.0.15/24
 514 Gateway=192.168.0.1
 515 DNS=192.168.0.1</programlisting>
 516                 </example>
 517
 518                 <example>
 519                         <title>/etc/systemd/network/bridge-slave-interface.network</title>
 520
 521                         <programlisting>[Match]
 522 Name=enp2s0
 523
 524 [Network]
 525 Bridge=bridge0</programlisting>
 526                 </example>
 527                 <example>
 528                         <title>/etc/systemd/network/ipip.network</title>
 529
 530                         <programlisting>[Match]
 531 Name=em1
 532
 533 [Network]
 534 Tunnel=ipip-tun</programlisting>
 535                 </example>
 536
 537                 <example>
 538                         <title>/etc/systemd/network/sit.network</title>
 539
 540                         <programlisting>[Match]
 541 Name=em1
 542
 543 [Network]
 544 Tunnel=sit-tun</programlisting>
 545                 </example>
 546
 547                 <example>
 548                         <title>/etc/systemd/network/gre.network</title>
 549
 550                         <programlisting>[Match]
 551 Name=em1
 552
 553 [Network]
 554 Tunnel=gre-tun</programlisting>
 555                 </example>
 556
 557                 <example>
 558                         <title>/etc/systemd/network/vti.network</title>
 559
 560                         <programlisting>[Match]
 561 Name=em1
 562
 563 [Network]
 564 Tunnel=vti-tun</programlisting>
 565                 </example>
 566         </refsect1>
 567
 568         <refsect1>
 569                 <title>See Also</title>
 570                 <para>
 571                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 572                         <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 573                         <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 574                 </para>
 575         </refsect1>
 576
 577 </refentry>