diff options
Diffstat (limited to 'man/systemd.link.xml')
| -rw-r--r-- | man/systemd.link.xml | 145 |
1 files changed, 128 insertions, 17 deletions
diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 063f8e3..3991d91 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.link" @@ -35,7 +35,9 @@ <para>The <filename>.link</filename> files are read from the files located in the system network directory <filename>/usr/lib/systemd/network</filename> and - <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory + <filename>/usr/local/lib/systemd/network</filename> + <xi:include href="standard-conf.xml" xpointer="usr-local-footnote" />, + the volatile runtime network directory <filename>/run/systemd/network</filename>, and the local administration network directory <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live. However, files @@ -361,7 +363,60 @@ <listitem> <para>A description of the device.</para> - <xi:include href="version-info.xml" xpointer="v211"/> + <xi:include href="version-info.xml" xpointer="v211"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Property=</varname></term> + <listitem> + <para>Set specified udev properties. This takes space separated list of key-value pairs + concatenated with equal sign (<literal>=</literal>). Example: + <programlisting>Property=HOGE=foo BAR=baz</programlisting> + This option supports simple specifier expansion, see the Specifiers section below. + This option can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + + <para>This setting is useful to configure the <literal>ID_NET_MANAGED_BY=</literal> property which + declares which network management service shall manage the interface, which is respected by + systemd-networkd and others. Use + <programlisting>Property=ID_NET_MANAGED_BY=io.systemd.Network</programlisting> + to declare explicitly that <command>systemd-networkd</command> shall manage the interface, or set + the property to something else to declare explicitly it shall not do so. See + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details how this property is used to match interface names.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ImportProperty=</varname></term> + <listitem> + <para>Import specified udev properties from the saved database. This takes space separated list of + property names. Example: <programlisting>ImportProperty=HOGE BAR</programlisting> + This option supports simple specifier expansion, see the Specifiers section below. + This option can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + <para>If the same property is also set in <varname>Property=</varname> in the above, then the + imported property value will be overridden by the value specified in <varname>Property=</varname>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UnsetProperty=</varname></term> + <listitem> + <para>Unset specified udev properties. This takes space separated list of + property names. Example: <programlisting>ImportProperty=HOGE BAR</programlisting> + This option supports simple specifier expansion, see the Specifiers section below. + This option can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + <para>This setting is applied after <varname>ImportProperty=</varname> and + <varname>Property=</varname> are applied. Hence, if the same property is specified in + <varname>ImportProperty=</varname> or <varname>Property=</varname>, then the imported or specified + property value will be ignored, and the property will be unset.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> </listitem> </varlistentry> <varlistentry> @@ -369,7 +424,7 @@ <listitem> <para>The <varname>ifalias</varname> interface property is set to this value.</para> - <xi:include href="version-info.xml" xpointer="v211"/> + <xi:include href="version-info.xml" xpointer="v211"/> </listitem> </varlistentry> <varlistentry> @@ -552,7 +607,7 @@ an allowed character, it's recommended to avoid it when naming interfaces as various tools (such as <citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>1</manvolnum></citerefentry>) use it as separator character. Also, fully numeric interface names are not allowed (in order to avoid - ambiguity with interface specification by numeric indexes), as are the special strings + ambiguity with interface specification by numeric indexes), nor are the special strings <literal>.</literal>, <literal>..</literal>, <literal>all</literal> and <literal>default</literal>.</para> @@ -915,6 +970,21 @@ </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> in 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 CPU affinity masks are merged. + If an empty string is assigned, the mask 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>ReceiveVLANCTAGHardwareAcceleration=</varname></term> <listitem> <para>Takes a boolean. If set to true, receive VLAN CTAG hardware acceleration is enabled. @@ -1261,6 +1331,47 @@ </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> @@ -1403,23 +1514,23 @@ MACAddress=cb:a9:87:65:43:21</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry> + <para><simplelist type="inline"> + <member><citerefentry> <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry> - </para> + </citerefentry></member> + </simplelist></para> </refsect1> </refentry> |