HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/systemd.link.xml

85,474 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: 5f5930adf50e62f06802fb7b7017a064a0ab937f

Lines 1001–1781 of 1,781

 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TCP6SegmentationOffload=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, TCP6 Segmentation Offload (tx-tcp6-segmentation) is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v235"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericSegmentationOffload=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, Generic Segmentation Offload (GSO) is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>PartialGenericSegmentationOffload=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, Partial Generic Segmentation Offload (GSO_Partial) is
          enabled. See
          <ulink url="https://docs.kernel.org/networking/segmentation-offloads.html#partial-generic-segmentation-offload">
          Partial Generic Segmentation Offload</ulink> for more details.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericReceiveOffload=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, Generic Receive Offload (GRO) is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericReceiveOffloadHardware=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, hardware accelerated Generic Receive Offload (GRO) is
          enabled. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericReceiveOffloadList=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, Generic Receive Offload (GRO) List for UDP is enabled.
          When unset, the kernel's default will be used. This corresponds to the command
          <command>ethtool -K <replaceable>INTERFACE</replaceable> rx-gro-list on|off</command>.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericReceiveOffloadUDPForwarding=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, Generic Receive Offload (GRO) for aggregating incoming UDP packets is enabled.
          When unset, the kernel's default will be used. This corresponds to the command
          <command>ethtool -K <replaceable>INTERFACE</replaceable> rx-udp-gro-forwarding on|off</command>.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>LargeReceiveOffload=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, Large Receive Offload (LRO) is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v232"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReceivePacketSteeringCPUMask=</varname></term>
        <listitem>
          <para>Configures Receive Packet Steering (RPS) list of CPUs to which RPS may forward traffic.
          Takes a list of CPU indices or ranges separated by either whitespace or commas. Alternatively,
          takes the special value <literal>all</literal>, which will include all available CPUs in the mask.
          CPU ranges are specified by the lower and upper CPU indices separated by a dash (e.g. <literal>2-6</literal>).
          This option may be specified more than once, in which case the specified list of CPU ranges are merged.
          If an empty string is assigned, the list is reset, all assignments prior to this will have no effect.
          Defaults to unset and RPS CPU list is unchanged. To disable RPS when it was previously enabled, use the
          special value <literal>disable</literal>.</para>
 
          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IRQAffinityPolicy=</varname></term>
        <listitem>
          <para>Specifies the IRQ distribution strategy for network interface MSI/MSI-X interrupts. Takes one
          of <literal>spread</literal> or <literal>single</literal>. When set to <literal>spread</literal>,
          queue IRQs are distributed across CPUs using a topology-aware maximum distance algorithm that
          prefers CPUs on different NUMA nodes, then different physical cores, then different hyperthreads.
          When set to <literal>single</literal>, all IRQs are pinned to a single CPU (CPU 0 by default, or
          the first CPU in the set specified by <varname>IRQAffinity=</varname>). When there are more IRQs
          than available CPUs, queues wrap around using round-robin assignment. When unset, no affinity
          management is performed. Setting this to an empty string explicitly disables affinity management.</para>
 
          <para>This option only applies to devices with MSI/MSI-X interrupts discoverable via
          <filename>/sys/class/net/<replaceable>iface</replaceable>/device/msi_irqs/</filename>. Virtual
          devices (veth, tap) and legacy INTx devices are skipped with a notice logged.</para>
 
          <para>Note that if <citerefentry><refentrytitle>irqbalance</refentrytitle><manvolnum>1</manvolnum>
          </citerefentry> or similar IRQ management daemons are running, they may override the configured
          affinity. Consider disabling such daemons or configuring them to exclude managed interfaces.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IRQAffinity=</varname></term>
        <listitem>
          <para>Filters the set of CPUs eligible for IRQ placement. Takes a list of CPU indices or ranges
          separated by either whitespace or commas (e.g., <literal>0-3</literal>, <literal>0,2,4,6</literal>,
          <literal>0-3,8-11</literal>). This option works in conjunction with
          <varname>IRQAffinityPolicy=</varname> and <varname>IRQAffinityNUMA=</varname> to constrain which
          CPUs receive network IRQs. When specified with <literal>spread</literal> policy, only the listed
          CPUs are considered for IRQ distribution. When specified with <literal>single</literal> policy,
          IRQs are pinned to the first CPU in the allowed set instead of CPU 0. Has no effect if
          <varname>IRQAffinityPolicy=</varname> is not set.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>IRQAffinityNUMA=</varname></term>
        <listitem>
          <para>Filters CPUs to those belonging to the specified NUMA node. Takes either
          <literal>local</literal> or an explicit NUMA node number (0, 1, 2, ...). When set to
          <literal>local</literal>, the NUMA node local to the NIC's PCIe slot is used (determined from
          <filename>/sys/class/net/<replaceable>iface</replaceable>/device/numa_node</filename>). If the
          device's NUMA node cannot be determined (e.g., non-NUMA system), a warning is logged and IRQ
          affinity configuration is skipped.</para>
 
          <para>When both <varname>IRQAffinity=</varname> and <varname>IRQAffinityNUMA=</varname> are
          specified, their intersection is used. If the intersection results in an empty set, an error is
          logged and no affinity is applied. Has no effect if <varname>IRQAffinityPolicy=</varname> is not
          set.</para>
 
          <xi:include href="version-info.xml" xpointer="v260"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReceiveVLANCTAGHardwareAcceleration=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, receive VLAN CTAG hardware acceleration is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TransmitVLANCTAGHardwareAcceleration=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, transmit VLAN CTAG hardware acceleration is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReceiveVLANCTAGFilter=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, receive filtering on VLAN CTAGs is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TransmitVLANSTAGHardwareAcceleration=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, transmit VLAN STAG hardware acceleration is enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>NTupleFilter=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, receive N-tuple filters and actions are enabled.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReceiveFCS=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, pass the Frame Check Sequence (FCS) value up the stack
          without trimming it, and allow userspace to calculate error rate or link health.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>ReceiveAll=</varname></term>
        <listitem>
          <para>Takes a boolean. If set to true, allow the interface to also receive damaged ethernet frames.
          When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RxChannels=</varname></term>
        <term><varname>TxChannels=</varname></term>
        <term><varname>OtherChannels=</varname></term>
        <term><varname>CombinedChannels=</varname></term>
        <listitem>
          <para>Specifies the number of receive, transmit, other, or combined channels, respectively.
          Takes an unsigned integer in the range 1…4294967295 or <literal>max</literal>. If set to
          <literal>max</literal>, the advertised maximum value of the hardware will be used. When
          unset, the number will not be changed. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RxBufferSize=</varname></term>
        <term><varname>RxMiniBufferSize=</varname></term>
        <term><varname>RxJumboBufferSize=</varname></term>
        <term><varname>TxBufferSize=</varname></term>
        <listitem>
          <para>Specifies the maximum number of pending packets in the NIC receive buffer, mini receive
          buffer, jumbo receive buffer, or transmit buffer, respectively. Takes an unsigned integer in
          the range 1…4294967295 or <literal>max</literal>. If set to <literal>max</literal>, the
          advertised maximum value of the hardware will be used. When unset, the number will not be
          changed. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v244"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RxFlowControl=</varname></term>
        <listitem>
          <para>Takes a boolean. When set, enables receive flow control, also known as the ethernet
          receive PAUSE message (generate and send ethernet PAUSE frames). When unset, the kernel's
          default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>TxFlowControl=</varname></term>
        <listitem>
          <para>Takes a boolean. When set, enables transmit flow control, also known as the ethernet
          transmit PAUSE message (respond to received ethernet PAUSE frames). When unset, the kernel's
          default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>AutoNegotiationFlowControl=</varname></term>
        <listitem>
          <para>Takes a boolean. When set, auto negotiation enables the interface to exchange state
          advertisements with the connected peer so that the two devices can agree on the ethernet
          PAUSE configuration. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v246"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericSegmentOffloadMaxBytes=</varname></term>
        <listitem>
          <para>Specifies the maximum size of a Generic Segment Offload (GSO) packet the
          device should accept. The usual suffixes K, M, G are supported and are
          understood to the base of 1024. An unsigned integer in the range 1…65536.
          Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>GenericSegmentOffloadMaxSegments=</varname></term>
        <listitem>
          <para>Specifies the maximum number of Generic Segment Offload (GSO) segments the device should
          accept. An unsigned integer in the range 1…65535. Defaults to unset.</para>
 
          <xi:include href="version-info.xml" xpointer="v248"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>UseAdaptiveRxCoalesce=</varname></term>
        <term><varname>UseAdaptiveTxCoalesce=</varname></term>
        <listitem>
          <para>Boolean properties that, when set, enable/disable adaptive Rx/Tx coalescing if the hardware
          supports it. When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>RxCoalesceSec=</varname></term>
        <term><varname>RxCoalesceIrqSec=</varname></term>
        <term><varname>RxCoalesceLowSec=</varname></term>
        <term><varname>RxCoalesceHighSec=</varname></term>
        <term><varname>TxCoalesceSec=</varname></term>
        <term><varname>TxCoalesceIrqSec=</varname></term>
        <term><varname>TxCoalesceLowSec=</varname></term>
        <term><varname>TxCoalesceHighSec=</varname></term>
        <listitem>
          <para>These properties configure the delay before Rx/Tx interrupts are generated after a packet is
          sent/received. The <literal>Irq</literal> properties come into effect when the host is servicing an
          IRQ. The <literal>Low</literal> and <literal>High</literal> properties come into effect when the
          packet rate drops below the low packet rate threshold or exceeds the high packet rate threshold
          respectively if adaptive Rx/Tx coalescing is enabled. When unset, the kernel's defaults will be
          used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
        <varlistentry>
        <term><varname>RxMaxCoalescedFrames=</varname></term>
        <term><varname>RxMaxCoalescedIrqFrames=</varname></term>
        <term><varname>RxMaxCoalescedLowFrames=</varname></term>
        <term><varname>RxMaxCoalescedHighFrames=</varname></term>
        <term><varname>TxMaxCoalescedFrames=</varname></term>
        <term><varname>TxMaxCoalescedIrqFrames=</varname></term>
        <term><varname>TxMaxCoalescedLowFrames=</varname></term>
        <term><varname>TxMaxCoalescedHighFrames=</varname></term>
        <listitem>
          <para>These properties configure the maximum number of frames that are sent/received before a Rx/Tx
          interrupt is generated. The <literal>Irq</literal> properties come into effect when the host is
          servicing an IRQ. The <literal>Low</literal> and <literal>High</literal> properties come into
          effect when the packet rate drops below the low packet rate threshold or exceeds the high packet
          rate threshold respectively if adaptive Rx/Tx coalescing is enabled. When unset, the kernel's
          defaults will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>CoalescePacketRateLow=</varname></term>
        <term><varname>CoalescePacketRateHigh=</varname></term>
        <listitem>
          <para>These properties configure the low and high packet rate (expressed in packets per second)
          threshold respectively and are used to determine when the corresponding coalescing settings for low
          and high packet rates come into effect if adaptive Rx/Tx coalescing is enabled. If unset, the
          kernel's defaults will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>CoalescePacketRateSampleIntervalSec=</varname></term>
        <listitem>
          <para>Configures how often to sample the packet rate used for adaptive Rx/Tx coalescing. This
          property cannot be zero. This lowest time granularity supported by this property is seconds.
          Partial seconds will be rounded up before being passed to the kernel. If unset, the kernel's
          default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><varname>StatisticsBlockCoalesceSec=</varname></term>
        <listitem>
          <para>How long to delay driver in-memory statistics block updates. If the driver does not have an
          in-memory statistic block, this property is ignored. This property cannot be zero. If unset, the
          kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v250"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MDI=</varname></term>
        <listitem>
          <para>Specifies the medium dependent interface (MDI) mode for the interface. A MDI describes
          the interface from a physical layer implementation to the physical medium used to carry the
          transmission. Takes one of the following words: <literal>straight</literal> (or equivalently:
          <literal>mdi</literal>), <literal>crossover</literal> (or equivalently:
          <literal>mdi-x</literal>, <literal>mdix</literal>), and <literal>auto</literal>. When
          <literal>straight</literal>, the MDI straight through mode will be used. When
          <literal>crossover</literal>, the MDI crossover (MDI-X) mode will be used. When
          <literal>auto</literal>, the MDI status is automatically detected. Defaults to unset, and the
          kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>SR-IOVVirtualFunctions=</varname></term>
        <listitem>
          <para>Specifies the number of SR-IOV virtual functions. Takes an integer in the range
          0…2147483647. Defaults to unset, and automatically determined from the values specified in
          the <varname>VirtualFunction=</varname> settings in the [SR-IOV] sections.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
    </variablelist>
  </refsect1>
 
  <refsect1 id='sr-iov'>
    <title>[SR-IOV] Section Options</title>
    <para>SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI
    functions which can then be e.g. injected into a VM. In the case of network VFs, SR-IOV reduces
    latency and CPU utilisation for north-south network traffic (that is, traffic with endpoints
    outside the host machine), by allowing traffic to bypass the host machine’s network stack.
    </para>
 
    <para>The presence of an [SR-IOV] section in a .link file will cause the creation and
    configuration of the specified virtual function. Within a .network file, the specified virtual
    function will be configured, but must already exist. Specify several [SR-IOV] sections to
    configure several SR-IOVs.</para>
 
    <para>The [SR-IOV] section accepts the following keys.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>VirtualFunction=</varname></term>
        <listitem>
          <para>Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move
          data in and out. Takes an integer in the range 0…2147483646. This option is compulsory.
          </para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>VLANId=</varname></term>
        <listitem>
          <para>Specifies VLAN ID of the virtual function. Takes an integer in the range 1…4095.</para>
 
        <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QualityOfService=</varname></term>
        <listitem>
          <para>Specifies quality of service of the virtual function. Takes an integer in the range
          1…4294967294.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>VLANProtocol=</varname></term>
        <listitem>
          <para>Specifies VLAN protocol of the virtual function. Takes <literal>802.1Q</literal> or
          <literal>802.1ad</literal>.</para>
 
        <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MACSpoofCheck=</varname></term>
        <listitem>
          <para>Takes a boolean. Controls the MAC spoof checking. When unset, the kernel's default will
          be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>QueryReceiveSideScaling=</varname></term>
        <listitem>
          <para>Takes a boolean. Toggle the ability of querying the receive side scaling (RSS)
          configuration of the virtual function (VF). The VF RSS information like RSS hash key may be
          considered sensitive on some devices where this information is shared between VF and the
          physical function (PF). When unset, the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>Trust=</varname></term>
        <listitem>
          <para>Takes a boolean. Allows one to set trust mode of the virtual function (VF). When set,
          VF users can set a specific feature which may impact security and/or performance. When unset,
          the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LinkState=</varname></term>
        <listitem>
          <para>Allows one to set the link state of the virtual function (VF). Takes a boolean or a
          special value <literal>auto</literal>. Setting to <literal>auto</literal> means a
          reflection of the physical function (PF) link state, <literal>yes</literal> lets the VF to
          communicate with other VFs on this host even if the PF link state is down,
          <literal>no</literal> causes the hardware to drop any packets sent by the VF. When unset,
          the kernel's default will be used.</para>
 
          <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>MACAddress=</varname></term>
        <listitem>
          <para>Specifies the MAC address for the virtual function.</para>
 
        <xi:include href="version-info.xml" xpointer="v251"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>[EnergyEfficientEthernet] Section Options</title>
    <para>The [EnergyEfficientEthernet] section controls the Energy Efficient Ethernet (EEE) feature of the
    interface, and accepts the following keys.</para>
 
    <variablelist class='network-directives'>
      <varlistentry>
        <term><varname>Enable=</varname></term>
        <listitem>
          <para>Takes a boolean argument. When true, the Energy Efficient Ethernet (EEE) feature will be
          enabled on the interface. Defaults to unset, and the enablement of EEE will be unchanged.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TxLowPowerIdle=</varname></term>
        <listitem>
          <para>Takes a boolean argument. When true, the transmit Low Power Idle (Tx-LPI) mode of the Energy
          Efficient Ethernet feature will be enabled on the interface. Defaults to unset, and the enablement
          of the mode will be unchanged.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>TxLowPowerIdleSec=</varname></term>
        <listitem>
          <para>Takes a timespan. This configures how long the interface should not enter the Low Power Idle
          mode after transmission. If it is too short, may decrease performance. If it is too long, may not
          gain energy saving. Defaults to unset, and the timespan will be unchanged.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
 
      <varlistentry>
        <term><varname>LinkMode=</varname></term>
        <listitem>
          <para>Takes a list of link modes, e.g. <literal>1000baset-full</literal>. See the table for
          <varname>Advertise=</varname> setting in [Link] section in the above for possible values. This
          configures the Energy Efficient Ethernet capable connection modes to be advertised. Defaults to
          unset, and the advertised modes will be unchanged.</para>
 
          <xi:include href="version-info.xml" xpointer="v258"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>Specifiers</title>
 
    <para>Some settings resolve specifiers which may be used to write generic unit files referring to runtime
    or unit parameters that are replaced when the unit files are loaded. Specifiers must be known and
    resolvable for the setting to be valid. The following specifiers are understood:</para>
 
    <table class='specifiers'>
      <title>Specifiers available in unit files</title>
      <tgroup cols='3' align='left' colsep='1' rowsep='1'>
        <colspec colname="spec" />
        <colspec colname="mean" />
        <colspec colname="detail" />
        <thead>
          <row>
            <entry>Specifier</entry>
            <entry>Meaning</entry>
            <entry>Details</entry>
          </row>
        </thead>
        <tbody>
          <xi:include href="standard-specifiers.xml" xpointer="a"/>
          <xi:include href="standard-specifiers.xml" xpointer="A"/>
          <xi:include href="standard-specifiers.xml" xpointer="b"/>
          <xi:include href="standard-specifiers.xml" xpointer="B"/>
          <xi:include href="standard-specifiers.xml" xpointer="H"/>
          <xi:include href="standard-specifiers.xml" xpointer="l"/>
          <xi:include href="standard-specifiers.xml" xpointer="m"/>
          <xi:include href="standard-specifiers.xml" xpointer="M"/>
          <xi:include href="standard-specifiers.xml" xpointer="o"/>
          <xi:include href="standard-specifiers.xml" xpointer="q"/>
          <xi:include href="standard-specifiers.xml" xpointer="T"/>
          <xi:include href="standard-specifiers.xml" xpointer="v"/>
          <xi:include href="standard-specifiers.xml" xpointer="V"/>
          <xi:include href="standard-specifiers.xml" xpointer="w"/>
          <xi:include href="standard-specifiers.xml" xpointer="W"/>
        </tbody>
      </tgroup>
    </table>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
 
    <example>
      <title>/usr/lib/systemd/network/99-default.link</title>
 
      <para>The link file <filename>99-default.link</filename> that is shipped with systemd defines the
      default policies for the interface name, alternative names, and MAC address of links.</para>
 
      <programlisting>[Match]
OriginalName=*
 
[Link]
NamePolicy=keep kernel database onboard slot path
AlternativeNamesPolicy=database onboard slot path
MACAddressPolicy=persistent</programlisting>
    </example>
 
    <example>
      <title>/etc/systemd/network/10-dmz.link</title>
 
      <para>This example assigns the fixed name <literal>dmz0</literal> to the interface with the MAC address
      00:a0:de:63:7a:e6:</para>
 
      <programlisting>[Match]
MACAddress=00:a0:de:63:7a:e6
 
[Link]
Name=dmz0</programlisting>
 
      <para><varname>NamePolicy=</varname> is not set, so <varname>Name=</varname> takes effect. We use the
      <literal>10-</literal> prefix to order this file early in the list. Note that it needs to be before
      <filename>99-default.link</filename>, i.e. it needs a numerical prefix, to have any effect at all.</para>
    </example>
 
    <example>
      <title>(Re-)applying a .link file to an interface</title>
 
      <para>After a new .link file has been created, or an existing .link file modified, the new settings
      may be applied to the matching interface with the following commands:</para>
 
      <programlisting>$ sudo udevadm control --reload
$ sudo ip link set eth0 down
$ sudo udevadm trigger --verbose --settle --action add /sys/class/net/eth0</programlisting>
 
      <para>You may also need to stop the service that manages the network interface, e.g.
      <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      or <filename>NetworkManager.service</filename> before the above operation, and then restart the service
      after that. For more details about <command>udevadm</command> command, see
      <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
    </example>
 
    <example>
      <title>Debugging <varname>NamePolicy=</varname> assignments</title>
 
      <programlisting>$ sudo SYSTEMD_LOG_LEVEL=debug udevadm test-builtin net_setup_link /sys/class/net/hub0
…
Parsed configuration file /usr/lib/systemd/network/99-default.link
Parsed configuration file /etc/systemd/network/10-eth0.link
ID_NET_DRIVER=cdc_ether
Config file /etc/systemd/network/10-eth0.link applies to device hub0
link_config: autonegotiation is unset or enabled, the speed and duplex are not writable.
hub0: Device has name_assign_type=4
Using default interface naming scheme 'v240'.
hub0: Policies did not yield a name, using specified Name=hub0.
ID_NET_LINK_FILE=/etc/systemd/network/10-eth0.link
ID_NET_NAME=hub0
…</programlisting>
 
     <para>Explicit <varname>Name=</varname> configuration wins in this case.</para>
 
     <programlisting>sudo SYSTEMD_LOG_LEVEL=debug udevadm test-builtin net_setup_link /sys/class/net/enp0s31f6
…
Parsed configuration file /usr/lib/systemd/network/99-default.link
Parsed configuration file /etc/systemd/network/10-eth0.link
Created link configuration context.
ID_NET_DRIVER=e1000e
Config file /usr/lib/systemd/network/99-default.link applies to device enp0s31f6
link_config: autonegotiation is unset or enabled, the speed and duplex are not writable.
enp0s31f6: Device has name_assign_type=4
Using default interface naming scheme 'v240'.
enp0s31f6: Policy *keep*: keeping existing userspace name
enp0s31f6: Device has addr_assign_type=0
enp0s31f6: MAC on the device already matches policy *persistent*
ID_NET_LINK_FILE=/usr/lib/systemd/network/99-default.link
…
</programlisting>
 
     <para>In this case, the interface was already renamed, so the <option>keep</option> policy specified as
     the first option in <filename index="false">99-default.link</filename> means that the existing name is
     preserved. If <option>keep</option> was removed, or if were in boot before the renaming has happened,
     we might get the following instead:</para>
 
     <programlisting>enp0s31f6: Policy *path* yields "enp0s31f6".
enp0s31f6: Device has addr_assign_type=0
enp0s31f6: MAC on the device already matches policy *persistent*
ID_NET_LINK_FILE=/usr/lib/systemd/network/99-default.link
ID_NET_NAME=enp0s31f6
…
</programlisting>
 
      <para>Please note that the details of output are subject to change.</para>
    </example>
 
    <example>
      <title>/etc/systemd/network/10-internet.link</title>
 
      <para>This example assigns the fixed name
      <literal>internet0</literal> to the interface with the device
      path <literal>pci-0000:00:1a.0-*</literal>:</para>
 
      <programlisting>[Match]
Path=pci-0000:00:1a.0-*
 
[Link]
Name=internet0</programlisting>
    </example>
 
    <example>
      <title>/etc/systemd/network/25-wireless.link</title>
 
      <para>Here's an overly complex example that shows the use of a large number of [Match] and [Link] settings.</para>
 
      <programlisting>[Match]
MACAddress=12:34:56:78:9a:bc
Driver=brcmsmac
Path=pci-0000:02:00.0-*
Type=wlan
Virtualization=no
Host=my-laptop
Architecture=x86-64
 
[Link]
Name=wireless0
MTUBytes=1450
BitsPerSecond=10M
WakeOnLan=magic
MACAddress=cb:a9:87:65:43:21</programlisting>
    </example>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
    <para><simplelist type="inline">
      <member><citerefentry>
        <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry></member>
      <member><citerefentry>
        <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry></member>
      <member><citerefentry>
        <refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry></member>
      <member><citerefentry>
        <refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry></member>
      <member><citerefentry>
        <refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry></member>
    </simplelist></para>
  </refsect1>
 
</refentry>