man/systemd.link.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd.link">
   7   <refentryinfo>
   8     <title>systemd.link</title>
   9     <productname>systemd</productname>
  10   </refentryinfo>
  11
  12   <refmeta>
  13     <refentrytitle>systemd.link</refentrytitle>
  14     <manvolnum>5</manvolnum>
  15   </refmeta>
  16
  17   <refnamediv>
  18     <refname>systemd.link</refname>
  19     <refpurpose>Network device configuration</refpurpose>
  20   </refnamediv>
  21
  22   <refsynopsisdiv>
  23     <para><filename><replaceable>link</replaceable>.link</filename></para>
  24   </refsynopsisdiv>
  25
  26   <refsect1>
  27     <title>Description</title>
  28
  29     <para>A plain ini-style text file that encodes configuration for matching network devices, used by
  30     <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry> and in
  31     particular its <command>net_setup_link</command> builtin. See
  32     <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry> for a
  33     general description of the syntax.</para>
  34
  35     <para>The link files are read from the files located in the system network directory
  36     <filename>/usr/lib/systemd/network</filename>, the volatile runtime network directory
  37     <filename>/run/systemd/network</filename>, and the local administration network directory
  38     <filename>/etc/systemd/network</filename>. Link files must have the extension
  39     <filename>.link</filename>; other extensions are ignored. All link files are collectively sorted
  40     and processed in lexical order, regardless of the directories in which they live. However, files
  41     with identical filenames replace each other. Files in <filename>/etc/</filename> have the highest
  42     priority, files in <filename>/run/</filename> take precedence over files with the same name in
  43     <filename>/usr/lib/</filename>. This can be used to override a system-supplied link file with a
  44     local file if needed. As a special case, an empty file (file size 0) or symlink with the same name
  45     pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is
  46     "masked").</para>
  47
  48     <para>Along with the link file <filename>foo.link</filename>, a "drop-in" directory
  49     <filename>foo.link.d/</filename> may exist. All files with the suffix <literal>.conf</literal>
  50     from this directory will be merged in the alphanumeric order and parsed after the main file itself
  51     has been parsed. This is useful to alter or add configuration settings, without having to modify
  52     the main configuration file. Each drop-in file must have appropriate section headers.</para>
  53
  54     <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal>
  55     directories can be placed in <filename>/usr/lib/systemd/network</filename> or
  56     <filename>/run/systemd/network</filename> directories. Drop-in files in <filename>/etc/</filename>
  57     take precedence over those in <filename>/run/</filename> which in turn take precedence over those
  58     in <filename>/usr/lib/</filename>. Drop-in files under any of these directories take precedence
  59     over the main link file wherever located.</para>
  60
  61     <para>The link file contains a [Match] section, which determines if a given link file may be applied to a
  62     given device, as well as a [Link] section specifying how the device should be configured. The first (in
  63     lexical order) of the link files that matches a given device is applied. Note that a default file
  64     <filename>99-default.link</filename> is shipped by the system. Any user-supplied
  65     <filename>.link</filename> should hence have a lexically earlier name to be considered at all.</para>
  66
  67     <para>See <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
  68     diagnosing problems with <filename>.link</filename> files.</para>
  69   </refsect1>
  70
  71   <refsect1>
  72     <title>[Match] Section Options</title>
  73
  74     <para>A link file is said to match a device if all matches specified by the
  75     [Match] section are satisfied. When a link file does not contain valid settings
  76     in [Match] section, then the file will match all devices and
  77     <command>systemd-udevd</command> warns about that. Hint: to avoid the warning and to make it clear
  78     that all interfaces shall be matched, add the following:
  79     <programlisting>OriginalName=*</programlisting>
  80     The following keys are accepted:</para>
  81
  82     <variablelist class='network-directives'>
  83       <!-- This list is reused in systemd.network(3), hence maintain a specific order:
  84            1. device matches shared between the two lists
  85            2. non-shared settings
  86            3. host matches shared between the two lists
  87         -->
  88
  89       <varlistentry id='mac-address'>
  90         <term><varname>MACAddress=</varname></term>
  91         <listitem>
  92           <para>A whitespace-separated list of hardware addresses. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example below.
  93           This option may appear more than once, in which case the lists are merged. If the empty string is assigned to this option, the list
  94           of hardware addresses defined prior to this is reset.</para>
  95
  96           <para>Example:
  97           <programlisting>MACAddress=01:23:45:67:89:ab 00-11-22-33-44-55 AABB.CCDD.EEFF</programlisting></para>
  98         </listitem>
  99       </varlistentry>
 100
 101       <varlistentry id='permanent-mac-address'>
 102         <term><varname>PermanentMACAddress=</varname></term>
 103         <listitem>
 104           <para>A whitespace-separated list of hardware's permanent addresses. While
 105           <varname>MACAddress=</varname> matches the device's current MAC address, this matches the
 106           device's permanent MAC address, which may be different from the current one. Use full
 107           colon-, hyphen- or dot-delimited hexadecimal. This option may appear more than once, in
 108           which case the lists are merged. If the empty string is assigned to this option, the list
 109           of hardware addresses defined prior to this is reset.</para>
 110         </listitem>
 111       </varlistentry>
 112
 113       <varlistentry id='path'>
 114         <term><varname>Path=</varname></term>
 115         <listitem>
 116           <para>A whitespace-separated list of shell-style globs matching
 117           the persistent path, as exposed by the udev property
 118           <varname>ID_PATH</varname>.</para>
 119         </listitem>
 120       </varlistentry>
 121
 122       <varlistentry id='driver'>
 123         <term><varname>Driver=</varname></term>
 124         <listitem>
 125           <para>A whitespace-separated list of shell-style globs matching the driver currently bound to the
 126           device, as exposed by the udev property <varname>ID_NET_DRIVER</varname> of its parent device, or
 127           if that is not set, the driver as exposed by <command>ethtool -i</command> of the device itself.
 128           If the list is prefixed with a "!", the test is inverted.</para>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry id='type'>
 133         <term><varname>Type=</varname></term>
 134         <listitem>
 135           <para>A whitespace-separated list of shell-style globs matching the device type, as exposed by
 136           <command>networkctl list</command>. If the list is prefixed with a "!", the test is inverted.
 137           Some valid values are <literal>ether</literal>, <literal>loopback</literal>, <literal>wlan</literal>, <literal>wwan</literal>.
 138           Valid types are named either from the udev <literal>DEVTYPE</literal> attribute, or
 139           <literal>ARPHRD_</literal> macros in <filename>linux/if_arp.h</filename>, so this is not comprehensive.
 140           </para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry id='property'>
 145         <term><varname>Property=</varname></term>
 146         <listitem>
 147           <para>A whitespace-separated list of udev property names with their values after equals sign
 148           (<literal>=</literal>). If multiple properties are specified, the test results are ANDed.
 149           If the list is prefixed with a "!", the test is inverted. If a value contains white
 150           spaces, then please quote whole key and value pair. If a value contains quotation, then
 151           please escape the quotation with <literal>\</literal>.</para>
 152
 153           <para>Example: if a .link file has the following:
 154           <programlisting>Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \"quotation\""</programlisting>
 155           then, the .link file matches only when an interface has all the above three properties.
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry>
 161         <term><varname>OriginalName=</varname></term>
 162         <listitem>
 163           <para>A whitespace-separated list of shell-style globs matching the device name, as exposed by the
 164           udev property "INTERFACE". This cannot be used to match on names that have already been changed
 165           from userspace. Caution is advised when matching on kernel-assigned names, as they are known to be
 166           unstable between reboots.</para>
 167         </listitem>
 168       </varlistentry>
 169
 170       <varlistentry id='host'>
 171         <term><varname>Host=</varname></term>
 172         <listitem>
 173           <para>Matches against the hostname or machine ID of the host. See <varname>ConditionHost=</varname> in
 174           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 175           for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
 176           If an empty string is assigned, then previously assigned value is cleared.
 177           </para>
 178         </listitem>
 179       </varlistentry>
 180
 181       <varlistentry id='virtualization'>
 182         <term><varname>Virtualization=</varname></term>
 183         <listitem>
 184           <para>Checks whether the system is executed in a virtualized environment and optionally test
 185           whether it is a specific implementation. See <varname>ConditionVirtualization=</varname> in
 186           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 187           for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
 188           If an empty string is assigned, then previously assigned value is cleared.
 189           </para>
 190         </listitem>
 191       </varlistentry>
 192
 193       <varlistentry id='kernel-command-line'>
 194         <term><varname>KernelCommandLine=</varname></term>
 195         <listitem>
 196           <para>Checks whether a specific kernel command line option is set. See
 197           <varname>ConditionKernelCommandLine=</varname> in
 198           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 199           for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
 200           If an empty string is assigned, then previously assigned value is cleared.
 201           </para>
 202         </listitem>
 203       </varlistentry>
 204
 205       <varlistentry id='kernel-version'>
 206         <term><varname>KernelVersion=</varname></term>
 207         <listitem>
 208           <para>Checks whether the kernel version (as reported by <command>uname -r</command>) matches a certain
 209           expression. See <varname>ConditionKernelVersion=</varname> in
 210           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
 211           details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
 212           If an empty string is assigned, then previously assigned value is cleared.
 213           </para>
 214         </listitem>
 215       </varlistentry>
 216
 217       <varlistentry id='architecture'>
 218         <term><varname>Architecture=</varname></term>
 219         <listitem>
 220           <para>Checks whether the system is running on a specific architecture. See
 221           <varname>ConditionArchitecture=</varname> in
 222           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 223           for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
 224           If an empty string is assigned, then previously assigned value is cleared.
 225           </para>
 226         </listitem>
 227       </varlistentry>
 228
 229       <varlistentry id='firmware'>
 230         <term><varname>Firmware=</varname></term>
 231         <listitem>
 232           <para>Checks whether the system is running on a machine with the specified firmware. See
 233           <varname>ConditionFirmware=</varname> in
 234           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 235           for details. When prefixed with an exclamation mark (<literal>!</literal>), the result is negated.
 236           If an empty string is assigned, then previously assigned value is cleared.
 237           </para>
 238         </listitem>
 239       </varlistentry>
 240     </variablelist>
 241
 242   </refsect1>
 243
 244   <refsect1>
 245     <title>[Link] Section Options</title>
 246
 247     <para>The [Link] section accepts the following
 248     keys:</para>
 249
 250     <variablelist class='network-directives'>
 251       <varlistentry>
 252         <term><varname>Description=</varname></term>
 253         <listitem>
 254           <para>A description of the device.</para>
 255         </listitem>
 256       </varlistentry>
 257       <varlistentry>
 258         <term><varname>Alias=</varname></term>
 259         <listitem>
 260           <para>The <varname>ifalias</varname> interface property is set to this value.</para>
 261         </listitem>
 262       </varlistentry>
 263       <varlistentry>
 264         <term><varname>MACAddressPolicy=</varname></term>
 265         <listitem>
 266           <para>The policy by which the MAC address should be set. The
 267           available policies are:
 268           </para>
 269
 270           <variablelist>
 271             <varlistentry>
 272               <term><option>persistent</option></term>
 273               <listitem>
 274                 <para>If the hardware has a persistent MAC address, as
 275                 most hardware should, and if it is used by the kernel,
 276                 nothing is done. Otherwise, a new MAC address is
 277                 generated which is guaranteed to be the same on every
 278                 boot for the given machine and the given device, but
 279                 which is otherwise random. This feature depends on ID_NET_NAME_*
 280                 properties to exist for the link. On hardware where these
 281                 properties are not set, the generation of a persistent MAC address
 282                 will fail.</para>
 283               </listitem>
 284             </varlistentry>
 285             <varlistentry>
 286               <term><option>random</option></term>
 287               <listitem>
 288                 <para>If the kernel is using a random MAC address,
 289                 nothing is done. Otherwise, a new address is randomly
 290                 generated each time the device appears, typically at
 291                 boot. Either way, the random address will have the
 292                 <literal>unicast</literal> and
 293                 <literal>locally administered</literal> bits set.</para>
 294               </listitem>
 295             </varlistentry>
 296             <varlistentry>
 297               <term><option>none</option></term>
 298               <listitem>
 299                 <para>Keeps the MAC address assigned by the kernel. Or use the MAC address specified in
 300                 <varname>MACAddress=</varname>.</para>
 301               </listitem>
 302             </varlistentry>
 303           </variablelist>
 304
 305           <para>An empty string assignment is equivalent to setting <literal>none</literal>.</para>
 306         </listitem>
 307       </varlistentry>
 308       <varlistentry>
 309         <term><varname>MACAddress=</varname></term>
 310         <listitem>
 311           <para>The interface MAC address to use. For this setting to take effect,
 312           <varname>MACAddressPolicy=</varname> must either be unset, empty, or <literal>none</literal>.
 313           </para>
 314         </listitem>
 315       </varlistentry>
 316       <varlistentry>
 317         <term><varname>NamePolicy=</varname></term>
 318         <listitem>
 319           <para>An ordered, space-separated list of policies by which the interface name should be set.
 320           <varname>NamePolicy=</varname> may be disabled by specifying <option>net.ifnames=0</option> on the
 321           kernel command line. Each of the policies may fail, and the first successful one is used. The name
 322           is not set directly, but is exported to udev as the property <option>ID_NET_NAME</option>, which
 323           is, by default, used by a
 324           <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 325           rule to set <varname>NAME</varname>. The available policies are:
 326           </para>
 327
 328           <variablelist>
 329             <varlistentry>
 330               <term><option>kernel</option></term>
 331               <listitem>
 332                 <para>If the kernel claims that the name it has set
 333                 for a device is predictable, then no renaming is
 334                 performed.</para>
 335               </listitem>
 336             </varlistentry>
 337             <varlistentry>
 338               <term><option>database</option></term>
 339               <listitem>
 340                 <para>The name is set based on entries in the udev's
 341                 Hardware Database with the key
 342                 <varname>ID_NET_NAME_FROM_DATABASE</varname>.
 343                 </para>
 344               </listitem>
 345             </varlistentry>
 346             <varlistentry>
 347               <term><option>onboard</option></term>
 348               <listitem>
 349                 <para>The name is set based on information given by
 350                 the firmware for on-board devices, as exported by the
 351                 udev property <varname>ID_NET_NAME_ONBOARD</varname>.
 352                 See <citerefentry><refentrytitle>systemd.net-naming-scheme</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 353                 </para>
 354               </listitem>
 355             </varlistentry>
 356             <varlistentry>
 357               <term><option>slot</option></term>
 358               <listitem>
 359                 <para>The name is set based on information given by
 360                 the firmware for hot-plug devices, as exported by the
 361                 udev property <varname>ID_NET_NAME_SLOT</varname>.
 362                 See <citerefentry><refentrytitle>systemd.net-naming-scheme</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 363                 </para>
 364               </listitem>
 365             </varlistentry>
 366             <varlistentry>
 367               <term><option>path</option></term>
 368               <listitem>
 369                 <para>The name is set based on the device's physical
 370                 location, as exported by the udev property
 371                 <varname>ID_NET_NAME_PATH</varname>.
 372                 See <citerefentry><refentrytitle>systemd.net-naming-scheme</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 373                 </para>
 374               </listitem>
 375             </varlistentry>
 376             <varlistentry>
 377               <term><option>mac</option></term>
 378               <listitem>
 379                 <para>The name is set based on the device's persistent
 380                 MAC address, as exported by the udev property
 381                 <varname>ID_NET_NAME_MAC</varname>.
 382                 See <citerefentry><refentrytitle>systemd.net-naming-scheme</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 383                 </para>
 384               </listitem>
 385             </varlistentry>
 386             <varlistentry>
 387               <term><option>keep</option></term>
 388               <listitem>
 389                 <para>If the device already had a name given by userspace (as part of creation of the device
 390                 or a rename), keep it.</para>
 391               </listitem>
 392             </varlistentry>
 393           </variablelist>
 394         </listitem>
 395       </varlistentry>
 396       <varlistentry>
 397         <term><varname>Name=</varname></term>
 398         <listitem>
 399           <para>The interface name to use. This option has lower precedence than
 400           <varname>NamePolicy=</varname>, so for this setting to take effect, <varname>NamePolicy=</varname>
 401           must either be unset, empty, disabled, or all policies configured there must fail. Also see the
 402           example below with <literal>Name=dmz0</literal>.</para>
 403
 404           <para>Note that specifying a name that the kernel might use for another
 405           interface (for example <literal>eth0</literal>) is dangerous because the
 406           name assignment done by udev will race with the assignment done by the
 407           kernel, and only one interface may use the name. Depending on the order of
 408           operations, either udev or the kernel will win, making the naming
 409           unpredictable. It is best to use some different prefix, for example
 410           <literal>internal0</literal>/<literal>external0</literal> or
 411           <literal>lan0</literal>/<literal>lan1</literal>/<literal>lan3</literal>.
 412           </para>
 413         </listitem>
 414       </varlistentry>
 415       <varlistentry>
 416         <term><varname>AlternativeNamesPolicy=</varname></term>
 417         <listitem>
 418           <para>A space-separated list of policies by which the interface's alternative names
 419           should be set. Each of the policies may fail, and all successful policies are used. The
 420           available policies are <literal>database</literal>, <literal>onboard</literal>,
 421           <literal>slot</literal>, <literal>path</literal>, and <literal>mac</literal>. If the
 422           kernel does not support the alternative names, then this setting will be ignored.
 423           </para>
 424         </listitem>
 425       </varlistentry>
 426       <varlistentry>
 427         <term><varname>AlternativeName=</varname></term>
 428         <listitem>
 429           <para>The alternative interface name to use. This option can be specified multiple times.
 430           If the empty string is assigned to this option, the list is reset, and all prior assignments
 431           have no effect. If the kernel does not support the alternative names, then this setting will
 432           be ignored.</para>
 433         </listitem>
 434       </varlistentry>
 435       <varlistentry>
 436         <term><varname>TransmitQueues=</varname></term>
 437         <listitem>
 438           <para>Specifies the device's number of transmit queues. An integer in the range 1…4096.
 439           When unset, the kernel's default will be used.</para>
 440         </listitem>
 441       </varlistentry>
 442       <varlistentry>
 443         <term><varname>ReceiveQueues=</varname></term>
 444         <listitem>
 445           <para>Specifies the device's number of receive queues. An integer in the range 1…4096.
 446           When unset, the kernel's default will be used.</para>
 447         </listitem>
 448       </varlistentry>
 449       <varlistentry>
 450         <term><varname>TransmitQueueLength=</varname></term>
 451         <listitem>
 452           <para>Specifies the transmit queue length of the device in number of packets. An unsigned integer
 453           in the range 0…4294967294. When unset, the kernel's default will be used.</para>
 454         </listitem>
 455       </varlistentry>
 456       <varlistentry>
 457         <term><varname>MTUBytes=</varname></term>
 458         <listitem>
 459           <para>The maximum transmission unit in bytes to set for the
 460           device. The usual suffixes K, M, G are supported and are
 461           understood to the base of 1024.</para>
 462         </listitem>
 463       </varlistentry>
 464       <varlistentry>
 465         <term><varname>BitsPerSecond=</varname></term>
 466         <listitem>
 467           <para>The speed to set for the device, the value is rounded
 468           down to the nearest Mbps. The usual suffixes K, M, G are
 469           supported and are understood to the base of 1000.</para>
 470         </listitem>
 471       </varlistentry>
 472       <varlistentry>
 473         <term><varname>Duplex=</varname></term>
 474         <listitem>
 475           <para>The duplex mode to set for the device. The accepted values are <option>half</option> and
 476           <option>full</option>.</para>
 477         </listitem>
 478       </varlistentry>
 479       <varlistentry>
 480         <term><varname>AutoNegotiation=</varname></term>
 481         <listitem>
 482           <para>Takes a boolean. If set to yes, automatic negotiation of transmission parameters is enabled.
 483           Autonegotiation is a procedure by which two connected ethernet devices choose
 484           common transmission parameters, such as speed, duplex mode, and flow control.
 485           When unset, the kernel's default will be used.</para>
 486
 487           <para>Note that if autonegotiation is enabled, speed and duplex settings are
 488           read-only. If autonegotiation is disabled, speed and duplex settings are writable
 489           if the driver supports multiple link modes.</para>
 490         </listitem>
 491       </varlistentry>
 492       <varlistentry>
 493         <term><varname>WakeOnLan=</varname></term>
 494         <listitem>
 495           <para>The Wake-on-LAN policy to set for the device. Takes the special value
 496           <literal>off</literal> which disables Wake-on-LAN, or space separated list of the following
 497           words:</para>
 498
 499           <variablelist>
 500             <varlistentry>
 501               <term><option>phy</option></term>
 502               <listitem>
 503                 <para>Wake on PHY activity.</para>
 504               </listitem>
 505             </varlistentry>
 506             <varlistentry>
 507               <term><option>unicast</option></term>
 508               <listitem>
 509                 <para>Wake on unicast messages.</para>
 510               </listitem>
 511             </varlistentry>
 512             <varlistentry>
 513               <term><option>multicast</option></term>
 514               <listitem>
 515                 <para>Wake on multicast messages.</para>
 516               </listitem>
 517             </varlistentry>
 518             <varlistentry>
 519               <term><option>broadcast</option></term>
 520               <listitem>
 521                 <para>Wake on broadcast messages.</para>
 522               </listitem>
 523             </varlistentry>
 524             <varlistentry>
 525               <term><option>arp</option></term>
 526               <listitem>
 527                 <para>Wake on ARP.</para>
 528               </listitem>
 529             </varlistentry>
 530             <varlistentry>
 531               <term><option>magic</option></term>
 532               <listitem>
 533                 <para>Wake on receipt of a magic packet.
 534                 </para>
 535               </listitem>
 536             </varlistentry>
 537             <varlistentry>
 538               <term><option>secureon</option></term>
 539               <listitem>
 540                 <para>Enable SecureOn password for MagicPacket. Implied when
 541                 <varname>WakeOnLanPassword=</varname> is specified. If specified without
 542                 <varname>WakeOnLanPassword=</varname> option, then the password is read from the
 543                 credential <literal><replaceable>LINK</replaceable>.link.wol.password</literal> (e.g.,
 544                 <literal>60-foo.link.wol.password</literal>), and if the credential not found, then
 545                 read from <literal>wol.password</literal>. See
 546                 <varname>LoadCredential=</varname>/<varname>SetCredential=</varname> in
 547                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 548                 for details. The password in the credential, must be 6 bytes in hex format with each
 549                 byte separated by a colon (<literal>:</literal>) like an Ethernet MAC address, e.g.,
 550                 <literal>aa:bb:cc:dd:ee:ff</literal>.</para>
 551               </listitem>
 552             </varlistentry>
 553           </variablelist>
 554
 555           <para>Defaults to unset, and the device's default will be used. This setting can be specified
 556           multiple times. If an empty string is assigned, then the all previous assignments are
 557           cleared.</para>
 558         </listitem>
 559       </varlistentry>
 560       <varlistentry>
 561         <term><varname>WakeOnLanPassword=</varname></term>
 562         <listitem>
 563           <para>Specifies the SecureOn password for MagicPacket. Takes an absolute path to a regular
 564           file or an <constant>AF_UNIX</constant> stream socket, or the plain password. When a path to
 565           a regular file is specified, the password is read from it. When an
 566           <constant>AF_UNIX</constant> stream socket is specified, a connection is made to it and the
 567           password is read from it. The password must be 6 bytes in hex format with each byte separated
 568           by a colon (<literal>:</literal>) like an Ethernet MAC address, e.g.,
 569           <literal>aa:bb:cc:dd:ee:ff</literal>. This implies <varname>WakeOnLan=secureon</varname>.
 570           Defaults to unset, and the current value will not be changed.</para>
 571         </listitem>
 572       </varlistentry>
 573       <varlistentry>
 574         <term><varname>Port=</varname></term>
 575         <listitem>
 576           <para>The port option is used to select the device port. The
 577           supported values are:</para>
 578
 579           <variablelist>
 580             <varlistentry>
 581               <term><option>tp</option></term>
 582               <listitem>
 583                 <para>An Ethernet interface using Twisted-Pair cable as the medium.</para>
 584               </listitem>
 585             </varlistentry>
 586             <varlistentry>
 587               <term><option>aui</option></term>
 588               <listitem>
 589                 <para>Attachment Unit Interface (AUI). Normally used with hubs.
 590                 </para>
 591               </listitem>
 592             </varlistentry>
 593             <varlistentry>
 594               <term><option>bnc</option></term>
 595               <listitem>
 596                 <para>An Ethernet interface using BNC connectors and co-axial cable.</para>
 597               </listitem>
 598             </varlistentry>
 599             <varlistentry>
 600               <term><option>mii</option></term>
 601               <listitem>
 602                 <para>An Ethernet interface using a Media Independent Interface (MII).</para>
 603               </listitem>
 604             </varlistentry>
 605             <varlistentry>
 606               <term><option>fibre</option></term>
 607               <listitem>
 608                 <para>An Ethernet interface using Optical Fibre as the medium.</para>
 609               </listitem>
 610             </varlistentry>
 611           </variablelist>
 612         </listitem>
 613       </varlistentry>
 614       <varlistentry>
 615         <term><varname>Advertise=</varname></term>
 616         <listitem>
 617           <para>This sets what speeds and duplex modes of operation are advertised for auto-negotiation.
 618           This implies <literal>AutoNegotiation=yes</literal>. The supported values are:
 619
 620           <table>
 621             <title>Supported advertise values</title>
 622             <tgroup cols='3'>
 623               <colspec colname='Advertise' />
 624               <colspec colname='Speed' />
 625               <colspec colname='Duplex Mode' />
 626
 627               <thead><row>
 628                 <entry>Advertise</entry>
 629                 <entry>Speed (Mbps)</entry>
 630                 <entry>Duplex Mode</entry>
 631               </row></thead>
 632               <tbody>
 633                 <row><entry><option>10baset-half</option></entry>
 634                 <entry>10</entry><entry>half</entry></row>
 635
 636                 <row><entry><option>10baset-full</option></entry>
 637                 <entry>10</entry><entry>full</entry></row>
 638
 639                 <row><entry><option>100baset-half</option></entry>
 640                 <entry>100</entry><entry>half</entry></row>
 641
 642                 <row><entry><option>100baset-full</option></entry>
 643                 <entry>100</entry><entry>full</entry></row>
 644
 645                 <row><entry><option>1000baset-half</option></entry>
 646                 <entry>1000</entry><entry>half</entry></row>
 647
 648                 <row><entry><option>1000baset-full</option></entry>
 649                 <entry>1000</entry><entry>full</entry></row>
 650
 651                 <row><entry><option>10000baset-full</option></entry>
 652                 <entry>10000</entry><entry>full</entry></row>
 653
 654                 <row><entry><option>2500basex-full</option></entry>
 655                 <entry>2500</entry><entry>full</entry></row>
 656
 657                 <row><entry><option>1000basekx-full</option></entry>
 658                 <entry>1000</entry><entry>full</entry></row>
 659
 660                 <row><entry><option>10000basekx4-full</option></entry>
 661                 <entry>10000</entry><entry>full</entry></row>
 662
 663                 <row><entry><option>10000basekr-full</option></entry>
 664                 <entry>10000</entry><entry>full</entry></row>
 665
 666                 <row><entry><option>10000baser-fec</option></entry>
 667                 <entry>10000</entry><entry>full</entry></row>
 668
 669                 <row><entry><option>20000basemld2-full</option></entry>
 670                 <entry>20000</entry><entry>full</entry></row>
 671
 672                 <row><entry><option>20000basekr2-full</option></entry>
 673                 <entry>20000</entry><entry>full</entry></row>
 674               </tbody>
 675             </tgroup>
 676           </table>
 677
 678           By default this is unset, i.e. all possible modes will be advertised.
 679           This option may be specified more than once, in which case all specified speeds and modes are advertised.
 680           If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect.
 681           </para>
 682         </listitem>
 683       </varlistentry>
 684       <varlistentry>
 685         <term><varname>ReceiveChecksumOffload=</varname></term>
 686         <listitem>
 687           <para>Takes a boolean. If set to true, hardware offload for checksumming of ingress
 688           network packets is enabled. When unset, the kernel's default will be used.</para>
 689         </listitem>
 690       </varlistentry>
 691       <varlistentry>
 692         <term><varname>TransmitChecksumOffload=</varname></term>
 693         <listitem>
 694           <para>Takes a boolean. If set to true, hardware offload for checksumming of egress
 695           network packets is enabled. When unset, the kernel's default will be used.</para>
 696         </listitem>
 697       </varlistentry>
 698       <varlistentry>
 699         <term><varname>TCPSegmentationOffload=</varname></term>
 700         <listitem>
 701           <para>Takes a boolean. If set to true, TCP Segmentation Offload (TSO) is enabled.
 702           When unset, the kernel's default will be used.</para>
 703         </listitem>
 704       </varlistentry>
 705        <varlistentry>
 706       <term><varname>TCP6SegmentationOffload=</varname></term>
 707         <listitem>
 708           <para>Takes a boolean. If set to true, TCP6 Segmentation Offload (tx-tcp6-segmentation) is enabled.
 709           When unset, the kernel's default will be used.</para>
 710         </listitem>
 711       </varlistentry>
 712       <varlistentry>
 713         <term><varname>GenericSegmentationOffload=</varname></term>
 714         <listitem>
 715           <para>Takes a boolean. If set to true, Generic Segmentation Offload (GSO) is enabled.
 716           When unset, the kernel's default will be used.</para>
 717         </listitem>
 718       </varlistentry>
 719       <varlistentry>
 720         <term><varname>GenericReceiveOffload=</varname></term>
 721         <listitem>
 722           <para>Takes a boolean. If set to true, Generic Receive Offload (GRO) is enabled.
 723           When unset, the kernel's default will be used.</para>
 724         </listitem>
 725       </varlistentry>
 726       <varlistentry>
 727         <term><varname>GenericReceiveOffloadHardware=</varname></term>
 728         <listitem>
 729           <para>Takes a boolean. If set to true, hardware accelerated Generic Receive Offload (GRO) is
 730           enabled. When unset, the kernel's default will be used.</para>
 731         </listitem>
 732       </varlistentry>
 733       <varlistentry>
 734         <term><varname>LargeReceiveOffload=</varname></term>
 735         <listitem>
 736           <para>Takes a boolean. If set to true, Large Receive Offload (LRO) is enabled.
 737           When unset, the kernel's default will be used.</para>
 738         </listitem>
 739       </varlistentry>
 740       <varlistentry>
 741         <term><varname>ReceiveVLANCTAGHardwareAcceleration=</varname></term>
 742         <listitem>
 743           <para>Takes a boolean. If set to true, receive VLAN CTAG hardware acceleration is enabled.
 744           When unset, the kernel's default will be used.</para>
 745         </listitem>
 746       </varlistentry>
 747       <varlistentry>
 748         <term><varname>TransmitVLANCTAGHardwareAcceleration=</varname></term>
 749         <listitem>
 750           <para>Takes a boolean. If set to true, transmit VLAN CTAG hardware acceleration is enabled.
 751           When unset, the kernel's default will be used.</para>
 752         </listitem>
 753       </varlistentry>
 754       <varlistentry>
 755         <term><varname>ReceiveVLANCTAGFilter=</varname></term>
 756         <listitem>
 757           <para>Takes a boolean. If set to true, receive filtering on VLAN CTAGs is enabled.
 758           When unset, the kernel's default will be used.</para>
 759         </listitem>
 760       </varlistentry>
 761       <varlistentry>
 762         <term><varname>TransmitVLANSTAGHardwareAcceleration=</varname></term>
 763         <listitem>
 764           <para>Takes a boolean. If set to true, transmit VLAN STAG HW acceleration is enabled.
 765           When unset, the kernel's default will be used.</para>
 766         </listitem>
 767       </varlistentry>
 768       <varlistentry>
 769         <term><varname>NTupleFilter=</varname></term>
 770         <listitem>
 771           <para>Takes a boolean. If set to true, receive N-tuple filters and actions are enabled.
 772           When unset, the kernel's default will be used.</para>
 773         </listitem>
 774       </varlistentry>
 775       <varlistentry>
 776         <term><varname>RxChannels=</varname></term>
 777         <term><varname>TxChannels=</varname></term>
 778         <term><varname>OtherChannels=</varname></term>
 779         <term><varname>CombinedChannels=</varname></term>
 780         <listitem>
 781           <para>Specifies the number of receive, transmit, other, or combined channels, respectively.
 782           Takes an unsigned integer in the range 1…4294967295 or <literal>max</literal>. If set to
 783           <literal>max</literal>, the advertised maximum value of the hardware will be used. When
 784           unset, the number will not be changed. Defaults to unset.</para>
 785         </listitem>
 786       </varlistentry>
 787       <varlistentry>
 788         <term><varname>RxBufferSize=</varname></term>
 789         <term><varname>RxMiniBufferSize=</varname></term>
 790         <term><varname>RxJumboBufferSize=</varname></term>
 791         <term><varname>TxBufferSize=</varname></term>
 792         <listitem>
 793           <para>Specifies the maximum number of pending packets in the NIC receive buffer, mini receive
 794           buffer, jumbo receive buffer, or transmit buffer, respectively. Takes an unsigned integer in
 795           the range 1…4294967295 or <literal>max</literal>. If set to <literal>max</literal>, the
 796           advertised maximum value of the hardware will be used. When unset, the number will not be
 797           changed. Defaults to unset.</para>
 798         </listitem>
 799       </varlistentry>
 800       <varlistentry>
 801         <term><varname>RxFlowControl=</varname></term>
 802         <listitem>
 803           <para>Takes a boolean. When set, enables receive flow control, also known as the ethernet
 804           receive PAUSE message (generate and send ethernet PAUSE frames). When unset, the kernel's
 805           default will be used.</para>
 806         </listitem>
 807       </varlistentry>
 808       <varlistentry>
 809         <term><varname>TxFlowControl=</varname></term>
 810         <listitem>
 811           <para>Takes a boolean. When set, enables transmit flow control, also known as the ethernet
 812           transmit PAUSE message (respond to received ethernet PAUSE frames). When unset, the kernel's
 813           default will be used.</para>
 814         </listitem>
 815       </varlistentry>
 816       <varlistentry>
 817         <term><varname>AutoNegotiationFlowControl=</varname></term>
 818         <listitem>
 819           <para>Takes a boolean. When set, auto negotiation enables the interface to exchange state
 820           advertisements with the connected peer so that the two devices can agree on the ethernet
 821           PAUSE configuration. When unset, the kernel's default will be used.</para>
 822         </listitem>
 823       </varlistentry>
 824       <varlistentry>
 825         <term><varname>GenericSegmentOffloadMaxBytes=</varname></term>
 826         <listitem>
 827           <para>Specifies the maximum size of a Generic Segment Offload (GSO) packet the
 828           device should accept. The usual suffixes K, M, G are supported and are
 829           understood to the base of 1024. An unsigned integer in the range 1…65536.
 830           Defaults to unset.</para>
 831         </listitem>
 832       </varlistentry>
 833       <varlistentry>
 834         <term><varname>GenericSegmentOffloadMaxSegments=</varname></term>
 835         <listitem>
 836           <para>Specifies the maximum number of Generic Segment Offload (GSO) segments the device should
 837           accept. An unsigned integer in the range 1…65535. Defaults to unset.</para>
 838         </listitem>
 839       </varlistentry>
 840       <varlistentry>
 841         <term><varname>UseAdaptiveRxCoalesce=</varname></term>
 842         <term><varname>UseAdaptiveTxCoalesce=</varname></term>
 843         <listitem>
 844           <para>Boolean properties that, when set, enable/disable adaptive Rx/Tx coalescing if the hardware
 845           supports it. When unset, the kernel's default will be used.</para>
 846         </listitem>
 847       </varlistentry>
 848       <varlistentry>
 849         <term><varname>RxCoalesceSec=</varname></term>
 850         <term><varname>RxCoalesceIrqSec=</varname></term>
 851         <term><varname>RxCoalesceLowSec=</varname></term>
 852         <term><varname>RxCoalesceHighSec=</varname></term>
 853         <term><varname>TxCoalesceSec=</varname></term>
 854         <term><varname>TxCoalesceIrqSec=</varname></term>
 855         <term><varname>TxCoalesceLowSec=</varname></term>
 856         <term><varname>TxCoalesceHighSec=</varname></term>
 857         <listitem>
 858           <para>These properties configure the delay before Rx/Tx interrupts are generated after a packet is
 859           sent/received. The <literal>Irq</literal> properties come into effect when the host is servicing an
 860           IRQ. The <literal>Low</literal> and <literal>High</literal> properties come into effect when the
 861           packet rate drops below the low packet rate threshold or exceeds the high packet rate threshold
 862           respectively if adaptive Rx/Tx coalescing is enabled. When unset, the kernel's defaults will be
 863           used.</para>
 864         </listitem>
 865       </varlistentry>
 866         <varlistentry>
 867         <term><varname>RxMaxCoalescedFrames=</varname></term>
 868         <term><varname>RxMaxCoalescedIrqFrames=</varname></term>
 869         <term><varname>RxMaxCoalescedLowFrames=</varname></term>
 870         <term><varname>RxMaxCoalescedHighFrames=</varname></term>
 871         <term><varname>TxMaxCoalescedFrames=</varname></term>
 872         <term><varname>TxMaxCoalescedIrqFrames=</varname></term>
 873         <term><varname>TxMaxCoalescedLowFrames=</varname></term>
 874         <term><varname>TxMaxCoalescedHighFrames=</varname></term>
 875         <listitem>
 876           <para>These properties configure the maximum number of frames that are sent/received before a Rx/Tx
 877           interrupt is generated. The <literal>Irq</literal> properties come into effect when the host is
 878           servicing an IRQ. The <literal>Low</literal> and <literal>High</literal> properties come into
 879           effect when the packet rate drops below the low packet rate threshold or exceeds the high packet
 880           rate threshold respectively if adaptive Rx/Tx coalescing is enabled. When unset, the kernel's
 881           defaults will be used.</para>
 882         </listitem>
 883       </varlistentry>
 884       <varlistentry>
 885         <term><varname>CoalescePacketRateLow=</varname></term>
 886         <term><varname>CoalescePacketRateHigh=</varname></term>
 887         <listitem>
 888           <para>These properties configure the low and high packet rate (expressed in packets per second)
 889           threshold respectively and are used to determine when the corresponding coalescing settings for low
 890           and high packet rates come into effect if adaptive Rx/Tx coalescing is enabled. If unset, the
 891           kernel's defaults will be used.</para>
 892         </listitem>
 893       </varlistentry>
 894       <varlistentry>
 895         <term><varname>CoalescePacketRateSampleIntervalSec=</varname></term>
 896         <listitem>
 897           <para>Configures how often to sample the packet rate used for adaptive Rx/Tx coalescing. This
 898           property cannot be zero. This lowest time granularity supported by this property is seconds.
 899           Partial seconds will be rounded up before being passed to the kernel. If unset, the kernel's
 900           default will be used.</para>
 901         </listitem>
 902       </varlistentry>
 903       <varlistentry>
 904         <term><varname>StatisticsBlockCoalesceSec=</varname></term>
 905         <listitem>
 906           <para>How long to delay driver in-memory statistics block updates. If the driver does not have an
 907           in-memory statistic block, this property is ignored. This property cannot be zero. If unset, the
 908           kernel's default will be used.</para>
 909         </listitem>
 910       </varlistentry>
 911
 912     </variablelist>
 913   </refsect1>
 914
 915   <refsect1>
 916     <title>Examples</title>
 917
 918     <example>
 919       <title>/usr/lib/systemd/network/99-default.link</title>
 920
 921       <para>The link file <filename>99-default.link</filename> that is
 922       shipped with systemd defines the default naming policy for
 923       links.</para>
 924
 925       <programlisting>[Link]
 926 NamePolicy=kernel database onboard slot path
 927 MACAddressPolicy=persistent</programlisting>
 928     </example>
 929
 930     <example>
 931       <title>/etc/systemd/network/10-dmz.link</title>
 932
 933       <para>This example assigns the fixed name <literal>dmz0</literal> to the interface with the MAC address
 934       00:a0:de:63:7a:e6:</para>
 935
 936       <programlisting>[Match]
 937 MACAddress=00:a0:de:63:7a:e6
 938
 939 [Link]
 940 Name=dmz0</programlisting>
 941
 942       <para><varname>NamePolicy=</varname> is not set, so <varname>Name=</varname> takes effect. We use the
 943       <literal>10-</literal> prefix to order this file early in the list. Note that it needs to be before
 944       <literal>99-link</literal>, i.e. it needs a numerical prefix, to have any effect at all.</para>
 945     </example>
 946
 947     <example>
 948       <title>Debugging <varname>NamePolicy=</varname> assignments</title>
 949
 950       <programlisting>$ sudo SYSTEMD_LOG_LEVEL=debug udevadm test-builtin net_setup_link /sys/class/net/hub0
 951 …
 952 Parsed configuration file /usr/lib/systemd/network/99-default.link
 953 Parsed configuration file /etc/systemd/network/10-eth0.link
 954 ID_NET_DRIVER=cdc_ether
 955 Config file /etc/systemd/network/10-eth0.link applies to device hub0
 956 link_config: autonegotiation is unset or enabled, the speed and duplex are not writable.
 957 hub0: Device has name_assign_type=4
 958 Using default interface naming scheme 'v240'.
 959 hub0: Policies didn't yield a name, using specified Name=hub0.
 960 ID_NET_LINK_FILE=/etc/systemd/network/10-eth0.link
 961 ID_NET_NAME=hub0
 962 …</programlisting>
 963
 964      <para>Explicit <varname>Name=</varname> configuration wins in this case.</para>
 965
 966      <programlisting>sudo SYSTEMD_LOG_LEVEL=debug udevadm test-builtin net_setup_link /sys/class/net/enp0s31f6
 967 …
 968 Parsed configuration file /usr/lib/systemd/network/99-default.link
 969 Parsed configuration file /etc/systemd/network/10-eth0.link
 970 Created link configuration context.
 971 ID_NET_DRIVER=e1000e
 972 Config file /usr/lib/systemd/network/99-default.link applies to device enp0s31f6
 973 link_config: autonegotiation is unset or enabled, the speed and duplex are not writable.
 974 enp0s31f6: Device has name_assign_type=4
 975 Using default interface naming scheme 'v240'.
 976 enp0s31f6: Policy *keep*: keeping existing userspace name
 977 enp0s31f6: Device has addr_assign_type=0
 978 enp0s31f6: MAC on the device already matches policy *persistent*
 979 ID_NET_LINK_FILE=/usr/lib/systemd/network/99-default.link
 980 …
 981 </programlisting>
 982
 983      <para>In this case, the interface was already renamed, so the <option>keep</option> policy specified as
 984      the first option in <filename index="false">99-default.link</filename> means that the existing name is
 985      preserved. If <option>keep</option> was removed, or if were in boot before the renaming has happened,
 986      we might get the following instead:</para>
 987
 988      <programlisting>enp0s31f6: Policy *path* yields "enp0s31f6".
 989 enp0s31f6: Device has addr_assign_type=0
 990 enp0s31f6: MAC on the device already matches policy *persistent*
 991 ID_NET_LINK_FILE=/usr/lib/systemd/network/99-default.link
 992 ID_NET_NAME=enp0s31f6
 993 …
 994 </programlisting>
 995
 996       <para>Please note that the details of output are subject to change.</para>
 997     </example>
 998
 999     <example>
1000       <title>/etc/systemd/network/10-internet.link</title>
1001
1002       <para>This example assigns the fixed name
1003       <literal>internet0</literal> to the interface with the device
1004       path <literal>pci-0000:00:1a.0-*</literal>:</para>
1005
1006       <programlisting>[Match]
1007 Path=pci-0000:00:1a.0-*
1008
1009 [Link]
1010 Name=internet0</programlisting>
1011     </example>
1012
1013     <example>
1014       <title>/etc/systemd/network/25-wireless.link</title>
1015
1016       <para>Here's an overly complex example that shows the use of a large number of [Match] and [Link] settings.</para>
1017
1018       <programlisting>[Match]
1019 MACAddress=12:34:56:78:9a:bc
1020 Driver=brcmsmac
1021 Path=pci-0000:02:00.0-*
1022 Type=wlan
1023 Virtualization=no
1024 Host=my-laptop
1025 Architecture=x86-64
1026
1027 [Link]
1028 Name=wireless0
1029 MTUBytes=1450
1030 BitsPerSecond=10M
1031 WakeOnLan=magic
1032 MACAddress=cb:a9:87:65:43:21</programlisting>
1033     </example>
1034   </refsect1>
1035
1036   <refsect1>
1037     <title>See Also</title>
1038     <para>
1039       <citerefentry>
1040         <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
1041       </citerefentry>,
1042       <citerefentry>
1043         <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
1044       </citerefentry>,
1045       <citerefentry>
1046         <refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum>
1047       </citerefentry>,
1048       <citerefentry>
1049         <refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
1050       </citerefentry>
1051     </para>
1052   </refsect1>
1053
1054 </refentry>