man/systemd.netdev.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.netdev" 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.netdev</refentrytitle>
  42                 <manvolnum>5</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd.netdev</refname>
  47                 <refpurpose>Virtual Network Device configuration</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <para><filename><replaceable>netdev</replaceable>.netdev</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>Virtual Network Device files must have the extension
  62                 <filename>.netdev</filename>; other extensions are ignored. Virtual
  63                 network devices are created as soon as networkd is started. If a netdev
  64                 with the specified name already exists, networkd will use that as-is
  65                 rather than create its own. Note that the settings of the pre-existing
  66                 netdev will not be changed by networkd.</para>
  67
  68                 <para>The <filename>.netdev</filename> files are read from the files located in the
  69                 system network directory <filename>/usr/lib/systemd/network</filename>,
  70                 the volatile runtime network directory
  71                 <filename>/run/systemd/network</filename> and the local administration
  72                 network directory <filename>/etc/systemd/network</filename>.
  73                 All configuration files are collectively sorted and processed in lexical order,
  74                 regardless of the directories in which they live. However, files with
  75                 identical filenames replace each other. Files in
  76                 <filename>/etc</filename> have the highest priority, files in
  77                 <filename>/run</filename> take precedence over files with the same
  78                 name in <filename>/usr/lib</filename>. This can be used to override a
  79                 system-supplied configuration file with a local file if needed; a symlink in
  80                 <filename>/etc</filename> with the same name as a configuration file in
  81                 <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
  82                 disables the configuration file entirely.</para>
  83
  84         </refsect1>
  85
  86         <refsect1>
  87                 <title>[Match] Section Options</title>
  88
  89                 <para>A virtual network device is only created if the
  90                 <literal>[Match]</literal> section matches the current
  91                 environment, or if the section is empty. The following keys are accepted:</para>
  92
  93                         <variablelist class='network-directives'>
  94                                 <varlistentry>
  95                                         <term><varname>Host=</varname></term>
  96                                         <listitem>
  97                                                 <para>Matches against the hostname or machine ID of the
  98                                                 host. See <literal>ConditionHost=</literal> in
  99                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 100                                                 for details.
 101                                                 </para>
 102                                         </listitem>
 103                                 </varlistentry>
 104                                 <varlistentry>
 105                                         <term><varname>Virtualization=</varname></term>
 106                                         <listitem>
 107                                                 <para>Checks whether the system is executed in a virtualized
 108                                                 environment and optionally test whether it is a specific
 109                                                 implementation. See <literal>ConditionVirtualization=</literal> in
 110                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 111                                                 for details.
 112                                                 </para>
 113                                         </listitem>
 114                                 </varlistentry>
 115                                 <varlistentry>
 116                                         <term><varname>KernelCommandLine=</varname></term>
 117                                         <listitem>
 118                                                 <para>Checks whether a specific kernel command line option is
 119                                                 set (or if prefixed with the exclamation mark unset). See
 120                                                 <literal>ConditionKernelCommandLine=</literal> in
 121                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 122                                                 for details.
 123                                                 </para>
 124                                         </listitem>
 125                                 </varlistentry>
 126                                 <varlistentry>
 127                                         <term><varname>Architecture=</varname></term>
 128                                         <listitem>
 129                                                 <para>Checks whether the system is running on a specific
 130                                                 architecture. See <literal>ConditionArchitecture=</literal> in
 131                                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 132                                                 for details.
 133                                                 </para>
 134                                         </listitem>
 135                                 </varlistentry>
 136                         </variablelist>
 137
 138         </refsect1>
 139
 140         <refsect1>
 141                 <title>[NetDev] Section Options</title>
 142
 143                         <para>The <literal>[NetDev]</literal> section accepts the following
 144                         keys:</para>
 145
 146                         <variablelist class='network-directives'>
 147                                 <varlistentry>
 148                                         <term><varname>Description=</varname></term>
 149                                         <listitem>
 150                                                 <para>A free-form description of the netdev.
 151                                                 </para>
 152                                         </listitem>
 153                                 </varlistentry>
 154                                 <varlistentry>
 155                                         <term><varname>Name=</varname></term>
 156                                         <listitem>
 157                                                 <para>The interface name used when creating the
 158                                                 netdev. This option is compulsory.</para>
 159                                         </listitem>
 160                                 </varlistentry>
 161                                 <varlistentry>
 162                                         <term><varname>Kind=</varname></term>
 163                                         <listitem>
 164                                                 <para>The netdev kind. Currently, <literal>bridge</literal>,
 165                                                 <literal>bond</literal>, <literal>vlan</literal>,
 166                                                 <literal>macvlan</literal>, <literal>vxlan</literal>,
 167                                                 <literal>ipip</literal>, <literal>gre</literal>,
 168                                                 <literal>sit</literal>, <literal>vti</literal>,
 169                                                 <literal>veth</literal>, <literal>tun</literal>,
 170                                                 <literal>tap</literal> and <literal>dummy</literal>
 171                                                 are supported. This option is compulsory.</para>
 172                                         </listitem>
 173                                 </varlistentry>
 174                                 <varlistentry>
 175                                         <term><varname>MTUBytes=</varname></term>
 176                                         <listitem>
 177                                                 <para>The maximum transmission unit in bytes to
 178                                                 set for the device. The usual suffixes K, M, G,
 179                                                 are supported and are understood to the base of
 180                                                 1024. This key is not currently suported for
 181                                                 <literal>tun</literal> or <literal>tap</literal> devices.
 182                                                 </para>
 183                                         </listitem>
 184                                 </varlistentry>
 185                                 <varlistentry>
 186                                         <term><varname>MACAddress=</varname></term>
 187                                         <listitem>
 188                                                 <para>The MAC address to use for the device.
 189                                                 If none is given, one is generated based on
 190                                                 the interface name and the
 191                                                 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 192                                                 This key is not currently suported for <literal>tun</literal> or <literal>tap</literal> devices.
 193                                                 </para>
 194                                         </listitem>
 195                                 </varlistentry>
 196                         </variablelist>
 197         </refsect1>
 198
 199         <refsect1>
 200                 <title>[VLAN] Section Options</title>
 201
 202                         <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind <literal>vlan</literal>,
 203                         and accepts the following key:</para>
 204
 205                         <variablelist class='network-directives'>
 206                                 <varlistentry>
 207                                         <term><varname>Id=</varname></term>
 208                                         <listitem>
 209                                                 <para>The VLAN ID to use. An integer in the range 0–4094.
 210                                                 This option is compulsory.</para>
 211                                         </listitem>
 212                                 </varlistentry>
 213                         </variablelist>
 214
 215         </refsect1>
 216
 217         <refsect1>
 218                 <title>[MACVLAN] Section Options</title>
 219
 220                         <para>The <literal>[MACVLAN]</literal> section only applies for netdevs of kind
 221                         <literal>macvlan</literal>, and accepts the following key:</para>
 222
 223                         <variablelist class='network-directives'>
 224                                 <varlistentry>
 225                                         <term><varname>Mode=</varname></term>
 226                                         <listitem>
 227                                                 <para>The MACVLAN mode to use. The supported options are
 228                                                 <literal>private</literal>, <literal>vepa</literal>,
 229                                                 <literal>bridge</literal> and <literal>passthru</literal>.
 230                                                 </para>
 231                                         </listitem>
 232                                 </varlistentry>
 233                         </variablelist>
 234
 235         </refsect1>
 236         <refsect1>
 237                 <title>[VXLAN] Section Options</title>
 238                         <para>The <literal>[VXLAN]</literal> section only applies for netdevs of kind
 239                         <literal>vxlan</literal>, and accepts the following key:</para>
 240
 241                         <variablelist class='network-directives'>
 242                                 <varlistentry>
 243                                         <term><varname>Id=</varname></term>
 244                                         <listitem>
 245                                                 <para>The VXLAN ID to use.</para>
 246                                         </listitem>
 247                                 </varlistentry>
 248                                 <varlistentry>
 249                                         <term><varname>Group=</varname></term>
 250                                         <listitem>
 251                                                 <para>An assigned multicast group IP address.</para>
 252                                         </listitem>
 253                                 </varlistentry>
 254                                 <varlistentry>
 255                                         <term><varname>TOS=</varname></term>
 256                                         <listitem>
 257                                                 <para>The Type Of Service byte value for a vxlan interface.</para>
 258                                         </listitem>
 259                                 </varlistentry>
 260                                 <varlistentry>
 261                                         <term><varname>TTL=</varname></term>
 262                                         <listitem>
 263                                                 <para>A fixed Time To Live N on Virtual eXtensible Local Area Network packets.
 264                                                 N is a number in the range 1-255. 0 is a special value meaning that packets
 265                                                 inherit the TTL value.</para>
 266                                         </listitem>
 267                                 </varlistentry>
 268                                 <varlistentry>
 269                                         <term><varname>MacLearning=</varname></term>
 270                                         <listitem>
 271                                                 <para>A boolean. When true, enables dynamic MAC learning
 272                                                 to discover remote MAC addresses.</para>
 273                                         </listitem>
 274                                 </varlistentry>
 275                         </variablelist>
 276         </refsect1>
 277         <refsect1>
 278                 <title>[Tunnel] Section Options</title>
 279
 280                         <para>The <literal>[Tunnel]</literal> section only applies for netdevs of kind
 281                         <literal>ipip</literal>, <literal>sit</literal>, <literal>gre</literal> and
 282                         <literal>vti</literal> and accepts the following keys:</para>
 283
 284                         <variablelist class='network-directives'>
 285                                 <varlistentry>
 286                                         <term><varname>Local=</varname></term>
 287                                         <listitem>
 288                                                 <para>A static local address for tunneled packets.
 289                                                 It must be an address on another interface of this host.</para>
 290                                         </listitem>
 291                                 </varlistentry>
 292                                 <varlistentry>
 293                                         <term><varname>Remote=</varname></term>
 294                                         <listitem>
 295                                                 <para>The remote endpoint of the tunnel.</para>
 296                                         </listitem>
 297                                 </varlistentry>
 298                                 <varlistentry>
 299                                         <term><varname>TOS=</varname></term>
 300                                         <listitem>
 301                                                 <para>The Type Of Service byte value for a tunnel interface.
 302                                                 For details about the TOS see the
 303                                                 <ulink url="http://tools.ietf.org/html/rfc1349">
 304                                                 Type of Service in the Internet Protocol Suite
 305                                                 </ulink> document.
 306                                                 </para>
 307                                         </listitem>
 308                                 </varlistentry>
 309                                 <varlistentry>
 310                                         <term><varname>TTL=</varname></term>
 311                                         <listitem>
 312                                                 <para>A fixed Time To Live N on tunneled packets.
 313                                                 N is a number in the range 1-255. 0 is a special value meaning that packets
 314                                                 inherit the TTL value. The default value for IPv4 tunnels is: inherit.
 315                                                 The default value for IPv6 tunnels is: 64.</para>
 316                                         </listitem>
 317                                 </varlistentry>
 318                                 <varlistentry>
 319                                         <term><varname>DiscoverPathMTU=</varname></term>
 320                                         <listitem>
 321                                                 <para>A boolean. When true, enables Path MTU Discovery on the tunnel.</para>
 322                                         </listitem>
 323                                 </varlistentry>
 324                         </variablelist>
 325         </refsect1>
 326         <refsect1>
 327                 <title>[Peer] Section Options</title>
 328
 329                         <para>The <literal>[Peer]</literal> section only applies for netdevs of kind <literal>veth</literal>
 330                         and accepts the following key:</para>
 331
 332                         <variablelist class='network-directives'>
 333                                 <varlistentry>
 334                                         <term><varname>Name=</varname></term>
 335                                         <listitem>
 336                                                 <para>The interface name used when creating the netdev.
 337                                                 This option is compulsory.</para>
 338                                         </listitem>
 339                                 </varlistentry>
 340                                 <varlistentry>
 341                                         <term><varname>MACAddress=</varname></term>
 342                                         <listitem>
 343                                                 <para>The peer MACAddress, if not set it is generated in the same
 344                                                 way as the MAC address of the main interface.</para>
 345                                         </listitem>
 346                                 </varlistentry>
 347                         </variablelist>
 348         </refsect1>
 349         <refsect1>
 350                 <title>[Tun] Section Options</title>
 351
 352                         <para>The <literal>[Tun]</literal> section only applies for netdevs of kind
 353                         <literal>tun</literal>, and accepts the following keys:</para>
 354
 355                         <variablelist class='network-directives'>
 356                                 <varlistentry>
 357                                         <term><varname>OneQueue=</varname></term>
 358                                         <listitem><para>Takes a boolean argument. Configures whether
 359                                         all packets are queued at the device (enabled), or a fixed number
 360                                         of packets are queued at the device and the rest at the
 361                                         <literal>qdisc</literal>. Defaults to <literal>no</literal>.</para>
 362                                         </listitem>
 363                                 </varlistentry>
 364                                 <varlistentry>
 365                                         <term><varname>MultiQueue=</varname></term>
 366                                         <listitem><para>Takes a boolean argument. Configures whether to
 367                                         use multiple file descriptors (queues) to parallelize packets
 368                                         sending and receiving. Defaults to <literal>no</literal>.</para>
 369                                         </listitem>
 370                                 </varlistentry>
 371                                 <varlistentry>
 372                                         <term><varname>PacketInfo=</varname></term>
 373                                         <listitem><para>Takes a boolean argument. Configures whether packets
 374                                         should be prepened with four extra bytes (two flag bytes and two
 375                                         protocol bytes). If disabled it indicates that the packets will be
 376                                         pure IP packets. Defaults to <literal>no</literal>.</para>
 377                                         </listitem>
 378                                 </varlistentry>
 379                                 <varlistentry>
 380                                         <term><varname>User=</varname></term>
 381                                         <listitem><para>User to grant access to the <filename>/dev/net/tun</filename>
 382                                         device.</para>
 383                                         </listitem>
 384                                 </varlistentry>
 385                                 <varlistentry>
 386                                         <term><varname>Group=</varname></term>
 387                                         <listitem><para>Group to grant access to the <filename>/dev/net/tun</filename>
 388                                         device.</para>
 389                                         </listitem>
 390                                 </varlistentry>
 391
 392                         </variablelist>
 393
 394         </refsect1>
 395
 396         <refsect1>
 397                 <title>[Tap] Section Options</title>
 398
 399                         <para>The <literal>[Tap]</literal> section only applies for netdevs of kind
 400                         <literal>tap</literal>, and accepts the same keys as the
 401                         <literal>[Tun]</literal> section.</para>
 402         </refsect1>
 403
 404         <refsect1>
 405                 <title>[Bond] Section Options</title>
 406
 407                         <para>The <literal>[Bond]</literal> section accepts the following
 408                         key:</para>
 409
 410                         <variablelist class='network-directives'>
 411                                 <varlistentry>
 412                                         <term><varname>Mode=</varname></term>
 413                                         <listitem>
 414                                           <para>Specifies one of the bonding policies. The default is
 415                                           <literal>balance-rr</literal> (round robin). Possible values are
 416                                                 <literal>balance-rr</literal>,
 417                                                 <literal>active-backup</literal>,
 418                                                 <literal>balance-xor</literal>,
 419                                                 <literal>broadcast</literal>,
 420                                                 <literal>802.3ad</literal>,
 421                                                 <literal>balance-tlb</literal>, and
 422                                                 <literal>balance-alb</literal>.
 423                                           </para>
 424                                         </listitem>
 425                                 </varlistentry>
 426
 427                                 <varlistentry>
 428                                   <term><varname>TransmitHashPolicy=</varname></term>
 429                                   <listitem>
 430                                     <para>Selects the transmit hash policy to use for slave selection in
 431                                     balance-xor, 802.3ad, and tlb modes. Possible values are
 432                                     <literal>layer2</literal>,
 433                                     <literal>layer3+4</literal>,
 434                                     <literal>layer2+3</literal>,
 435                                     <literal>encap2+3</literal>,
 436                                     <literal>802.3ad</literal>, and
 437                                     <literal>encap3+4</literal>.
 438                                     </para>
 439                                   </listitem>
 440                                 </varlistentry>
 441
 442                                 <varlistentry>
 443                                   <term><varname>LACPTransmitRate=</varname></term>
 444                                   <listitem>
 445                                     <para>Specifies the rate with which link partner
 446                                     transmits Link Aggregation Control Protocol Data Unit packets
 447                                     in 802.3ad mode. Possible values are
 448                                     <literal>slow</literal>, which requests partner to transmit LACPDUs every 30 seconds, and
 449                                     <literal>fast</literal>, which requests partner to transmit LACPDUs every second.
 450                                     The default value is <literal>slow</literal>.</para>
 451                                   </listitem>
 452                                 </varlistentry>
 453
 454                                 <varlistentry>
 455                                   <term><varname>MIIMonitorSec=</varname></term>
 456                                   <listitem>
 457                                     <para>Specifies the frequency that Media Independent Interface link
 458                                     monitoring will occur. A value of zero disables MII link monitoring.
 459                                     This values is rounded down to the nearest millisecond. The default
 460                                     value is 0.</para>
 461                                   </listitem>
 462                                 </varlistentry>
 463
 464                                 <varlistentry>
 465                                   <term><varname>UpDelaySec=</varname></term>
 466                                   <listitem>
 467                                     <para>Specifies the delay before a link is enabled after a link up
 468                                     status has been detected. This value is rounded down to a multiple of
 469                                     MIIMonitorSec. The default value is 0.</para>
 470                                   </listitem>
 471                                 </varlistentry>
 472
 473                                 <varlistentry>
 474                                   <term><varname>DownDelaySec=</varname></term>
 475                                   <listitem>
 476                                     <para>Specifies the delay before a link is disabled after a link down
 477                                     status has been detected. This value is rounded down to a multiple of
 478                                     MIIMonitorSec. The default value is 0.</para>
 479                                   </listitem>
 480                                 </varlistentry>
 481
 482                         </variablelist>
 483         </refsect1>
 484
 485         <refsect1>
 486                 <title>Example</title>
 487                 <example>
 488                         <title>/etc/systemd/network/bridge.netdev</title>
 489
 490                         <programlisting>[NetDev]
 491 Name=bridge0
 492 Kind=bridge</programlisting>
 493                 </example>
 494
 495                 <example>
 496                         <title>/etc/systemd/network/vlan1.netdev</title>
 497
 498                         <programlisting>[Match]
 499 Virtualization=no
 500
 501 [NetDev]
 502 Name=vlan1
 503 Kind=vlan
 504
 505 [VLAN]
 506 Id=1</programlisting>
 507                 </example>
 508                 <example>
 509                         <title>/etc/systemd/network/ipip.netdev</title>
 510                         <programlisting>[NetDev]
 511 Name=ipip-tun
 512 Kind=ipip
 513 MTUBytes=1480
 514
 515 [Tunnel]
 516 Local=192.168.223.238
 517 Remote=192.169.224.239
 518 TTL=64</programlisting>
 519                 </example>
 520                 <example>
 521                   <title>/etc/systemd/network/tap.netdev</title>
 522                   <programlisting>[NetDev]
 523 Name=tap-test
 524 Kind=tap
 525
 526 [Tap]
 527 MultiQueue=true
 528 PacketInfo=true</programlisting> </example>
 529
 530                 <example>
 531                         <title>/etc/systemd/network/sit.netdev</title>
 532                         <programlisting>[NetDev]
 533 Name=sit-tun
 534 Kind=sit
 535 MTUBytes=1480
 536
 537 [Tunnel]
 538 Local=10.65.223.238
 539 Remote=10.65.223.239</programlisting>
 540                 </example>
 541
 542                 <example>
 543                         <title>/etc/systemd/network/gre.netdev</title>
 544                         <programlisting>[NetDev]
 545 Name=gre-tun
 546 Kind=gre
 547 MTUBytes=1480
 548
 549 [Tunnel]
 550 Local=10.65.223.238
 551 Remote=10.65.223.239</programlisting>
 552                 </example>
 553
 554                 <example>
 555                         <title>/etc/systemd/network/vti.netdev</title>
 556
 557                         <programlisting>[NetDev]
 558 Name=vti-tun
 559 Kind=vti
 560 MTUBytes=1480
 561
 562 [Tunnel]
 563 Local=10.65.223.238
 564 Remote=10.65.223.239</programlisting>
 565                 </example>
 566
 567                 <example>
 568                         <title>/etc/systemd/network/veth.netdev</title>
 569                         <programlisting>[NetDev]
 570 Name=veth-test
 571 Kind=veth
 572
 573 [Peer]
 574 Name=veth-peer</programlisting>
 575                 </example>
 576
 577                 <example>
 578                         <title>/etc/systemd/network/dummy.netdev</title>
 579                         <programlisting>[NetDev]
 580 Name=dummy-test
 581 Kind=dummy
 582 MACAddress=12:34:56:78:9a:bc</programlisting>
 583                 </example>
 584
 585         </refsect1>
 586         <refsect1>
 587                 <title>See Also</title>
 588                 <para>
 589                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 590                         <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 591                         <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 592                 </para>
 593         </refsect1>
 594
 595 </refentry>