2018-07-02 21:15:39 +00:00
<?xml version='1.0'?>
2019-03-14 13:40:58 +00:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2015-06-18 17:47:44 +00:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2020-11-09 04:23:58 +00:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2014-02-25 18:30:40 +00:00
2020-01-08 10:43:09 +00:00
<refentry id= "systemd.network" conditional= 'ENABLE_NETWORKD'
xmlns:xi="http://www.w3.org/2001/XInclude">
2014-02-25 18:30:40 +00:00
2015-02-04 02:14:13 +00:00
<refentryinfo >
<title > systemd.network</title>
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > systemd.network</refentrytitle>
<manvolnum > 5</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd.network</refname>
<refpurpose > Network configuration</refpurpose>
</refnamediv>
<refsynopsisdiv >
<para > <filename > <replaceable > network</replaceable> .network</filename> </para>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
2020-03-03 18:08:26 +00:00
<para > A plain ini-style text file that encodes network configuration for matching network interfaces,
used by
2015-02-04 02:14:13 +00:00
<citerefentry > <refentrytitle > systemd-networkd</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
2020-07-10 22:05:23 +00:00
See <citerefentry > <refentrytitle > systemd.syntax</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
2020-03-03 18:08:26 +00:00
for a general description of the syntax.</para>
2015-02-04 02:14:13 +00:00
2016-09-10 13:34:07 +00:00
<para > The main network file must have the extension <filename > .network</filename> ; other
extensions are ignored. Networks are applied to links whenever the links appear.</para>
2019-01-02 13:30:24 +00:00
<para > The <filename > .network</filename> files are read from the files located in the system network
directories <filename > /usr/lib/systemd/network</filename> and
<filename > /usr/local/lib/systemd/network</filename> , 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 lexical order, regardless of the directories in which they live. However, files with identical
2020-10-05 16:08:21 +00:00
filenames replace each other. Files in <filename > /etc/</filename> have the highest priority, files in
<filename > /run/</filename> take precedence over files with the same name under
<filename > /usr/</filename> . This can be used to override a system-supplied configuration file with a local
2019-01-02 13:30:24 +00:00
file if needed. As a special case, an empty file (file size 0) or symlink with the same name pointing to
<filename > /dev/null</filename> disables the configuration file entirely (it is "masked").</para>
2016-09-10 13:34:07 +00:00
<para > Along with the network file <filename > foo.network</filename> , a "drop-in" directory
<filename > foo.network.d/</filename> may exist. All files with the suffix
2021-05-20 06:55:06 +00:00
<literal > .conf</literal> from this directory will be merged in the alphanumeric order and parsed
after the main file itself has been parsed. This is useful to alter or add configuration settings,
without having to modify the main configuration file. Each drop-in file must have appropriate
section headers.</para>
2016-09-10 13:34:07 +00:00
<para > In addition to <filename > /etc/systemd/network</filename> , drop-in <literal > .d</literal>
directories can be placed in <filename > /usr/lib/systemd/network</filename> or
<filename > /run/systemd/network</filename> directories. Drop-in files in
2020-10-05 16:08:21 +00:00
<filename > /etc/</filename> take precedence over those in <filename > /run/</filename> which in turn
take precedence over those in <filename > /usr/lib/</filename> . Drop-in files under any of these
2019-08-17 16:30:57 +00:00
directories take precedence over the main network file wherever located.</para>
2015-02-04 02:14:13 +00:00
</refsect1>
<refsect1 >
<title > [Match] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The network file contains a [Match] section, which determines if a given network file may be
applied to a given device; and a [Network] section specifying how the device should be configured. The
first (in lexical order) of the network files that matches a given device is applied, all later files
are ignored, even if they match as well.</para>
<para > A network file is said to match a network interface if all matches specified by the [Match]
section are satisfied. When a network file does not contain valid settings in [Match] section, then the
file will match all interfaces and <command > systemd-networkd</command> warns about that. Hint: to avoid
the warning and to make it clear that all interfaces shall be matched, add the following:
<programlisting > Name=*</programlisting> The following keys are accepted:</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
2020-01-08 10:43:09 +00:00
<xi:include href= "systemd.link.xml" xpointer= "mac-address" />
<xi:include href= "systemd.link.xml" xpointer= "permanent-mac-address" />
<xi:include href= "systemd.link.xml" xpointer= "path" />
<xi:include href= "systemd.link.xml" xpointer= "driver" />
<xi:include href= "systemd.link.xml" xpointer= "type" />
<xi:include href= "systemd.link.xml" xpointer= "property" />
2018-05-09 03:00:16 +00:00
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > Name=</varname> </term>
<listitem >
2019-12-15 13:46:19 +00:00
<para > A whitespace-separated list of shell-style globs matching the device name, as exposed
by the udev property <literal > INTERFACE</literal> , or device's alternative names. If the
list is prefixed with a "!", the test is inverted.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2019-06-22 16:44:13 +00:00
2019-10-25 07:29:23 +00:00
<varlistentry >
2019-10-25 12:18:23 +00:00
<term > <varname > WLANInterfaceType=</varname> </term>
2019-10-25 07:29:23 +00:00
<listitem >
<para > A whitespace-separated list of wireless network type. Supported values are
<literal > ad-hoc</literal> , <literal > station</literal> , <literal > ap</literal> ,
<literal > ap-vlan</literal> , <literal > wds</literal> , <literal > monitor</literal> ,
<literal > mesh-point</literal> , <literal > p2p-client</literal> , <literal > p2p-go</literal> ,
<literal > p2p-device</literal> , <literal > ocb</literal> , and <literal > nan</literal> . If the
list is prefixed with a "!", the test is inverted.
</para>
</listitem>
</varlistentry>
2020-01-08 10:43:09 +00:00
2019-07-24 05:46:55 +00:00
<varlistentry >
<term > <varname > SSID=</varname> </term>
<listitem >
<para > A whitespace-separated list of shell-style globs matching the SSID of the currently
connected wireless LAN. If the list is prefixed with a "!", the test is inverted.
</para>
</listitem>
</varlistentry>
2020-01-08 10:43:09 +00:00
2019-07-24 06:32:24 +00:00
<varlistentry >
<term > <varname > BSSID=</varname> </term>
<listitem >
<para > A whitespace-separated list of hardware address of the currently connected wireless
LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in
2020-07-06 08:49:59 +00:00
<varname > MACAddress=</varname> . 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 is reset.</para>
2019-07-24 06:32:24 +00:00
</listitem>
</varlistentry>
2020-01-08 10:43:09 +00:00
<xi:include href= "systemd.link.xml" xpointer= "host" />
<xi:include href= "systemd.link.xml" xpointer= "virtualization" />
<xi:include href= "systemd.link.xml" xpointer= "kernel-command-line" />
<xi:include href= "systemd.link.xml" xpointer= "kernel-version" />
<xi:include href= "systemd.link.xml" xpointer= "architecture" />
2021-11-10 01:56:42 +00:00
<xi:include href= "systemd.link.xml" xpointer= "firmware" />
2015-02-04 02:14:13 +00:00
</variablelist>
</refsect1>
<refsect1 >
<title > [Link] Section Options</title>
2021-09-02 21:09:54 +00:00
<para > The [Link] section accepts the following keys:</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > MACAddress=</varname> </term>
<listitem >
2016-05-08 19:58:34 +00:00
<para > The hardware address to set for the device.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MTUBytes=</varname> </term>
<listitem >
<para > The maximum transmission unit in bytes to set for the
device. The usual suffixes K, M, G, are supported and are
understood to the base of 1024.</para>
2016-04-21 00:34:13 +00:00
<para > Note that if IPv6 is enabled on the interface, and the MTU is chosen
below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2016-08-04 14:00:58 +00:00
<varlistentry >
<term > <varname > ARP=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol)
for this interface is enabled. When unset, the kernel's default will be used.</para>
2016-08-04 14:00:58 +00:00
<para > For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
interfaces atop a single lower-level physical interface, which will then only serve as a
link/"bridge" device aggregating traffic to the same physical link and not participate in
2020-12-15 04:00:17 +00:00
the network otherwise. Defaults to unset.</para>
2016-08-04 14:00:58 +00:00
</listitem>
</varlistentry>
2018-05-29 14:58:11 +00:00
<varlistentry >
<term > <varname > Multicast=</varname> </term>
<listitem >
2020-12-15 04:00:17 +00:00
<para > Takes a boolean. If set to true, the multicast flag on the device is enabled. Defaults to unset.</para>
2018-06-01 14:22:12 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > AllMulticast=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. If set to true, the driver retrieves all multicast packets from the network.
2020-12-15 04:00:17 +00:00
This happens when multicast routing is enabled. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Promiscuous=</varname> </term>
<listitem >
<para > Takes a boolean. If set to true, promiscuous mode of the interface is enabled.
Defaults to unset.</para>
2021-08-17 14:53:29 +00:00
<para > If this is set to false for the underlying link of a <literal > passthru</literal> mode MACVLAN/MACVTAP,
the virtual interface will be created with the <literal > nopromisc</literal> flag set.</para>
2018-05-29 14:58:11 +00:00
</listitem>
</varlistentry>
2016-09-27 22:18:14 +00:00
<varlistentry >
<term > <varname > Unmanaged=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. When <literal > yes</literal> , no attempts are
2016-09-27 22:18:14 +00:00
made to bring up or configure matching links, equivalent to
when there are no matching network files. Defaults to
<literal > no</literal> .</para>
<para > This is useful for preventing later matching network
files from interfering with certain interfaces that are fully
controlled by other applications.</para>
</listitem>
</varlistentry>
2020-04-07 12:36:55 +00:00
<varlistentry >
<term > <varname > Group=</varname> </term>
<listitem >
2021-05-21 05:11:36 +00:00
<para > Link groups are similar to port ranges found in managed switches. When network interfaces
are added to a numbered group, operations on all the interfaces from that group can be
performed at once. Takes an unsigned integer in the range 0…4294967295. Defaults to unset.
</para>
2020-04-07 12:36:55 +00:00
</listitem>
2021-01-04 15:40:47 +00:00
</varlistentry>
2017-11-30 17:03:50 +00:00
<varlistentry >
<term > <varname > RequiredForOnline=</varname> </term>
<listitem >
2020-01-09 20:31:50 +00:00
<para > Takes a boolean or a minimum operational state and an optional maximum operational state.
Please see <citerefentry > <refentrytitle > networkctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
2019-03-06 14:47:29 +00:00
for possible operational states. When <literal > yes</literal> , the network is deemed required when
2021-04-06 13:56:05 +00:00
determining whether the system is online (including when running
<command > systemd-networkd-wait-online</command> ). When <literal > no</literal> , the network is ignored
when determining the online state. When a minimum operational state and an optional maximum operational
2020-01-09 20:31:50 +00:00
state are set, <literal > yes</literal> is implied, and this controls the minimum and maximum
2021-06-08 16:01:31 +00:00
operational state required for the network interface to be considered online.</para>
2019-03-06 14:47:29 +00:00
2021-06-08 16:01:31 +00:00
<para > Defaults to <literal > yes</literal> when <varname > ActivationPolicy=</varname> is not set,
or set to <literal > up</literal> , <literal > always-up</literal> , or <literal > bound</literal> .
Defaults to <literal > no</literal> when <varname > ActivationPolicy=</varname> is set to
<literal > manual</literal> or <literal > down</literal> . This is forced to <literal > no</literal>
when <varname > ActivationPolicy=</varname> is set to <literal > always-down</literal> .</para>
<para > The network will be brought up normally (as configured by <varname > ActivationPolicy=</varname> ),
but in the event that there is no address being assigned by DHCP or the
2017-11-30 17:03:50 +00:00
cable is not plugged in, the link will simply remain offline and be
2019-03-06 14:47:29 +00:00
skipped automatically by <command > systemd-networkd-wait-online</command>
2018-10-10 07:13:39 +00:00
if <literal > RequiredForOnline=no</literal> .</para>
2017-11-30 17:03:50 +00:00
</listitem>
</varlistentry>
2021-04-11 20:29:11 +00:00
<varlistentry >
<term > <varname > RequiredFamilyForOnline=</varname> </term>
<listitem >
2021-04-16 13:04:24 +00:00
<para > Takes an address family. When specified, an IP address in the given family is deemed required
when determining whether the link is online (including when running
<command > systemd-networkd-wait-online</command> ). Takes one of <literal > ipv4</literal> ,
<literal > ipv6</literal> , <literal > both</literal> , or <literal > any</literal> . Defaults to
<literal > any</literal> . Note that this option has no effect if
<literal > RequiredForOnline=no</literal> , or if <literal > RequiredForOnline=</literal> specifies a
minimum operational state below <literal > degraded</literal> .</para>
2021-04-11 20:29:11 +00:00
</listitem>
</varlistentry>
network: add ActivationPolicy= configuration parameter
This parameter allows configuring the activation policy for an interface,
meaning how it manages the interface's administrative state (IFF_UP flag).
The policy can be configured to bring the interface either up or down when
the interface is (re)configured, to always force the interface either up or
down, or to never change the interface administrative state.
If the interface is bound with BindCarrier=, its administrative state is
controlled by the interface(s) it's bound to, and this parameter is forced
to 'bound'.
This changes the default behavior of how systemd-networkd sets the IFF_UP
flag; previously, it was set up (if not already up) every time the
link_joined() function was called. Now, with the default ActivationPolicy=
setting of 'up', it will only set the IFF_UP flag once, the first time
link_joined() is called, during an interface's configuration; and on
the first link_joined() call each time the interface is reconfigured.
Fixes: #3031
Fixes: #17437
2020-06-18 20:09:40 +00:00
<varlistentry >
<term > <varname > ActivationPolicy=</varname> </term>
<listitem >
<para > Specifies the policy for <command > systemd-networkd</command> managing the link
administrative state. Specifically, this controls how <command > systemd-networkd</command>
changes the network device's <literal > IFF_UP</literal> flag, which is sometimes
controlled by system administrators by running e.g., <command > ip set dev eth0 up</command>
or <command > ip set dev eth0 down</command> , and can also be changed with
<command > networkctl up eth0</command> or <command > networkctl down eth0</command> .</para>
<para > Takes one of <literal > up</literal> , <literal > always-up</literal> ,
<literal > manual</literal> , <literal > always-down</literal> , <literal > down</literal> ,
or <literal > bound</literal> . When <literal > manual</literal> , <command > systemd-networkd</command>
will not change the link's admin state automatically; the system administrator must bring the
interface up or down manually, as desired. When <literal > up</literal> (the default) or
<literal > always-up</literal> , or <literal > down</literal> or <literal > always-down</literal> ,
<command > systemd-networkd</command> will set the link up or down, respectively,
when the interface is (re)configured. When <literal > always-up</literal> or
<literal > always-down</literal> , <command > systemd-networkd</command> will set the link up
or down, respectively, any time <command > systemd-networkd</command> detects a change in
the administrative state. When <varname > BindCarrier=</varname> is also set, this is
automatically set to <literal > bound</literal> and any other value is ignored.</para>
2021-06-08 16:01:31 +00:00
<para > When the policy is set to <literal > down</literal> or <literal > manual</literal> ,
the default value of <varname > RequiredForOnline=</varname> is <literal > no</literal> .
When the policy is set to <literal > always-down</literal> , the value of
<varname > RequiredForOnline=</varname> forced to <literal > no</literal> .</para>
network: add ActivationPolicy= configuration parameter
This parameter allows configuring the activation policy for an interface,
meaning how it manages the interface's administrative state (IFF_UP flag).
The policy can be configured to bring the interface either up or down when
the interface is (re)configured, to always force the interface either up or
down, or to never change the interface administrative state.
If the interface is bound with BindCarrier=, its administrative state is
controlled by the interface(s) it's bound to, and this parameter is forced
to 'bound'.
This changes the default behavior of how systemd-networkd sets the IFF_UP
flag; previously, it was set up (if not already up) every time the
link_joined() function was called. Now, with the default ActivationPolicy=
setting of 'up', it will only set the IFF_UP flag once, the first time
link_joined() is called, during an interface's configuration; and on
the first link_joined() call each time the interface is reconfigured.
Fixes: #3031
Fixes: #17437
2020-06-18 20:09:40 +00:00
<para > The administrative state is not the same as the carrier state, so using
<literal > always-up</literal> does not mean the link will never lose carrier. The link
carrier depends on both the administrative state as well as the network device's physical
connection. However, to avoid reconfiguration failures, when using <literal > always-up</literal> ,
<varname > IgnoreCarrierLoss=</varname> is forced to true.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
</variablelist>
</refsect1>
2020-06-21 11:17:34 +00:00
<refsect1 >
<title > [SR-IOV] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [SR-IOV] section accepts the following keys. Specify several [SR-IOV] sections to configure
several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource into virtual
PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves
north-south network performance (that is, traffic with endpoints outside the host machine) by allowing
traffic to bypass the host machine’ </para>
2020-06-21 11:17:34 +00:00
<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
2021-01-28 19:42:37 +00:00
in and out. Takes an unsigned integer in the range 0…2147483646. This option is compulsory.</para>
2020-06-21 11:17:34 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > VLANId=</varname> </term>
<listitem >
2021-01-28 19:42:37 +00:00
<para > Specifies VLAN ID of the virtual function. Takes an unsigned integer in the range 1…4095.</para>
2020-06-21 11:17:34 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > QualityOfService=</varname> </term>
<listitem >
2021-01-28 19:42:37 +00:00
<para > Specifies quality of service of the virtual function. Takes an unsigned integer in the range 1…4294967294.</para>
2020-06-21 11:17:34 +00:00
</listitem>
2020-06-22 10:26:31 +00:00
</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>
</listitem>
2020-06-21 11:17:34 +00:00
</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>
</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>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Trust=</varname> </term>
<listitem >
<para > Takes a boolean. Allows 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>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > LinkState=</varname> </term>
<listitem >
<para > Allows 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>
</listitem>
</varlistentry>
2020-06-22 10:48:33 +00:00
<varlistentry >
<term > <varname > MACAddress=</varname> </term>
<listitem >
<para > Specifies the MAC address for the virtual function.</para>
</listitem>
</varlistentry>
2020-06-21 11:17:34 +00:00
</variablelist>
</refsect1>
2015-02-04 02:14:13 +00:00
<refsect1 >
<title > [Network] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [Network] section accepts the following keys:</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Description=</varname> </term>
<listitem >
<para > A description of the device. This is only used for
presentation purposes.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DHCP=</varname> </term>
<listitem >
2015-08-27 15:32:30 +00:00
<para > Enables DHCPv4 and/or DHCPv6 client support. Accepts
2015-02-04 02:14:13 +00:00
<literal > yes</literal> , <literal > no</literal> ,
2017-07-21 20:21:30 +00:00
<literal > ipv4</literal> , or <literal > ipv6</literal> . Defaults
to <literal > no</literal> .</para>
2015-05-19 02:34:07 +00:00
networkd: IPv6 router discovery - follow IPv6AcceptRouterAdvertisemnt=
The previous behavior:
When DHCPv6 was enabled, router discover was performed first, and then DHCPv6 was
enabled only if the relevant flags were passed in the Router Advertisement message.
Moreover, router discovery was performed even if AcceptRouterAdvertisements=false,
moreover, even if router advertisements were accepted (by the kernel) the flags
indicating that DHCPv6 should be performed were ignored.
New behavior:
If RouterAdvertisements are accepted, and either no routers are found, or an
advertisement is received indicating DHCPv6 should be performed, the DHCPv6
client is started. Moreover, the DHCP option now truly enables the DHCPv6
client regardless of router discovery (though it will probably not be
very useful to get a lease withotu any routes, this seems the more consistent
approach).
The recommended default setting should be to set DHCP=ipv4 and to leave
IPv6AcceptRouterAdvertisements unset.
2015-10-18 16:25:58 +00:00
<para > Note that DHCPv6 will by default be triggered by Router
2015-12-26 17:25:49 +00:00
Advertisement, if that is enabled, regardless of this parameter.
networkd: IPv6 router discovery - follow IPv6AcceptRouterAdvertisemnt=
The previous behavior:
When DHCPv6 was enabled, router discover was performed first, and then DHCPv6 was
enabled only if the relevant flags were passed in the Router Advertisement message.
Moreover, router discovery was performed even if AcceptRouterAdvertisements=false,
moreover, even if router advertisements were accepted (by the kernel) the flags
indicating that DHCPv6 should be performed were ignored.
New behavior:
If RouterAdvertisements are accepted, and either no routers are found, or an
advertisement is received indicating DHCPv6 should be performed, the DHCPv6
client is started. Moreover, the DHCP option now truly enables the DHCPv6
client regardless of router discovery (though it will probably not be
very useful to get a lease withotu any routes, this seems the more consistent
approach).
The recommended default setting should be to set DHCP=ipv4 and to leave
IPv6AcceptRouterAdvertisements unset.
2015-10-18 16:25:58 +00:00
By enabling DHCPv6 support explicitly, the DHCPv6 client will
be started regardless of the presence of routers on the link,
or what flags the routers pass. See
2016-06-07 09:19:26 +00:00
<literal > IPv6AcceptRA=</literal> .</para>
networkd: IPv6 router discovery - follow IPv6AcceptRouterAdvertisemnt=
The previous behavior:
When DHCPv6 was enabled, router discover was performed first, and then DHCPv6 was
enabled only if the relevant flags were passed in the Router Advertisement message.
Moreover, router discovery was performed even if AcceptRouterAdvertisements=false,
moreover, even if router advertisements were accepted (by the kernel) the flags
indicating that DHCPv6 should be performed were ignored.
New behavior:
If RouterAdvertisements are accepted, and either no routers are found, or an
advertisement is received indicating DHCPv6 should be performed, the DHCPv6
client is started. Moreover, the DHCP option now truly enables the DHCPv6
client regardless of router discovery (though it will probably not be
very useful to get a lease withotu any routes, this seems the more consistent
approach).
The recommended default setting should be to set DHCP=ipv4 and to leave
IPv6AcceptRouterAdvertisements unset.
2015-10-18 16:25:58 +00:00
<para > Furthermore, note that by default the domain name
2015-05-19 02:34:07 +00:00
specified through DHCP is not used for name resolution.
See option <option > UseDomains=</option> below.</para>
2016-05-06 15:08:03 +00:00
2020-07-06 09:00:06 +00:00
<para > See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP
client support.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DHCPServer=</varname> </term>
<listitem >
2019-03-08 18:17:21 +00:00
<para > Takes a boolean. If set to <literal > yes</literal> , DHCPv4 server will be started. Defaults
2020-07-06 09:00:06 +00:00
to <literal > no</literal> . Further settings for the DHCP server may be set in the [DHCPServer]
2015-08-27 15:32:30 +00:00
section described below.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
2015-02-13 23:32:26 +00:00
<term > <varname > LinkLocalAddressing=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
networkd: merge ll addressing fallback modes into normal "boolean" values
They are not really boolean, because we have both ipv4 and ipv6, but
for each protocol we have either unset, no, and yes.
From https://github.com/systemd/systemd/issues/13316#issuecomment-582906817:
LinkLocalAddressing must be a boolean option, at least for ipv4:
- LinkLocalAddressing=no => no LL at all.
- LinkLocalAddressing=yes + Static Address => invalid configuration, warn and
interpret as LinkLocalAddressing=no, no LL at all.
(we check that during parsing and reject)
- LinkLocalAddressing=yes + DHCP => LL process should be subordinated to the
DHCP one, an LL address must be acquired at start or after a short N
unsuccessful DHCP attemps, and must not stop DHCP to keeping trying. When a
DHCP address is acquired, drop the LL address. If the DHCP address is lost,
re-adquire a new LL address.
(next patch will move in this direction)
- LinkLocalAddressing=fallback has no reason to exist, because LL address must
always be allocated as a fallback option when using DHCP. Having both DHCP
and LL address at the same time is an RFC violation, so
LinkLocalAdressing=yes correctly implemented is already the "fallback"
behavior. The fallback option must be deprecated and if present in older
configs must be interpreted as LinkLocalAddressing=yes.
(removed)
- And for IPv6, the LinkLocalAddress option has any sense at all? IPv6-LL
address aren't required to be always set for every IPv6 enabled interface (in
this case, coexisting with static or dynamic address if any)? Shouldn't be
always =yes?
(good question)
This effectively reverts 29e81083bd2fcb2dbf83f67ef358c7d25adf7e9d. There is no
special "fallback" mode now, so the check doesn't make sense anymore.
2020-10-08 14:59:26 +00:00
<para > Enables link-local address autoconfiguration. Accepts <option > yes</option> ,
<option > no</option> , <option > ipv4</option> , and <option > ipv6</option> . An IPv6 link-local address
is configured when <option > yes</option> or <option > ipv6</option> . An IPv4 link-local address is
2020-10-08 18:14:51 +00:00
configured when <option > yes</option> or <option > ipv4</option> and when DHCPv4 autoconfiguration
has been unsuccessful for some time. (IPv4 link-local address autoconfiguration will usually
happen in parallel with repeated attempts to acquire a DHCPv4 lease).</para>
networkd: merge ll addressing fallback modes into normal "boolean" values
They are not really boolean, because we have both ipv4 and ipv6, but
for each protocol we have either unset, no, and yes.
From https://github.com/systemd/systemd/issues/13316#issuecomment-582906817:
LinkLocalAddressing must be a boolean option, at least for ipv4:
- LinkLocalAddressing=no => no LL at all.
- LinkLocalAddressing=yes + Static Address => invalid configuration, warn and
interpret as LinkLocalAddressing=no, no LL at all.
(we check that during parsing and reject)
- LinkLocalAddressing=yes + DHCP => LL process should be subordinated to the
DHCP one, an LL address must be acquired at start or after a short N
unsuccessful DHCP attemps, and must not stop DHCP to keeping trying. When a
DHCP address is acquired, drop the LL address. If the DHCP address is lost,
re-adquire a new LL address.
(next patch will move in this direction)
- LinkLocalAddressing=fallback has no reason to exist, because LL address must
always be allocated as a fallback option when using DHCP. Having both DHCP
and LL address at the same time is an RFC violation, so
LinkLocalAdressing=yes correctly implemented is already the "fallback"
behavior. The fallback option must be deprecated and if present in older
configs must be interpreted as LinkLocalAddressing=yes.
(removed)
- And for IPv6, the LinkLocalAddress option has any sense at all? IPv6-LL
address aren't required to be always set for every IPv6 enabled interface (in
this case, coexisting with static or dynamic address if any)? Shouldn't be
always =yes?
(good question)
This effectively reverts 29e81083bd2fcb2dbf83f67ef358c7d25adf7e9d. There is no
special "fallback" mode now, so the check doesn't make sense anymore.
2020-10-08 14:59:26 +00:00
2021-09-02 21:10:07 +00:00
<para > Defaults to <option > no</option> when <varname > KeepMaster=</varname> or
<varname > Bridge=</varname> is set or when the specified
2021-08-25 09:50:01 +00:00
<varname > MACVLAN=</varname> /<varname > MACVTAP=</varname> has <varname > Mode=passthru</varname> , or
networkd: merge ll addressing fallback modes into normal "boolean" values
They are not really boolean, because we have both ipv4 and ipv6, but
for each protocol we have either unset, no, and yes.
From https://github.com/systemd/systemd/issues/13316#issuecomment-582906817:
LinkLocalAddressing must be a boolean option, at least for ipv4:
- LinkLocalAddressing=no => no LL at all.
- LinkLocalAddressing=yes + Static Address => invalid configuration, warn and
interpret as LinkLocalAddressing=no, no LL at all.
(we check that during parsing and reject)
- LinkLocalAddressing=yes + DHCP => LL process should be subordinated to the
DHCP one, an LL address must be acquired at start or after a short N
unsuccessful DHCP attemps, and must not stop DHCP to keeping trying. When a
DHCP address is acquired, drop the LL address. If the DHCP address is lost,
re-adquire a new LL address.
(next patch will move in this direction)
- LinkLocalAddressing=fallback has no reason to exist, because LL address must
always be allocated as a fallback option when using DHCP. Having both DHCP
and LL address at the same time is an RFC violation, so
LinkLocalAdressing=yes correctly implemented is already the "fallback"
behavior. The fallback option must be deprecated and if present in older
configs must be interpreted as LinkLocalAddressing=yes.
(removed)
- And for IPv6, the LinkLocalAddress option has any sense at all? IPv6-LL
address aren't required to be always set for every IPv6 enabled interface (in
this case, coexisting with static or dynamic address if any)? Shouldn't be
always =yes?
(good question)
This effectively reverts 29e81083bd2fcb2dbf83f67ef358c7d25adf7e9d. There is no
special "fallback" mode now, so the check doesn't make sense anymore.
2020-10-08 14:59:26 +00:00
<option > ipv6</option> otherwise.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2020-06-30 08:01:30 +00:00
<varlistentry >
<term > <varname > IPv6LinkLocalAddressGenerationMode=</varname> </term>
<listitem >
2021-05-21 23:15:00 +00:00
<para > Specifies how IPv6 link local address is generated. Takes one of
<literal > eui64</literal> , <literal > none</literal> , <literal > stable-privacy</literal> and
2021-06-07 21:21:57 +00:00
<literal > random</literal> . When unset, <literal > stable-privacy</literal> is used if
<varname > IPv6StableSecretAddress=</varname> is specified, and if not,
<literal > eui64</literal> is used. Note that if <varname > LinkLocalAddressing=</varname> is
<literal > no</literal> or <literal > ipv4</literal> , then
<varname > IPv6LinkLocalAddressGenerationMode=</varname> will be ignored. Also, even if
<varname > LinkLocalAddressing=</varname> is <literal > yes</literal> or
<literal > ipv6</literal> , setting <varname > IPv6LinkLocalAddressGenerationMode=none</varname>
disables to configure an IPv6 link-local address.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > IPv6StableSecretAddress=</varname> </term>
<listitem >
<para > Takes an IPv6 address. The specified address will be used as a stable secret for
generating IPv6 link-local address. If this setting is specified, and
<varname > IPv6LinkLocalAddressGenerationMode=</varname> is unset, then
<varname > IPv6LinkLocalAddressGenerationMode=stable-privacy</varname> is implied.
If this setting is not specified, and <literal > stable-privacy</literal> is set to
<varname > IPv6LinkLocalAddressGenerationMode=</varname> ,
then a stable secret address will be generated from the local machine ID and the interface
name.</para>
2020-06-30 08:01:30 +00:00
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > IPv4LLRoute=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. If set to true, sets up the route needed for
2015-02-04 02:14:13 +00:00
non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
to false.
</para>
</listitem>
</varlistentry>
2019-05-14 07:43:14 +00:00
<varlistentry >
<term > <varname > DefaultRouteOnDevice=</varname> </term>
<listitem >
<para > Takes a boolean. If set to true, sets up the default route bound to the interface.
Defaults to false. This is useful when creating routes on point-to-point interfaces.
2021-06-15 07:05:08 +00:00
This is equivalent to e.g. the following,
<programlisting > ip route add default dev veth99</programlisting>
or,
<programlisting > [Route]
Gateway=0.0.0.0</programlisting> </para>
<para > Currently, there are no way to specify e.g., the table for the route configured by
this setting. To configure the default route with such an additional property, please use
the following instead:
<programlisting > [Route]
Gateway=0.0.0.0
Table=1234</programlisting> </para>
2019-05-14 07:43:14 +00:00
</listitem>
</varlistentry>
2015-02-13 23:30:51 +00:00
<varlistentry >
2015-02-04 02:14:13 +00:00
<term > <varname > LLMNR=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean or <literal > resolve</literal> . When true,
2016-01-05 16:32:25 +00:00
enables <ulink
url="https://tools.ietf.org/html/rfc4795">Link-Local
Multicast Name Resolution</ulink> on the link. When set to
<literal > resolve</literal> , only resolution is enabled,
but not host registration and announcement. Defaults to
true. This setting is read by
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MulticastDNS=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean or <literal > resolve</literal> . When true,
2016-01-05 16:32:25 +00:00
enables <ulink
url="https://tools.ietf.org/html/rfc6762">Multicast
DNS</ulink> support on the link. When set to
<literal > resolve</literal> , only resolution is enabled,
but not host or service registration and
announcement. Defaults to false. This setting is read by
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2018-06-11 19:33:57 +00:00
<varlistentry >
2018-06-13 18:26:24 +00:00
<term > <varname > DNSOverTLS=</varname> </term>
2018-06-11 19:33:57 +00:00
<listitem >
2019-02-18 19:41:46 +00:00
<para > Takes a boolean or <literal > opportunistic</literal> .
When true, enables
2018-06-11 19:33:57 +00:00
<ulink
url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink>
2019-02-18 19:41:46 +00:00
support on the link.
When set to <literal > opportunistic</literal> , compatibility with
non-DNS-over-TLS servers is increased, by automatically
turning off DNS-over-TLS servers in this case.
This option defines a per-interface setting for
2018-06-11 19:33:57 +00:00
<citerefentry > <refentrytitle > resolved.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> 's
2018-06-13 18:26:24 +00:00
global <varname > DNSOverTLS=</varname> option. Defaults to
2018-06-11 19:33:57 +00:00
false. This setting is read by
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
2016-01-05 18:57:33 +00:00
<varlistentry >
<term > <varname > DNSSEC=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Takes a boolean or <literal > allow-downgrade</literal> . When true, enables
<ulink url= "https://tools.ietf.org/html/rfc4033" > DNSSEC</ulink>
2016-01-05 18:57:33 +00:00
DNS validation support on the link. When set to
<literal > allow-downgrade</literal> , compatibility with
non-DNSSEC capable networks is increased, by automatically
2017-08-03 21:36:21 +00:00
turning off DNSSEC in this case. This option defines a
2016-01-05 18:57:33 +00:00
per-interface setting for
<citerefentry > <refentrytitle > resolved.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> 's
global <varname > DNSSEC=</varname> option. Defaults to
false. This setting is read by
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
2016-01-06 17:36:32 +00:00
<varlistentry >
<term > <varname > DNSSECNegativeTrustAnchors=</varname> </term>
<listitem > <para > A space-separated list of DNSSEC negative
trust anchor domains. If specified and DNSSEC is enabled,
look-ups done via the interface's DNS server will be subject
to the list of negative trust anchors, and not require
authentication for the specified domains, or anything below
it. Use this to disable DNSSEC authentication for specific
private domains, that cannot be proven valid using the
Internet DNS hierarchy. Defaults to the empty list. This
setting is read by
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > LLDP=</varname> </term>
<listitem >
2016-02-21 19:58:01 +00:00
<para > Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly
implemented on professional routers and bridges which announces which physical port a system is connected
to, as well as other related data. Accepts a boolean or the special value
sd-lldp: rework sd-lldp API
This reworks the sd-lldp substantially, simplifying things on one hand, and
extending the logic a bit on the other.
Specifically:
- Besides the sd_lldp object only one other object is maintained now,
sd_lldp_neighbor. It's used both as storage for literal LLDP packets, and for
maintainging info about peers in the database. Separation between packet, TLV
and chassis data is not maintained anymore. This should be a major
simplification.
- The sd-lldp API has been extended so that a couple of per-neighbor fields may
be queried directly, without iterating through the object. Other fields that
may appear multiple times, OTOH have to be iterated through.
- The maximum number of entries in the neighbor database is now configurable
during runtime.
- The generation of callbacks from sd_lldp objects is more restricted:
callbacks are only invoked when actual data changed.
- The TTL information is now hooked with a timer event, so that removals from
the neighbor database due to TTLs now result in a callback event.
- Querying LLDP neighbor database will now return a strictly ordered array, to
guarantee stability.
- A "capabilities" mask may now be configured, that selects what type of LLDP
neighbor data is collected. This may be used to restrict collection of LLDP
info about routers instead of all neighbors. This is now exposed via
networkd's LLDP= setting.
- sd-lldp's API to serialize the collected data to text files has been removed.
Instead, there's now an API to extract the raw binary data from LLDP neighbor
objects, as well as one to convert this raw binary data back to an LLDP
neighbor object. networkd will save this raw binary data to /run now, and the
client side can simply parse the information.
- support for parsing the more exotic TLVs has been removed, since we are not
using that. Instead there are now APIs to extract the raw data from TLVs.
Given how easy it is to parse the TLVs clients should do so now directly
instead of relying on our APIs for that.
- A lot of the APIs that parse out LLDP strings have been simplified so that
they actually return strings, instead of char arrays with a length. To deal
with possibly dangerous characters the strings are escaped if needed.
- APIs to extract and format the chassis and port IDs as strings has been
added.
- lldp.h has been simplified a lot. The enums are anonymous now, since they
were never used as enums, but simply as constants. Most definitions we don't
actually use ourselves have eben removed.
2016-02-19 16:58:52 +00:00
<literal > routers-only</literal> . When true, incoming LLDP packets are accepted and a database of all LLDP
neighbors maintained. If <literal > routers-only</literal> is set only LLDP data of various types of routers
is collected and LLDP data about other types of devices ignored (such as stations, telephones and
2016-02-19 18:59:32 +00:00
others). If false, LLDP reception is disabled. Defaults to <literal > routers-only</literal> . Use
sd-lldp: rework sd-lldp API
This reworks the sd-lldp substantially, simplifying things on one hand, and
extending the logic a bit on the other.
Specifically:
- Besides the sd_lldp object only one other object is maintained now,
sd_lldp_neighbor. It's used both as storage for literal LLDP packets, and for
maintainging info about peers in the database. Separation between packet, TLV
and chassis data is not maintained anymore. This should be a major
simplification.
- The sd-lldp API has been extended so that a couple of per-neighbor fields may
be queried directly, without iterating through the object. Other fields that
may appear multiple times, OTOH have to be iterated through.
- The maximum number of entries in the neighbor database is now configurable
during runtime.
- The generation of callbacks from sd_lldp objects is more restricted:
callbacks are only invoked when actual data changed.
- The TTL information is now hooked with a timer event, so that removals from
the neighbor database due to TTLs now result in a callback event.
- Querying LLDP neighbor database will now return a strictly ordered array, to
guarantee stability.
- A "capabilities" mask may now be configured, that selects what type of LLDP
neighbor data is collected. This may be used to restrict collection of LLDP
info about routers instead of all neighbors. This is now exposed via
networkd's LLDP= setting.
- sd-lldp's API to serialize the collected data to text files has been removed.
Instead, there's now an API to extract the raw binary data from LLDP neighbor
objects, as well as one to convert this raw binary data back to an LLDP
neighbor object. networkd will save this raw binary data to /run now, and the
client side can simply parse the information.
- support for parsing the more exotic TLVs has been removed, since we are not
using that. Instead there are now APIs to extract the raw data from TLVs.
Given how easy it is to parse the TLVs clients should do so now directly
instead of relying on our APIs for that.
- A lot of the APIs that parse out LLDP strings have been simplified so that
they actually return strings, instead of char arrays with a length. To deal
with possibly dangerous characters the strings are escaped if needed.
- APIs to extract and format the chassis and port IDs as strings has been
added.
- lldp.h has been simplified a lot. The enums are anonymous now, since they
were never used as enums, but simply as constants. Most definitions we don't
actually use ourselves have eben removed.
2016-02-19 16:58:52 +00:00
<citerefentry > <refentrytitle > networkctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> to query the
2016-02-21 19:58:01 +00:00
collected neighbor data. LLDP is only available on Ethernet links. See <varname > EmitLLDP=</varname> below
for enabling LLDP packet emission from the local system.
2015-02-04 02:14:13 +00:00
</para>
</listitem>
</varlistentry>
2016-02-21 19:58:01 +00:00
<varlistentry >
<term > <varname > EmitLLDP=</varname> </term>
<listitem >
2016-05-06 19:27:36 +00:00
<para > Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values
<literal > nearest-bridge</literal> , <literal > non-tpmr-bridge</literal> and
<literal > customer-bridge</literal> . Defaults to false, which turns off LLDP packet emission. If not false,
a short LLDP packet with information about the local system is sent out in regular intervals on the
2020-04-14 08:37:40 +00:00
link. The LLDP packet will contain information about the local hostname, the local machine ID (as stored
2016-05-06 19:27:36 +00:00
in <citerefentry > <refentrytitle > machine-id</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ) and the
2016-02-21 19:58:01 +00:00
local interface name, as well as the pretty hostname of the system (as set in
<citerefentry > <refentrytitle > machine-info</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ). LLDP
2016-05-06 19:27:36 +00:00
emission is only available on Ethernet links. Note that this setting passes data suitable for
identification of host to the network and should thus not be enabled on untrusted networks, where such
identification data should not be made available. Use this option to permit other systems to identify on
which interfaces they are connected to this system. The three special values control propagation of the
LLDP packets. The <literal > nearest-bridge</literal> setting permits propagation only to the nearest
connected bridge, <literal > non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, but
not any other bridges, and <literal > customer-bridge</literal> permits propagation until a customer bridge
is reached. For details about these concepts, see <ulink
2018-06-06 21:24:33 +00:00
url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink> . Note that
2016-05-06 19:27:36 +00:00
configuring this setting to true is equivalent to <literal > nearest-bridge</literal> , the recommended and
most restricted level of propagation. See <varname > LLDP=</varname> above for an option to enable LLDP
reception.</para>
2016-02-21 19:58:01 +00:00
</listitem>
</varlistentry>
2020-03-30 19:57:58 +00:00
2015-02-17 12:06:57 +00:00
<varlistentry >
<term > <varname > BindCarrier=</varname> </term>
<listitem >
2016-02-22 23:29:32 +00:00
<para > A link name or a list of link names. When set, controls the behavior of the current
link. When all links in the list are in an operational down state, the current link is brought
network: add ActivationPolicy= configuration parameter
This parameter allows configuring the activation policy for an interface,
meaning how it manages the interface's administrative state (IFF_UP flag).
The policy can be configured to bring the interface either up or down when
the interface is (re)configured, to always force the interface either up or
down, or to never change the interface administrative state.
If the interface is bound with BindCarrier=, its administrative state is
controlled by the interface(s) it's bound to, and this parameter is forced
to 'bound'.
This changes the default behavior of how systemd-networkd sets the IFF_UP
flag; previously, it was set up (if not already up) every time the
link_joined() function was called. Now, with the default ActivationPolicy=
setting of 'up', it will only set the IFF_UP flag once, the first time
link_joined() is called, during an interface's configuration; and on
the first link_joined() call each time the interface is reconfigured.
Fixes: #3031
Fixes: #17437
2020-06-18 20:09:40 +00:00
down. When at least one link has carrier, the current interface is brought up.</para>
<para > This forces <varname > ActivationPolicy=</varname> to be set to <literal > bound</literal> .</para>
2015-02-17 12:06:57 +00:00
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > Address=</varname> </term>
<listitem >
<para > A static IPv4 or IPv6 address and its prefix length,
separated by a <literal > /</literal> character. Specify
this key more than once to configure several addresses.
The format of the address must be as described in
2015-03-14 02:22:39 +00:00
<citerefentry project= 'man-pages' > <refentrytitle > inet_pton</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> .
2015-02-04 02:14:13 +00:00
This is a short-hand for an [Address] section only
containing an Address key (see below). This option may be
specified more than once.
</para>
2019-02-20 10:01:49 +00:00
<para > If the specified address is <literal > 0.0.0.0</literal> (for IPv4) or <literal > ::</literal>
(for IPv6), a new address range of the requested size is automatically allocated from a
system-wide pool of unused ranges. Note that the prefix length must be equal or larger than 8 for
IPv4, and 64 for IPv6. The allocated range is checked against all current network interfaces and
all known network configuration files to avoid address range conflicts. The default system-wide
pool consists of 192.168.0.0/16, 172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fd00::/8 for IPv6.
This functionality is useful to manage a large number of dynamically created network interfaces
with the same network configuration and automatic address range assignment.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Gateway=</varname> </term>
<listitem >
<para > The gateway address, which must be in the format
described in
2015-03-14 02:22:39 +00:00
<citerefentry project= 'man-pages' > <refentrytitle > inet_pton</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> .
2015-02-04 02:14:13 +00:00
This is a short-hand for a [Route] section only containing
a Gateway key. This option may be specified more than
once.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DNS=</varname> </term>
<listitem >
2021-01-28 19:38:27 +00:00
<para > A DNS server address, which must be in the format described in
2015-03-14 02:22:39 +00:00
<citerefentry project= 'man-pages' > <refentrytitle > inet_pton</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> .
2020-07-19 04:57:51 +00:00
This option may be specified more than once. Each address can optionally take a port number
separated with <literal > :</literal> , a network interface name or index separated with
<literal > %</literal> , and a Server Name Indication (SNI) separated with <literal > #</literal> .
When IPv6 address is specified with a port number, then the address must be in the square
brackets. That is, the acceptable full formats are
<literal > 111.222.333.444:9953%ifname#example.com</literal> for IPv4 and
2021-01-28 19:38:27 +00:00
<literal > [1111:2222::3333]:9953%ifname#example.com</literal> for IPv6. If an empty string is
assigned, then the all previous assignments are cleared. This setting is read by
networkd: rework Domains= setting
Previously, .network files only knew a vaguely defined "Domains=" concept, for which the documentation declared it was
the "DNS domain" for the network connection, without specifying what that means.
With this the Domains setting is reworked, so that there are now "routing" domains and "search" domains. The former are
to be used by resolved to route DNS request to specific network interfaces, the latter is to be used for searching
single-label hostnames with (in addition to being used for routing). Both settings are configured in the "Domains="
setting. Normal domain names listed in it are now considered search domains (for compatibility with existing setups),
while those prefixed with "~" are considered routing domains only. To route all lookups to a specific interface the
routing domain "." may be used, referring to the root domain. An alternative syntax for this is the "*", as was already
implemented before using the "wildcard" domain concept.
This commit adds proper parsers for this new logic, and exposes this via the sd-network API. This information is not
used by resolved yet, this will be added in a later commit.
2016-01-25 18:46:00 +00:00
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Domains=</varname> </term>
<listitem >
2020-03-03 17:03:53 +00:00
<para > A whitespace-separated list of domains which should be resolved using the DNS servers on
this link. Each item in the list should be a domain name, optionally prefixed with a tilde
(<literal > ~</literal> ). The domains with the prefix are called "routing-only domains". The
domains without the prefix are called "search domains" and are first used as search suffixes for
2020-04-14 08:37:40 +00:00
extending single-label hostnames (hostnames containing no dots) to become fully qualified
domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the
2020-03-03 17:03:53 +00:00
specified search domains are appended to it in turn, converting it into a fully qualified domain
name, until one of them may be successfully resolved.</para>
2016-10-02 12:32:44 +00:00
2020-04-14 08:37:40 +00:00
<para > Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for hostnames
2016-10-02 12:32:44 +00:00
ending in those domains (hence also single label names, if any "search domains" are listed), are routed to
the DNS servers configured for this interface. The domain routing logic is particularly useful on
multi-homed hosts with DNS servers serving particular private DNS zones on each interface.</para>
<para > The "routing-only" domain <literal > ~.</literal> (the tilde indicating definition of a routing domain,
the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special
effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed
to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers
if a link on which they are connected is available.</para>
networkd: rework Domains= setting
Previously, .network files only knew a vaguely defined "Domains=" concept, for which the documentation declared it was
the "DNS domain" for the network connection, without specifying what that means.
With this the Domains setting is reworked, so that there are now "routing" domains and "search" domains. The former are
to be used by resolved to route DNS request to specific network interfaces, the latter is to be used for searching
single-label hostnames with (in addition to being used for routing). Both settings are configured in the "Domains="
setting. Normal domain names listed in it are now considered search domains (for compatibility with existing setups),
while those prefixed with "~" are considered routing domains only. To route all lookups to a specific interface the
routing domain "." may be used, referring to the root domain. An alternative syntax for this is the "*", as was already
implemented before using the "wildcard" domain concept.
This commit adds proper parsers for this new logic, and exposes this via the sd-network API. This information is not
used by resolved yet, this will be added in a later commit.
2016-01-25 18:46:00 +00:00
<para > This setting is read by
2016-10-02 12:32:44 +00:00
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
"Search domains" correspond to the <varname > domain</varname> and <varname > search</varname> entries in
2017-05-07 15:29:40 +00:00
<citerefentry project= 'man-pages' > <refentrytitle > resolv.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
2016-10-02 12:32:44 +00:00
Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain
name servers limited to a specific link.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2018-12-04 14:34:04 +00:00
<varlistentry >
<term > <varname > DNSDefaultRoute=</varname> </term>
<listitem >
<para > Takes a boolean argument. If true, this link's configured DNS servers are used for resolving domain
names that do not match any link's configured <varname > Domains=</varname> setting. If false, this link's
configured DNS servers are never used for such domains, and are exclusively used for resolving names that
match at least one of the domains configured on this link. If not specified defaults to an automatic mode:
queries not matching any link's configured domains will be routed to this link if it has no routing-only
domains configured.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > NTP=</varname> </term>
<listitem >
2020-06-16 18:35:18 +00:00
<para > An NTP server address (either an IP address, or a hostname). This option may be specified more than once. This setting is read by
networkd: rework Domains= setting
Previously, .network files only knew a vaguely defined "Domains=" concept, for which the documentation declared it was
the "DNS domain" for the network connection, without specifying what that means.
With this the Domains setting is reworked, so that there are now "routing" domains and "search" domains. The former are
to be used by resolved to route DNS request to specific network interfaces, the latter is to be used for searching
single-label hostnames with (in addition to being used for routing). Both settings are configured in the "Domains="
setting. Normal domain names listed in it are now considered search domains (for compatibility with existing setups),
while those prefixed with "~" are considered routing domains only. To route all lookups to a specific interface the
routing domain "." may be used, referring to the root domain. An alternative syntax for this is the "*", as was already
implemented before using the "wildcard" domain concept.
This commit adds proper parsers for this new logic, and exposes this via the sd-network API. This information is not
used by resolved yet, this will be added in a later commit.
2016-01-25 18:46:00 +00:00
<citerefentry > <refentrytitle > systemd-timesyncd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > IPForward=</varname> </term>
2015-11-13 11:49:15 +00:00
<listitem > <para > Configures IP packet forwarding for the
system. If enabled, incoming packets on any network
interface will be forwarded to any other interfaces
2018-11-27 06:07:58 +00:00
according to the routing table. Takes a boolean,
or the values <literal > ipv4</literal> or
2015-11-13 11:49:15 +00:00
<literal > ipv6</literal> , which only enable IP packet
forwarding for the specified address family. This controls
the <filename > net.ipv4.ip_forward</filename> and
<filename > net.ipv6.conf.all.forwarding</filename> sysctl
options of the network interface (see <ulink
2015-04-24 17:53:38 +00:00
url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink>
for details about sysctl options). Defaults to
<literal > no</literal> .</para>
2015-11-13 11:49:15 +00:00
<para > Note: this setting controls a global kernel option,
and does so one way only: if a network that has this setting
enabled is set up the global setting is turned on. However,
it is never turned off again, even after all networks with
this setting enabled are shut down again.</para>
<para > To allow IP packet forwarding only between specific
network interfaces use a firewall.</para>
2015-04-24 17:53:38 +00:00
</listitem>
2015-02-04 02:14:13 +00:00
</varlistentry>
<varlistentry >
<term > <varname > IPMasquerade=</varname> </term>
2021-02-17 07:17:37 +00:00
<listitem > <para > Configures IP masquerading for the network interface. If enabled, packets
forwarded from the network interface will be appear as coming from the local host. Takes one
of <literal > ipv4</literal> , <literal > ipv6</literal> , <literal > both</literal> , or
<literal > no</literal> . Defaults to <literal > no</literal> . If enabled, this automatically sets
<varname > IPForward=</varname> to one of <literal > ipv4</literal> , <literal > ipv6</literal> or
<literal > yes</literal> .</para>
<para > Note. Any positive boolean values such as <literal > yes</literal> or
<literal > true</literal> are now deprecated. Please use one of the values in the above.</para>
</listitem>
2015-02-04 02:14:13 +00:00
</varlistentry>
2015-07-05 05:55:20 +00:00
<varlistentry >
<term > <varname > IPv6PrivacyExtensions=</varname> </term>
2015-07-06 18:29:33 +00:00
<listitem > <para > Configures use of stateless temporary
addresses that change over time (see <ulink
url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink> ,
Privacy Extensions for Stateless Address Autoconfiguration
in IPv6). Takes a boolean or the special values
<literal > prefer-public</literal> and
2014-08-03 05:11:12 +00:00
<literal > kernel</literal> . When true, enables the privacy
2015-07-06 18:29:33 +00:00
extensions and prefers temporary addresses over public
2014-08-03 05:11:12 +00:00
addresses. When <literal > prefer-public</literal> , enables the
2015-07-06 18:29:33 +00:00
privacy extensions, but prefers public addresses over
temporary addresses. When false, the privacy extensions
2014-08-03 05:11:12 +00:00
remain disabled. When <literal > kernel</literal> , the kernel's
2015-07-06 18:29:33 +00:00
default setting will be left in place. Defaults to
2015-07-05 05:55:20 +00:00
<literal > no</literal> .</para> </listitem>
</varlistentry>
2015-09-12 02:48:36 +00:00
<varlistentry >
2016-06-07 09:19:26 +00:00
<term > <varname > IPv6AcceptRA=</varname> </term>
2020-03-03 17:36:03 +00:00
<listitem > <para > Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the
interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may
trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no
routers are found on the link. The default is to disable RA reception for bridge devices or when IP
forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link
2020-04-21 18:46:53 +00:00
local addressing is disabled.</para>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
2020-07-06 09:00:06 +00:00
<para > Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see
below.</para>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
<para > Also see <ulink
url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel
documentation regarding <literal > accept_ra</literal> , but note that systemd's setting of
<constant > 1</constant> (i.e. true) corresponds to kernel's setting of <constant > 2</constant> .</para>
2019-03-13 16:00:56 +00:00
2019-07-16 01:46:27 +00:00
<para > Note that kernel's implementation of the IPv6 RA protocol is always disabled,
regardless of this setting. If this option is enabled, a userspace implementation of the IPv6
RA protocol is used, and the kernel's own implementation remains disabled, since
<command > systemd-networkd</command> needs to know all details supplied in the advertisements,
and these are not available from the kernel if the kernel's own implementation is used.</para>
2015-09-30 18:59:43 +00:00
</listitem>
2015-09-12 02:48:36 +00:00
</varlistentry>
2015-10-12 09:02:12 +00:00
<varlistentry >
<term > <varname > IPv6DuplicateAddressDetection=</varname> </term>
2014-08-03 05:11:37 +00:00
<listitem > <para > Configures the amount of IPv6 Duplicate
2018-11-27 05:40:25 +00:00
Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
2015-10-12 09:02:12 +00:00
</para> </listitem>
</varlistentry>
2015-11-10 03:59:24 +00:00
<varlistentry >
<term > <varname > IPv6HopLimit=</varname> </term>
<listitem > <para > Configures IPv6 Hop Limit. For each router that
forwards the packet, the hop limit is decremented by 1. When the
hop limit field reaches zero, the packet is discarded.
2018-11-27 05:40:25 +00:00
When unset, the kernel's default will be used.
2015-11-10 03:59:24 +00:00
</para> </listitem>
</varlistentry>
2020-06-08 04:48:14 +00:00
<varlistentry >
<term > <varname > IPv4AcceptLocal=</varname> </term>
<listitem > <para > Takes a boolean. Accept packets with local source addresses. In combination
with suitable routing, this can be used to direct packets between two local interfaces over
the wire and have them accepted properly. When unset, the kernel's default will be used.
</para> </listitem>
</varlistentry>
2021-02-18 08:55:13 +00:00
<varlistentry >
<term > <varname > IPv4RouteLocalnet=</varname> </term>
<listitem > <para > Takes a boolean. When true, the kernel does not consider loopback addresses as martian source or destination
while routing. This enables the use of 127.0.0.0/8 for local routing purposes. When unset, the kernel's default will be used.
</para> </listitem>
</varlistentry>
2016-04-14 09:56:57 +00:00
<varlistentry >
2016-12-22 09:23:29 +00:00
<term > <varname > IPv4ProxyARP=</varname> </term>
2018-11-27 06:07:58 +00:00
<listitem > <para > Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
2016-04-14 09:56:57 +00:00
usually a router, answers ARP requests intended for another machine. By "faking" its identity,
2020-07-06 08:49:59 +00:00
the router accepts responsibility for routing packets to the "real" destination. See <ulink
2016-04-14 09:56:57 +00:00
url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink> .
2018-11-27 05:40:25 +00:00
When unset, the kernel's default will be used.
2016-04-14 09:56:57 +00:00
</para> </listitem>
</varlistentry>
2017-02-10 23:47:55 +00:00
<varlistentry >
2017-05-09 18:04:55 +00:00
<term > <varname > IPv6ProxyNDP=</varname> </term>
2018-11-27 06:07:58 +00:00
<listitem > <para > Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
2017-05-09 18:04:55 +00:00
Protocol) is a technique for IPv6 to allow routing of addresses to a different
destination when peers expect them to be present on a certain physical link.
2017-02-10 23:47:55 +00:00
In this case a router answers Neighbour Advertisement messages intended for
another machine by offering its own MAC address as destination.
2017-05-09 18:04:55 +00:00
Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
2017-02-10 23:47:55 +00:00
Advertisement messages for addresses in the IPv6 neighbor proxy table,
2017-05-09 18:04:55 +00:00
which can also be shown by <command > ip -6 neighbour show proxy</command> .
systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
interface depending on this option.
2018-11-27 05:40:25 +00:00
When unset, the kernel's default will be used.
2017-05-09 18:04:55 +00:00
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > IPv6ProxyNDPAddress=</varname> </term>
<listitem > <para > An IPv6 address, for which Neighbour Advertisement messages will be
proxied. This option may be specified more than once. systemd-networkd will add the
<option > IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table.
2018-09-25 10:40:35 +00:00
This option implies <option > IPv6ProxyNDP=yes</option> but has no effect if
2018-11-27 05:40:25 +00:00
<option > IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used.
2017-02-10 23:47:55 +00:00
</para> </listitem>
</varlistentry>
2017-09-06 11:20:08 +00:00
<varlistentry >
2020-10-19 03:48:39 +00:00
<term > <varname > IPv6SendRA=</varname> </term>
<listitem > <para > Whether to enable or disable Router Advertisement sending on a link. Takes a
boolean value. When enabled, prefixes configured in [IPv6Prefix] sections and routes
configured in [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA]
section. If <varname > DHCPv6PrefixDelegation=</varname> is enabled, then the delegated
prefixes are also distributed. See <varname > DHCPv6PrefixDelegation=</varname> setting and the
[IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPv6PrefixDelegation] sections for more
2020-07-06 09:00:06 +00:00
configuration options.</para> </listitem>
2017-09-06 11:20:08 +00:00
</varlistentry>
2020-10-19 03:48:39 +00:00
<varlistentry >
<term > <varname > DHCPv6PrefixDelegation=</varname> </term>
<listitem > <para > Takes a boolean value. When enabled, requests prefixes using a DHCPv6 client
configured on another link. By default, an address within each delegated prefix will be
assigned, and the prefixes will be announced through IPv6 Router Advertisement when
<varname > IPv6SendRA=</varname> is enabled. Such default settings can be configured in
2020-11-12 13:39:42 +00:00
[DHCPv6PrefixDelegation] section. Defaults to disabled.</para> </listitem>
2020-10-19 03:48:39 +00:00
</varlistentry>
2018-04-20 09:38:39 +00:00
<varlistentry >
<term > <varname > IPv6MTUBytes=</varname> </term>
<listitem > <para > Configures IPv6 maximum transmission unit (MTU).
2018-11-27 05:40:25 +00:00
An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used.
2018-04-20 09:38:39 +00:00
</para> </listitem>
</varlistentry>
2021-09-02 21:10:07 +00:00
<varlistentry >
<term > <varname > KeepMaster=</varname> </term>
<term > <varname > Bond=</varname> </term>
<term > <varname > Bridge=</varname> </term>
<term > <varname > VRF=</varname> </term>
<listitem >
<para > Takes a boolean value. When enabled, the current master interface index will not be
changed, and <varname > BatmanAdvanced=</varname> , <varname > Bond=</varname> ,
<varname > Bridge=</varname> , and <varname > VRF=</varname> settings are ignored. This may be
useful when a netdev with a master interface is created by another program, e.g.
<citerefentry > <refentrytitle > systemd-nspawn</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> .
Defaults to false.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-06-09 19:41:08 +00:00
<term > <varname > BatmanAdvanced=</varname> </term>
2015-02-04 02:14:13 +00:00
<term > <varname > Bond=</varname> </term>
2021-06-09 19:41:08 +00:00
<term > <varname > Bridge=</varname> </term>
2016-06-12 23:05:49 +00:00
<term > <varname > VRF=</varname> </term>
<listitem >
2021-06-09 19:41:08 +00:00
<para > The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link
to. See
2016-12-02 19:00:46 +00:00
<citerefentry > <refentrytitle > systemd.netdev</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
</para>
2016-06-12 23:05:49 +00:00
</listitem>
</varlistentry>
2018-07-02 12:31:58 +00:00
<varlistentry >
<term > <varname > IPVLAN=</varname> </term>
2021-06-09 19:45:54 +00:00
<term > <varname > IPVTAP=</varname> </term>
<term > <varname > L2TP=</varname> </term>
2021-06-09 19:41:08 +00:00
<term > <varname > MACsec=</varname> </term>
2015-02-04 02:14:13 +00:00
<term > <varname > MACVLAN=</varname> </term>
2021-06-09 19:45:54 +00:00
<term > <varname > MACVTAP=</varname> </term>
2015-02-04 02:14:13 +00:00
<term > <varname > Tunnel=</varname> </term>
2021-06-09 19:41:08 +00:00
<term > <varname > VLAN=</varname> </term>
<term > <varname > VXLAN=</varname> </term>
2021-06-09 19:45:54 +00:00
<term > <varname > Xfrm=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
2021-06-30 12:26:47 +00:00
<para > The name of an IPVLAN, IPVTAP, L2TP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, VXLAN, or
2021-06-09 19:45:54 +00:00
Xfrm to be created on the link. See
2019-04-03 11:27:36 +00:00
<citerefentry > <refentrytitle > systemd.netdev</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
This option may be specified more than once.</para>
</listitem>
</varlistentry>
2017-08-26 13:37:46 +00:00
<varlistentry >
<term > <varname > ActiveSlave=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Specifies the new active slave. The <literal > ActiveSlave=</literal>
2017-08-26 13:37:46 +00:00
option is only valid for following modes:
<literal > active-backup</literal> ,
<literal > balance-alb</literal> and
<literal > balance-tlb</literal> . Defaults to false.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > PrimarySlave=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Specifies which slave is the primary device. The specified
2017-08-26 13:37:46 +00:00
device will always be the active slave while it is available. Only when the
primary is off-line will alternate devices be used. This is useful when
one slave is preferred over another, e.g. when one slave has higher throughput
than another. The <literal > PrimarySlave=</literal> option is only valid for
following modes:
<literal > active-backup</literal> ,
<literal > balance-alb</literal> and
<literal > balance-tlb</literal> . Defaults to false.
</para>
</listitem>
</varlistentry>
2017-09-06 14:57:04 +00:00
<varlistentry >
<term > <varname > ConfigureWithoutCarrier=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
2020-04-27 10:38:40 +00:00
Defaults to false. If <option > IgnoreCarrierLoss=</option> is not explicitly set, it will
default to this value.
2017-09-06 14:57:04 +00:00
</para>
</listitem>
</varlistentry>
2018-06-01 09:34:49 +00:00
<varlistentry >
<term > <varname > IgnoreCarrierLoss=</varname> </term>
<listitem >
2020-04-27 10:38:40 +00:00
<para > Takes a boolean. Allows networkd to retain both the static and dynamic configuration
of the interface even if its carrier is lost. When unset, the value specified with
<option > ConfigureWithoutCarrier=</option> is used.
2018-06-01 09:34:49 +00:00
</para>
network: add ActivationPolicy= configuration parameter
This parameter allows configuring the activation policy for an interface,
meaning how it manages the interface's administrative state (IFF_UP flag).
The policy can be configured to bring the interface either up or down when
the interface is (re)configured, to always force the interface either up or
down, or to never change the interface administrative state.
If the interface is bound with BindCarrier=, its administrative state is
controlled by the interface(s) it's bound to, and this parameter is forced
to 'bound'.
This changes the default behavior of how systemd-networkd sets the IFF_UP
flag; previously, it was set up (if not already up) every time the
link_joined() function was called. Now, with the default ActivationPolicy=
setting of 'up', it will only set the IFF_UP flag once, the first time
link_joined() is called, during an interface's configuration; and on
the first link_joined() call each time the interface is reconfigured.
Fixes: #3031
Fixes: #17437
2020-06-18 20:09:40 +00:00
<para > When <varname > ActivationPolicy=</varname> is set to <literal > always-up</literal> , this
is forced to <literal > true</literal> .
</para>
2018-06-01 09:34:49 +00:00
</listitem>
</varlistentry>
2019-06-03 06:37:25 +00:00
<varlistentry >
<term > <varname > KeepConfiguration=</varname> </term>
<listitem >
<para > Takes a boolean or one of <literal > static</literal> , <literal > dhcp-on-stop</literal> ,
<literal > dhcp</literal> . When <literal > static</literal> , <command > systemd-networkd</command>
will not drop static addresses and routes on starting up process. When set to
<literal > dhcp-on-stop</literal> , <command > systemd-networkd</command> will not drop addresses
and routes on stopping the daemon. When <literal > dhcp</literal> ,
the addresses and routes provided by a DHCP server will never be dropped even if the DHCP
lease expires. This is contrary to the DHCP specification, but may be the best choice if,
e.g., the root filesystem relies on this connection. The setting <literal > dhcp</literal>
implies <literal > dhcp-on-stop</literal> , and <literal > yes</literal> implies
2019-10-01 15:12:31 +00:00
<literal > dhcp</literal> and <literal > static</literal> . Defaults to <literal > no</literal> .
</para>
2019-06-03 06:37:25 +00:00
</listitem>
</varlistentry>
2021-06-09 19:41:08 +00:00
</variablelist>
2015-02-04 02:14:13 +00:00
</refsect1>
<refsect1 >
<title > [Address] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > An [Address] section accepts the following keys. Specify several [Address]
2015-02-04 02:14:13 +00:00
sections to configure several addresses.</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Address=</varname> </term>
<listitem >
2020-07-06 09:00:06 +00:00
<para > As in the [Network] section. This key is mandatory. Each [Address] section can contain one
<varname > Address=</varname> setting.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Peer=</varname> </term>
<listitem >
<para > The peer address in a point-to-point connection.
2019-02-20 10:02:31 +00:00
Accepts the same format as the <varname > Address=</varname>
2015-02-04 02:14:13 +00:00
key.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Broadcast=</varname> </term>
<listitem >
2021-02-18 21:01:34 +00:00
<para > Takes an IPv4 address or boolean value. The address must be in the format described in
2015-03-14 02:22:39 +00:00
<citerefentry project= 'man-pages' > <refentrytitle > inet_pton</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> .
2021-02-18 21:01:34 +00:00
If set to true, then the IPv4 broadcast address will be derived from the
<varname > Address=</varname> setting. If set to false, then the broadcast address will not
be set. Defaults to true, except for wireguard interfaces, where it default to false.
</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Label=</varname> </term>
<listitem >
2021-08-16 03:57:18 +00:00
<para > Specifies the label for the IPv4 address. The label must be a 7-bit ASCII string with
a length of 1…15 characters. Defaults to unset.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2016-05-03 19:54:26 +00:00
<varlistentry >
<term > <varname > PreferredLifetime=</varname> </term>
<listitem >
2021-01-28 19:38:27 +00:00
<para > Allows the default "preferred lifetime" of the address to be overridden. Only three
settings are accepted: <literal > forever</literal> , <literal > infinity</literal> , which is the
default and means that the address never expires, and <literal > 0</literal> , which means that the
address is considered immediately "expired" and will not be used, unless explicitly requested. A
setting of <option > PreferredLifetime=0</option> is useful for addresses which are added to be
used only by a specific application, which is then configured to use them explicitly.</para>
2016-05-03 19:54:26 +00:00
</listitem>
</varlistentry>
2017-08-01 07:44:08 +00:00
<varlistentry >
<term > <varname > Scope=</varname> </term>
<listitem >
2021-01-17 01:10:57 +00:00
<para > The scope of the address, which can be
<literal > global</literal> (valid everywhere on the network, even through a gateway),
<literal > link</literal> (only valid on this device, will not traverse a gateway) or
<literal > host</literal> (only valid within the device itself, e.g. 127.0.0.1)
2021-01-28 19:42:37 +00:00
or an unsigned integer in the range 0…255.
2017-08-01 07:44:08 +00:00
Defaults to <literal > global</literal> .</para>
</listitem>
</varlistentry>
2021-04-17 17:02:29 +00:00
<varlistentry >
<term > <varname > RouteMetric=</varname> </term>
<listitem >
<para > The metric of the prefix route, which is pointing to the subnet of the configured IP
address, taking the configured prefix length into account. Takes an unsigned integer in the
range 0…4294967295. When unset or set to 0, the kernel's default value is used. This
setting will be ignored when <varname > AddPrefixRoute=</varname> is false.</para>
</listitem>
</varlistentry>
2016-10-08 11:05:41 +00:00
<varlistentry >
<term > <varname > HomeAddress=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Designates this address the "home address" as defined in
2016-10-08 11:05:41 +00:00
<ulink url= "https://tools.ietf.org/html/rfc6275" > RFC 6275</ulink> .
Supported only on IPv6. Defaults to false.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DuplicateAddressDetection=</varname> </term>
<listitem >
2019-11-21 15:54:52 +00:00
<para > Takes one of <literal > ipv4</literal> , <literal > ipv6</literal> ,
<literal > both</literal> , <literal > none</literal> . When <literal > ipv4</literal> ,
2021-06-16 01:32:28 +00:00
performs IPv4 Address Conflict Detection. See
<ulink url= "https://tools.ietf.org/html/rfc5227" > RFC 5227</ulink> .
2019-11-21 15:54:52 +00:00
When <literal > ipv6</literal> , performs IPv6 Duplicate Address Detection. See
<ulink url= "https://tools.ietf.org/html/rfc4862" > RFC 4862</ulink> .
Defaults to <literal > ipv6</literal> .</para>
2016-10-08 11:05:41 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > ManageTemporaryAddress=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. If true the kernel manage temporary addresses created
2016-10-08 11:05:41 +00:00
from this one as template on behalf of Privacy Extensions
2021-01-12 21:34:32 +00:00
<ulink url= "https://tools.ietf.org/html/rfc3041" > RFC 3041</ulink> . For this to become
2016-10-08 11:05:41 +00:00
active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
2019-12-24 12:50:04 +00:00
The given address needs to have a prefix length of 64. This flag allows using privacy
2016-10-08 11:05:41 +00:00
extensions in a manually configured network, just like if stateless auto-configuration
2021-01-12 21:34:32 +00:00
was active. Defaults to false.</para>
2016-10-08 11:05:41 +00:00
</listitem>
</varlistentry>
<varlistentry >
2019-12-07 15:32:36 +00:00
<term > <varname > AddPrefixRoute=</varname> </term>
2016-10-08 11:05:41 +00:00
<listitem >
2019-12-07 15:32:36 +00:00
<para > Takes a boolean. When true, the prefix route for the address is automatically added.
Defaults to true.</para>
2016-10-08 11:05:41 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > AutoJoin=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Joining multicast group on ethernet level via
2016-10-08 11:05:41 +00:00
<command > ip maddr</command> command would not work if we have an Ethernet switch that does
IGMP snooping since the switch would not replicate multicast packets on ports that did not
have IGMP reports for the multicast addresses. Linux vxlan interfaces created via
<command > ip link add vxlan</command> or networkd's netdev kind vxlan have the group option
that enables then to do the required join. By extending ip address command with option
<literal > autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan
interfaces as well as other tunneling mechanisms that need to receive multicast traffic.
Defaults to <literal > no</literal> .</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
</variablelist>
</refsect1>
2018-11-29 03:00:58 +00:00
<refsect1 >
<title > [Neighbor] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, static
entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links
matched for the network. Specify several [Neighbor] sections to configure several static neighbors.
</para>
2018-11-29 03:00:58 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Address=</varname> </term>
<listitem >
<para > The IP address of the neighbor.</para>
</listitem>
</varlistentry>
<varlistentry >
2019-07-10 17:23:41 +00:00
<term > <varname > LinkLayerAddress=</varname> </term>
2018-11-29 03:00:58 +00:00
<listitem >
2019-07-10 17:23:41 +00:00
<para > The link layer address (MAC address or IP address) of the neighbor.</para>
2018-11-29 03:00:58 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2017-04-25 10:36:50 +00:00
<refsect1 >
<title > [IPv6AddressLabel] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel]
sections to configure several address labels. IPv6 address labels are used for address selection. See
<ulink url= "https://tools.ietf.org/html/rfc3484" > RFC 3484</ulink> . Precedence is managed by userspace,
2020-11-09 20:25:29 +00:00
and only the label itself is stored in the kernel.</para>
2017-04-25 10:36:50 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Label=</varname> </term>
<listitem >
2021-11-04 00:20:21 +00:00
<para > The label for the prefix, an unsigned integer in the range 0…4294967294.
2020-07-06 08:49:59 +00:00
0xffffffff is reserved. This setting is mandatory.</para>
2017-04-25 10:36:50 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Prefix=</varname> </term>
<listitem >
<para > IPv6 prefix is an address with a prefix length, separated by a slash <literal > /</literal> character.
This key is mandatory. </para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2017-09-14 19:51:39 +00:00
<refsect1 >
<title > [RoutingPolicyRule] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule]
2017-09-14 19:51:39 +00:00
sections to configure several rules.</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > TypeOfService=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Takes a number between 0 and 255 that specifies the type of service to match.</para>
2017-09-14 19:51:39 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > From=</varname> </term>
<listitem >
<para > Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > To=</varname> </term>
<listitem >
<para > Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > FirewallMark=</varname> </term>
<listitem >
2020-11-13 06:05:31 +00:00
<para > Specifies the iptables firewall mark value to match (a number between 1 and
4294967295). Optionally, the firewall mask (also a number between 1 and 4294967295) can be
suffixed with a slash (<literal > /</literal> ), e.g., <literal > 7/255</literal> .</para>
2017-09-14 19:51:39 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Table=</varname> </term>
<listitem >
2021-01-19 11:58:53 +00:00
<para > Specifies the routing table identifier to lookup if the rule selector matches. Takes one of predefined names
<literal > default</literal> , <literal > main</literal> , and <literal > local</literal> , and names defined in <varname > RouteTable=</varname>
in <citerefentry > <refentrytitle > networkd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2019-07-08 11:19:28 +00:00
or a number between 1 and 4294967295. Defaults to <literal > main</literal> .</para>
2017-09-14 19:51:39 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Priority=</varname> </term>
<listitem >
<para > Specifies the priority of this rule. <varname > Priority=</varname> is an unsigned
2021-08-17 05:03:19 +00:00
integer in the range 0…4294967295. Higher number means lower priority, and rules get
processed in order of increasing number. Defaults to unset, and the kernel will pick
a value dynamically.</para>
2017-09-14 19:51:39 +00:00
</listitem>
</varlistentry>
2017-11-21 10:51:50 +00:00
<varlistentry >
<term > <varname > IncomingInterface=</varname> </term>
<listitem >
<para > Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > OutgoingInterface=</varname> </term>
<listitem >
<para > Specifies the outgoing device to match. The outgoing interface is only available for packets originating from local sockets that are bound to a device.</para>
</listitem>
</varlistentry>
2018-11-27 05:28:54 +00:00
<varlistentry >
<term > <varname > SourcePort=</varname> </term>
<listitem >
<para > Specifies the source IP port or IP port range match in forwarding information base (FIB) rules.
A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DestinationPort=</varname> </term>
<listitem >
<para > Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules.
A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
2018-11-29 15:42:39 +00:00
<term > <varname > IPProtocol=</varname> </term>
2018-11-27 05:28:54 +00:00
<listitem >
2018-11-29 15:43:40 +00:00
<para > Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as <literal > tcp</literal> ,
<literal > udp</literal> or <literal > sctp</literal> , or IP protocol number such as <literal > 6</literal> for <literal > tcp</literal> or
<literal > 17</literal> for <literal > udp</literal> .
2018-11-27 05:28:54 +00:00
Defaults to unset.</para>
</listitem>
</varlistentry>
2018-12-03 12:55:30 +00:00
<varlistentry >
<term > <varname > InvertRule=</varname> </term>
<listitem >
2020-02-02 23:25:48 +00:00
<para > A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
2018-12-03 12:55:30 +00:00
</listitem>
</varlistentry>
2019-07-31 22:41:36 +00:00
<varlistentry >
<term > <varname > Family=</varname> </term>
<listitem >
<para > Takes a special value <literal > ipv4</literal> , <literal > ipv6</literal> , or
<literal > both</literal> . By default, the address family is determined by the address
specified in <varname > To=</varname> or <varname > From=</varname> . If neither
<varname > To=</varname> nor <varname > From=</varname> are specified, then defaults to
<literal > ipv4</literal> .</para>
</listitem>
</varlistentry>
2020-01-26 13:22:38 +00:00
<varlistentry >
<term > <varname > User=</varname> </term>
<listitem >
<para > Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to
unset.</para>
</listitem>
</varlistentry>
2020-02-02 23:25:48 +00:00
<varlistentry >
<term > <varname > SuppressPrefixLength=</varname> </term>
<listitem >
2021-01-28 19:42:37 +00:00
<para > Takes a number <replaceable > N</replaceable> in the range 0…128 and rejects routing
2020-02-02 23:25:48 +00:00
decisions that have a prefix length of <replaceable > N</replaceable> or less. Defaults to
unset.</para>
</listitem>
</varlistentry>
2020-12-18 03:21:15 +00:00
<varlistentry >
<term > <varname > Type=</varname> </term>
<listitem >
<para > Specifies Routing Policy Database (RPDB) rule type. Takes one of <literal > blackhole</literal> ,
<literal > unreachable</literal> or <literal > prohibit</literal> .
</para>
</listitem>
</varlistentry>
2017-09-14 19:51:39 +00:00
</variablelist>
2019-10-04 19:40:51 +00:00
</refsect1>
<refsect1 >
<title > [NextHop] Section Options</title>
2020-07-06 08:49:59 +00:00
<para > The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The
[NextHop] section accepts the following keys. Specify several [NextHop] sections to configure several
hops.</para>
2019-10-04 19:40:51 +00:00
<variablelist class= 'network-directives' >
2021-02-09 06:42:51 +00:00
<varlistentry >
<term > <varname > Id=</varname> </term>
<listitem >
<para > The id of the next hop. Takes an unsigned integer in the range 1…4294967295. If left
unspecified, then automatically chosen by kernel.</para>
</listitem>
</varlistentry>
2019-10-04 19:40:51 +00:00
<varlistentry >
<term > <varname > Gateway=</varname> </term>
<listitem >
2021-02-09 06:42:51 +00:00
<para > As in the [Network] section.</para>
2019-10-04 19:40:51 +00:00
</listitem>
</varlistentry>
<varlistentry >
2021-02-09 06:42:51 +00:00
<term > <varname > Family=</varname> </term>
2019-10-04 19:40:51 +00:00
<listitem >
2021-02-09 06:42:51 +00:00
<para > Takes one of the special values <literal > ipv4</literal> or <literal > ipv6</literal> .
By default, the family is determined by the address specified in
<varname > Gateway=</varname> . If <varname > Gateway=</varname> is not specified, then defaults
to <literal > ipv4</literal> .</para>
2019-10-04 19:40:51 +00:00
</listitem>
</varlistentry>
2021-02-14 05:49:35 +00:00
<varlistentry >
<term > <varname > OnLink=</varname> </term>
<listitem >
<para > Takes a boolean. If set to true, the kernel does not have to check if the gateway is
reachable directly by the current machine (i.e., attached to the local network), so that we
can insert the nexthop in the kernel table without it being complained about. Defaults to
<literal > no</literal> .</para>
</listitem>
</varlistentry>
2021-02-14 17:56:24 +00:00
<varlistentry >
<term > <varname > Blackhole=</varname> </term>
<listitem >
<para > Takes a boolean. If enabled, packets to the corresponding routes are discarded
silently, and <varname > Gateway=</varname> cannot be specified. Defaults to
<literal > no</literal> .</para>
</listitem>
</varlistentry>
2021-05-14 01:15:23 +00:00
<varlistentry >
<term > <varname > Group=</varname> </term>
<listitem >
<para > Takes a whitespace separated list of nexthop IDs. Each ID must be in the range
1…4294967295. Optionally, each nexthop ID can take a weight after a colon
(<literal > <replaceable > id</replaceable> <optional > :<replaceable > weight</replaceable> </optional> </literal> ).
The weight must be in the range 1…255. If the weight is not specified, then it is assumed
that the weight is 1. This setting cannot be specified with <varname > Gateway=</varname> ,
<varname > Family=</varname> , <varname > Blackhole=</varname> . This setting can be specified
multiple times. If an empty string is assigned, then the all previous assignments are
cleared. Defaults to unset.</para>
</listitem>
</varlistentry>
2019-10-04 19:40:51 +00:00
</variablelist>
2017-09-14 19:51:39 +00:00
</refsect1>
2015-02-04 02:14:13 +00:00
<refsect1 >
<title > [Route] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [Route] section accepts the following keys. Specify several [Route] sections to configure
several routes.</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Gateway=</varname> </term>
<listitem >
2020-10-07 11:34:00 +00:00
<para > Takes the gateway address or the special values <literal > _dhcp4</literal> and
2020-10-12 05:52:11 +00:00
<literal > _ipv6ra</literal> . If <literal > _dhcp4</literal> or <literal > _ipv6ra</literal> is
set, then the gateway address provided by DHCPv4 or IPv6 RA is used.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2021-02-14 05:49:46 +00:00
<varlistentry >
<term > <varname > GatewayOnLink=</varname> </term>
<listitem >
<para > Takes a boolean. If set to true, the kernel does not have to check if the gateway is
2021-02-14 05:49:35 +00:00
reachable directly by the current machine (i.e., attached to the local network), so that we
can insert the route in the kernel table without it being complained about. Defaults to
<literal > no</literal> .</para>
2021-02-14 05:49:46 +00:00
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > Destination=</varname> </term>
<listitem >
<para > The destination prefix of the route. Possibly
2014-08-03 05:11:12 +00:00
followed by a slash and the prefix length. If omitted, a
2015-02-04 02:14:13 +00:00
full-length host route is assumed.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Source=</varname> </term>
<listitem >
<para > The source prefix of the route. Possibly followed by
2014-08-03 05:11:12 +00:00
a slash and the prefix length. If omitted, a full-length
2015-02-04 02:14:13 +00:00
host route is assumed.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Metric=</varname> </term>
<listitem >
2021-04-17 17:37:13 +00:00
<para > The metric of the route. Takes an unsigned integer in the range 0…4294967295.
2021-07-27 07:37:29 +00:00
Defaults to unset, and the kernel's default will be used.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2017-04-25 07:32:59 +00:00
<varlistentry >
<term > <varname > IPv6Preference=</varname> </term>
<listitem >
<para > Specifies the route preference as defined in <ulink
2020-07-06 08:49:59 +00:00
url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery messages. Which
can be one of <literal > low</literal> the route has a lowest priority, <literal > medium</literal>
the route has a default priority or <literal > high</literal> the route has a highest priority.
</para>
2017-04-25 07:32:59 +00:00
</listitem>
</varlistentry>
2015-02-09 15:22:34 +00:00
<varlistentry >
<term > <varname > Scope=</varname> </term>
<listitem >
2021-01-17 01:10:57 +00:00
<para > The scope of the IPv4 route, which can be <literal > global</literal> , <literal > site</literal> ,
<literal > link</literal> , <literal > host</literal> , or
<literal > nowhere</literal> :</para>
<itemizedlist >
<listitem > <para > <literal > global</literal> means the route can reach
hosts more than one hop away.</para> </listitem>
<listitem > <para > <literal > site</literal> means an interior route in
the local autonomous system.</para> </listitem>
<listitem > <para > <literal > link</literal> means the route can only
reach hosts on the local network (one hop away).</para> </listitem>
<listitem > <para > <literal > host</literal> means the route will not
leave the local machine (used for internal addresses like
127.0.0.1).</para> </listitem>
<listitem > <para > <literal > nowhere</literal> means the destination
doesn't exist.</para> </listitem>
</itemizedlist>
<para > For IPv4 route, defaults to <literal > host</literal> if <varname > Type=</varname> is
<literal > local</literal> or <literal > nat</literal> ,
and <literal > link</literal> if <varname > Type=</varname> is
2019-11-26 03:41:54 +00:00
<literal > broadcast</literal> , <literal > multicast</literal> , or <literal > anycast</literal> .
2021-01-17 01:10:57 +00:00
In other cases, defaults to <literal > global</literal> . The value is
not used for IPv6.</para>
2015-02-09 15:22:34 +00:00
</listitem>
2015-09-23 15:26:36 +00:00
</varlistentry>
<varlistentry >
<term > <varname > PreferredSource=</varname> </term>
<listitem >
<para > The preferred source address of the route. The address
must be in the format described in
<citerefentry project= 'man-pages' > <refentrytitle > inet_pton</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> .</para>
</listitem>
2015-02-09 15:22:34 +00:00
</varlistentry>
2016-05-03 17:48:21 +00:00
<varlistentry >
2019-11-26 03:41:54 +00:00
<term > <varname > Table=</varname> </term>
2016-05-03 17:48:21 +00:00
<listitem >
2021-01-19 11:58:53 +00:00
<para > The table identifier for the route. Takes one of predefined names <literal > default</literal> , <literal > main</literal> ,
and <literal > local</literal> , and names defined in <varname > RouteTable=</varname> in <citerefentry > <refentrytitle > networkd.conf</refentrytitle>
<manvolnum > 5</manvolnum> </citerefentry> , or a number between 1 and 4294967295. The table can be retrieved using
<command > ip route show table <replaceable > num</replaceable> </command> . If unset and <varname > Type=</varname> is <literal > local</literal> ,
<literal > broadcast</literal> , <literal > anycast</literal> , or <literal > nat</literal> , then <literal > local</literal> is used.
2019-11-26 03:41:54 +00:00
In other cases, defaults to <literal > main</literal> .
2016-05-03 17:48:21 +00:00
</para>
</listitem>
</varlistentry>
2017-05-09 18:01:25 +00:00
<varlistentry >
<term > <varname > Protocol=</varname> </term>
<listitem >
2018-10-16 15:19:23 +00:00
<para > The protocol identifier for the route. Takes a number between 0 and 255 or the special values
2019-07-14 00:51:54 +00:00
<literal > kernel</literal> , <literal > boot</literal> , <literal > static</literal> ,
<literal > ra</literal> and <literal > dhcp</literal> . Defaults to <literal > static</literal> .
2017-05-09 18:01:25 +00:00
</para>
</listitem>
</varlistentry>
2017-09-19 14:28:26 +00:00
<varlistentry >
<term > <varname > Type=</varname> </term>
<listitem >
2019-07-07 00:40:17 +00:00
<para > Specifies the type for the route. Takes one of <literal > unicast</literal> ,
<literal > local</literal> , <literal > broadcast</literal> , <literal > anycast</literal> ,
<literal > multicast</literal> , <literal > blackhole</literal> , <literal > unreachable</literal> ,
<literal > prohibit</literal> , <literal > throw</literal> , <literal > nat</literal> , and
<literal > xresolve</literal> . If <literal > unicast</literal> , a regular route is defined, i.e. a
2018-10-16 15:18:30 +00:00
route indicating the path to take to a destination network address. If <literal > blackhole</literal> , packets
to the defined route are discarded silently. If <literal > unreachable</literal> , packets to the defined route
are discarded and the ICMP message "Host Unreachable" is generated. If <literal > prohibit</literal> , packets
to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is
generated. If <literal > throw</literal> , route lookup in the current routing table will fail and the route
selection process will return to Routing Policy Database (RPDB). Defaults to <literal > unicast</literal> .
2017-09-19 14:28:26 +00:00
</para>
</listitem>
</varlistentry>
2017-12-29 14:18:05 +00:00
<varlistentry >
<term > <varname > InitialCongestionWindow=</varname> </term>
<listitem >
2020-09-17 08:01:36 +00:00
<para > The TCP initial congestion window is used during the start of a TCP connection.
During the start of a TCP session, when a client requests a resource, the server's initial
congestion window determines how many packets will be sent during the initial burst of data
without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is
considered an extremely large value for this option. When unset, the kernel's default
(typically 10) will be used.</para>
2017-12-29 14:18:05 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > InitialAdvertisedReceiveWindow=</varname> </term>
<listitem >
2020-09-17 08:01:36 +00:00
<para > The TCP initial advertised receive window is the amount of receive data (in bytes)
that can initially be buffered at one time on a connection. The sending host can send only
that amount of data before waiting for an acknowledgment and window update from the
receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely
large value for this option. When unset, the kernel's default will be used.</para>
2017-12-29 14:18:05 +00:00
</listitem>
</varlistentry>
2018-01-19 23:49:15 +00:00
<varlistentry >
<term > <varname > QuickAck=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
2018-01-19 23:49:15 +00:00
</para>
</listitem>
</varlistentry>
2019-05-13 11:15:33 +00:00
<varlistentry >
<term > <varname > FastOpenNoCookie=</varname> </term>
<listitem >
<para > Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis.
When unset, the kernel's default will be used.
</para>
</listitem>
2018-01-19 23:49:15 +00:00
</varlistentry>
2019-05-16 09:49:08 +00:00
<varlistentry >
<term > <varname > TTLPropagate=</varname> </term>
<listitem >
<para > Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress.
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
2018-05-21 11:33:36 +00:00
<varlistentry >
<term > <varname > MTUBytes=</varname> </term>
<listitem >
<para > The maximum transmission unit in bytes to set for the
route. The usual suffixes K, M, G, are supported and are
understood to the base of 1024.</para>
<para > Note that if IPv6 is enabled on the interface, and the MTU is chosen
below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para>
</listitem>
2019-09-23 11:25:21 +00:00
</varlistentry>
<varlistentry >
<term > <varname > IPServiceType=</varname> </term>
<listitem >
2019-11-28 18:26:57 +00:00
<para > Takes string; <literal > CS6</literal> or <literal > CS4</literal> . Used to set IP
service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.</para>
2019-09-23 11:25:21 +00:00
</listitem>
</varlistentry>
2021-01-07 15:17:17 +00:00
<varlistentry >
<term > <varname > TCPAdvertisedMaximumSegmentSize=</varname> </term>
<listitem >
<para > Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G, are
2021-11-04 00:20:21 +00:00
supported and are understood to the base of 1024. An unsigned integer in the range 1…4294967294.
2021-01-07 15:17:17 +00:00
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
2019-11-28 15:36:02 +00:00
<varlistentry >
<term > <varname > MultiPathRoute=<replaceable > address</replaceable> [@<replaceable > name</replaceable> ] [<replaceable > weight</replaceable> ]</varname> </term>
<listitem >
<para > Configures multipath route. Multipath routing is the technique of using multiple
alternative paths through a network. Takes gateway address. Optionally, takes a network
interface name or index separated with <literal > @</literal> , and a weight in 1..256 for
this multipath route separated with whitespace. This setting can be specified multiple
times. If an empty string is assigned, then the all previous assignments are cleared.</para>
</listitem>
</varlistentry>
2021-02-09 09:52:57 +00:00
<varlistentry >
<term > <varname > NextHop=</varname> </term>
<listitem >
<para > Specifies the nexthop id. Takes an unsigned integer in the range 1…4294967295.
If set, the corresponding [NextHop] section must be configured. Defaults to unset.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
</variablelist>
</refsect1>
<refsect1 >
2019-07-10 08:33:05 +00:00
<title > [DHCPv4] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
2015-08-27 15:32:30 +00:00
<varname > DHCP=</varname> setting described above:</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
2021-05-14 06:58:44 +00:00
<!-- DHCP packet contents -->
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendHostname=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
2021-05-14 07:04:30 +00:00
<para > When true (the default), the machine's hostname (or the value specified with
2021-07-27 07:37:29 +00:00
<varname > Hostname=</varname> , described below) will be sent to the DHCP server. Note that the
hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be
formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option is
true.</para>
2021-05-14 06:58:44 +00:00
</listitem>
</varlistentry>
2015-05-19 02:34:07 +00:00
2021-05-14 06:58:44 +00:00
<varlistentry >
<term > <varname > Hostname=</varname> </term>
<listitem >
<para > Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname.
Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and
no spaces or dots, and be formatted as a valid DNS domain name.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
2019-07-16 17:47:20 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > MUDURL=</varname> </term>
2019-07-16 17:47:20 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the
DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification that the
string is a valid URL will be performed. DHCPv4 clients are intended to have at most one MUD URL
associated with them. See <ulink url= "https://tools.ietf.org/html/rfc8520" > RFC </ulink> .
</para>
<para > MUD is an embedded software standard defined by the IETF that allows IoT device makers to
advertise device specifications, including the intended communication patterns for their device
when it connects to the network. The network can then use this to author a context-specific
access policy, so the device functions only within those parameters.</para>
2019-07-16 17:47:20 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
2015-03-13 19:01:29 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > ClientIdentifier=</varname> </term>
2015-03-13 19:01:29 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > The DHCPv4 client identifier to use. Takes one of <option > mac</option> ,
<option > duid</option> or <option > duid-only</option> . If set to <option > mac</option> , the
MAC address of the link is used. If set to <option > duid</option> , an RFC4361-compliant Client
ID, which is the combination of IAID and DUID (see below), is used. If set to
<option > duid-only</option> , only DUID is used, this may not be RFC compliant, but some setups
may require to use this. Defaults to <option > duid</option> .</para>
2015-03-13 19:01:29 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
2021-04-20 17:23:00 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > VendorClassIdentifier=</varname> </term>
2021-04-20 17:23:00 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > The vendor class identifier used to identify vendor
type and configuration.</para>
2021-04-20 17:23:00 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
2019-09-18 13:22:47 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UserClass=</varname> </term>
2019-09-18 13:22:47 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > A DHCPv4 client can use UserClass option to identify the type or category of user or
applications it represents. The information contained in this option is a string that represents
the user class of which the client is a member. Each class sets an identifying string of
information to be used by the DHCP service to classify clients. Takes a whitespace-separated list
of strings.</para>
2019-09-18 13:22:47 +00:00
</listitem>
</varlistentry>
2020-03-27 20:12:07 +00:00
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > DUIDType=</varname> </term>
<listitem >
<para > Override the global <varname > DUIDType=</varname> setting for this network. See
<citerefentry > <refentrytitle > networkd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for a description of possible values.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DUIDRawData=</varname> </term>
<listitem >
<para > Override the global <varname > DUIDRawData=</varname> setting for this network. See
<citerefentry > <refentrytitle > networkd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for a description of possible values.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > IAID=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
integer.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
2017-07-29 23:10:40 +00:00
<varlistentry >
<term > <varname > Anonymize=</varname> </term>
<listitem >
2021-04-14 05:13:26 +00:00
<para > Takes a boolean. When true, the options sent to the DHCP server will follow the
<ulink url= "https://tools.ietf.org/html/rfc7844" > RFC 7844</ulink> (Anonymity Profiles for
DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para>
<para > This option should only be set to true when <varname > MACAddressPolicy=</varname> is
2021-05-14 06:58:44 +00:00
set to <option > random</option> (see
2021-06-28 09:44:22 +00:00
<citerefentry > <refentrytitle > systemd.link</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ).
2021-04-14 05:13:26 +00:00
</para>
<para > When true, <varname > SendHostname=</varname> , <varname > ClientIdentifier=</varname> ,
<varname > VendorClassIdentifier=</varname> , <varname > UserClass=</varname> ,
<varname > RequestOptions=</varname> , <varname > SendOption=</varname> ,
<varname > SendVendorOption=</varname> , and <varname > MUDURL=</varname> are ignored.</para>
2017-07-29 23:10:40 +00:00
2021-04-14 05:13:26 +00:00
<para > With this option enabled DHCP requests will mimic those generated by Microsoft
Windows, in order to reduce the ability to fingerprint and recognize installations. This
means DHCP request sizes will grow and lease data will be more comprehensive than normally,
though most of the requested data is not actually used.</para>
2017-07-29 23:10:40 +00:00
</listitem>
</varlistentry>
2020-03-30 14:43:28 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > RequestOptions=</varname> </term>
2020-03-30 14:43:28 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Sets request options to be sent to the server in the DHCPv4 request options list. A
whitespace-separated list of integers in the range 1…254. Defaults to unset.</para>
2020-03-30 14:43:28 +00:00
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendOption=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type
and data separated with a colon
(<literal > <replaceable > option</replaceable> :<replaceable > type</replaceable> :<replaceable > value</replaceable> </literal> ).
The option number must be an integer in the range 1…254. The type takes one of
<literal > uint8</literal> , <literal > uint16</literal> , <literal > uint32</literal> ,
<literal > ipv4address</literal> , or <literal > string</literal> . Special characters in the data
string may be escaped using <ulink
url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
escapes</ulink> . This setting can be specified multiple times. If an empty string is specified,
then all options specified earlier are cleared. Defaults to unset.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
2015-07-11 03:56:55 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendVendorOption=</varname> </term>
2018-08-02 07:32:42 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data
type and data separated with a colon
(<literal > <replaceable > option</replaceable> :<replaceable > type</replaceable> :<replaceable > value</replaceable> </literal> ).
The option number must be an integer in the range 1…254. The type takes one of
<literal > uint8</literal> , <literal > uint16</literal> , <literal > uint32</literal> ,
<literal > ipv4address</literal> , or <literal > string</literal> . Special characters in the data
string may be escaped using <ulink
url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
escapes</ulink> . This setting can be specified multiple times. If an empty string is specified,
then all options specified earlier are cleared. Defaults to unset.</para>
2018-08-02 07:32:42 +00:00
</listitem>
</varlistentry>
2016-01-25 21:27:01 +00:00
2021-05-14 06:58:44 +00:00
<!-- How to use the DHCP lease -->
2016-01-25 21:27:01 +00:00
2021-08-14 20:50:14 +00:00
<varlistentry >
<term > <varname > Label=</varname> </term>
<listitem >
<para > Specifies the label for the IPv4 address received from the DHCP server.
The label must be a 7-bit ASCII string with a length of 1…15 characters.
Defaults to unset.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseDNS=</varname> </term>
2020-03-16 09:55:10 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true (the default), the DNS servers received from the DHCP server will be used.</para>
<para > This corresponds to the <option > nameserver</option>
option in <citerefentry
project='man-pages'><refentrytitle > resolv.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2020-03-16 09:55:10 +00:00
</listitem>
</varlistentry>
2015-08-27 15:32:30 +00:00
2015-03-03 18:49:48 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > RoutesToDNS=</varname> </term>
2015-03-03 18:49:48 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true, the routes to the DNS servers received from the DHCP server will be
configured. When <varname > UseDNS=</varname> is disabled, this setting is ignored.
Defaults to true.</para>
2015-03-03 18:49:48 +00:00
</listitem>
</varlistentry>
2016-04-30 00:16:55 +00:00
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseNTP=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true (the default), the NTP servers received from the DHCP server will be used by
<filename > systemd-timesyncd.service</filename> .</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2016-04-26 14:19:28 +00:00
2018-05-07 12:21:02 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > RoutesToNTP=</varname> </term>
2018-05-07 12:21:02 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true, the routes to the NTP servers received from the DHCP server will be
configured. When <varname > UseNTP=</varname> is disabled, this setting is ignored.
Defaults to true.</para>
2018-05-07 12:21:02 +00:00
</listitem>
</varlistentry>
2019-05-04 11:40:54 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseSIP=</varname> </term>
2019-05-04 11:40:54 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true (the default), the SIP servers received from the DHCP server will be collected
and made available to client programs.</para>
2019-05-04 11:40:54 +00:00
</listitem>
</varlistentry>
2016-04-30 00:16:55 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseMTU=</varname> </term>
2016-04-30 00:16:55 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true, the interface maximum transmission unit from the DHCP server will be used on the
current link. If <varname > MTUBytes=</varname> is set, then this setting is ignored. Defaults to
false.</para>
2016-04-30 00:16:55 +00:00
</listitem>
</varlistentry>
2016-04-26 14:19:28 +00:00
2016-04-30 00:16:55 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseHostname=</varname> </term>
2016-04-30 00:16:55 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true (the default), the hostname received from the DHCP server will be set as the
transient hostname of the system.</para>
2016-04-26 14:19:28 +00:00
</listitem>
</varlistentry>
2016-04-30 00:16:55 +00:00
2016-05-06 15:04:05 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseDomains=</varname> </term>
2016-05-06 15:04:05 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Takes a boolean, or the special value <option > route</option> . When true, the domain name
received from the DHCP server will be used as DNS search domain over this link, similar to the
effect of the <option > Domains=</option> setting. If set to <option > route</option> , the domain
name received from the DHCP server will be used for routing DNS queries only, but not for
searching, similar to the effect of the <option > Domains=</option> setting when the argument is
prefixed with <literal > ~</literal> . Defaults to false.</para>
<para > It is recommended to enable this option only on trusted networks, as setting this affects
resolution of all hostnames, in particular of single-label names. It is generally safer to use
the supplied domain only as routing domain, rather than as search domain, in order to not have it
affect local resolution of single-label names.</para>
<para > When set to true, this setting corresponds to the <option > domain</option> option in
<citerefentry project= 'man-pages' > <refentrytitle > resolv.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
</para>
2016-05-06 15:04:05 +00:00
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseRoutes=</varname> </term>
2015-02-04 02:14:13 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true (the default), the static routes will be requested from the DHCP server and added
to the routing table with a metric of 1024, and a scope of <option > global</option> ,
<option > link</option> or <option > host</option> , depending on the route's destination and
gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's own
address, the scope will be set to <option > host</option> . Otherwise if the gateway is null (a
direct route), a <option > link</option> scope will be used. For anything else, scope defaults to
<option > global</option> .</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2016-04-30 00:16:55 +00:00
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > RouteMetric=</varname> </term>
<listitem >
2021-08-17 14:53:49 +00:00
<para > Set the routing metric for routes specified by the DHCP server (including the prefix
route added for the specified prefix). Takes an unsigned integer in the range 0…4294967295.
Defaults to 1024.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2016-09-19 02:26:12 +00:00
<varlistentry >
<term > <varname > RouteTable=<replaceable > num</replaceable> </varname> </term>
<listitem >
2016-09-24 14:56:13 +00:00
<para > The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
2016-09-19 02:26:12 +00:00
The table can be retrieved using <command > ip route show table <replaceable > num</replaceable> </command> .
</para>
2020-07-06 08:49:59 +00:00
<para > When used in combination with <varname > VRF=</varname> , the
VRF's routing table is used when this parameter is not specified.
2017-09-26 23:52:07 +00:00
</para>
2016-09-19 02:26:12 +00:00
</listitem>
</varlistentry>
2016-11-10 23:34:19 +00:00
2019-12-19 10:05:16 +00:00
<varlistentry >
<term > <varname > RouteMTUBytes=</varname> </term>
<listitem >
<para > Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para>
</listitem>
</varlistentry>
2016-11-10 23:34:19 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseGateway=</varname> </term>
2016-11-10 23:34:19 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true, the gateway will be requested from the DHCP server and added to the routing
table with a metric of 1024, and a scope of <option > link</option> . When unset, the value specified
with <varname > UseRoutes=</varname> is used.</para>
2016-11-10 23:34:19 +00:00
</listitem>
</varlistentry>
2018-01-22 08:09:18 +00:00
2021-05-14 06:58:44 +00:00
<varlistentry >
<term > <varname > UseTimezone=</varname> </term>
<listitem > <para > When true, the timezone received from the DHCP server will be set as timezone of
the local system. Defaults to false.</para> </listitem>
</varlistentry>
<varlistentry >
2020-05-20 04:23:36 +00:00
<term > <varname > FallbackLeaseLifetimeSec=</varname> </term>
<listitem >
<para > Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
2021-07-27 07:37:29 +00:00
Takes one of <literal > forever</literal> or <literal > infinity</literal> . The latter means that the
address never expires. Defaults to unset.</para>
2020-05-20 04:23:36 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
<!-- How to communicate with the server -->
2019-05-13 14:30:28 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > RequestBroadcast=</varname> </term>
2019-05-13 14:30:28 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Request the server to use broadcast messages before the IP address has been configured.
This is necessary for devices that cannot receive RAW packets, or that cannot receive packets at
all before an IP address has been configured. On the other hand, this must not be enabled on
networks where broadcasts are filtered out.</para>
2019-05-13 14:30:28 +00:00
</listitem>
</varlistentry>
2019-12-20 13:13:18 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > MaxAttempts=</varname> </term>
2019-12-20 13:13:18 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Specifies how many times the DHCPv4 client configuration should be attempted. Takes a
number or <literal > infinity</literal> . Defaults to <literal > infinity</literal> . Note that the
time between retries is increased exponentially, up to approximately one per minute, so the
network will not be overloaded even if this number is high. The default is suitable in most
circumstances.</para>
2019-12-20 13:13:18 +00:00
</listitem>
</varlistentry>
2019-07-09 14:23:28 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > ListenPort=</varname> </term>
<listitem >
2021-05-14 07:04:30 +00:00
<para > Set the port from which the DHCP client packets originate.</para>
2021-05-14 06:58:44 +00:00
</listitem>
2020-06-26 03:28:52 +00:00
</varlistentry>
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > DenyList=</varname> </term>
<listitem >
2021-08-22 16:36:21 +00:00
<para > A whitespace-separated list of IPv4 addresses. Each address can optionally take a
prefix length after <literal > /</literal> . DHCP offers from servers in the list are
2021-05-14 06:58:44 +00:00
rejected. Note that if <varname > AllowList=</varname> is configured then
<varname > DenyList=</varname> is ignored.</para>
</listitem>
2019-09-17 12:49:22 +00:00
</varlistentry>
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > AllowList=</varname> </term>
2019-07-09 14:23:28 +00:00
<listitem >
2021-08-22 16:36:21 +00:00
<para > A whitespace-separated list of IPv4 addresses. Each address can optionally take a
prefix length after <literal > /</literal> . DHCP offers from servers in the list are
2021-05-14 06:58:44 +00:00
accepted.</para>
2019-07-09 14:23:28 +00:00
</listitem>
</varlistentry>
2019-09-26 18:06:02 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendRelease=</varname> </term>
2019-09-26 18:06:02 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
true.</para>
2020-02-28 18:28:49 +00:00
</listitem>
</varlistentry>
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendDecline=</varname> </term>
2020-02-28 18:28:49 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > A boolean. When <literal > true</literal> , the DHCPv4 client receives the IP address from the
DHCP server. After a new IP is received, the DHCPv4 client performs IPv4 Duplicate Address
Detection. If duplicate use is detected, the DHCPv4 client rejects the IP by sending a
<constant > DHCPDECLINE</constant> packet and tries to obtain an IP address again. See <ulink
2021-07-12 02:06:08 +00:00
url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink> . Defaults to
2021-05-14 06:58:44 +00:00
<literal > unset</literal> .</para>
2019-09-26 18:06:02 +00:00
</listitem>
</varlistentry>
2021-05-14 06:58:44 +00:00
</variablelist>
2019-07-09 14:23:28 +00:00
</refsect1>
<refsect1 >
<title > [DHCPv6] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
2019-07-10 08:33:05 +00:00
<varname > DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
2019-07-09 14:23:28 +00:00
<variablelist class= 'network-directives' >
2021-05-14 06:58:44 +00:00
<!-- DHCP packet contents -->
2021-01-11 15:02:09 +00:00
2019-07-09 14:23:28 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > MUDURL=</varname> </term>
2021-04-10 01:24:17 +00:00
<term > <varname > IAID=</varname> </term>
<term > <varname > DUIDType=</varname> </term>
<term > <varname > DUIDRawData=</varname> </term>
2021-05-14 06:58:44 +00:00
<term > <varname > RequestOptions=</varname> </term>
2019-07-09 14:23:28 +00:00
<listitem >
2020-07-06 09:00:06 +00:00
<para > As in the [DHCPv4] section.</para>
2019-07-09 14:23:28 +00:00
</listitem>
</varlistentry>
2018-01-22 08:09:18 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendOption=</varname> </term>
2020-03-30 14:31:10 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option
numbers, the option number is an integer in the range 1…65536.</para>
2020-03-30 14:31:10 +00:00
</listitem>
</varlistentry>
2020-04-23 12:31:47 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > SendVendorOption=</varname> </term>
2020-04-23 12:31:47 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP
option number, data type, and data separated with a colon (<literal > <replaceable > enterprise
identifier</replaceable> :<replaceable > option</replaceable> :<replaceable > type</replaceable> :<replaceable > value</replaceable> </literal> ).
Enterprise identifier is an unsigned integer in the range 1…4294967294. The option number must be
an integer in the range 1…254. Data type takes one of <literal > uint8</literal> ,
<literal > uint16</literal> , <literal > uint32</literal> , <literal > ipv4address</literal> ,
<literal > ipv6address</literal> , or <literal > string</literal> . Special characters in the data
string may be escaped using <ulink
url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
escapes</ulink> . This setting can be specified multiple times. If an empty string is specified,
then all options specified earlier are cleared. Defaults to unset.</para>
2020-04-23 12:31:47 +00:00
</listitem>
</varlistentry>
2020-05-26 08:46:54 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UserClass=</varname> </term>
2020-05-26 08:46:54 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > A DHCPv6 client can use User Class option to identify the type or category of user or
applications it represents. The information contained in this option is a string that represents
the user class of which the client is a member. Each class sets an identifying string of
information to be used by the DHCP service to classify clients. Special characters in the data
string may be escaped using <ulink
2020-07-06 08:49:59 +00:00
url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
2020-05-26 08:46:54 +00:00
escapes</ulink> . This setting can be specified multiple times. If an empty string is specified,
2021-05-14 06:58:44 +00:00
then all options specified earlier are cleared. Takes a whitespace-separated list of
strings. Note that currently <constant > NUL</constant> bytes are not allowed.</para>
2020-05-26 08:46:54 +00:00
</listitem>
</varlistentry>
2018-09-07 20:15:55 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > VendorClass=</varname> </term>
2018-09-07 20:15:55 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the
hardware on which the client is running. The information contained in the data area of this
option is contained in one or more opaque fields that identify details of the hardware
configuration. Takes a whitespace-separated list of strings.</para>
2018-09-07 20:15:55 +00:00
</listitem>
</varlistentry>
2019-09-25 03:14:12 +00:00
<varlistentry >
<term > <varname > PrefixDelegationHint=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Takes an IPv6 address with prefix length in the same format as the
<varname > Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix
hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range
2021-11-04 00:20:21 +00:00
1…128. Defaults to unset.</para>
2019-09-25 03:14:12 +00:00
</listitem>
</varlistentry>
2020-02-15 12:51:34 +00:00
2021-05-14 06:58:44 +00:00
<!-- How to use the DHCP lease -->
2020-02-15 12:51:34 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > UseAddress=</varname> </term>
2020-02-15 12:51:34 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > When true (the default), the IP addresses provided by the DHCPv6 server will be
assigned.</para>
2020-02-15 12:51:34 +00:00
</listitem>
</varlistentry>
2020-05-01 14:30:31 +00:00
2021-10-13 07:26:09 +00:00
<varlistentry >
<term > <varname > UseDelegatedPrefix=</varname> </term>
<listitem >
<para > When true (the default), the client will request the DHCPv6 server to delegate
prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are
assigned to the interfaces which enables <varname > DHCPv6PrefixDelegation=</varname> .
See also <varname > DHCPv6PrefixDelegation=</varname> in [Network] section,
[DHCPv6PrefixDelegation] section, and
<ulink url= "https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3" > RFC 8415</ulink> .
</para>
</listitem>
</varlistentry>
2020-05-01 14:30:31 +00:00
<varlistentry >
2021-09-08 00:35:34 +00:00
<term > <varname > RouteMetric=</varname> </term>
2021-05-14 06:58:44 +00:00
<term > <varname > UseDNS=</varname> </term>
<term > <varname > UseNTP=</varname> </term>
<term > <varname > UseHostname=</varname> </term>
<term > <varname > UseDomains=</varname> </term>
2020-05-01 14:30:31 +00:00
<listitem >
2021-05-14 06:58:44 +00:00
<para > As in the [DHCPv4] section.</para>
2020-05-01 14:30:31 +00:00
</listitem>
</varlistentry>
2020-05-18 12:49:47 +00:00
2021-05-14 06:58:44 +00:00
<!-- How to communicate with the server -->
2020-05-17 15:14:47 +00:00
<varlistentry >
2021-05-14 06:58:44 +00:00
<term > <varname > WithoutRA=</varname> </term>
<listitem >
2021-10-14 10:27:08 +00:00
<para > Allows DHCPv6 client to start without router advertisements's managed or other
address configuration flag. Takes one of <literal > no</literal> , <literal > solicit</literal>
or <literal > information-request</literal> . When this is not specified and
<varname > UplinkInterface=:self</varname> is specified, then <literal > solicit</literal> is
implied. Otherwise, defaults to <literal > no</literal> , and the DHCPv6 client will be
started when an RA is received. See also <varname > DHCPv6Client=</varname> setting in the
[IPv6AcceptRA] section.</para>
2021-05-14 06:58:44 +00:00
</listitem>
</varlistentry>
2015-08-27 15:32:30 +00:00
</variablelist>
2019-07-09 14:23:28 +00:00
</refsect1>
2020-07-28 20:50:04 +00:00
<refsect1 >
<title > [DHCPv6PrefixDelegation] Section Options</title>
2020-10-19 03:48:39 +00:00
<para > The [DHCPv6PrefixDelegation] section configures delegated prefixes assigned by DHCPv6 server.
The settings in this section are used only when <varname > DHCPv6PrefixDelegation=</varname> setting
is enabled.</para>
2020-07-28 20:50:04 +00:00
<variablelist class= 'network-directives' >
2021-10-13 09:00:52 +00:00
<varlistentry >
<term > <varname > UplinkInterface=</varname> </term>
<listitem >
<para > Specifies the name or the index of the uplink interface, or one of the special values
<literal > :self</literal> and <literal > :auto</literal> . When <literal > :self</literal> , the
2021-10-14 10:27:08 +00:00
interface itself is considered the uplink interface, and
<varname > WithoutRA=solicit</varname> is implied if the setting is not explicitly specified.
When <literal > :auto</literal> , the first link which acquired prefixes to be delegated from
the DHCPv6 server is selected. Defaults to <literal > :auto</literal> .</para>
2021-10-13 09:00:52 +00:00
</listitem>
</varlistentry>
2020-07-28 20:50:04 +00:00
<varlistentry >
<term > <varname > SubnetId=</varname> </term>
<listitem >
<para > Configure a specific subnet ID on the interface from a (previously) received prefix
delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in
<ulink url= "https://tools.ietf.org/html/rfc4291#section-2.5.4" > RFC 4291</ulink> , section
2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff
2020-10-19 03:48:39 +00:00
inclusive.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Announce=</varname> </term>
<listitem >
<para > Takes a boolean. When enabled, and <varname > IPv6SendRA=</varname> in [Network] section
is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement.
Defaults to yes.</para>
2020-07-28 20:50:04 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Assign=</varname> </term>
<listitem >
<para > Takes a boolean. Specifies whether to add an address from the delegated prefixes which
2020-10-19 03:48:39 +00:00
are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN
interfce), the EUI-64 algorithm will be used by default to form an interface identifier from
the delegated prefixes. See also <varname > Token=</varname> setting below. Defaults to yes.
</para>
2020-07-28 20:50:04 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Token=</varname> </term>
<listitem >
2020-10-19 03:48:39 +00:00
<para > Specifies an optional address generation mode for assigning an address in each
2021-09-24 19:10:34 +00:00
delegated prefix. This accepts the same syntax as <varname > Token=</varname> in the
[IPv6AcceptRA] section. If <varname > Assign=</varname> is set to false, then this setting will
be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para>
2020-07-28 20:50:04 +00:00
</listitem>
</varlistentry>
2021-01-12 21:34:32 +00:00
<varlistentry >
<term > <varname > ManageTemporaryAddress=</varname> </term>
<listitem >
<para > As in the [Address] section, but defaults to true.</para>
</listitem>
</varlistentry>
2021-04-17 17:32:51 +00:00
<varlistentry >
<term > <varname > RouteMetric=</varname> </term>
<listitem >
<para > The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
2021-10-14 20:57:30 +00:00
the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
</para>
2021-04-17 17:32:51 +00:00
</listitem>
</varlistentry>
2020-07-28 20:50:04 +00:00
</variablelist>
</refsect1>
2016-03-30 23:33:55 +00:00
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
<refsect1 >
2016-06-07 09:19:26 +00:00
<title > [IPv6AcceptRA] Section Options</title>
2021-11-13 06:29:26 +00:00
<para > The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled
with the <varname > IPv6AcceptRA=</varname> setting described above:</para>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
2021-11-13 06:29:26 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Token=</varname> </term>
<listitem >
<para > Specifies an optional address generation mode for the Stateless Address
Autoconfiguration (SLAAC). The following values are supported:</para>
<variablelist >
<varlistentry >
<term > <option > eui64</option> </term>
<listitem >
<para >
The EUI-64 algorithm will be used to generate an address for that prefix.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > static:<replaceable > ADDRESS</replaceable> </option> </term>
<listitem >
<para >
An IPv6 address must be specified after a colon (<literal > :</literal> ), and the
lower bits of the supplied address are combined with the upper bits of a prefix
received in a Router Advertisement (RA) message to form a complete address. Note
that if multiple prefixes are received in an RA message, or in multiple RA messages,
addresses will be formed from each of them using the supplied address. This mode
implements SLAAC but uses a static interface identifier instead of an identifier
generated by using the EUI-64 algorithm. Because the interface identifier is static,
if Duplicate Address Detection detects that the computed address is a duplicate
(in use by another node on the link), then this mode will fail to provide an address
for that prefix. If an IPv6 address without mode is specified, then
<literal > static</literal> mode is assumed.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > prefixstable[:<replaceable > ADDRESS</replaceable> ]</option> </term>
<listitem >
<para >
The algorithm specified in
<ulink url= "https://tools.ietf.org/html/rfc7217" > RFC 7217</ulink> will be used to
generate interface identifiers. This mode can optionally take an IPv6 address
separated with a colon (<literal > :</literal> ). If an IPv6 address is specified,
then an interface identifier is generated only when a prefix received in an RA
message matches the supplied address.
</para>
<para >
Note that the <literal > prefixstable</literal> algorithm uses both the interface
name and MAC address as input to the hash to compute the interface identifier, so
if either of those are changed the resulting interface identifier (and address)
will be changed, even if the prefix received in the RA message has not been
changed.
</para>
</listitem>
</varlistentry>
</variablelist>
<para > If no address generation mode is specified (which is the default), or a received
prefix does not match any of the addresses provided in <literal > prefixstable</literal>
mode, then the EUI-64 algorithm will be used to form an interface identifier for that
prefix.</para>
<para > This setting can be specified multiple times. If an empty string is assigned, then
the all previous assignments are cleared.</para>
<para > Examples:
<programlisting > Token=eui64
2021-09-24 19:04:09 +00:00
Token=::1a:2b:3c:4d
2021-09-24 19:52:47 +00:00
Token=static:::1a:2b:3c:4d
Token=prefixstable
Token=prefixstable:2002:da8:1::</programlisting> </para>
2021-11-13 06:29:26 +00:00
</listitem>
</varlistentry>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseDNS=</varname> </term>
<listitem >
<para > When true (the default), the DNS servers received in the Router Advertisement will be used.</para>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
2021-11-13 06:29:26 +00:00
<para > This corresponds to the <option > nameserver</option> option in <citerefentry
project='man-pages'><refentrytitle > resolv.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseDomains=</varname> </term>
<listitem >
<para > Takes a boolean, or the special value <literal > route</literal> . When true, the domain name
received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to
the effect of the <option > Domains=</option> setting. If set to <literal > route</literal> , the domain name
received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the
effect of the <option > Domains=</option> setting when the argument is prefixed with
<literal > ~</literal> . Defaults to false.</para>
<para > It is recommended to enable this option only on trusted networks, as setting this affects resolution
of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
only as routing domain, rather than as search domain, in order to not have it affect local resolution of
single-label names.</para>
<para > When set to true, this setting corresponds to the <option > domain</option> option in <citerefentry
project='man-pages'><refentrytitle > resolv.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
2016-09-19 02:59:11 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > RouteTable=<replaceable > num</replaceable> </varname> </term>
<listitem >
<para > The table identifier for the routes received in the Router Advertisement
(a number between 1 and 4294967295, or 0 to unset).
The table can be retrieved using <command > ip route show table <replaceable > num</replaceable> </command> .
</para>
</listitem>
</varlistentry>
2019-02-14 15:35:17 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > RouteMetric=</varname> </term>
<listitem >
<para > Set the routing metric for the routes received in the Router Advertisement. Takes an
unsigned integer in the range 0…4294967295. Defaults to 1024.</para>
</listitem>
</varlistentry>
2021-04-17 17:31:13 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseMTU=</varname> </term>
<listitem >
<para > Takes a boolean. When true, the MTU received in the Router Advertisement will be
used. Defaults to true.</para>
</listitem>
</varlistentry>
2021-08-20 00:41:34 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseGateway=</varname> </term>
<listitem >
<para > When true (the default), the router address will be configured as the default gateway.
</para>
</listitem>
</varlistentry>
2021-11-08 21:44:45 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseRoutePrefix=</varname> </term>
<listitem >
<para > When true (the default), the routes corresponding to the route prefixes received in
the Router Advertisement will be configured.</para>
</listitem>
</varlistentry>
2021-11-08 21:44:45 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseAutonomousPrefix=</varname> </term>
<listitem >
<para > When true (the default), the autonomous prefix received in the Router Advertisement will be used and take
precedence over any statically configured ones.</para>
</listitem>
</varlistentry>
2019-02-14 15:35:17 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > UseOnLinkPrefix=</varname> </term>
<listitem >
<para > When true (the default), the onlink prefix received in the Router Advertisement will be
used and takes precedence over any statically configured ones.</para>
</listitem>
</varlistentry>
2019-02-14 15:35:17 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > RouterDenyList=</varname> </term>
<listitem >
<para > A whitespace-separated list of IPv6 router addresses. Each address can optionally
take a prefix length after <literal > /</literal> . Any information advertised by the listed
router is ignored.</para>
</listitem>
</varlistentry>
2020-12-24 05:27:25 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > RouterAllowList=</varname> </term>
<listitem >
<para > A whitespace-separated list of IPv6 router addresses. Each address can optionally
take a prefix length after <literal > /</literal> . Only information advertised by the listed
router is accepted. Note that if <varname > RouterAllowList=</varname> is configured then
<varname > RouterDenyList=</varname> is ignored.</para>
</listitem>
</varlistentry>
2020-12-24 05:27:25 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > PrefixDenyList=</varname> </term>
<listitem >
<para > A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
prefix length after <literal > /</literal> . IPv6 prefixes supplied via router advertisements
in the list are ignored.</para>
</listitem>
</varlistentry>
2020-12-14 06:23:17 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > PrefixAllowList=</varname> </term>
<listitem >
<para > A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its
prefix length after <literal > /</literal> . IPv6 prefixes supplied via router advertisements
in the list are allowed. Note that if <varname > PrefixAllowList=</varname> is configured
then <varname > PrefixDenyList=</varname> is ignored.</para>
</listitem>
</varlistentry>
2020-12-18 19:28:38 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > RouteDenyList=</varname> </term>
<listitem >
<para > A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
its prefix length after <literal > /</literal> . IPv6 route prefixes supplied via router
advertisements in the list are ignored.</para>
</listitem>
</varlistentry>
2019-05-17 16:21:20 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > RouteAllowList=</varname> </term>
<listitem >
<para > A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take
its prefix length after <literal > /</literal> . IPv6 route prefixes supplied via router
advertisements in the list are allowed. Note that if <varname > RouteAllowList=</varname> is
configured then <varname > RouteDenyList=</varname> is ignored.</para>
</listitem>
</varlistentry>
2020-12-18 19:28:38 +00:00
2021-11-13 06:29:26 +00:00
<varlistentry >
<term > <varname > DHCPv6Client=</varname> </term>
<listitem >
<para > Takes a boolean, or the special value <literal > always</literal> . When true, the
DHCPv6 client will be started when the RA has the managed or other information flag. If set
to <literal > always</literal> , the DHCPv6 client will be started in managed mode when an RA
is received, even if neither managed nor other information flag is set in the RA. This will
be ignored when <varname > WithoutRA=</varname> in the [DHCPv6] section is enabled, or
<varname > UplinkInterface=:self</varname> in the [DHCPv6PrefixDelegation] section is
specified. Defaults to true.</para>
</listitem>
</varlistentry>
</variablelist>
network: beef up ipv6 RA support considerably
This reworks sd-ndisc and networkd substantially to support IPv6 RA much more
comprehensively. Since the API is extended quite a bit networkd has been ported
over too, and the patch is not as straight-forward as one could wish. The
rework includes:
- Support for DNSSL, RDNSS and RA routing options in sd-ndisc and networkd. Two
new configuration options have been added to networkd to make this
configurable.
- sd-ndisc now exposes an sd_ndisc_router object that encapsulates a full RA
message, and has direct, friendly acessor functions for the singleton RA
properties, as well as an iterative interface to iterate through known and
unsupported options. The router object may either be retrieved from the wire,
or generated from raw data. In many ways the sd-ndisc API now matches the
sd-lldp API, except that no implicit database of seen data is kept. (Note
that sd-ndisc actually had a half-written, but unused implementaiton of such
a store, which is removed now.)
- sd-ndisc will now collect the reception timestamps of RA, which is useful to
make sd_ndisc_router fully descriptive of what it covers.
Fixes: #1079
2016-06-02 18:38:12 +00:00
</refsect1>
2015-08-27 15:32:30 +00:00
<refsect1 >
<title > [DHCPServer] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [DHCPServer] section contains settings for the DHCP server, if enabled via the
2015-08-27 15:32:30 +00:00
<varname > DHCPServer=</varname> option described above:</para>
<variablelist class= 'network-directives' >
2021-05-14 11:27:33 +00:00
<varlistentry >
<term > <varname > ServerAddress=</varname> </term>
<listitem > <para > Specifies server address for the DHCP server. Takes an IPv4 address with prefix
2021-07-27 07:37:29 +00:00
length, for example <literal > 192.168.0.1/24</literal> . This setting may be useful when the link on
which the DHCP server is running has multiple static addresses. When unset, one of static addresses
in the link will be automatically selected. Defaults to unset.</para> </listitem>
2021-05-14 11:27:33 +00:00
</varlistentry>
2015-08-28 22:18:20 +00:00
<varlistentry >
<term > <varname > PoolOffset=</varname> </term>
<term > <varname > PoolSize=</varname> </term>
<listitem > <para > Configures the pool of addresses to hand out. The pool
is a contiguous sequence of IP addresses in the subnet configured for
the server address, which does not include the subnet nor the broadcast
address. <varname > PoolOffset=</varname> takes the offset of the pool
from the start of subnet, or zero to use the default value.
<varname > PoolSize=</varname> takes the number of IP addresses in the
2014-08-03 05:11:12 +00:00
pool or zero to use the default value. By default, the pool starts at
2015-08-28 22:18:20 +00:00
the first address after the subnet address and takes up the rest of
the subnet, excluding the broadcast address. If the pool includes
the server address (the default), this is reserved and not handed
out to clients.</para> </listitem>
</varlistentry>
2015-08-27 15:32:30 +00:00
<varlistentry >
<term > <varname > DefaultLeaseTimeSec=</varname> </term>
<term > <varname > MaxLeaseTimeSec=</varname> </term>
<listitem > <para > Control the default and maximum DHCP lease
time to pass to clients. These settings take time values in seconds or
another common time unit, depending on the suffix. The default
lease time is used for clients that did not ask for a specific
lease time. If a client asks for a lease time longer than the
2014-08-03 05:11:12 +00:00
maximum lease time, it is automatically shortened to the
2015-08-27 15:32:30 +00:00
specified time. The default lease time defaults to 1h, the
maximum lease time to 12h. Shorter lease times are beneficial
if the configuration data in DHCP leases changes frequently
and clients shall learn the new settings with shorter
latencies. Longer lease times reduce the generated DHCP
network traffic.</para> </listitem>
</varlistentry>
2021-05-17 18:42:19 +00:00
<varlistentry >
<term > <varname > UplinkInterface=</varname> </term>
2021-07-13 12:27:51 +00:00
<listitem > <para > Specifies the name or the index of the uplink interface, or one of the special
values <literal > :none</literal> and <literal > :auto</literal> . When emitting DNS, NTP, or SIP
servers is enabled but no servers are specified, the servers configured in the uplink interface
will be emitted. When <literal > :auto</literal> , the link which has a default gateway with the
highest priority will be automatically selected. When <literal > :none</literal> , no uplink
interface will be selected. Defaults to <literal > :auto</literal> .</para> </listitem>
2021-05-17 18:42:19 +00:00
</varlistentry>
2015-08-27 15:32:30 +00:00
<varlistentry >
<term > <varname > EmitDNS=</varname> </term>
<term > <varname > DNS=</varname> </term>
2020-06-16 18:35:18 +00:00
<listitem > <para > <varname > EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases
handed out to clients shall contain DNS server information. Defaults to <literal > yes</literal> . The
DNS servers to pass to clients may be configured with the <varname > DNS=</varname> option, which takes
a list of IPv4 addresses. If the <varname > EmitDNS=</varname> option is enabled but no servers
configured, the servers are automatically propagated from an "uplink" interface that has appropriate
servers set. The "uplink" interface is determined by the default route of the system with the highest
priority. Note that this information is acquired at the time the lease is handed out, and does not
take uplink interfaces into account that acquire DNS server information at a later point. If no
2021-01-28 19:38:27 +00:00
suitable uplink interface is found the DNS server data from <filename > /etc/resolv.conf</filename> is
2020-06-16 18:35:18 +00:00
used. Also, note that the leases are not refreshed if the uplink network configuration changes. To
ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable
to shorten the DHCP lease time via <varname > MaxLeaseTimeSec=</varname> described
2015-08-27 15:32:30 +00:00
above.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > EmitNTP=</varname> </term>
<term > <varname > NTP=</varname> </term>
2019-09-18 13:22:47 +00:00
<term > <varname > EmitSIP=</varname> </term>
<term > <varname > SIP=</varname> </term>
2020-06-16 18:35:18 +00:00
<term > <varname > EmitPOP3=</varname> </term>
<term > <varname > POP3=</varname> </term>
<term > <varname > EmitSMTP=</varname> </term>
<term > <varname > SMTP=</varname> </term>
<term > <varname > EmitLPR=</varname> </term>
<term > <varname > LPR=</varname> </term>
<listitem > <para > Similar to the <varname > EmitDNS=</varname> and <varname > DNS=</varname> settings
described above, these settings configure whether and what server information for the indicate
protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and
defaults apply as for <varname > EmitDNS=</varname> and <varname > DNS=</varname> .</para> </listitem>
2020-03-27 20:12:07 +00:00
</varlistentry>
2016-05-17 23:34:25 +00:00
<varlistentry >
<term > <varname > EmitRouter=</varname> </term>
2021-11-02 03:58:50 +00:00
<term > <varname > Router=</varname> </term>
<listitem > <para > The <varname > EmitRouter=</varname> setting takes a boolean value, and configures
whether the DHCP lease should contain the router option. The <varname > Router=</varname> setting
takes an IPv4 address, and configures the router address to be emitted. When the
<varname > Router=</varname> setting is not specified, then the server address will be used for
the router option. When the <varname > EmitRouter=</varname> setting is disabled, the
<varname > Router=</varname> setting will be ignored. The <varname > EmitRouter=</varname> setting
defaults to true, and the <varname > Router=</varname> setting defaults to unset.
</para> </listitem>
2016-05-17 23:34:25 +00:00
</varlistentry>
2015-08-27 15:32:30 +00:00
<varlistentry >
<term > <varname > EmitTimezone=</varname> </term>
<term > <varname > Timezone=</varname> </term>
2018-11-27 06:07:58 +00:00
<listitem > <para > Takes a boolean. Configures whether the DHCP leases handed out
to clients shall contain timezone information. Defaults to <literal > yes</literal> . The
2015-08-27 15:32:30 +00:00
<varname > Timezone=</varname> setting takes a timezone string
(such as <literal > Europe/Berlin</literal> or
<literal > UTC</literal> ) to pass to clients. If no explicit
2014-08-03 05:11:12 +00:00
timezone is set, the system timezone of the local host is
2015-08-27 15:32:30 +00:00
propagated, as determined by the
<filename > /etc/localtime</filename> symlink.</para> </listitem>
</varlistentry>
2019-09-20 02:22:17 +00:00
<varlistentry >
2019-11-18 08:33:58 +00:00
<term > <varname > SendOption=</varname> </term>
<listitem >
<para > Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type
and data (<literal > <replaceable > option</replaceable> :<replaceable > type</replaceable> :<replaceable > value</replaceable> </literal> ).
2021-01-28 19:42:37 +00:00
The option number is an integer in the range 1…254. The type takes one of <literal > uint8</literal> ,
2020-05-01 14:30:31 +00:00
<literal > uint16</literal> , <literal > uint32</literal> , <literal > ipv4address</literal> , <literal > ipv6address</literal> , or
2020-02-28 18:28:49 +00:00
<literal > string</literal> . Special characters in the data string may be escaped using
<ulink url= "https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences" > C-style
escapes</ulink> . This setting can be specified multiple times. If an empty string is specified,
then all options specified earlier are cleared. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > SendVendorOption=</varname> </term>
<listitem >
<para > Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type
and data (<literal > <replaceable > option</replaceable> :<replaceable > type</replaceable> :<replaceable > value</replaceable> </literal> ).
2021-01-28 19:42:37 +00:00
The option number is an integer in the range 1…254. The type takes one of <literal > uint8</literal> ,
2019-11-18 08:33:58 +00:00
<literal > uint16</literal> , <literal > uint32</literal> , <literal > ipv4address</literal> , or
<literal > string</literal> . Special characters in the data string may be escaped using
<ulink url= "https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences" > C-style
escapes</ulink> . This setting can be specified multiple times. If an empty string is specified,
then all options specified earlier are cleared. Defaults to unset.</para>
</listitem>
2019-09-20 02:22:17 +00:00
</varlistentry>
2021-03-09 11:57:37 +00:00
<varlistentry >
<term > <varname > BindToInterface=</varname> </term>
2021-04-21 03:51:07 +00:00
<listitem >
<para > Takes a boolean value. When <literal > yes</literal> , DHCP server socket will be bound
to its network interface and all socket communication will be restricted to this interface.
Defaults to <literal > yes</literal> , except if <varname > RelayTarget=</varname> is used (see below),
2021-11-11 09:01:19 +00:00
in which case it defaults to <literal > no</literal> .</para>
2021-04-21 03:51:07 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > RelayTarget=</varname> </term>
<listitem >
<para > Takes an IPv4 address, which must be in the format described in
<citerefentry project= 'man-pages' > <refentrytitle > inet_pton</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> .
Turns this DHCP server into a DHCP relay agent. See <ulink url= "https://tools.ietf.org/html/rfc1542" > RFC 1542</ulink> .
The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > RelayAgentCircuitId=</varname> </term>
<listitem >
<para > Specifies value for Agent Circuit ID suboption of Relay Agent Information option.
Takes a string, which must be in the format <literal > string:<replaceable > value</replaceable> </literal> ,
where <literal > <replaceable > value</replaceable> </literal> should be replaced with the value of the suboption.
Defaults to unset (means no Agent Circuit ID suboption is generated).
Ignored if <varname > RelayTarget=</varname> is not specified.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > RelayAgentRemoteId=</varname> </term>
<listitem >
<para > Specifies value for Agent Remote ID suboption of Relay Agent Information option.
Takes a string, which must be in the format <literal > string:<replaceable > value</replaceable> </literal> ,
where <literal > <replaceable > value</replaceable> </literal> should be replaced with the value of the suboption.
Defaults to unset (means no Agent Remote ID suboption is generated).
Ignored if <varname > RelayTarget=</varname> is not specified.</para>
2021-03-09 11:57:37 +00:00
</listitem>
</varlistentry>
2019-09-20 02:22:17 +00:00
2015-08-27 15:32:30 +00:00
</variablelist>
</refsect1>
2020-10-20 19:46:15 +00:00
<refsect1 >
<title > [DHCPServerStaticLease] Section Options</title>
2021-07-27 07:37:29 +00:00
<para > The <literal > [DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a
fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple
times.</para>
2020-10-20 19:46:15 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > MACAddress=</varname> </term>
2021-07-27 07:37:29 +00:00
<listitem > <para > The hardware address of a device to match. This key is mandatory.</para> </listitem>
2020-10-20 19:46:15 +00:00
</varlistentry>
<varlistentry >
<term > <varname > Address=</varname> </term>
2021-07-27 07:37:29 +00:00
<listitem > <para > The IPv4 address that should be assigned to the device that was matched with
<varname > MACAddress=</varname> . This key is mandatory.</para> </listitem>
2020-10-20 19:46:15 +00:00
</varlistentry>
</variablelist>
</refsect1>
2015-02-04 02:14:13 +00:00
<refsect1 >
2020-10-19 03:48:39 +00:00
<title > [IPv6SendRA] Section Options</title>
<para > The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether
to act as a router, if enabled via the <varname > IPv6SendRA=</varname> option described above. IPv6
network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections.
</para>
2017-09-06 11:20:08 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Managed=</varname> </term>
<term > <varname > OtherInformation=</varname> </term>
2018-11-27 06:07:58 +00:00
<listitem > <para > Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6
addresses on the network link when <varname > Managed=</varname>
2017-09-06 11:20:08 +00:00
is set to <literal > true</literal> or if only additional network
information can be obtained via DHCPv6 for the network link when
2018-11-27 06:07:58 +00:00
<varname > OtherInformation=</varname> is set to
2017-09-06 11:20:08 +00:00
<literal > true</literal> . Both settings default to
<literal > false</literal> , which means that a DHCPv6 server is not being
used.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > RouterLifetimeSec=</varname> </term>
2020-11-09 07:29:32 +00:00
<listitem > <para > Takes a timespan. Configures the IPv6 router lifetime in seconds. When set to
2021-10-27 04:22:49 +00:00
0, the host is not acting as a router. The value must be 0 second, or between 4 seconds and
9000 seconds. Defaults to 1800 seconds (30 minutes).</para>
2017-09-06 11:20:08 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > RouterPreference=</varname> </term>
<listitem > <para > Configures IPv6 router preference if
<varname > RouterLifetimeSec=</varname> is non-zero. Valid values are
<literal > high</literal> , <literal > medium</literal> and
<literal > low</literal> , with <literal > normal</literal> and
<literal > default</literal> added as synonyms for
<literal > medium</literal> just to make configuration easier. See
<ulink url= "https://tools.ietf.org/html/rfc4191" > RFC 4191</ulink>
for details. Defaults to <literal > medium</literal> .</para> </listitem>
</varlistentry>
2021-06-15 18:51:57 +00:00
<varlistentry >
<term > <varname > UplinkInterface=</varname> </term>
<listitem > <para > Specifies the name or the index of the uplink interface, or one of the special
values <literal > :none</literal> and <literal > :auto</literal> . When emitting DNS servers or
search domains is enabled but no servers are specified, the servers configured in the uplink
interface will be emitted. When <literal > :auto</literal> , the link which has a default gateway
with the highest priority will be automatically selected. When <literal > :none</literal> , no
uplink interface will be selected. Defaults to <literal > :auto</literal> .</para> </listitem>
</varlistentry>
2017-09-06 11:20:08 +00:00
<varlistentry >
2017-09-29 17:48:07 +00:00
<term > <varname > EmitDNS=</varname> </term>
2017-09-06 11:20:08 +00:00
<term > <varname > DNS=</varname> </term>
2021-06-15 18:51:57 +00:00
<listitem > <para > <varname > DNS=</varname> specifies a list of recursive DNS server IPv6 addresses
that are distributed via Router Advertisement messages when <varname > EmitDNS=</varname> is true.
<varname > DNS=</varname> also takes special value <literal > _link_local</literal> ; in that case
the IPv6 link local address is distributed. If <varname > DNS=</varname> is empty, DNS servers are
read from the [Network] section. If the [Network] section does not contain any DNS servers
either, DNS servers from the uplink interface specified in <varname > UplinkInterface=</varname>
will be used. When <varname > EmitDNS=</varname> is false, no DNS server information is sent in
Router Advertisement messages. <varname > EmitDNS=</varname> defaults to true.</para> </listitem>
2017-09-06 11:20:08 +00:00
</varlistentry>
2017-09-07 09:24:00 +00:00
<varlistentry >
2017-09-29 17:48:07 +00:00
<term > <varname > EmitDomains=</varname> </term>
2017-09-07 09:24:00 +00:00
<term > <varname > Domains=</varname> </term>
2020-07-06 09:00:06 +00:00
<listitem > <para > A list of DNS search domains distributed via Router Advertisement messages when
2021-06-15 18:51:57 +00:00
<varname > EmitDomains=</varname> is true. If <varname > Domains=</varname> is empty, DNS search
domains are read from the [Network] section. If the [Network] section does not contain any DNS
search domains either, DNS search domains from the uplink interface specified in
<varname > UplinkInterface=</varname> will be used. When <varname > EmitDomains=</varname> is false,
no DNS search domain information is sent in Router Advertisement messages.
<varname > EmitDomains=</varname> defaults to true.</para> </listitem>
2017-09-07 09:24:00 +00:00
</varlistentry>
2017-09-06 11:20:08 +00:00
<varlistentry >
<term > <varname > DNSLifetimeSec=</varname> </term>
2021-09-28 02:44:27 +00:00
<listitem > <para > Lifetime in seconds for the DNS server addresses listed in
<varname > DNS=</varname> and search domains listed in <varname > Domains=</varname> . Defaults to
2021-10-24 19:32:05 +00:00
3600 seconds (one hour).</para> </listitem>
2017-09-06 11:20:08 +00:00
</varlistentry>
</variablelist>
</refsect1>
2019-09-14 11:14:22 +00:00
<refsect1 >
2017-09-06 11:20:08 +00:00
<title > [IPv6Prefix] Section Options</title>
2020-07-06 08:49:59 +00:00
<para > One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router
Advertisements. See <ulink url= "https://tools.ietf.org/html/rfc4861" > RFC 4861</ulink> for further
details.</para>
2017-09-06 11:20:08 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > AddressAutoconfiguration=</varname> </term>
<term > <varname > OnLink=</varname> </term>
2018-11-27 06:07:58 +00:00
<listitem > <para > Takes a boolean to specify whether IPv6 addresses can be
2017-09-06 11:20:08 +00:00
autoconfigured with this prefix and whether the prefix can be used for
onlink determination. Both settings default to <literal > true</literal>
in order to ease configuration.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > Prefix=</varname> </term>
2020-07-06 09:00:06 +00:00
<listitem > <para > The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static
IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a
<literal > /</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6
prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one
prefix to another.</para> </listitem>
2017-09-06 11:20:08 +00:00
</varlistentry>
<varlistentry >
<term > <varname > PreferredLifetimeSec=</varname> </term>
<term > <varname > ValidLifetimeSec=</varname> </term>
2021-10-24 19:32:05 +00:00
<listitem > <para > Preferred and valid lifetimes for the prefix measured in seconds.
<varname > PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and
<varname > ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para> </listitem>
2019-09-14 11:14:22 +00:00
</varlistentry>
2020-02-27 12:32:43 +00:00
<varlistentry >
<term > <varname > Assign=</varname> </term>
<listitem > <para > Takes a boolean. When true, adds an address from the prefix. Default to false.
</para> </listitem>
</varlistentry>
2021-04-17 17:49:15 +00:00
2021-09-24 19:12:31 +00:00
<varlistentry >
<term > <varname > Token=</varname> </term>
<listitem >
<para > Specifies an optional address generation mode for assigning an address in each
prefix. This accepts the same syntax as <varname > Token=</varname> in the [IPv6AcceptRA]
section. If <varname > Assign=</varname> is set to false, then this setting will be ignored.
Defaults to unset, which means the EUI-64 algorithm will be used.</para>
</listitem>
</varlistentry>
2021-04-17 17:49:15 +00:00
<varlistentry >
<term > <varname > RouteMetric=</varname> </term>
<listitem >
<para > The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295.
When unset or set to 0, the kernel's default value is used. This setting is ignored when
<varname > Assign=</varname> is false.</para>
</listitem>
</varlistentry>
2019-09-14 11:14:22 +00:00
</variablelist>
</refsect1>
<refsect1 >
<title > [IPv6RoutePrefix] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > One or more [IPv6RoutePrefix] sections contain the IPv6
2019-09-14 11:14:22 +00:00
prefix routes that are announced via Router Advertisements. See
<ulink url= "https://tools.ietf.org/html/rfc4191" > RFC 4191</ulink>
for further details.</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Route=</varname> </term>
2020-07-06 09:00:06 +00:00
<listitem > <para > The IPv6 route that is to be distributed to hosts. Similarly to configuring static
IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length,
separated by a <literal > /</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure
multiple IPv6 prefix routes.</para> </listitem>
2019-09-14 11:14:22 +00:00
</varlistentry>
<varlistentry >
<term > <varname > LifetimeSec=</varname> </term>
2021-10-24 19:32:05 +00:00
<listitem > <para > Lifetime for the route prefix measured in seconds.
<varname > LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para> </listitem>
2017-09-06 11:20:08 +00:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
2015-02-04 02:14:13 +00:00
<title > [Bridge] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [Bridge] section accepts the following keys:</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
2015-07-23 18:03:40 +00:00
<varlistentry >
<term > <varname > UnicastFlood=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Controls whether the bridge should flood
2015-07-25 03:04:57 +00:00
traffic for which an FDB entry is missing and the destination
2018-11-27 05:40:25 +00:00
is unknown through this port. When unset, the kernel's default will be used.
2015-07-25 02:37:04 +00:00
</para>
2015-07-23 18:03:40 +00:00
</listitem>
</varlistentry>
2019-03-10 20:25:24 +00:00
<varlistentry >
<term > <varname > MulticastFlood=</varname> </term>
<listitem >
<para > Takes a boolean. Controls whether the bridge should flood
traffic for which an MDB entry is missing and the destination
is unknown through this port. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
2018-12-03 10:47:36 +00:00
<varlistentry >
<term > <varname > MulticastToUnicast=</varname> </term>
<listitem >
<para > Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of
the bridge. Which means unicast copies are only delivered to hosts which are interested in it.
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
2019-03-10 20:25:24 +00:00
<varlistentry >
<term > <varname > NeighborSuppression=</varname> </term>
<listitem >
<para > Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for
this port. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Learning=</varname> </term>
<listitem >
<para > Takes a boolean. Configures whether MAC address learning is enabled for
this port. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
2015-07-23 18:03:40 +00:00
<varlistentry >
<term > <varname > HairPin=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Takes a boolean. Configures whether traffic may be sent back out of the port on which it
was received. When this flag is false, then the bridge will not forward traffic back out of the
receiving port. When unset, the kernel's default will be used.</para>
2015-07-23 18:03:40 +00:00
</listitem>
</varlistentry>
<varlistentry >
2015-07-25 02:52:26 +00:00
<term > <varname > UseBPDU=</varname> </term>
2015-07-23 18:03:40 +00:00
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
2018-11-27 05:40:25 +00:00
processed by the bridge port. When unset, the kernel's default will be used.</para>
2015-07-23 18:03:40 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > FastLeave=</varname> </term>
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. This flag allows the bridge to immediately stop multicast
2014-08-03 05:11:37 +00:00
traffic on a port that receives an IGMP Leave message. It is only used with
2018-11-27 05:40:25 +00:00
IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
2015-07-23 18:03:40 +00:00
</listitem>
</varlistentry>
<varlistentry >
2015-07-25 03:12:20 +00:00
<term > <varname > AllowPortToBeRoot=</varname> </term>
2015-07-23 18:03:40 +00:00
<listitem >
2018-11-27 06:07:58 +00:00
<para > Takes a boolean. Configures whether a given port is allowed to
2015-07-25 02:37:04 +00:00
become a root port. Only used when STP is enabled on the bridge.
2018-11-27 05:40:25 +00:00
When unset, the kernel's default will be used.</para>
2015-07-23 18:03:40 +00:00
</listitem>
</varlistentry>
2019-05-04 14:51:13 +00:00
<varlistentry >
<term > <varname > ProxyARP=</varname> </term>
<listitem >
<para > Takes a boolean. Configures whether proxy ARP to be enabled on this port.
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > ProxyARPWiFi=</varname> </term>
<listitem >
<para > Takes a boolean. Configures whether proxy ARP to be enabled on this port
which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications.
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
2019-05-09 00:32:12 +00:00
<varlistentry >
<term > <varname > MulticastRouter=</varname> </term>
<listitem >
<para > Configures this port for having multicast routers attached. A port with a multicast
router will receive all multicast traffic. Takes one of <literal > no</literal>
to disable multicast routers on this port, <literal > query</literal> to let the system detect
the presence of routers, <literal > permanent</literal> to permanently enable multicast traffic
forwarding on this port, or <literal > temporary</literal> to enable multicast routers temporarily
on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > Cost=</varname> </term>
<listitem >
2015-07-25 02:37:04 +00:00
<para > Sets the "cost" of sending packets of this interface.
2014-08-03 05:11:37 +00:00
Each port in a bridge may have a different speed and the cost
2015-02-04 02:14:13 +00:00
is used to decide which link to use. Faster interfaces
2017-08-03 21:36:21 +00:00
should have lower costs. It is an integer value between 1 and
2017-04-11 21:17:31 +00:00
65535.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Priority=</varname> </term>
<listitem >
<para > Sets the "priority" of sending packets on this interface.
Each port in a bridge may have a different priority which is used
to decide which link to use. Lower value means higher priority.
2017-08-03 21:36:21 +00:00
It is an integer value between 0 to 63. Networkd does not set any
2017-04-11 21:17:31 +00:00
default, meaning the kernel default value of 32 is used.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > [BridgeFDB] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [BridgeFDB] section manages the forwarding database table of a port and accepts the following
keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para>
2015-02-04 02:14:13 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > MACAddress=</varname> </term>
<listitem >
2020-07-06 09:00:06 +00:00
<para > As in the [Network] section. This key is mandatory.</para>
2015-02-04 02:14:13 +00:00
</listitem>
</varlistentry>
2019-04-30 09:23:39 +00:00
<varlistentry >
<term > <varname > Destination=</varname> </term>
<listitem >
<para > Takes an IP address of the destination VXLAN tunnel endpoint.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
<varlistentry >
<term > <varname > VLANId=</varname> </term>
<listitem >
2014-08-03 05:11:37 +00:00
<para > The VLAN ID for the new static MAC table entry. If
2017-12-04 12:05:18 +00:00
omitted, no VLAN ID information is appended to the new static MAC
2015-02-04 02:14:13 +00:00
table entry.</para>
</listitem>
</varlistentry>
2019-05-06 14:28:52 +00:00
<varlistentry >
<term > <varname > VNI=</varname> </term>
<listitem >
<para > The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
2021-01-28 19:42:37 +00:00
the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
2019-05-06 14:28:52 +00:00
Defaults to unset.</para>
</listitem>
</varlistentry>
2019-05-08 14:13:21 +00:00
<varlistentry >
<term > <varname > AssociatedWith=</varname> </term>
<listitem >
<para > Specifies where the address is associated with. Takes one of <literal > use</literal> ,
<literal > self</literal> , <literal > master</literal> or <literal > router</literal> .
<literal > use</literal> means the address is in use. User space can use this option to
indicate to the kernel that the fdb entry is in use. <literal > self</literal> means
the address is associated with the port drivers fdb. Usually hardware. <literal > master</literal>
means the address is associated with master devices fdb. <literal > router</literal> means
the destination address is associated with a router. Note that it's valid if the referenced
device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal > self</literal> .</para>
</listitem>
</varlistentry>
2021-05-14 05:28:18 +00:00
<varlistentry >
<term > <varname > OutgoingInterface=</varname> </term>
<listitem >
<para > Specifies the name or index of the outgoing interface for the VXLAN device driver to
reach the remote VXLAN tunnel endpoint. Defaults to unset.</para>
</listitem>
</varlistentry>
2015-02-04 02:14:13 +00:00
</variablelist>
</refsect1>
2020-09-09 12:14:44 +00:00
<refsect1 >
<title > [BridgeMDB] Section Options</title>
<para > The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following
keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > MulticastGroupAddress=</varname> </term>
<listitem >
<para > Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > VLANId=</varname> </term>
<listitem >
<para > The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2018-04-10 15:26:20 +00:00
2020-03-30 19:57:58 +00:00
<refsect1 >
<title > [LLDP] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
2020-09-29 10:31:27 +00:00
keys:</para>
2020-03-30 19:57:58 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > MUDURL=</varname> </term>
<listitem >
2020-09-29 10:27:19 +00:00
<para > When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
LLDP packets. The syntax and semantics are the same as for <varname > MUDURL=</varname> in the
[DHCPv4] section described above.</para>
<para > The MUD URLs received via LLDP packets are saved and can be read using the
2020-03-30 19:57:58 +00:00
<function > sd_lldp_neighbor_get_mud_url()</function> function.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2018-04-10 15:26:20 +00:00
<refsect1 >
<title > [CAN] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
following keys:</para>
2018-04-10 15:26:20 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > BitRate=</varname> </term>
<listitem >
<para > The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can
2021-01-28 19:42:37 +00:00
be used here. Takes a number in the range 1…4294967295.</para>
2018-04-10 15:26:20 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > SamplePoint=</varname> </term>
<listitem >
<para > Optional sample point in percent with one decimal (e.g. <literal > 75%</literal> ,
2021-08-15 17:41:15 +00:00
<literal > 87.5%</literal> ) or permille (e.g. <literal > 875‰</literal> ). This will be ignored when
<varname > BitRate=</varname> is unspecified.</para>
2018-04-10 15:26:20 +00:00
</listitem>
</varlistentry>
2021-08-15 18:36:58 +00:00
<varlistentry >
<term > <varname > TimeQuantaNSec=</varname> </term>
<term > <varname > PropagationSegment=</varname> </term>
<term > <varname > PhaseBufferSegment1=</varname> </term>
<term > <varname > PhaseBufferSegment2=</varname> </term>
<term > <varname > SyncJumpWidth=</varname> </term>
<listitem >
<para > Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
synchronization jump width, which allow to define the CAN bit-timing in a hardware
independent format as proposed by the Bosch CAN 2.0 Specification.
<varname > TimeQuantaNSec=</varname> takes a timespan in nanoseconds.
<varname > PropagationSegment=</varname> , <varname > PhaseBufferSegment1=</varname> ,
<varname > PhaseBufferSegment2=</varname> , and <varname > SyncJumpWidth=</varname> take number
of time quantum specified in <varname > TimeQuantaNSec=</varname> and must be an unsigned
integer in the range 0…4294967295. These settings except for
<varname > SyncJumpWidth=</varname> will be ignored when <varname > BitRate=</varname> is
specified.</para>
2018-04-10 15:26:20 +00:00
</listitem>
</varlistentry>
2020-03-26 21:27:41 +00:00
<varlistentry >
<term > <varname > DataBitRate=</varname> </term>
<term > <varname > DataSamplePoint=</varname> </term>
<listitem >
<para > The bitrate and sample point for the data phase, if CAN-FD is used. These settings are
analogous to the <varname > BitRate=</varname> and <varname > SamplePoint=</varname> keys.</para>
</listitem>
</varlistentry>
2021-08-15 18:36:58 +00:00
<varlistentry >
<term > <varname > DataTimeQuantaNSec=</varname> </term>
<term > <varname > DataPropagationSegment=</varname> </term>
<term > <varname > DataPhaseBufferSegment1=</varname> </term>
<term > <varname > DataPhaseBufferSegment2=</varname> </term>
<term > <varname > DataSyncJumpWidth=</varname> </term>
<listitem >
<para > Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the
synchronization jump width for the data phase, if CAN-FD is used. These settings are
analogous to the <varname > TimeQuantaNSec=</varname> or related settings.</para>
</listitem>
</varlistentry>
2020-03-26 21:27:41 +00:00
<varlistentry >
<term > <varname > FDMode=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , CAN-FD mode is enabled for the interface.
Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using
2021-08-15 18:36:58 +00:00
the <varname > DataBitRate=</varname> and <varname > DataSamplePoint=</varname> keys, or
<varname > DataTimeQuanta=</varname> and related settings.</para>
2020-03-26 21:27:41 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > FDNonISO=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , non-ISO CAN-FD mode is enabled for the
interface. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
2018-04-10 15:26:20 +00:00
<varlistentry >
<term > <varname > RestartSec=</varname> </term>
<listitem >
<para > Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be
triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can
be specified using decimals (e.g. <literal > 0.1s</literal> ) or a <literal > ms</literal> or
<literal > us</literal> postfix. Using <literal > infinity</literal> or <literal > 0</literal> will turn the
automatic restart off. By default automatic restart is disabled.</para>
</listitem>
</varlistentry>
2020-02-12 02:13:45 +00:00
<varlistentry >
<term > <varname > Termination=</varname> </term>
<listitem >
2021-11-04 00:20:21 +00:00
<para > Takes a boolean or a termination resistor value in ohm in the range 0…65535. When
2021-08-15 17:16:53 +00:00
<literal > yes</literal> , the termination resistor is set to 120 ohm. When
<literal > no</literal> or <literal > 0</literal> is set, the termination resistor is disabled.
When unset, the kernel's default will be used.</para>
2020-02-12 02:13:45 +00:00
</listitem>
</varlistentry>
2019-03-11 14:25:20 +00:00
<varlistentry >
<term > <varname > TripleSampling=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , three samples (instead of one) are used to determine
the value of a received bit by majority rule. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
2021-01-05 17:53:44 +00:00
<varlistentry >
<term > <varname > BusErrorReporting=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , reporting of CAN bus errors is activated
(those include single bit, frame format, and bit stuffing errors, unable to send dominant bit,
unable to send recessive bit, bus overload, active error announcement, error occurred on
transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a
single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para>
</listitem>
</varlistentry>
2020-03-16 04:40:30 +00:00
<varlistentry >
<term > <varname > ListenOnly=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , listen-only mode is enabled. When the
interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK
bit. Listen-only mode is important to debug CAN networks without interfering with the
communication or acknowledge the CAN frame. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
2021-08-15 16:53:26 +00:00
<varlistentry >
<term > <varname > Loopback=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , loopback mode is enabled. When the
loopback mode is enabled, the interface treats messages transmitted by itself as received
messages. The loopback mode is important to debug CAN networks. When unset, the kernel's
default will be used.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > OneShot=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , one-shot mode is enabled. When unset,
the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > PresumeAck=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , the interface will ignore missing CAN
ACKs. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > ClassicDataLengthCode=</varname> </term>
<listitem >
<para > Takes a boolean. When <literal > yes</literal> , the interface will handle the 4bit data
length code (DLC). When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
2018-04-10 15:26:20 +00:00
</variablelist>
</refsect1>
2020-02-05 10:10:33 +00:00
<refsect1 >
<title > [QDisc] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
2020-02-05 10:10:33 +00:00
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > Parent=</varname> </term>
<listitem >
<para > Specifies the parent Queueing Discipline (qdisc). Takes one of <literal > clsact</literal>
or <literal > ingress</literal> . This is mandatory.</para>
</listitem>
</varlistentry>
2020-02-10 07:05:35 +00:00
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-05 10:10:33 +00:00
</variablelist>
</refsect1>
2019-10-07 14:19:00 +00:00
<refsect1 >
2020-02-04 12:45:29 +00:00
<title > [NetworkEmulator] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It
can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP
applications, or limit the bandwidth usage of a particular service to simulate internet connections.
</para>
2019-10-07 14:19:00 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2019-10-07 14:19:00 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > DelaySec=</varname> </term>
2019-10-07 14:19:00 +00:00
<listitem >
<para > Specifies the fixed amount of delay to be added to all packets going out of the
interface. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > DelayJitterSec=</varname> </term>
2019-10-07 14:19:00 +00:00
<listitem >
<para > Specifies the chosen delay to be added to the packets outgoing to the network
interface. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > PacketLimit=</varname> </term>
2019-10-07 14:19:00 +00:00
<listitem >
<para > Specifies the maximum number of packets the qdisc may hold queued at a time.
2021-11-04 00:20:21 +00:00
An unsigned integer in the range 0…4294967294. Defaults to 1000.</para>
2019-10-07 14:19:00 +00:00
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > LossRate=</varname> </term>
2019-10-07 14:19:00 +00:00
<listitem >
<para > Specifies an independent loss probability to be added to the packets outgoing from the
network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para>
</listitem>
</varlistentry>
2019-10-30 17:58:02 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > DuplicateRate=</varname> </term>
2019-10-30 17:58:02 +00:00
<listitem >
<para > Specifies that the chosen percent of packets is duplicated before queuing them.
Takes a percentage value, suffixed with "%". Defaults to unset.</para>
</listitem>
</varlistentry>
2020-02-04 12:45:29 +00:00
</variablelist>
</refsect1>
2019-10-30 17:58:02 +00:00
2020-02-04 12:45:29 +00:00
<refsect1 >
2020-02-04 16:22:41 +00:00
<title > [TokenBucketFilter] Section Options</title>
2020-07-06 08:49:59 +00:00
<para > The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
(tbf).</para>
2020-02-04 12:45:29 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2020-02-04 12:45:29 +00:00
<varlistentry >
<term > <varname > LatencySec=</varname> </term>
2019-11-17 06:30:03 +00:00
<listitem >
<para > Specifies the latency parameter, which specifies the maximum amount of time a
2020-02-04 16:22:41 +00:00
packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
2019-11-17 06:30:03 +00:00
</listitem>
</varlistentry>
2019-12-07 20:54:33 +00:00
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > LimitBytes=</varname> </term>
2019-12-07 20:54:33 +00:00
<listitem >
<para > Takes the number of bytes that can be queued waiting for tokens to become available.
When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes,
2020-07-01 07:05:32 +00:00
respectively, to the base of 1024. Defaults to unset.</para>
2019-12-07 20:54:33 +00:00
</listitem>
</varlistentry>
2019-11-17 06:30:03 +00:00
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > BurstBytes=</varname> </term>
2019-11-17 06:30:03 +00:00
<listitem >
<para > Specifies the size of the bucket. This is the maximum amount of bytes that tokens
can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is
2020-07-01 07:05:32 +00:00
parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
2019-11-17 06:30:03 +00:00
unset.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > Rate=</varname> </term>
2019-11-17 06:30:03 +00:00
<listitem >
<para > Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
2020-01-12 07:01:25 +00:00
bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
2019-11-17 06:30:03 +00:00
Defaults to unset.</para>
</listitem>
</varlistentry>
2019-12-07 20:54:33 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > MPUBytes=</varname> </term>
2019-12-07 20:54:33 +00:00
<listitem >
<para > The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes)
for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
2020-07-01 07:05:32 +00:00
Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
2019-12-07 20:54:33 +00:00
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > PeakRate=</varname> </term>
2019-12-07 20:54:33 +00:00
<listitem >
<para > Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
2020-01-12 07:01:25 +00:00
specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
2019-12-07 20:54:33 +00:00
1000. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > MTUBytes=</varname> </term>
2019-12-07 20:54:33 +00:00
<listitem >
<para > Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
2020-07-01 07:05:32 +00:00
size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
2019-12-07 20:54:33 +00:00
Defaults to unset.</para>
</listitem>
</varlistentry>
2020-02-04 12:45:29 +00:00
</variablelist>
</refsect1>
2020-03-09 09:48:03 +00:00
<refsect1 >
<title > [PIE] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
controller-Enhanced (PIE).</para>
2020-03-09 09:48:03 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-03-09 09:48:03 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
<listitem >
2021-01-28 19:42:37 +00:00
<para > Specifies the hard limit on the queue size in number of packets. When this limit is reached,
incoming packets are dropped. An unsigned integer in the range 1…4294967294. Defaults to unset and
kernel's default is used.</para>
2020-03-09 13:03:49 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > [FlowQueuePIE] Section Options</title>
<para > The <literal > [FlowQueuePIE]</literal> section manages the queueing discipline
(qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para>
<variablelist class= 'network-directives' >
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
<listitem >
2021-01-28 19:38:27 +00:00
<para > Specifies the hard limit on the queue size in number of packets. When this limit is reached,
incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and
kernel's default is used.</para>
2020-03-09 09:48:03 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-02-11 07:24:27 +00:00
<refsect1 >
<title > [StochasticFairBlue] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
(sfb).</para>
2020-02-11 07:24:27 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-11 07:24:27 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Specifies the hard limit on the queue size in number of packets. When this limit is reached,
2021-11-04 00:20:21 +00:00
incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
2020-07-06 08:49:59 +00:00
kernel's default is used.</para>
2020-02-11 07:24:27 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-02-04 12:45:29 +00:00
<refsect1 >
<title > [StochasticFairnessQueueing] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
fairness queueing (sfq).</para>
2020-02-04 12:45:29 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2019-11-27 11:42:21 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > PerturbPeriodSec=</varname> </term>
2019-11-27 11:42:21 +00:00
<listitem >
<para > Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
</listitem>
</varlistentry>
2020-02-04 12:45:29 +00:00
</variablelist>
</refsect1>
2020-03-10 11:53:32 +00:00
<refsect1 >
<title > [BFIFO] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
Out (bfifo).</para>
2020-03-10 11:53:32 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-03-10 11:53:32 +00:00
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > LimitBytes=</varname> </term>
2020-03-10 11:53:32 +00:00
<listitem >
2020-09-29 10:31:27 +00:00
<para > Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
kernel default is used.</para>
2020-03-10 11:53:32 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-02-10 15:12:21 +00:00
<refsect1 >
<title > [PFIFO] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
(pfifo).</para>
2020-02-10 15:12:21 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 15:12:21 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
<listitem >
2021-01-28 19:38:27 +00:00
<para > Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents
overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this
limit is reached, incoming packets are dropped. An unsigned integer in the range
2021-11-04 00:20:21 +00:00
0…4294967294. Defaults to unset and kernel's default is used.</para>
2020-02-10 15:12:21 +00:00
</listitem>
</varlistentry>
2020-03-02 06:54:17 +00:00
</variablelist>
</refsect1>
2020-03-10 12:19:56 +00:00
<refsect1 >
<title > [PFIFOHeadDrop] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
Head Drop (pfifo_head_drop).</para>
2020-03-10 12:19:56 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-03-10 12:19:56 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
<listitem >
2020-07-06 09:00:06 +00:00
<para > As in [PFIFO] section.</para> </listitem>
2020-03-10 12:19:56 +00:00
</varlistentry>
</variablelist>
</refsect1>
2020-03-11 10:02:20 +00:00
<refsect1 >
<title > [PFIFOFast] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
(pfifo_fast).</para>
2020-03-11 10:02:20 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-03-11 10:02:20 +00:00
</variablelist>
</refsect1>
2020-03-02 06:54:17 +00:00
<refsect1 >
<title > [CAKE] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
(CAKE).</para>
2020-03-02 06:54:17 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 15:12:21 +00:00
2020-03-02 06:54:17 +00:00
<varlistentry >
2021-11-02 19:32:00 +00:00
<term > <varname > Bandwidth=</varname> </term>
2020-03-02 06:54:17 +00:00
<listitem >
2021-11-02 19:32:00 +00:00
<para > Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is
parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to
unset and kernel's default is used.</para>
2020-03-02 06:54:17 +00:00
</listitem>
2020-03-12 09:33:15 +00:00
</varlistentry>
2020-03-02 06:54:17 +00:00
2021-11-02 19:05:02 +00:00
<varlistentry >
<term > <varname > AutoRateIngress=</varname> </term>
<listitem >
<para > Takes a boolean value. Enables automatic capacity estimation based on traffic arriving
at this qdisc. This is most likely to be useful with cellular links, which tend to change
quality randomly. If this setting is enabled, the <varname > Bandwidth=</varname> setting is
used as an initial estimate. Defaults to unset, and the kernel's default is used.</para>
</listitem>
</varlistentry>
2020-03-02 06:54:17 +00:00
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > OverheadBytes=</varname> </term>
2020-03-02 06:54:17 +00:00
<listitem >
2021-11-04 00:20:21 +00:00
<para > Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
Takes an integer in the range -64…256. Defaults to unset and kernel's default is used.
</para>
2020-03-02 06:54:17 +00:00
</listitem>
2020-03-12 09:33:15 +00:00
</varlistentry>
2020-03-02 06:54:17 +00:00
<varlistentry >
2021-11-03 19:16:20 +00:00
<term > <varname > MPUBytes=</varname> </term>
2020-03-02 06:54:17 +00:00
<listitem >
2021-11-03 19:16:20 +00:00
<para > Rounds each packet (including overhead) up to the specified bytes. Takes an integer in
the range 1…256. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
2021-11-02 19:50:00 +00:00
<varlistentry >
<term > <varname > CompensationMode=</varname> </term>
<listitem >
<para > Takes one of <literal > none</literal> , <literal > atm</literal> , or <literal > ptm</literal> .
Specifies the compensation mode for overhead calculation. When <literal > none</literal> , no
compensation is taken into account. When <literal > atm</literal> , enables the compensation for
ATM cell framing, which is normally found on ADSL links. When <literal > ptm</literal> , enables
the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b
encoding scheme. Defaults to unset and the kernel's default is used.</para>
</listitem>
</varlistentry>
2021-11-04 01:04:47 +00:00
<varlistentry >
<term > <varname > UseRawPacketSize=</varname> </term>
<listitem >
<para > Takes a boolean value. When true, the packet size reported by the Linux kernel will be
used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default
is used.</para>
</listitem>
</varlistentry>
2021-11-02 20:48:15 +00:00
<varlistentry >
<term > <varname > FlowIsolationMode=</varname> </term>
<listitem >
<para > CAKE places packets from different flows into different queues, then packets from each
queue are delivered fairly. This specifies whether the fairness is based on source address,
destination address, individual flows, or any combination of those. The available values are:
</para>
<variablelist >
<varlistentry >
<term > <option > none</option> </term>
<listitem > <para >
The flow isolation is disabled, and all traffic passes through a single queue.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > src-host</option> </term>
<listitem > <para >
Flows are defined only by source address. Equivalnet to the <literal > srchost</literal>
option for <command > tc qdisc</command> command. See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > dst-host</option> </term>
<listitem > <para >
Flows are defined only by destination address. Equivalnet to the
<literal > srchost</literal> option for <command > tc qdisc</command> command. See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > hosts</option> </term>
<listitem > <para >
Flows are defined by source-destination host pairs. Equivalent to the same option for
<command > tc qdisc</command> command. See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > flows</option> </term>
<listitem > <para >
Flows are defined by the entire 5-tuple of source address, destination address,
transport protocol, source port and destination port. Equivalent to the same option for
<command > tc qdisc</command> command. See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > dual-src-host</option> </term>
<listitem > <para >
Flows are defined by the 5-tuple (see <literal > flows</literal> in the above), and
fairness is applied first over source addresses, then over individual flows. Equivalnet
to the <literal > dual-srchost</literal> option for <command > tc qdisc</command> command.
See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > dual-dst-host</option> </term>
<listitem > <para >
Flows are defined by the 5-tuple (see <literal > flows</literal> in the above), and
fairness is applied first over destination addresses, then over individual flows.
Equivalnet to the <literal > dual-dsthost</literal> option for
<command > tc qdisc</command> command. See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > triple</option> </term>
<listitem > <para >
Flows are defined by the 5-tuple (see <literal > flows</literal> ), and fairness is
applied over source and destination addresses, and also over individual flows.
Equivalnet to the <literal > triple-isolate</literal> option for
<command > tc qdisc</command> command. See also
<citerefentry project= 'man-pages' > <refentrytitle > tc-cake</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .
</para> </listitem>
</varlistentry>
</variablelist>
<para > Defaults to unset and the kernel's default is used.</para>
</listitem>
</varlistentry>
2021-11-02 20:55:54 +00:00
<varlistentry >
<term > <varname > NAT=</varname> </term>
<listitem >
<para > Takes a boolean value. When true, CAKE performs a NAT lookup before applying
flow-isolation rules, to determine the true addresses and port numbers of the packet, to
improve fairness between hosts inside the NAT. This has no practical effect when
<varname > FlowIsolationMode=</varname> is <literal > none</literal> or <literal > flows</literal> ,
or if NAT is performed on a different host. Defaults to unset, and the kernel's default is
used.</para>
</listitem>
</varlistentry>
2021-11-03 19:59:37 +00:00
<varlistentry >
<term > <varname > PriorityQueueingPreset=</varname> </term>
<listitem >
<para > CAKE divides traffic into <literal > tins</literal> , and each tin has its own independent
set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of
tin profiles. The available values are:</para>
<variablelist >
<varlistentry >
<term > <option > besteffort</option> </term>
<listitem > <para >
Disables priority queueing by placing all traffic in one tin.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > precedence</option> </term>
<listitem > <para >
Enables priority queueing based on the legacy interpretation of TOS
<literal > Precedence</literal> field. Use of this preset on the modern Internet is
firmly discouraged.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > diffserv8</option> </term>
<listitem > <para >
Enables priority queueing based on the Differentiated Service
(<literal > DiffServ</literal> ) field with eight tins: Background Traffic, High
Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell,
Minimum Latency, and Network Control.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > diffserv4</option> </term>
<listitem > <para >
Enables priority queueing based on the Differentiated Service
(<literal > DiffServ</literal> ) field with four tins: Background Traffic, Best Effort,
Streaming Media, and Latency Sensitive.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > diffserv3</option> </term>
<listitem > <para >
Enables priority queueing based on the Differentiated Service
(<literal > DiffServ</literal> ) field with three tins: Background Traffic, Best Effort,
and Latency Sensitive.
</para> </listitem>
</varlistentry>
</variablelist>
<para > Defaults to unset, and the kernel's default is used.</para>
2020-03-02 06:54:17 +00:00
</listitem>
</varlistentry>
2021-11-03 19:59:37 +00:00
2021-11-03 20:13:20 +00:00
<varlistentry >
<term > <varname > FirewallMark=</varname> </term>
<listitem >
<para > Takes an integer in the range 1…4294967295. When specified, firewall-mark-based
overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is
used.</para>
</listitem>
</varlistentry>
2021-11-03 20:32:44 +00:00
<varlistentry >
<term > <varname > Wash=</varname> </term>
<listitem >
<para > Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of
any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para>
</listitem>
</varlistentry>
2021-11-03 20:38:13 +00:00
<varlistentry >
<term > <varname > SplitGSO=</varname> </term>
<listitem >
<para > Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO)
super-packets into their on-the-wire components and dequeue them individually. Defaults to
unset, and the kernel's default is used.</para>
</listitem>
</varlistentry>
2020-02-10 15:12:21 +00:00
</variablelist>
</refsect1>
2020-02-04 12:45:29 +00:00
<refsect1 >
<title > [ControlledDelay] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [ControlledDelay] section manages the queueing discipline (qdisc) of
2020-02-04 12:45:29 +00:00
controlled delay (CoDel).</para>
2019-11-27 11:42:21 +00:00
2020-02-04 12:45:29 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2020-02-04 12:45:29 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
2019-12-21 19:18:09 +00:00
<listitem >
2020-07-06 08:49:59 +00:00
<para > Specifies the hard limit on the queue size in number of packets. When this limit is reached,
2021-11-04 00:20:21 +00:00
incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
2020-07-06 08:49:59 +00:00
kernel's default is used.</para>
2019-12-21 19:18:09 +00:00
</listitem>
</varlistentry>
2019-12-28 13:07:24 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > TargetSec=</varname> </term>
2019-12-28 13:07:24 +00:00
<listitem >
<para > Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > IntervalSec=</varname> </term>
2019-12-28 13:07:24 +00:00
<listitem >
<para > Takes a timespan. This is used to ensure that the measured minimum delay does not
become too stale. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > ECN=</varname> </term>
2019-12-28 13:07:24 +00:00
<listitem >
<para > Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > CEThresholdSec=</varname> </term>
2019-12-28 13:07:24 +00:00
<listitem >
<para > Takes a timespan. This sets a threshold above which all packets are marked with ECN
Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
2020-02-04 12:45:29 +00:00
</variablelist>
</refsect1>
2019-12-28 13:07:24 +00:00
2020-03-10 07:46:40 +00:00
<refsect1 >
<title > [DeficitRoundRobinScheduler] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
Robin Scheduler (DRR).</para>
2020-03-10 07:46:40 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-03-10 07:46:40 +00:00
</variablelist>
</refsect1>
2020-03-11 15:36:08 +00:00
<refsect1 >
<title > [DeficitRoundRobinSchedulerClass] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
Robin Scheduler (DRR).</para>
2020-03-11 15:36:08 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "tclass-parent" />
<xi:include href= "tc.xml" xpointer= "tclass-classid" />
2020-03-11 15:36:08 +00:00
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > QuantumBytes=</varname> </term>
2020-03-11 15:36:08 +00:00
<listitem >
2020-07-01 07:05:32 +00:00
<para > Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves
to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the
interface.</para>
2020-03-11 15:36:08 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-06-09 08:23:11 +00:00
<refsect1 >
<title > [EnhancedTransmissionSelection] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
Transmission Selection (ETS).</para>
2020-06-09 08:23:11 +00:00
<variablelist class= 'network-directives' >
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
<varlistentry >
<term > <varname > Bands=</varname> </term>
<listitem >
2021-11-04 00:20:21 +00:00
<para > Specifies the number of bands. An unsigned integer in the range 1…16. This value has to be at
2020-07-06 08:49:59 +00:00
least large enough to cover the strict bands specified through the <varname > StrictBands=</varname>
and bandwidth-sharing bands specified in <varname > QuantumBytes=</varname> .</para>
2020-06-09 08:23:11 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > StrictBands=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Specifies the number of bands that should be created in strict mode. An unsigned integer in
2021-11-04 00:20:21 +00:00
the range 1…16.</para>
2020-06-09 08:23:11 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > QuantumBytes=</varname> </term>
<listitem >
<para > Specifies the white-space separated list of quantum used in band-sharing bands. When
suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
respectively, to the base of 1024. This setting can be specified multiple times. If an empty
string is assigned, then the all previous assignments are cleared.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > PriorityMap=</varname> </term>
<listitem >
2020-09-29 10:31:27 +00:00
<para > The priority map maps the priority of a packet to a band. The argument is a whitespace
separated list of numbers. The first number indicates which band the packets with priority 0 should
be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
2021-01-28 19:42:37 +00:00
the last one. Each band number must be in the range 0…255. This setting can be specified multiple
2020-09-29 10:31:27 +00:00
times. If an empty string is assigned, then the all previous assignments are cleared.</para>
2020-06-09 08:23:11 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-02-10 12:24:02 +00:00
<refsect1 >
<title > [GenericRandomEarlyDetection] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
Early Detection (GRED).</para>
2020-02-10 12:24:02 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 12:24:02 +00:00
<varlistentry >
<term > <varname > VirtualQueues=</varname> </term>
<listitem >
2021-06-30 12:26:47 +00:00
<para > Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
2021-01-28 19:42:37 +00:00
and kernel's default is used.</para>
2020-02-10 12:24:02 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DefaultVirtualQueue=</varname> </term>
<listitem >
<para > Specifies the number of default virtual queue. This must be less than <varname > VirtualQueue=</varname> .
Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > GenericRIO=</varname> </term>
<listitem >
<para > Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to
unset and kernel's default is used.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-02-04 12:45:29 +00:00
<refsect1 >
<title > [FairQueueingControlledDelay] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
controlled delay (FQ-CoDel).</para>
2020-02-04 12:45:29 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2020-02-04 12:45:29 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
2019-12-07 19:48:18 +00:00
<listitem >
<para > Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
dropped. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
2019-12-12 08:25:29 +00:00
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > MemoryLimitBytes=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
<para > Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance.
When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > Flows=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
<para > Specifies the number of flows into which the incoming packets are classified.
Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > TargetSec=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
<para > Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay.
Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > IntervalSec=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
<para > Takes a timespan. This is used to ensure that the measured minimum delay does not
become too stale. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > QuantumBytes=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
2020-07-06 08:49:59 +00:00
<para > Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
2019-12-12 08:25:29 +00:00
When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > ECN=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
<para > Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to
unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > CEThresholdSec=</varname> </term>
2019-12-12 08:25:29 +00:00
<listitem >
<para > Takes a timespan. This sets a threshold above which all packets are marked with ECN
Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
2020-02-04 12:45:29 +00:00
</variablelist>
</refsect1>
<refsect1 >
2020-02-04 16:35:12 +00:00
<title > [FairQueueing] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
(FQ).</para>
2020-02-04 12:45:29 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2019-12-11 09:52:51 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > PacketLimit=</varname> </term>
2019-12-11 09:52:51 +00:00
<listitem >
<para > Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are
dropped. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
2019-12-13 11:55:33 +00:00
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > FlowLimit=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Specifies the hard limit on the maximum number of packets queued per flow. Defaults to
unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > QuantumBytes=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed
to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's
default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > InitialQuantumBytes=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is
allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as
Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > MaximumRate=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
2020-01-12 07:01:25 +00:00
specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
2019-12-13 11:55:33 +00:00
1000. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > Buckets=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Specifies the size of the hash table used for flow lookups. Defaults to unset and
kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > OrphanMask=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part
of hash and reduce number of buckets associated with the traffic. Defaults to unset and
kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > Pacing=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's
default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-02-04 12:45:29 +00:00
<term > <varname > CEThresholdSec=</varname> </term>
2019-12-13 11:55:33 +00:00
<listitem >
<para > Takes a timespan. This sets a threshold above which all packets are marked with ECN
Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
2019-10-07 14:19:00 +00:00
</variablelist>
</refsect1>
2020-02-06 08:52:24 +00:00
<refsect1 >
<title > [TrivialLinkEqualizer] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
equalizer (teql).</para>
2020-02-06 08:52:24 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 07:05:35 +00:00
2020-02-06 08:52:24 +00:00
<varlistentry >
<term > <varname > Id=</varname> </term>
<listitem >
<para > Specifies the interface ID <literal > N</literal> of teql. Defaults to <literal > 0</literal> .
Note that when teql is used, currently, the module <constant > sch_teql</constant> with
<constant > max_equalizers=N+1</constant> option must be loaded before
<command > systemd-networkd</command> is started.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2020-02-10 10:41:12 +00:00
<refsect1 >
<title > [HierarchyTokenBucket] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
bucket (htb).</para>
2020-02-10 10:41:12 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-10 10:41:12 +00:00
<varlistentry >
<term > <varname > DefaultClass=</varname> </term>
<listitem >
<para > Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent
to the class. Defaults to unset.</para>
</listitem>
</varlistentry>
2020-06-08 08:36:52 +00:00
<varlistentry >
<term > <varname > RateToQuantum=</varname> </term>
<listitem >
<para > Takes an unsigned integer. The DRR quantums are calculated by dividing the value
configured in <varname > Rate=</varname> by <varname > RateToQuantum=</varname> .</para>
</listitem>
</varlistentry>
2020-02-10 10:41:12 +00:00
</variablelist>
</refsect1>
2020-02-12 00:52:56 +00:00
<refsect1 >
<title > [HierarchyTokenBucketClass] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
(htb).</para>
2020-02-12 00:52:56 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "tclass-parent" />
<xi:include href= "tc.xml" xpointer= "tclass-classid" />
2020-02-12 00:52:56 +00:00
<varlistentry >
<term > <varname > Priority=</varname> </term>
<listitem >
<para > Specifies the priority of the class. In the round-robin process, classes with the lowest
2020-06-08 08:36:52 +00:00
priority field are tried for packets first.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > QuantumBytes=</varname> </term>
<listitem >
<para > Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the
specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MTUBytes=</varname> </term>
<listitem >
<para > Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified
size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > OverheadBytes=</varname> </term>
<listitem >
<para > Takes an unsigned integer which specifies per-packet size overhead used in rate
computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes,
Megabytes, or Gigabytes, respectively, to the base of 1024.</para>
2020-02-12 00:52:56 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > Rate=</varname> </term>
<listitem >
<para > Specifies the maximum rate this class and all its children are guaranteed. When suffixed
with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively,
to the base of 1000. This setting is mandatory.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > CeilRate=</varname> </term>
<listitem >
<para > Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare.
When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits,
respectively, to the base of 1000. When unset, the value specified with <varname > Rate=</varname>
is used.</para>
</listitem>
</varlistentry>
2020-06-08 08:36:52 +00:00
<varlistentry >
<term > <varname > BufferBytes=</varname> </term>
<listitem >
<para > Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed
with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively,
to the base of 1024.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > CeilBufferBytes=</varname> </term>
<listitem >
<para > Specifies the maximum bytes burst for ceil which can be accumulated during idle period.
When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes,
respectively, to the base of 1024.</para>
</listitem>
</varlistentry>
2020-03-11 10:55:13 +00:00
</variablelist>
</refsect1>
<refsect1 >
<title > [HeavyHitterFilter] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
(hhf).</para>
2020-03-11 10:55:13 +00:00
<variablelist class= 'network-directives' >
2020-03-12 09:33:15 +00:00
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
2020-02-12 00:52:56 +00:00
2020-03-11 10:55:13 +00:00
<varlistentry >
<term > <varname > PacketLimit=</varname> </term>
<listitem >
2020-07-06 08:49:59 +00:00
<para > Specifies the hard limit on the queue size in number of packets. When this limit is reached,
2021-11-04 00:20:21 +00:00
incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and
2020-07-06 08:49:59 +00:00
kernel's default is used.</para>
2020-03-11 10:55:13 +00:00
</listitem>
</varlistentry>
2020-02-12 00:52:56 +00:00
</variablelist>
</refsect1>
2020-03-19 21:41:57 +00:00
<refsect1 >
<title > [QuickFairQueueing] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
(QFQ).</para>
2020-03-19 21:41:57 +00:00
<variablelist class= 'network-directives' >
<xi:include href= "tc.xml" xpointer= "qdisc-parent" />
<xi:include href= "tc.xml" xpointer= "qdisc-handle" />
</variablelist>
</refsect1>
2020-06-03 06:07:45 +00:00
<refsect1 >
<title > [QuickFairQueueingClass] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
(qfq).</para>
2020-06-03 06:07:45 +00:00
<variablelist class= 'network-directives' >
<xi:include href= "tc.xml" xpointer= "tclass-parent" />
<xi:include href= "tc.xml" xpointer= "tclass-classid" />
<varlistentry >
<term > <varname > Weight=</varname> </term>
<listitem >
2021-01-28 19:42:37 +00:00
<para > Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
2020-06-03 06:07:45 +00:00
unset in which case the kernel default is used.</para>
</listitem>
</varlistentry>
<varlistentry >
2020-07-01 07:05:32 +00:00
<term > <varname > MaxPacketBytes=</varname> </term>
2020-06-03 06:07:45 +00:00
<listitem >
2021-01-28 19:38:27 +00:00
<para > Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the
specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of
1024. When unset, the kernel default is used.</para>
2020-06-03 06:07:45 +00:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2016-06-01 13:18:21 +00:00
<refsect1 >
<title > [BridgeVLAN] Section Options</title>
2020-07-06 09:00:06 +00:00
<para > The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the
following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The
<varname > VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in
2016-06-01 13:18:21 +00:00
<citerefentry > <refentrytitle > systemd.netdev</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
<variablelist class= 'network-directives' >
<varlistentry >
<term > <varname > VLAN=</varname> </term>
<listitem >
2021-11-04 00:20:21 +00:00
<para > The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes
an integer in the range 1…4094.</para>
2016-06-01 13:18:21 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > EgressUntagged=</varname> </term>
<listitem >
<para > The VLAN ID specified here will be used to untag frames on egress. Configuring
<varname > EgressUntagged=</varname> implicates the use of <varname > VLAN=</varname> above and will enable the
VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > PVID=</varname> </term>
<listitem >
<para > The Port VLAN ID specified here is assigned to all untagged frames at ingress.
<varname > PVID=</varname> can be used only once. Configuring <varname > PVID=</varname> implicates the use of
<varname > VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2015-02-04 02:14:13 +00:00
<refsect1 >
2016-12-02 19:00:46 +00:00
<title > Examples</title>
2015-02-04 02:14:13 +00:00
<example >
2016-12-02 19:00:46 +00:00
<title > Static network configuration</title>
2015-02-04 02:14:13 +00:00
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/50-static.network
[Match]
2014-02-25 18:30:40 +00:00
Name=enp2s0
[Network]
Address=192.168.0.15/24
Gateway=192.168.0.1</programlisting>
2016-12-02 19:00:46 +00:00
<para > This brings interface <literal > enp2s0</literal> up with a static address. The
specified gateway will be used for a default route.</para>
2015-02-04 02:14:13 +00:00
</example>
2014-02-25 18:30:40 +00:00
2015-02-04 02:14:13 +00:00
<example >
2016-12-02 19:00:46 +00:00
<title > DHCP on ethernet links</title>
2014-02-25 18:30:40 +00:00
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/80-dhcp.network
[Match]
2014-02-25 18:30:40 +00:00
Name=en*
[Network]
2015-03-13 04:25:31 +00:00
DHCP=yes</programlisting>
2016-12-02 19:00:46 +00:00
<para > This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
<literal > en</literal> (i.e. ethernet interfaces).</para>
2015-02-04 02:14:13 +00:00
</example>
2014-02-25 18:30:40 +00:00
2019-08-09 10:09:26 +00:00
<example >
<title > IPv6 Prefix Delegation</title>
<programlisting > # /etc/systemd/network/55-ipv6-pd-upstream.network
[Match]
Name=enp1s0
[Network]
DHCP=ipv6</programlisting>
<programlisting > # /etc/systemd/network/56-ipv6-pd-downstream.network
[Match]
Name=enp2s0
[Network]
2020-10-19 03:48:39 +00:00
IPv6SendRA=yes
DHCPv6PrefixDelegation=yes</programlisting>
2019-08-09 10:09:26 +00:00
2020-10-19 03:48:39 +00:00
<para > This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the
DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.
The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network.
</para>
2019-08-09 10:09:26 +00:00
</example>
2015-02-04 02:14:13 +00:00
<example >
2016-12-02 19:00:46 +00:00
<title > A bridge with two enslaved links</title>
2014-03-17 20:08:40 +00:00
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/25-bridge-static.network
[Match]
2014-03-17 20:08:40 +00:00
Name=bridge0
[Network]
Address=192.168.0.15/24
Gateway=192.168.0.1
DNS=192.168.0.1</programlisting>
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/25-bridge-slave-interface-1.network
[Match]
2014-03-17 20:08:40 +00:00
Name=enp2s0
[Network]
Bridge=bridge0</programlisting>
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/25-bridge-slave-interface-2.network
[Match]
Name=wlp3s0
[Network]
Bridge=bridge0</programlisting>
<para > This creates a bridge and attaches devices <literal > enp2s0</literal> and
<literal > wlp3s0</literal> to it. The bridge will have the specified static address
and network assigned, and a default route via the specified gateway will be
added. The specified DNS server will be added to the global list of DNS resolvers.
</para>
2016-06-01 13:18:21 +00:00
</example>
2016-12-02 19:00:46 +00:00
2016-06-01 13:18:21 +00:00
<example >
2016-12-02 19:00:46 +00:00
<title > </title>
2016-06-01 13:18:21 +00:00
2016-12-02 19:00:46 +00:00
<programlisting >
# /etc/systemd/network/20-bridge-slave-interface-vlan.network
[Match]
2016-06-01 13:18:21 +00:00
Name=enp2s0
[Network]
Bridge=bridge0
[BridgeVLAN]
VLAN=1-32
PVID=42
EgressUntagged=42
[BridgeVLAN]
VLAN=100-200
[BridgeVLAN]
EgressUntagged=300-400</programlisting>
2014-07-01 19:49:28 +00:00
2016-12-02 19:00:46 +00:00
<para > This overrides the configuration specified in the previous example for the
interface <literal > enp2s0</literal> , and enables VLAN on that bridge port. VLAN IDs
1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be
untagged when they leave on this interface. Untagged packets which arrive on this
interface will be assigned VLAN ID 42.</para>
2015-02-04 02:14:13 +00:00
</example>
2014-07-01 19:49:28 +00:00
2015-02-04 02:14:13 +00:00
<example >
2016-12-02 19:00:46 +00:00
<title > Various tunnels</title>
2014-07-01 19:49:28 +00:00
2016-12-02 19:00:46 +00:00
<programlisting > /etc/systemd/network/25-tunnels.network
[Match]
Name=ens1
2014-07-01 19:49:28 +00:00
[Network]
2016-12-02 19:00:46 +00:00
Tunnel=ipip-tun
Tunnel=sit-tun
Tunnel=gre-tun
Tunnel=vti-tun
</programlisting>
<programlisting > /etc/systemd/network/25-tunnel-ipip.netdev
[NetDev]
Name=ipip-tun
Kind=ipip
</programlisting>
<programlisting > /etc/systemd/network/25-tunnel-sit.netdev
[NetDev]
Name=sit-tun
Kind=sit
</programlisting>
<programlisting > /etc/systemd/network/25-tunnel-gre.netdev
[NetDev]
Name=gre-tun
Kind=gre
</programlisting>
<programlisting > /etc/systemd/network/25-tunnel-vti.netdev
[NetDev]
Name=vti-tun
Kind=vti
</programlisting>
<para > This will bring interface <literal > ens1</literal> up and create an IPIP tunnel,
a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para>
2015-02-04 02:14:13 +00:00
</example>
2014-07-01 19:49:28 +00:00
2015-02-04 02:14:13 +00:00
<example >
2016-12-02 19:00:46 +00:00
<title > A bond device</title>
2014-07-01 19:49:28 +00:00
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/30-bond1.network
[Match]
Name=bond1
2014-07-01 19:49:28 +00:00
[Network]
2016-12-02 19:00:46 +00:00
DHCP=ipv6
</programlisting>
2014-07-01 19:49:28 +00:00
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/30-bond1.netdev
[NetDev]
Name=bond1
Kind=bond
</programlisting>
2014-07-01 19:49:28 +00:00
2017-01-19 15:54:22 +00:00
<programlisting > # /etc/systemd/network/30-bond1-dev1.network
2016-12-02 19:00:46 +00:00
[Match]
MACAddress=52:54:00:e9:64:41
2014-07-01 19:49:28 +00:00
[Network]
2016-12-02 19:00:46 +00:00
Bond=bond1
</programlisting>
2015-08-21 03:14:49 +00:00
2017-01-19 15:54:22 +00:00
<programlisting > # /etc/systemd/network/30-bond1-dev2.network
2016-12-02 19:00:46 +00:00
[Match]
MACAddress=52:54:00:e9:64:42
2015-08-21 03:14:49 +00:00
[Network]
2016-12-02 19:00:46 +00:00
Bond=bond1
2016-06-12 23:05:49 +00:00
</programlisting>
2016-12-02 19:00:46 +00:00
<para > This will create a bond device <literal > bond1</literal> and enslave the two
devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP
will be used to acquire an address.</para>
2016-06-12 23:05:49 +00:00
</example>
<example >
2016-12-02 19:00:46 +00:00
<title > Virtual Routing and Forwarding (VRF)</title>
<para > Add the <literal > bond1</literal> interface to the VRF master interface
<literal > vrf1</literal> . This will redirect routes generated on this interface to be
2017-09-26 23:54:20 +00:00
within the routing table defined during VRF creation. For kernels before 4.8 traffic
won't be redirected towards the VRFs routing table unless specific ip-rules are added.
</para>
2016-12-02 19:00:46 +00:00
<programlisting > # /etc/systemd/network/25-vrf.network
[Match]
2016-06-12 23:05:49 +00:00
Name=bond1
[Network]
2016-12-02 19:00:46 +00:00
VRF=vrf1
2015-08-21 03:14:49 +00:00
</programlisting>
</example>
2016-12-23 17:09:29 +00:00
<example >
<title > MacVTap</title>
<para > This brings up a network interface <literal > macvtap-test</literal>
and attaches it to <literal > enp0s25</literal> .</para>
2017-03-21 00:32:23 +00:00
<programlisting > # /usr/lib/systemd/network/25-macvtap.network
2016-12-23 17:09:29 +00:00
[Match]
Name=enp0s25
[Network]
MACVTAP=macvtap-test
</programlisting>
</example>
2019-07-08 15:09:46 +00:00
<example >
<title > A Xfrm interface with physical underlying device.</title>
<programlisting > # /etc/systemd/network/27-xfrm.netdev
[NetDev]
Name=xfrm0
[Xfrm]
InterfaceId=7</programlisting>
<programlisting > # /etc/systemd/network/27-eth0.network
[Match]
Name=eth0
[Network]
Xfrm=xfrm0</programlisting>
<para > This creates a <literal > xfrm0</literal> interface and binds it to the <literal > eth0</literal> device.
This allows hardware based ipsec offloading to the <literal > eth0</literal> nic.
If offloading is not needed, xfrm interfaces can be assigned to the <literal > lo</literal> device.
</para>
</example>
2015-02-04 02:14:13 +00:00
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2016-01-05 16:40:51 +00:00
<citerefentry > <refentrytitle > systemd-networkd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2015-02-04 02:14:13 +00:00
<citerefentry > <refentrytitle > systemd.link</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2016-01-05 16:32:25 +00:00
<citerefentry > <refentrytitle > systemd.netdev</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd-resolved.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2015-02-04 02:14:13 +00:00
</para>
</refsect1>
2014-02-25 18:30:40 +00:00
</refentry>
