shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-25 23:21:33 +03:00
Code
149cda85bf
systemd-stable/man/systemd.network.xml

4303 lines
208 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 00:15:39 +03:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-18 20:47:44 +03:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 07:23:58 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
man: use xi:include to avoid duplication ... and fix some unwarranted discrepancies between the two man pages.
2020-01-08 13:43:09 +03:00
<refentry id="systemd.network" conditional='ENABLE_NETWORKD'
xmlns:xi="http://www.w3.org/2001/XInclude">
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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>
man: document that .link/.network/.netdev files have the usual ini syntax Fixes #1266.
2020-03-03 21:08:26 +03:00
<para>A plain ini-style text file that encodes network configuration for matching network interfaces,
used by
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
man: fix some manvolnum
2020-07-11 01:05:23 +03:00
See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
man: document that .link/.network/.netdev files have the usual ini syntax Fixes #1266.
2020-03-03 21:08:26 +03:00
for a general description of the syntax.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
man: mention that netdev,network files support dropins Also update the description of drop-ins in systemd.unit(5) to say that .d directories, not .conf files, are in /etc/system/system, /run/systemd/system, etc.
2016-09-10 16:34:07 +03: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>
udev,network: use standard paths for .network and .link files This centralizes the configuration to one header file. /usr/local/lib is now included in the search list, and documentation is updated accordingly.
2019-01-02 16:30:24 +03: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
man: use trailing slash on directories in more places
2020-10-05 19:08:21 +03: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
udev,network: use standard paths for .network and .link files This centralizes the configuration to one header file. /usr/local/lib is now included in the search list, and documentation is updated accordingly.
2019-01-02 16:30:24 +03: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>
man: mention that netdev,network files support dropins Also update the description of drop-ins in systemd.unit(5) to say that .d directories, not .conf files, are in /etc/system/system, /run/systemd/system, etc.
2016-09-10 16:34:07 +03: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
man: mention that drop-in files are merged in alphanumeric order This addresses the request in https://github.com/systemd/systemd/issues/19467#issuecomment-829332877.
2021-05-20 09:55:06 +03: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>
man: mention that netdev,network files support dropins Also update the description of drop-ins in systemd.unit(5) to say that .d directories, not .conf files, are in /etc/system/system, /run/systemd/system, etc.
2016-09-10 16:34:07 +03: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
man: use trailing slash on directories in more places
2020-10-05 19:08:21 +03: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
trivial spelling fixes (#13339)
2019-08-17 19:30:57 +03:00
directories take precedence over the main network file wherever located.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>[Match] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<variablelist class='network-directives'>
man: use xi:include to avoid duplication ... and fix some unwarranted discrepancies between the two man pages.
2020-01-08 13:43:09 +03: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" />
man: document that MACAddress= in [Match] section can take multiple MAC addresses
2018-05-09 06:00:16 +03:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>Name=</varname></term>
<listitem>
network: make Name= in [Match] support alternative names of interfaces
2019-12-15 16:46:19 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
network,udev: add Property= setting in [Match] section Closes #5665.
2019-06-22 19:44:13 +03:00
network: support matching based on wifi interfece type
2019-10-25 10:29:23 +03:00
<varlistentry>
Merge pull request #13623 from yuwata/network-wifi-iftype
2019-10-25 15:18:23 +03:00
<term><varname>WLANInterfaceType=</varname></term>
network: support matching based on wifi interfece type
2019-10-25 10:29:23 +03: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>
man: use xi:include to avoid duplication ... and fix some unwarranted discrepancies between the two man pages.
2020-01-08 13:43:09 +03:00
network: support matching based on wifi SSID
2019-07-24 08:46:55 +03: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>
man: use xi:include to avoid duplication ... and fix some unwarranted discrepancies between the two man pages.
2020-01-08 13:43:09 +03:00
network: add support matching based on BSSID=
2019-07-24 09:32:24 +03: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
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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>
network: add support matching based on BSSID=
2019-07-24 09:32:24 +03:00
</listitem>
</varlistentry>
man: use xi:include to avoid duplication ... and fix some unwarranted discrepancies between the two man pages.
2020-01-08 13:43:09 +03: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" />
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</variablelist>
</refsect1>
<refsect1>
<title>[Link] Section Options</title>
man: drop unnecessary white space
2021-09-03 00:09:54 +03:00
<para>The [Link] section accepts the following keys:</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>MACAddress=</varname></term>
<listitem>
man: clarify different uses of MACAddress Improve the networkd documentation to clarify that Match.MACAddress is for selection, but Link.MACAddress describes an action to be taken.
2016-05-08 22:58:34 +03:00
<para>The hardware address to set for the device.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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>
networkd: bump MTU to 1280 for interfaces which have IPv6 enabled (#3077) IPv6 protocol requires a minimum MTU of 1280 bytes on the interface. This fixes #3046. Introduce helper link_ipv6_enabled() to figure out whether IPV6 is enabled. Introduce network_has_static_ipv6_addresses() to find out if any static ipv6 address configured. If IPv6 is not configured on any interface that is SLAAC, DHCPv6 and static IPv6 addresses not configured, then IPv6 will be automatically disabled for that interface, that is we write "1" to /proc/sys/net/ipv6/conf//disable_ipv6.
2016-04-21 03:34:13 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: add support to configure NOARP/ARP for interface (#3854) https://lists.freedesktop.org/archives/systemd-devel/2016-August/037268.html
2016-08-04 17:00:58 +03:00
<varlistentry>
<term><varname>ARP=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03: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>
networkd: add support to configure NOARP/ARP for interface (#3854) https://lists.freedesktop.org/archives/systemd-devel/2016-August/037268.html
2016-08-04 17:00:58 +03: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
network: Allow to configure interface promiscuous mode
2020-12-15 07:00:17 +03:00
the network otherwise. Defaults to unset.</para>
networkd: add support to configure NOARP/ARP for interface (#3854) https://lists.freedesktop.org/archives/systemd-devel/2016-August/037268.html
2016-08-04 17:00:58 +03:00
</listitem>
</varlistentry>
networkd: Add ability to set MULTICAST flag on interface Closes #9113 fix ARP toggling flag
2018-05-29 17:58:11 +03:00
<varlistentry>
<term><varname>Multicast=</varname></term>
<listitem>
network: Allow to configure interface promiscuous mode
2020-12-15 07:00:17 +03:00
<para>Takes a boolean. If set to true, the multicast flag on the device is enabled. Defaults to unset.</para>
networkd: enable to set IFF_ALLMULTI to network device (#9146) networkd: allow setting set IFF_ALLMULTI flag on network devices
2018-06-01 17:22:12 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>AllMulticast=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the network.
network: Allow to configure interface promiscuous mode
2020-12-15 07:00:17 +03: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>
man: network: mention that Promiscuous= can be used to set nopromisc for passthru MACV{LAN,TAP}
2021-08-17 17:53:29 +03: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>
networkd: Add ability to set MULTICAST flag on interface Closes #9113 fix ARP toggling flag
2018-05-29 17:58:11 +03:00
</listitem>
</varlistentry>
networkd: support marking links unmanaged
2016-09-28 01:18:14 +03:00
<varlistentry>
<term><varname>Unmanaged=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. When <literal>yes</literal>, no attempts are
networkd: support marking links unmanaged
2016-09-28 01:18:14 +03: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>
network: Add support to group links. Link groups are similar to port ranges found in managed switches. You can add network interfaces to a numbered group and perform operations on all the interfaces from that group at once.
2020-04-07 15:36:55 +03:00
<varlistentry>
<term><varname>Group=</varname></term>
<listitem>
network: allow to set Group=0 in [Link] section Previously, when a link has already in a numbered group, we cannot remove the link from the group. This also fixes the range mentioned in the man page.
2021-05-21 08:11:36 +03: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>
network: Add support to group links. Link groups are similar to port ranges found in managed switches. You can add network interfaces to a numbered group and perform operations on all the interfaces from that group at once.
2020-04-07 15:36:55 +03:00
</listitem>
network: Allow to set device's receive queues and transmit queues
2021-01-04 18:40:47 +03:00
</varlistentry>
Add a "RequiredForOnline=" Link attribute for .network files (#7347) RequiredForOnline= denotes a link/network that does/does not require being up for systemd-networkd-wait-online to consider the system online; this makes it possible to ignore devices without modifying parameters to wait-online.
2017-11-30 20:03:50 +03:00
<varlistentry>
<term><varname>RequiredForOnline=</varname></term>
<listitem>
wait-online: Add maximum operational state option
2020-01-09 23:31:50 +03: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>
man: update wait-online and RequiredForOnline= setting
2019-03-06 17:47:29 +03:00
for possible operational states. When <literal>yes</literal>, the network is deemed required when
man: clarify RequiredForOnline= behaviour for online state With new "online state" semantics in networkd, make the description of RequiredForOnline= a little more broad.
2021-04-06 16:56:05 +03: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
wait-online: Add maximum operational state option
2020-01-09 23:31:50 +03:00
state are set, <literal>yes</literal> is implied, and this controls the minimum and maximum
network: default RequiredForOnline=false if ActivactionPolicy= not set to up If ActivationPolicy= is set to down, always-down, or manual, then any matching link will delay boot (due to delaying network-online.target). If RequiredForOnline= wasn't explicitly set, then default it to false if ActivationPolicy= is down or manual. If ActivationPolicy=always-down, then force RequiredForOnline=no.
2021-06-08 19:01:31 +03:00
operational state required for the network interface to be considered online.</para>
man: update wait-online and RequiredForOnline= setting
2019-03-06 17:47:29 +03:00
network: default RequiredForOnline=false if ActivactionPolicy= not set to up If ActivationPolicy= is set to down, always-down, or manual, then any matching link will delay boot (due to delaying network-online.target). If RequiredForOnline= wasn't explicitly set, then default it to false if ActivationPolicy= is down or manual. If ActivationPolicy=always-down, then force RequiredForOnline=no.
2021-06-08 19:01:31 +03: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
Add a "RequiredForOnline=" Link attribute for .network files (#7347) RequiredForOnline= denotes a link/network that does/does not require being up for systemd-networkd-wait-online to consider the system online; this makes it possible to ignore devices without modifying parameters to wait-online.
2017-11-30 20:03:50 +03:00
cable is not plugged in, the link will simply remain offline and be
man: update wait-online and RequiredForOnline= setting
2019-03-06 17:47:29 +03:00
skipped automatically by <command>systemd-networkd-wait-online</command>
man: fix typo
2018-10-10 10:13:39 +03:00
if <literal>RequiredForOnline=no</literal>.</para>
Add a "RequiredForOnline=" Link attribute for .network files (#7347) RequiredForOnline= denotes a link/network that does/does not require being up for systemd-networkd-wait-online to consider the system online; this makes it possible to ignore devices without modifying parameters to wait-online.
2017-11-30 20:03:50 +03:00
</listitem>
</varlistentry>
network: save IPv4/IPv6 address states into state file This also introduces RequiredFamilyForOnline= setting to .network file, and IPv4AddressState/IPv6AddressState DBus properties.
2021-04-11 23:29:11 +03:00
<varlistentry>
<term><varname>RequiredFamilyForOnline=</varname></term>
<listitem>
man: clarify RequiredFamilyForOnline= behaviour for online state With new "online state" semantics in networkd, make the description of RequiredFamilyForOnline= a little more broad. Some rewording has been done to make the passage easier to understand.
2021-04-16 16:04:24 +03: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>
network: save IPv4/IPv6 address states into state file This also introduces RequiredFamilyForOnline= setting to .network file, and IPv4AddressState/IPv6AddressState DBus properties.
2021-04-11 23:29:11 +03: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 23:09:40 +03: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>
network: default RequiredForOnline=false if ActivactionPolicy= not set to up If ActivationPolicy= is set to down, always-down, or manual, then any matching link will delay boot (due to delaying network-online.target). If RequiredForOnline= wasn't explicitly set, then default it to false if ActivationPolicy= is down or manual. If ActivationPolicy=always-down, then force RequiredForOnline=no.
2021-06-08 19:01:31 +03: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 23:09:40 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</variablelist>
</refsect1>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03:00
<refsect1>
<title>[SR-IOV] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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’s network stack.</para>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03: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
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
in and out. Takes an unsigned integer in the range 0…2147483646. This option is compulsory.</para>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>VLANId=</varname></term>
<listitem>
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
<para>Specifies VLAN ID of the virtual function. Takes an unsigned integer in the range 1…4095.</para>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>QualityOfService=</varname></term>
<listitem>
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
<para>Specifies quality of service of the virtual function. Takes an unsigned integer in the range 1…4294967294.</para>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03:00
</listitem>
network: add VLANProtocol= setting in [SR-IOV] section
2020-06-22 13:26:31 +03: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>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03: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>
network: add MACAddress= setting in [SR-IOV] section
2020-06-22 13:48:33 +03:00
<varlistentry>
<term><varname>MACAddress=</varname></term>
<listitem>
<para>Specifies the MAC address for the virtual function.</para>
</listitem>
</varlistentry>
network: Introduce SR-IOV SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected in to a VM. In the case of network VFs, SR-IOV improves north-south n etwork performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine’s network stack.
2020-06-21 14:17:34 +03:00
</variablelist>
</refsect1>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<refsect1>
<title>[Network] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [Network] section accepts the following keys:</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
<para>Enables DHCPv4 and/or DHCPv6 client support. Accepts
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<literal>yes</literal>, <literal>no</literal>,
man/systemd.network: DHCP defaults to "no" (#6423) Code at: /src/network/networkd-network.c#L160
2017-07-21 23:21:30 +03:00
<literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults
to <literal>no</literal>.</para>
man: explain UseDomains a bit more https://bugs.freedesktop.org/show_bug.cgi?id=85397
2015-05-19 05:34:07 +03: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 19:25:58 +03:00
<para>Note that DHCPv6 will by default be triggered by Router
man: fix typos
2015-12-26 20:25:49 +03: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 19:25:58 +03: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
networkd: rename IPv6AcceptRouterAdvertisements to IPv6AcceptRA The long name is just too hard to type. We generally should avoid using acronyms too liberally, if they aren't established enough, but it appears that "RA" is known well enough. Internally we call the option "ipv6_accept_ra" anyway, and the kernel also exposes it under this name. Hence, let's rename the IPv6AcceptRouterAdvertisements= setting and the [IPv6AcceptRouterAdvertisements] section to IPv6AcceptRA= and [IPv6AcceptRA]. The old setting IPv6AcceptRouterAdvertisements= is kept for compatibility with older configuration. (However the section [IPv6AcceptRouterAdvertisements] is not, as it was never available in a published version of systemd.
2016-06-07 12:19:26 +03: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 19:25:58 +03:00
<para>Furthermore, note that by default the domain name
man: explain UseDomains a bit more https://bugs.freedesktop.org/show_bug.cgi?id=85397
2015-05-19 05:34:07 +03:00
specified through DHCP is not used for name resolution.
See option <option>UseDomains=</option> below.</para>
man: link the part about [DHCP] to the DHCP= explanation
2016-05-06 18:08:03 +03:00
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP
client support.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DHCPServer=</varname></term>
<listitem>
fix a typo in the man page for dhcpserver
2019-03-08 21:17:21 +03:00
<para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
to <literal>no</literal>. Further settings for the DHCP server may be set in the [DHCPServer]
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
section described below.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
networkd: .network - rename LinkLocal to LinkLocalAddressing Makes it a bit less ambiguous.
2015-02-14 02:32:26 +03:00
<term><varname>LinkLocalAddressing=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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 17:59:26 +03: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
networkd: start ipv4ll when dhcp has trouble getting a lease Fixes #13316.
2020-10-08 21:14:51 +03: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 17:59:26 +03:00
network: introduce KeepMaster= setting Closes #20624.
2021-09-03 00:10:07 +03:00
<para>Defaults to <option>no</option> when <varname>KeepMaster=</varname> or
<varname>Bridge=</varname> is set or when the specified
network: default LinkLocalAddresssing= to no for link stacked with a passthru mode MACVLAN/MACVTAP For similar reason to the case of a bridge slave: we don't want any IP configuration for it.
2021-08-25 12:50:01 +03: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 17:59:26 +03:00
<option>ipv6</option> otherwise.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
network: move IPv6LinkLocalAddressGenerationMode= to [Network] section This also moves and renames variables and functions. Follow-ups for a6f1848a2328cf1493f363968d105cc23019af8a.
2020-06-30 11:01:30 +03:00
<varlistentry>
<term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term>
<listitem>
network: IPv6LinkLocalAddressGenerationMode=none disables IPv6LL addressing
2021-05-22 02:15:00 +03:00
<para>Specifies how IPv6 link local address is generated. Takes one of
<literal>eui64</literal>, <literal>none</literal>, <literal>stable-privacy</literal> and
network: introduce IPv6StableSecretAddress= setting Previously, IPv6LinkLocalAddressGenerationMode= is not set, then we define the address generation mode based on the result of reading stable_secret sysctl value. This makes the mode is determined by whether a secret address is specified in the new setting. Closes #19622.
2021-06-08 00:21:57 +03: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>
network: move IPv6LinkLocalAddressGenerationMode= to [Network] section This also moves and renames variables and functions. Follow-ups for a6f1848a2328cf1493f363968d105cc23019af8a.
2020-06-30 11:01:30 +03:00
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>IPv4LLRoute=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. If set to true, sets up the route needed for
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
to false.
</para>
</listitem>
</varlistentry>
network: add DefaultRouteOnDevice= setting in [Network] section When enabled, then default route bound to the interface will be created. This is useful when adding routes on point-to-point interfaces. Closes #788.
2019-05-14 10:43:14 +03: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.
man: add an example to configure default route on device with table Prompted by #19911.
2021-06-15 10:05:08 +03: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>
network: add DefaultRouteOnDevice= setting in [Network] section When enabled, then default route bound to the interface will be created. This is useful when adding routes on point-to-point interfaces. Closes #788.
2019-05-14 10:43:14 +03:00
</listitem>
</varlistentry>
man: systemd.network - document IPv6Token
2015-02-14 02:30:51 +03:00
<varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<term><varname>LLMNR=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean or <literal>resolve</literal>. When true,
networkd,resolved: add a per-interface mdns configuration option
2016-01-05 19:32:25 +03: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>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean or <literal>resolve</literal>. When true,
networkd,resolved: add a per-interface mdns configuration option
2016-01-05 19:32:25 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
man: document DNS-over-TLS options
2018-06-11 22:33:57 +03:00
<varlistentry>
resolve: rename PrivateDNS to DNSOverTLS PrivateDNS is not considered a good name for this option, so rename it to DNSOverTLS
2018-06-13 21:26:24 +03:00
<term><varname>DNSOverTLS=</varname></term>
man: document DNS-over-TLS options
2018-06-11 22:33:57 +03:00
<listitem>
resolved: add strict mode for DNS-over-TLS Add strict mode for DNS-over-TLS, which will require TLS support from the server. Closes #10755
2019-02-18 22:41:46 +03:00
<para>Takes a boolean or <literal>opportunistic</literal>.
When true, enables
man: document DNS-over-TLS options
2018-06-11 22:33:57 +03:00
<ulink
url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink>
resolved: add strict mode for DNS-over-TLS Add strict mode for DNS-over-TLS, which will require TLS support from the server. Closes #10755
2019-02-18 22:41:46 +03: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
man: document DNS-over-TLS options
2018-06-11 22:33:57 +03:00
<citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s
resolve: rename PrivateDNS to DNSOverTLS PrivateDNS is not considered a good name for this option, so rename it to DNSOverTLS
2018-06-13 21:26:24 +03:00
global <varname>DNSOverTLS=</varname> option. Defaults to
man: document DNS-over-TLS options
2018-06-11 22:33:57 +03:00
false. This setting is read by
<citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</listitem>
</varlistentry>
resolved,networkd: add a per-interface DNSSEC setting This adds a DNSSEC= setting to .network files, and makes resolved honour them.
2016-01-05 21:57:33 +03:00
<varlistentry>
<term><varname>DNSSEC=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>Takes a boolean or <literal>allow-downgrade</literal>. When true, enables
<ulink url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink>
resolved,networkd: add a per-interface DNSSEC setting This adds a DNSSEC= setting to .network files, and makes resolved honour them.
2016-01-05 21:57:33 +03:00
DNS validation support on the link. When set to
<literal>allow-downgrade</literal>, compatibility with
non-DNSSEC capable networks is increased, by automatically
man: fix typos (#6532)
2017-08-04 00:36:21 +03:00
turning off DNSSEC in this case. This option defines a
resolved,networkd: add a per-interface DNSSEC setting This adds a DNSSEC= setting to .network files, and makes resolved honour them.
2016-01-05 21:57:33 +03: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>
resolved: introduce support for per-interface negative trust anchors
2016-01-06 20:36:32 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>LLDP=</varname></term>
<listitem>
man: document the new EmitLLDP= .network setting Also, beef up the LLDP documentation a bit.
2016-02-21 22:58:01 +03: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 19:58:52 +03: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
networkd: turn on LLDP reception by default, in "routers-only" mode This way "networkctl status" becomes a bit more useful by default, as router information is just visible, without any further configuration. LLDP reception is fully passive and relatively low simple and low traffic, hence this should be safe to enable by default.
2016-02-19 21:59:32 +03: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 19:58:52 +03:00
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the
man: document the new EmitLLDP= .network setting Also, beef up the LLDP documentation a bit.
2016-02-21 22:58:01 +03: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.
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</para>
</listitem>
</varlistentry>
man: document the new EmitLLDP= .network setting Also, beef up the LLDP documentation a bit.
2016-02-21 22:58:01 +03:00
<varlistentry>
<term><varname>EmitLLDP=</varname></term>
<listitem>
networkd: reworkd LLDP emission to allow control of propagation level This allows selecting the propagation level of emitted LLDP packets (specifically: the destination MAC address of the packets). This is useful because it allows generating LLDP packets that optionally cross certain types of bridges. See 802.11ab-2009, Table 7-1 for details.
2016-05-06 22:27:36 +03: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
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 11:37:40 +03:00
link. The LLDP packet will contain information about the local hostname, the local machine ID (as stored
networkd: reworkd LLDP emission to allow control of propagation level This allows selecting the propagation level of emitted LLDP packets (specifically: the destination MAC address of the packets). This is useful because it allows generating LLDP packets that optionally cross certain types of bridges. See 802.11ab-2009, Table 7-1 for details.
2016-05-06 22:27:36 +03:00
in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the
man: document the new EmitLLDP= .network setting Also, beef up the LLDP documentation a bit.
2016-02-21 22:58:01 +03: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
networkd: reworkd LLDP emission to allow control of propagation level This allows selecting the propagation level of emitted LLDP packets (specifically: the destination MAC address of the packets). This is useful because it allows generating LLDP packets that optionally cross certain types of bridges. See 802.11ab-2009, Table 7-1 for details.
2016-05-06 22:27:36 +03: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
man: update url to latest 802.1AB (2016) standard
2018-06-07 00:24:33 +03:00
url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>. Note that
networkd: reworkd LLDP emission to allow control of propagation level This allows selecting the propagation level of emitted LLDP packets (specifically: the destination MAC address of the packets). This is useful because it allows generating LLDP packets that optionally cross certain types of bridges. See 802.11ab-2009, Table 7-1 for details.
2016-05-06 22:27:36 +03: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>
man: document the new EmitLLDP= .network setting Also, beef up the LLDP documentation a bit.
2016-02-21 22:58:01 +03:00
</listitem>
</varlistentry>
LLDP: Add support to transmit MUD URL
2020-03-30 22:57:58 +03:00
networkd: add support for Uplink Failure Detection Introduce BindCarrier= to indicate the set of links that determine if the current link should be brought UP or DOWN. [tomegun: add a bit to commit message]
2015-02-17 15:06:57 +03:00
<varlistentry>
<term><varname>BindCarrier=</varname></term>
<listitem>
man: network - clarify BindCarrier documentation Make it clear that we are talking of links (in the sense used in networkd) and not ports. Addresses issue #964.
2016-02-23 02:29:32 +03: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 23:09:40 +03: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>
networkd: add support for Uplink Failure Detection Introduce BindCarrier= to indicate the set of links that determine if the current link should be brought UP or DOWN. [tomegun: add a bit to commit message]
2015-02-17 15:06:57 +03:00
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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
man: fix a bunch of links All hail linkchecker!
2015-03-14 05:22:39 +03:00
<citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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>
man: mention limit about prefix length when null address is specified to Address=
2019-02-20 13:01:49 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Gateway=</varname></term>
<listitem>
<para>The gateway address, which must be in the format
described in
man: fix a bunch of links All hail linkchecker!
2015-03-14 05:22:39 +03:00
<citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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>
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03:00
<para>A DNS server address, which must be in the format described in
man: fix a bunch of links All hail linkchecker!
2015-03-14 05:22:39 +03:00
<citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
man: update explanation about the format to specify DNS servers
2020-07-19 07:57:51 +03: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
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03: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 21:46:00 +03:00
<citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Domains=</varname></term>
<listitem>
man: specify that Domains= is a space-separated list Fixes #14998.
2020-03-03 20:03:53 +03: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
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 11:37:40 +03: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
man: specify that Domains= is a space-separated list Fixes #14998.
2020-03-03 20:03:53 +03: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>
man: rework the explanation of Domains= Put more emphasis on the routing part. This is the more interesting thing, and also more complicated and novel. Explain "search domains" as the special case. Also explain the effect of ~. in more detail.
2016-10-02 15:32:44 +03:00
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 11:37:40 +03:00
<para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for hostnames
man: rework the explanation of Domains= Put more emphasis on the routing part. This is the more interesting thing, and also more complicated and novel. Explain "search domains" as the special case. Also explain the effect of ~. in more detail.
2016-10-02 15:32:44 +03: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 21:46:00 +03:00
<para>This setting is read by
man: rework the explanation of Domains= Put more emphasis on the routing part. This is the more interesting thing, and also more complicated and novel. Explain "search domains" as the special case. Also explain the effect of ~. in more detail.
2016-10-02 15:32:44 +03: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
man: fix links to external man pages linkchecker ftw!
2017-05-07 18:29:40 +03:00
<citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
man: rework the explanation of Domains= Put more emphasis on the routing part. This is the more interesting thing, and also more complicated and novel. Explain "search domains" as the special case. Also explain the effect of ~. in more detail.
2016-10-02 15:32:44 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: permit DNS "DefaultRoute" configuration in .network files
2018-12-04 17:34:04 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>NTP=</varname></term>
<listitem>
network: clean-up DHCP lease server data configuration This is an attempt to clean up the POP3/SMTP/LPR/… DHCP lease server data logic in networkd. This reduces code duplication and fixes a number of bugs. This removes any support for collecting POP3/SMPT/LPR servers acquired via local DHCP client releases since noone uses that, and given how old these protocols are I doubt this will change. It keeps support for configuring them for the dhcp server however. The differences between the DNS/NTP/SIP/POP3/SMTP/LPR configuration logics are minimized. This removes the relevant symbols from sd-network.h (which is an internal API only at this point after all). This is unfortunately not well test, given the old code for this had barely any tests. But the new code should not perform worse at least, and allow us to release, since it corrects some interfaces visible in the .network configuration format. Fixes: #15943
2020-06-16 21:35:18 +03: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 21:46:00 +03:00
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPForward=</varname></term>
networkd: stop managing per-interface IP forwarding settings As it turns out the kernel does not support per-interface IPv6 packet forwarding controls (unlike as it does for IPv4), but only supports a global option (#1597). Also, the current per-interface management of the setting isn't really useful, as you want it to propagate to at least one more interface than the one you configure it on. This created much grief (#1411, #1808). Hence, let's roll this logic back and simplify this again, so that we can expose the same behaviour on IPv4 and IPv6 and things start to work automatically again for most folks: if a network with this setting set is set up we propagate the setting into the global setting, but this is strictly one-way: we never reset it again, and we do nothing for network interfaces where this setting is not enabled. Fixes: #1808, #1597.
2015-11-13 14:49:15 +03: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
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
according to the routing table. Takes a boolean,
or the values <literal>ipv4</literal> or
networkd: stop managing per-interface IP forwarding settings As it turns out the kernel does not support per-interface IPv6 packet forwarding controls (unlike as it does for IPv4), but only supports a global option (#1597). Also, the current per-interface management of the setting isn't really useful, as you want it to propagate to at least one more interface than the one you configure it on. This created much grief (#1411, #1808). Hence, let's roll this logic back and simplify this again, so that we can expose the same behaviour on IPv4 and IPv6 and things start to work automatically again for most folks: if a network with this setting set is set up we propagate the setting into the global setting, but this is strictly one-way: we never reset it again, and we do nothing for network interfaces where this setting is not enabled. Fixes: #1808, #1597.
2015-11-13 14:49:15 +03: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
man: extend documentation on IPForward= and IPMasquerade= Mention the default values, and clarify how this relates to the underlying sysctls.
2015-04-24 20:53:38 +03: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>
networkd: stop managing per-interface IP forwarding settings As it turns out the kernel does not support per-interface IPv6 packet forwarding controls (unlike as it does for IPv4), but only supports a global option (#1597). Also, the current per-interface management of the setting isn't really useful, as you want it to propagate to at least one more interface than the one you configure it on. This created much grief (#1411, #1808). Hence, let's roll this logic back and simplify this again, so that we can expose the same behaviour on IPv4 and IPv6 and things start to work automatically again for most folks: if a network with this setting set is set up we propagate the setting into the global setting, but this is strictly one-way: we never reset it again, and we do nothing for network interfaces where this setting is not enabled. Fixes: #1808, #1597.
2015-11-13 14:49:15 +03: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>
man: extend documentation on IPForward= and IPMasquerade= Mention the default values, and clarify how this relates to the underlying sysctls.
2015-04-24 20:53:38 +03:00
</listitem>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
<varlistentry>
<term><varname>IPMasquerade=</varname></term>
network: warn when any positive boolean string is specified for IPMasquerade= Previously, any positive boolean string for IPMasquerade= enables only IPv4 masquerade. The commit 48ed276647c754bfb3ed5c6c5af9404e073ffe54 adds IPv6 masquerade support. However, only "yes" is handled as "ipv4", and other positive boolean strings are handled as "both". This makes all positive boolean strings considered as "ipv4", warn that they are deprecated, and suggest to use "ipv4" or "both". Follow-up for 48ed276647c754bfb3ed5c6c5af9404e073ffe54.
2021-02-17 10:17:37 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</varlistentry>
man: add manual for ipv6 privacy extension
2015-07-05 08:55:20 +03:00
<varlistentry>
<term><varname>IPv6PrivacyExtensions=</varname></term>
networkd: various fixes for the IPv6 privacy extensions support - Make sure that the IPv6PrivacyExtensions=yes results in prefer-temporary, not prefer-public. - Introduce special enum value "kernel" to leave setting unset, similar how we have it for the IP forwarding settings. - Bring the enum values in sync with the the strings we parse for them, to the level this makes sense (specifically, rename "disabled" to "no", and "prefer-temporary" to "yes"). - Make sure we really set the value to to "no" by default, the way it is already documented in the man page. - Fix whitespace error. - Make sure link_ipv6_privacy_extensions() actually returns the correct enum type, rather than implicitly casting it to "bool". - properly size formatting buffer for ipv6 sysctl value - Don't complain if /proc/sys isn't writable - Document that the enum follows the kernel's own values (0 = off, 1 = prefer-public, 2 = prefer-temporary) - Drop redundant negating of error code passed to log_syntax() - Manpage fixes This fixes a number of issues from PR #417
2015-07-06 21:29:33 +03: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
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
<literal>kernel</literal>. When true, enables the privacy
networkd: various fixes for the IPv6 privacy extensions support - Make sure that the IPv6PrivacyExtensions=yes results in prefer-temporary, not prefer-public. - Introduce special enum value "kernel" to leave setting unset, similar how we have it for the IP forwarding settings. - Bring the enum values in sync with the the strings we parse for them, to the level this makes sense (specifically, rename "disabled" to "no", and "prefer-temporary" to "yes"). - Make sure we really set the value to to "no" by default, the way it is already documented in the man page. - Fix whitespace error. - Make sure link_ipv6_privacy_extensions() actually returns the correct enum type, rather than implicitly casting it to "bool". - properly size formatting buffer for ipv6 sysctl value - Don't complain if /proc/sys isn't writable - Document that the enum follows the kernel's own values (0 = off, 1 = prefer-public, 2 = prefer-temporary) - Drop redundant negating of error code passed to log_syntax() - Manpage fixes This fixes a number of issues from PR #417
2015-07-06 21:29:33 +03:00
extensions and prefers temporary addresses over public
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
addresses. When <literal>prefer-public</literal>, enables the
networkd: various fixes for the IPv6 privacy extensions support - Make sure that the IPv6PrivacyExtensions=yes results in prefer-temporary, not prefer-public. - Introduce special enum value "kernel" to leave setting unset, similar how we have it for the IP forwarding settings. - Bring the enum values in sync with the the strings we parse for them, to the level this makes sense (specifically, rename "disabled" to "no", and "prefer-temporary" to "yes"). - Make sure we really set the value to to "no" by default, the way it is already documented in the man page. - Fix whitespace error. - Make sure link_ipv6_privacy_extensions() actually returns the correct enum type, rather than implicitly casting it to "bool". - properly size formatting buffer for ipv6 sysctl value - Don't complain if /proc/sys isn't writable - Document that the enum follows the kernel's own values (0 = off, 1 = prefer-public, 2 = prefer-temporary) - Drop redundant negating of error code passed to log_syntax() - Manpage fixes This fixes a number of issues from PR #417
2015-07-06 21:29:33 +03:00
privacy extensions, but prefers public addresses over
temporary addresses. When false, the privacy extensions
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
remain disabled. When <literal>kernel</literal>, the kernel's
networkd: various fixes for the IPv6 privacy extensions support - Make sure that the IPv6PrivacyExtensions=yes results in prefer-temporary, not prefer-public. - Introduce special enum value "kernel" to leave setting unset, similar how we have it for the IP forwarding settings. - Bring the enum values in sync with the the strings we parse for them, to the level this makes sense (specifically, rename "disabled" to "no", and "prefer-temporary" to "yes"). - Make sure we really set the value to to "no" by default, the way it is already documented in the man page. - Fix whitespace error. - Make sure link_ipv6_privacy_extensions() actually returns the correct enum type, rather than implicitly casting it to "bool". - properly size formatting buffer for ipv6 sysctl value - Don't complain if /proc/sys isn't writable - Document that the enum follows the kernel's own values (0 = off, 1 = prefer-public, 2 = prefer-temporary) - Drop redundant negating of error code passed to log_syntax() - Manpage fixes This fixes a number of issues from PR #417
2015-07-06 21:29:33 +03:00
default setting will be left in place. Defaults to
man: add manual for ipv6 privacy extension
2015-07-05 08:55:20 +03:00
<literal>no</literal>.</para></listitem>
</varlistentry>
man: add support for accept ra man
2015-09-12 05:48:36 +03:00
<varlistentry>
networkd: rename IPv6AcceptRouterAdvertisements to IPv6AcceptRA The long name is just too hard to type. We generally should avoid using acronyms too liberally, if they aren't established enough, but it appears that "RA" is known well enough. Internally we call the option "ipv6_accept_ra" anyway, and the kernel also exposes it under this name. Hence, let's rename the IPv6AcceptRouterAdvertisements= setting and the [IPv6AcceptRouterAdvertisements] section to IPv6AcceptRA= and [IPv6AcceptRA]. The old setting IPv6AcceptRouterAdvertisements= is kept for compatibility with older configuration. (However the section [IPv6AcceptRouterAdvertisements] is not, as it was never available in a published version of systemd.
2016-06-07 12:19:26 +03:00
<term><varname>IPv6AcceptRA=</varname></term>
man: document the default value for IPv6AcceptRA= Fixes #14121.
2020-03-03 20:36:03 +03: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
tree-wide: fix spelling errors Based on a report from Fossies.org using Codespell. Followup to #15436
2020-04-21 21:46:53 +03: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 21:38:12 +03:00
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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 21:38:12 +03: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>
networkd: clarify that IPv6 RA uses our own stack, no the kernel's Fixes: #8906
2019-03-13 19:00:56 +03:00
doc: update explanation of IPv6AcceptRA=
2019-07-16 04:46:27 +03: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>
man: describe IPv6AcceptRouterAdvertisements= better With the previous description it wasn't clear that the kernel default is being described. Add link to kernel docs.
2015-09-30 21:59:43 +03:00
</listitem>
man: add support for accept ra man
2015-09-12 05:48:36 +03:00
</varlistentry>
man: add man for IPV6 DAD
2015-10-12 12:02:12 +03:00
<varlistentry>
<term><varname>IPv6DuplicateAddressDetection=</varname></term>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
<listitem><para>Configures the amount of IPv6 Duplicate
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
man: add man for IPV6 DAD
2015-10-12 12:02:12 +03:00
</para></listitem>
</varlistentry>
man: add man for IPV6 hop limit
2015-11-10 06:59:24 +03: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.
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
When unset, the kernel's default will be used.
man: add man for IPV6 hop limit
2015-11-10 06:59:24 +03:00
</para></listitem>
</varlistentry>
network: introduce IPv4AcceptLocal= setting Closes #16090.
2020-06-08 07:48:14 +03: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>
network: Add "route_localnet" sysctl support
2021-02-18 11:55:13 +03: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>
networkd: Add support to configure proxy arp support to interfaces (#3020) Fixes: #2889
2016-04-14 12:56:57 +03:00
<varlistentry>
networkd: Rename ProxyARP to IPv4ProxyARP (#4947) Rename the arp proxy option to IPv4ProxyARP= in order to clarify its relationship to IPv4, and map to the various IPv6 options we have. Fixes: #4768
2016-12-22 12:23:29 +03:00
<term><varname>IPv4ProxyARP=</varname></term>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host,
networkd: Add support to configure proxy arp support to interfaces (#3020) Fixes: #2889
2016-04-14 12:56:57 +03:00
usually a router, answers ARP requests intended for another machine. By "faking" its identity,
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
the router accepts responsibility for routing packets to the "real" destination. See <ulink
networkd: Add support to configure proxy arp support to interfaces (#3020) Fixes: #2889
2016-04-14 12:56:57 +03:00
url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>.
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
When unset, the kernel's default will be used.
networkd: Add support to configure proxy arp support to interfaces (#3020) Fixes: #2889
2016-04-14 12:56:57 +03:00
</para></listitem>
</varlistentry>
networkd: add IPv6ProxyNDPAddress support (#5174) IPv6 Neighbor discovery proxy is the IPv6 equivalent to proxy ARP for IPv4. It is required when ISPs do not unconditional route IPv6 subnets to their designated target, but expect neighbor solicitation messages for every address on a link. A variable IPv6ProxyNDPAddress= is introduced to the [Network] section, each representing a IPv6 neighbour proxy entry in the neighbour table.
2017-02-11 02:47:55 +03:00
<varlistentry>
networkd: add IPv6ProxyNDP (#5913) This allows enabling proxy_ndp even if no addresses are configured in networkd, as well as disabling proxy_ndp from a drop-in.
2017-05-09 21:04:55 +03:00
<term><varname>IPv6ProxyNDP=</varname></term>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<listitem><para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery
networkd: add IPv6ProxyNDP (#5913) This allows enabling proxy_ndp even if no addresses are configured in networkd, as well as disabling proxy_ndp from a drop-in.
2017-05-09 21:04:55 +03: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.
networkd: add IPv6ProxyNDPAddress support (#5174) IPv6 Neighbor discovery proxy is the IPv6 equivalent to proxy ARP for IPv4. It is required when ISPs do not unconditional route IPv6 subnets to their designated target, but expect neighbor solicitation messages for every address on a link. A variable IPv6ProxyNDPAddress= is introduced to the [Network] section, each representing a IPv6 neighbour proxy entry in the neighbour table.
2017-02-11 02:47:55 +03:00
In this case a router answers Neighbour Advertisement messages intended for
another machine by offering its own MAC address as destination.
networkd: add IPv6ProxyNDP (#5913) This allows enabling proxy_ndp even if no addresses are configured in networkd, as well as disabling proxy_ndp from a drop-in.
2017-05-09 21:04:55 +03:00
Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour
networkd: add IPv6ProxyNDPAddress support (#5174) IPv6 Neighbor discovery proxy is the IPv6 equivalent to proxy ARP for IPv4. It is required when ISPs do not unconditional route IPv6 subnets to their designated target, but expect neighbor solicitation messages for every address on a link. A variable IPv6ProxyNDPAddress= is introduced to the [Network] section, each representing a IPv6 neighbour proxy entry in the neighbour table.
2017-02-11 02:47:55 +03:00
Advertisement messages for addresses in the IPv6 neighbor proxy table,
networkd: add IPv6ProxyNDP (#5913) This allows enabling proxy_ndp even if no addresses are configured in networkd, as well as disabling proxy_ndp from a drop-in.
2017-05-09 21:04:55 +03: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.
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
When unset, the kernel's default will be used.
networkd: add IPv6ProxyNDP (#5913) This allows enabling proxy_ndp even if no addresses are configured in networkd, as well as disabling proxy_ndp from a drop-in.
2017-05-09 21:04:55 +03: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.
man: also use "yes"/"no" rather than "true"/"false" in man pages We usually use yes/no in all our unit files, do the same in the man pages. Triggered by: https://github.com/systemd/systemd/pull/9824#issuecomment-420729987
2018-09-25 13:40:35 +03:00
This option implies <option>IPv6ProxyNDP=yes</option> but has no effect if
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
<option>IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used.
networkd: add IPv6ProxyNDPAddress support (#5174) IPv6 Neighbor discovery proxy is the IPv6 equivalent to proxy ARP for IPv4. It is required when ISPs do not unconditional route IPv6 subnets to their designated target, but expect neighbor solicitation messages for every address on a link. A variable IPv6ProxyNDPAddress= is introduced to the [Network] section, each representing a IPv6 neighbour proxy entry in the neighbour table.
2017-02-11 02:47:55 +03:00
</para></listitem>
</varlistentry>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<varlistentry>
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
configuration options.</para></listitem>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
</varlistentry>
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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
man: DHCPv6PrefixDelegation= is disabled by dafault
2020-11-12 16:39:42 +03:00
[DHCPv6PrefixDelegation] section. Defaults to disabled.</para></listitem>
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03:00
</varlistentry>
networkd: add support to configure IPv6 MTU (#8664) This patch supports to configure IPv6 MTU. Closes #8632
2018-04-20 12:38:39 +03:00
<varlistentry>
<term><varname>IPv6MTUBytes=</varname></term>
<listitem><para>Configures IPv6 maximum transmission unit (MTU).
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used.
networkd: add support to configure IPv6 MTU (#8664) This patch supports to configure IPv6 MTU. Closes #8632
2018-04-20 12:38:39 +03:00
</para></listitem>
</varlistentry>
network: introduce KeepMaster= setting Closes #20624.
2021-09-03 00:10:07 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: merge several settings about netdev
2021-06-09 22:41:08 +03:00
<term><varname>BatmanAdvanced=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<term><varname>Bond=</varname></term>
man: merge several settings about netdev
2021-06-09 22:41:08 +03:00
<term><varname>Bridge=</varname></term>
networkd: vrf: add support for enslaving devices to VRFs
2016-06-13 02:05:49 +03:00
<term><varname>VRF=</varname></term>
<listitem>
man: merge several settings about netdev
2021-06-09 22:41:08 +03:00
<para>The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link
to. See
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
networkd: vrf: add support for enslaving devices to VRFs
2016-06-13 02:05:49 +03:00
</listitem>
</varlistentry>
Add IPVLAN= to systemd.network man page (#9480) Required and seems to work in 238.133
2018-07-02 15:31:58 +03:00
<varlistentry>
<term><varname>IPVLAN=</varname></term>
man: add missing settings Fixes #19869.
2021-06-09 22:45:54 +03:00
<term><varname>IPVTAP=</varname></term>
<term><varname>L2TP=</varname></term>
man: merge several settings about netdev
2021-06-09 22:41:08 +03:00
<term><varname>MACsec=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<term><varname>MACVLAN=</varname></term>
man: add missing settings Fixes #19869.
2021-06-09 22:45:54 +03:00
<term><varname>MACVTAP=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<term><varname>Tunnel=</varname></term>
man: merge several settings about netdev
2021-06-09 22:41:08 +03:00
<term><varname>VLAN=</varname></term>
<term><varname>VXLAN=</varname></term>
man: add missing settings Fixes #19869.
2021-06-09 22:45:54 +03:00
<term><varname>Xfrm=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<listitem>
tree-wide: "a" -> "an"
2021-06-30 15:26:47 +03:00
<para>The name of an IPVLAN, IPVTAP, L2TP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, VXLAN, or
man: add missing settings Fixes #19869.
2021-06-09 22:45:54 +03:00
Xfrm to be created on the link. See
network: Introduce MACsec Media Access Control Security (MACsec) is an 802.1AE IEEE industry-standard security technology that provides secure communication for all traffic on Ethernet links. MACsec provides point-to-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats, including denial of service, intrusion, man-in-the-middle, masquerading, passive wiretapping, and playback attacks. Closes #5754
2019-04-03 14:27:36 +03:00
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
This option may be specified more than once.</para>
</listitem>
</varlistentry>
Networkd Bond DOC: Move ActiveSlave and PrimarySlave to [Network] (#6610) Fixes #6545
2017-08-26 16:37:46 +03:00
<varlistentry>
<term><varname>ActiveSlave=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal>
Networkd Bond DOC: Move ActiveSlave and PrimarySlave to [Network] (#6610) Fixes #6545
2017-08-26 16:37:46 +03: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>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Specifies which slave is the primary device. The specified
Networkd Bond DOC: Move ActiveSlave and PrimarySlave to [Network] (#6610) Fixes #6545
2017-08-26 16:37:46 +03: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>
networkd: Allow configure a specific link even if it has no carrier. (#6740) This work allows to configure a specific link even if it has no carrier. Closes #6645.
2017-09-06 17:57:04 +03:00
<varlistentry>
<term><varname>ConfigureWithoutCarrier=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier.
network: Change IgnoreCarrierLoss default to value of ConfigureWithoutCarrier It doesn't make much sense to have ConfigureWithoutCarrier set, but not IgnoreCarrierLoss; all the configuration added during initial interface bring-up will be lost at the first carrier up/down.
2020-04-27 13:38:40 +03:00
Defaults to false. If <option>IgnoreCarrierLoss=</option> is not explicitly set, it will
default to this value.
networkd: Allow configure a specific link even if it has no carrier. (#6740) This work allows to configure a specific link even if it has no carrier. Closes #6645.
2017-09-06 17:57:04 +03:00
</para>
</listitem>
</varlistentry>
networkd: Allow to retain configs even if carrier is lost When there is bad link in the network the carrier goes up/down. This makes networkd stops all the clients and drop config. But if the remote router/dhcpserver running a prevention of DHCP Starvation attack or DHCP Flood attack it does not allow networkd to take a DHCP lease resulting failure in configuration. This patch allows to keep the client running and keep the conf also for this scenario. Closes #9111
2018-06-01 12:34:49 +03:00
<varlistentry>
<term><varname>IgnoreCarrierLoss=</varname></term>
<listitem>
network: Change IgnoreCarrierLoss default to value of ConfigureWithoutCarrier It doesn't make much sense to have ConfigureWithoutCarrier set, but not IgnoreCarrierLoss; all the configuration added during initial interface bring-up will be lost at the first carrier up/down.
2020-04-27 13:38:40 +03: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.
networkd: Allow to retain configs even if carrier is lost When there is bad link in the network the carrier goes up/down. This makes networkd stops all the clients and drop config. But if the remote router/dhcpserver running a prevention of DHCP Starvation attack or DHCP Flood attack it does not allow networkd to take a DHCP lease resulting failure in configuration. This patch allows to keep the client running and keep the conf also for this scenario. Closes #9111
2018-06-01 12:34:49 +03: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 23:09:40 +03:00
<para>When <varname>ActivationPolicy=</varname> is set to <literal>always-up</literal>, this
is forced to <literal>true</literal>.
</para>
networkd: Allow to retain configs even if carrier is lost When there is bad link in the network the carrier goes up/down. This makes networkd stops all the clients and drop config. But if the remote router/dhcpserver running a prevention of DHCP Starvation attack or DHCP Flood attack it does not allow networkd to take a DHCP lease resulting failure in configuration. This patch allows to keep the client running and keep the conf also for this scenario. Closes #9111
2018-06-01 12:34:49 +03:00
</listitem>
</varlistentry>
man: add documentation about KeepConfiguration
2019-06-03 09:37:25 +03: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
networkd: drop DHCPv4 config on stop, keep on restart, by default This partially reverts 95355a281c06c5970b7355c38b066910c3be4958. It seems that other parts of link_stop_clients() should be skipped when restarting, but I don't know enough about those other clients to have an opinion if it is better to stop&start them on restart or not. Anyway, that can be done in later patches now that the support for restarts is there. Fixes #13625.
2019-10-01 18:12:31 +03:00
<literal>dhcp</literal> and <literal>static</literal>. Defaults to <literal>no</literal>.
</para>
man: add documentation about KeepConfiguration
2019-06-03 09:37:25 +03:00
</listitem>
</varlistentry>
man: merge several settings about netdev
2021-06-09 22:41:08 +03:00
</variablelist>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>[Address] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>An [Address] section accepts the following keys. Specify several [Address]
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
sections to configure several addresses.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Address=</varname></term>
<listitem>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>As in the [Network] section. This key is mandatory. Each [Address] section can contain one
<varname>Address=</varname> setting.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Peer=</varname></term>
<listitem>
<para>The peer address in a point-to-point connection.
man: mention Address= can be specified once in [Address] section
2019-02-20 13:02:31 +03:00
Accepts the same format as the <varname>Address=</varname>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
key.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Broadcast=</varname></term>
<listitem>
network: make Broadcast= accept boolean value And disable it for wireguard interfaces by default. Closes #18492.
2021-02-19 00:01:34 +03:00
<para>Takes an IPv4 address or boolean value. The address must be in the format described in
man: fix a bunch of links All hail linkchecker!
2015-03-14 05:22:39 +03:00
<citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
network: make Broadcast= accept boolean value And disable it for wireguard interfaces by default. Closes #18492.
2021-02-19 00:01:34 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Label=</varname></term>
<listitem>
man: address label can be set only for IPv4 addresses
2021-08-16 06:57:18 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: Add support to configure IPv6 preferred lifetime (#3102) Closes #2166. We only allow 0, infinity and forever. infinity and forever is same.
2016-05-03 22:54:26 +03:00
<varlistentry>
<term><varname>PreferredLifetime=</varname></term>
<listitem>
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03: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>
networkd: Add support to configure IPv6 preferred lifetime (#3102) Closes #2166. We only allow 0, infinity and forever. infinity and forever is same.
2016-05-03 22:54:26 +03:00
</listitem>
</varlistentry>
networkd: add scope to address section (#6449) This work allows to configure address Scope to host | link | global or a number. Closes #6446
2017-08-01 10:44:08 +03:00
<varlistentry>
<term><varname>Scope=</varname></term>
<listitem>
man: clarify what network scopes are
2021-01-17 04:10:57 +03: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)
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
or an unsigned integer in the range 0…255.
networkd: add scope to address section (#6449) This work allows to configure address Scope to host | link | global or a number. Closes #6446
2017-08-01 10:44:08 +03:00
Defaults to <literal>global</literal>.</para>
</listitem>
</varlistentry>
network: add RouteMetric= setting in [Address] section
2021-04-17 20:02:29 +03: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>
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
<varlistentry>
<term><varname>HomeAddress=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Designates this address the "home address" as defined in
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03: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>
network: introduce DAD for static address Closes #2527.
2019-11-21 18:54:52 +03:00
<para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>,
<literal>both</literal>, <literal>none</literal>. When <literal>ipv4</literal>,
man: fix RFC number and its title
2021-06-16 04:32:28 +03:00
performs IPv4 Address Conflict Detection. See
<ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>.
network: introduce DAD for static address Closes #2527.
2019-11-21 18:54:52 +03: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>
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ManageTemporaryAddress=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. If true the kernel manage temporary addresses created
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
from this one as template on behalf of Privacy Extensions
network: introduce ManageTemporaryAddress= setting in [DHCPv6PrefixDelegation] section The setting is enabled by default, as NDisc also enabled the flag by default. Closes #18208.
2021-01-13 00:34:32 +03:00
<ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
active, the use_tempaddr sysctl setting has to be set to a value greater than zero.
Fix several typos in documentation Found by lintian
2019-12-24 15:50:04 +03:00
The given address needs to have a prefix length of 64. This flag allows using privacy
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
extensions in a manually configured network, just like if stateless auto-configuration
network: introduce ManageTemporaryAddress= setting in [DHCPv6PrefixDelegation] section The setting is enabled by default, as NDisc also enabled the flag by default. Closes #18208.
2021-01-13 00:34:32 +03:00
was active. Defaults to false.</para>
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
</listitem>
</varlistentry>
<varlistentry>
network: introduce AddPrefixRoute= and deprecate PrefixRoute= PrefixRoute= was added by e63be0847c39bfdca45c25c505922814374581a7, but unfortunately, the meaning of PrefixRoute= is inverted; when true IFA_F_NOPREFIXROUTE flag is added. This introduces AddPrefixRoute= setting.
2019-12-07 18:32:36 +03:00
<term><varname>AddPrefixRoute=</varname></term>
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
<listitem>
network: introduce AddPrefixRoute= and deprecate PrefixRoute= PrefixRoute= was added by e63be0847c39bfdca45c25c505922814374581a7, but unfortunately, the meaning of PrefixRoute= is inverted; when true IFA_F_NOPREFIXROUTE flag is added. This introduces AddPrefixRoute= setting.
2019-12-07 18:32:36 +03:00
<para>Takes a boolean. When true, the prefix route for the address is automatically added.
Defaults to true.</para>
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>AutoJoin=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Joining multicast group on ethernet level via
networkd: address add support to configure flags (#4201) This patch enables to configure IFA_F_HOMEADDRESS IFA_F_NODAD IFA_F_MANAGETEMPADDR IFA_F_NOPREFIXROUTE IFA_F_MCAUTOJOIN
2016-10-08 14:05:41 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</variablelist>
</refsect1>
networkd: Static neighbor support When using networkd we currently have no way of ensuring that static neighbor entries are set when our link comes up. This change adds a new section to the network definition that allows multiple static neighbors to be set on a link.
2018-11-29 06:00:58 +03:00
<refsect1>
<title>[Neighbor] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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>
networkd: Static neighbor support When using networkd we currently have no way of ensuring that static neighbor entries are set when our link comes up. This change adds a new section to the network definition that allows multiple static neighbors to be set on a link.
2018-11-29 06:00:58 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Address=</varname></term>
<listitem>
<para>The IP address of the neighbor.</para>
</listitem>
</varlistentry>
<varlistentry>
network: rename Neighbor.MACAddress= to Neighbor.LinkLayerAddress= And make it support IPv4 address. Closes #13015.
2019-07-10 20:23:41 +03:00
<term><varname>LinkLayerAddress=</varname></term>
networkd: Static neighbor support When using networkd we currently have no way of ensuring that static neighbor entries are set when our link comes up. This change adds a new section to the network definition that allows multiple static neighbors to be set on a link.
2018-11-29 06:00:58 +03:00
<listitem>
network: rename Neighbor.MACAddress= to Neighbor.LinkLayerAddress= And make it support IPv4 address. Closes #13015.
2019-07-10 20:23:41 +03:00
<para>The link layer address (MAC address or IP address) of the neighbor.</para>
networkd: Static neighbor support When using networkd we currently have no way of ensuring that static neighbor entries are set when our link comes up. This change adds a new section to the network definition that allows multiple static neighbors to be set on a link.
2018-11-29 06:00:58 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
networkd: add support for address label IPv6 address labels are used for address selection; they are described in RFC 3484. Precedence is managed by userspace, and only the label itself is stored in the kernel. enp0s25.network [Match] Name=enp0s25 [Network] DHCP=yes Address = 2001:db8:f00:baa::b [AddressLabel] Label=199 Prefix=2001:db8:41::/64 [AddressLabel] Label=11 Prefix=2001:db8:31::/64 [AddressLabel] Label=123 Prefix=2001:db8:21::/64 [AddressLabel] Label=124 Prefix=2001:db8:11::/64 [sus@maximus label]$ ip addrlabel list prefix ::1/128 label 0 prefix ::/96 label 3 prefix ::ffff:0.0.0.0/96 label 4 prefix 2001:db8:41::/64 dev enp0s25 label 199 prefix 2001:db8:31::/64 dev enp0s25 label 11 prefix 2001:db8:21::/64 dev enp0s25 label 123 prefix 2001:db8:11::/64 dev enp0s25 label 124 prefix 2001::/32 label 6 prefix 2001:10::/28 label 7 prefix 3ffe::/16 label 12 prefix 2002::/16 label 2 prefix fec0::/10 label 11 prefix fc00::/7 label 5 prefix ::/0 label 1
2017-04-25 13:36:50 +03:00
<refsect1>
<title>[IPv6AddressLabel] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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,
man: add missing period
2020-11-09 23:25:29 +03:00
and only the label itself is stored in the kernel.</para>
networkd: add support for address label IPv6 address labels are used for address selection; they are described in RFC 3484. Precedence is managed by userspace, and only the label itself is stored in the kernel. enp0s25.network [Match] Name=enp0s25 [Network] DHCP=yes Address = 2001:db8:f00:baa::b [AddressLabel] Label=199 Prefix=2001:db8:41::/64 [AddressLabel] Label=11 Prefix=2001:db8:31::/64 [AddressLabel] Label=123 Prefix=2001:db8:21::/64 [AddressLabel] Label=124 Prefix=2001:db8:11::/64 [sus@maximus label]$ ip addrlabel list prefix ::1/128 label 0 prefix ::/96 label 3 prefix ::ffff:0.0.0.0/96 label 4 prefix 2001:db8:41::/64 dev enp0s25 label 199 prefix 2001:db8:31::/64 dev enp0s25 label 11 prefix 2001:db8:21::/64 dev enp0s25 label 123 prefix 2001:db8:11::/64 dev enp0s25 label 124 prefix 2001::/32 label 6 prefix 2001:10::/28 label 7 prefix 3ffe::/16 label 12 prefix 2002::/16 label 2 prefix fec0::/10 label 11 prefix fc00::/7 label 5 prefix ::/0 label 1
2017-04-25 13:36:50 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Label=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>The label for the prefix, an unsigned integer in the range 0–4294967294.
0xffffffff is reserved. This setting is mandatory.</para>
networkd: add support for address label IPv6 address labels are used for address selection; they are described in RFC 3484. Precedence is managed by userspace, and only the label itself is stored in the kernel. enp0s25.network [Match] Name=enp0s25 [Network] DHCP=yes Address = 2001:db8:f00:baa::b [AddressLabel] Label=199 Prefix=2001:db8:41::/64 [AddressLabel] Label=11 Prefix=2001:db8:31::/64 [AddressLabel] Label=123 Prefix=2001:db8:21::/64 [AddressLabel] Label=124 Prefix=2001:db8:11::/64 [sus@maximus label]$ ip addrlabel list prefix ::1/128 label 0 prefix ::/96 label 3 prefix ::ffff:0.0.0.0/96 label 4 prefix 2001:db8:41::/64 dev enp0s25 label 199 prefix 2001:db8:31::/64 dev enp0s25 label 11 prefix 2001:db8:21::/64 dev enp0s25 label 123 prefix 2001:db8:11::/64 dev enp0s25 label 124 prefix 2001::/32 label 6 prefix 2001:10::/28 label 7 prefix 3ffe::/16 label 12 prefix 2002::/16 label 2 prefix fec0::/10 label 11 prefix fc00::/7 label 5 prefix ::/0 label 1
2017-04-25 13:36:50 +03: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>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
<refsect1>
<title>[RoutingPolicyRule] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule]
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
sections to configure several rules.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>TypeOfService=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>Takes a number between 0 and 255 that specifies the type of service to match.</para>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03: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>
man: mention that FirewallMark= optionally takes firewall mask Closes #17587.
2020-11-13 09:05:31 +03: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>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Table=</varname></term>
<listitem>
network: add support to RoutingPolicyRule lookup table name
2021-01-19 14:58:53 +03: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>,
network: use string table to parse route table or scope
2019-07-08 14:19:28 +03:00
or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Priority=</varname></term>
<listitem>
<para>Specifies the priority of this rule. <varname>Priority=</varname> is an unsigned
network: do not assume the highest priority when Priority= is unspecified Previously, when Priority= is unspecified, networkd configured the rule with the highest (=0) priority. This commit makes networkd distinguish the case the setting is unspecified and one explicitly specified as Priority=0. Note. 1) If the priority is unspecified on configure, then kernel dynamically picks a priority for the rule. 2) The new behavior is consistent with 'ip rule' command. Replaces #15606.
2021-08-17 08:03:19 +03: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>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
</listitem>
</varlistentry>
networkd: support incoming/outgoing device for rule matching (#7223) Closes #7210
2017-11-21 13:51:50 +03: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>
networkd: add support to configure ip rule port range and protocol. Please see: iprule: support for ip_proto, sport and dport match options https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=f686f764682745daf6a93b0a6330ba42a961f858 Closes 10622
2018-11-27 08:28:54 +03: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>
network: rename Protocol= in [RoutingPolicyRule] to IPProtocol=
2018-11-29 18:42:39 +03:00
<term><varname>IPProtocol=</varname></term>
networkd: add support to configure ip rule port range and protocol. Please see: iprule: support for ip_proto, sport and dport match options https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=f686f764682745daf6a93b0a6330ba42a961f858 Closes 10622
2018-11-27 08:28:54 +03:00
<listitem>
network: make IPProtocol= also accept IP protocol number
2018-11-29 18:43:40 +03: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>.
networkd: add support to configure ip rule port range and protocol. Please see: iprule: support for ip_proto, sport and dport match options https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=f686f764682745daf6a93b0a6330ba42a961f858 Closes 10622
2018-11-27 08:28:54 +03:00
Defaults to unset.</para>
</listitem>
</varlistentry>
networkd: RPDB rule - add support to configure inverted rule. Closes #10706
2018-12-03 15:55:30 +03:00
<varlistentry>
<term><varname>InvertRule=</varname></term>
<listitem>
network: add SuppressPrefixLength option to RoutingPolicyRule (#14736) Closes #14724.
2020-02-03 02:25:48 +03:00
<para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
networkd: RPDB rule - add support to configure inverted rule. Closes #10706
2018-12-03 15:55:30 +03:00
</listitem>
</varlistentry>
network: add RoutingPolicyRule.Family= setting Closes #13233.
2019-08-01 01:41:36 +03: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>
network: support UID based routing policy Closes #14666.
2020-01-26 16:22:38 +03: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>
network: add SuppressPrefixLength option to RoutingPolicyRule (#14736) Closes #14724.
2020-02-03 02:25:48 +03:00
<varlistentry>
<term><varname>SuppressPrefixLength=</varname></term>
<listitem>
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
<para>Takes a number <replaceable>N</replaceable> in the range 0…128 and rejects routing
network: add SuppressPrefixLength option to RoutingPolicyRule (#14736) Closes #14724.
2020-02-03 02:25:48 +03:00
decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
unset.</para>
</listitem>
</varlistentry>
network: Allow to configure unreachable/blackhole RoutingPolicyRule (#17984)
2020-12-18 06:21:15 +03: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>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
</variablelist>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
</refsect1>
<refsect1>
<title>[NextHop] Section Options</title>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
<variablelist class='network-directives'>
man: update explanations of settings in [NextHop] section
2021-02-09 09:42:51 +03: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>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
<varlistentry>
<term><varname>Gateway=</varname></term>
<listitem>
man: update explanations of settings in [NextHop] section
2021-02-09 09:42:51 +03:00
<para>As in the [Network] section.</para>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
</listitem>
</varlistentry>
<varlistentry>
man: update explanations of settings in [NextHop] section
2021-02-09 09:42:51 +03:00
<term><varname>Family=</varname></term>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
<listitem>
man: update explanations of settings in [NextHop] section
2021-02-09 09:42:51 +03: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>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
</listitem>
</varlistentry>
network: nexthop: add OnLink= setting
2021-02-14 08:49:35 +03: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>
network: nexthop: add Blackhole= setting in [NextHop] section As similar to unreachable type routes, blackhole nexthops do not have NHA_OID attribute, so they are managed by Manager.
2021-02-14 20:56:24 +03: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>
network: nexthop: add Group= setting to configure multipath route with group nexthop
2021-05-14 04:15:23 +03: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>
network: introduce ip nexthop routing Used to manipulate entries in the kernel's nexthop tables. Example: ``` [NextHop] Id=3 Gateway=192.168.5.1 ```
2019-10-04 22:40:51 +03:00
</variablelist>
networkd: add support to configure IP Rule (#5725) Routing Policy rule manipulates rules in the routing policy database control the route selection algorithm. This work supports to configure Rule ``` [RoutingPolicyRule] TypeOfService=0x08 Table=7 From= 192.168.100.18 ``` ``` ip rule show 0: from all lookup local 0: from 192.168.100.18 tos 0x08 lookup 7 ``` V2 changes: 1. Added logic to handle duplicate rules. 2. If rules are changed or deleted and networkd restarted then those are deleted when networkd restarts next time V3: 1. Add parse_fwmark_fwmask
2017-09-14 22:51:39 +03:00
</refsect1>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<refsect1>
<title>[Route] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [Route] section accepts the following keys. Specify several [Route] sections to configure
several routes.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Gateway=</varname></term>
<listitem>
network: introduce Gateway=_dhcp4 and _dhcp6, and deprecate "_dhcp" Fixes #17249.
2020-10-07 14:34:00 +03:00
<para>Takes the gateway address or the special values <literal>_dhcp4</literal> and
network: rename Gateway=_dhcp6 -> Gateway=_ipv6ra
2020-10-12 08:52:11 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
man: fix indentation
2021-02-14 08:49:46 +03: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
network: nexthop: add OnLink= setting
2021-02-14 08:49:35 +03: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>
man: fix indentation
2021-02-14 08:49:46 +03:00
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>Destination=</varname></term>
<listitem>
<para>The destination prefix of the route. Possibly
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
followed by a slash and the prefix length. If omitted, a
Reindent man pages to 2ch
2015-02-04 05:14:13 +03: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
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
a slash and the prefix length. If omitted, a full-length
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
host route is assumed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Metric=</varname></term>
<listitem>
man: update explanation about route metric
2021-04-17 20:37:13 +03:00
<para>The metric of the route. Takes an unsigned integer in the range 0…4294967295.
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03:00
Defaults to unset, and the kernel's default will be used.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: make IPv6 route preference configurable (#5700) The work supports route preference configurable. i.e. able to set low, medium and high.
2017-04-25 10:32:59 +03:00
<varlistentry>
<term><varname>IPv6Preference=</varname></term>
<listitem>
<para>Specifies the route preference as defined in <ulink
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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>
networkd: make IPv6 route preference configurable (#5700) The work supports route preference configurable. i.e. able to set low, medium and high.
2017-04-25 10:32:59 +03:00
</listitem>
</varlistentry>
networkd: support route scopes For now we only support the hardcoded values RT_SCOPE_{UNIVERSE,LOCAL,HOST}, and not numerical values or values from /etc/iproute2/rt_scopes. This addresses https://bugs.freedesktop.org/show_bug.cgi?id=88508.
2015-02-09 18:22:34 +03:00
<varlistentry>
<term><varname>Scope=</varname></term>
<listitem>
man: clarify what network scopes are
2021-01-17 04:10:57 +03: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
network: also assume Table=local for ipv6 route if Type=local, broadcast, anycast or nat (#14148) Also, if Type=multicast and scope is not set, then assume Scope=link. Fixes #14122.
2019-11-26 06:41:54 +03:00
<literal>broadcast</literal>, <literal>multicast</literal>, or <literal>anycast</literal>.
man: clarify what network scopes are
2021-01-17 04:10:57 +03:00
In other cases, defaults to <literal>global</literal>. The value is
not used for IPv6.</para>
networkd: support route scopes For now we only support the hardcoded values RT_SCOPE_{UNIVERSE,LOCAL,HOST}, and not numerical values or values from /etc/iproute2/rt_scopes. This addresses https://bugs.freedesktop.org/show_bug.cgi?id=88508.
2015-02-09 18:22:34 +03:00
</listitem>
networkd: add support to configure preferred source of static routes
2015-09-23 18:26:36 +03: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>
networkd: support route scopes For now we only support the hardcoded values RT_SCOPE_{UNIVERSE,LOCAL,HOST}, and not numerical values or values from /etc/iproute2/rt_scopes. This addresses https://bugs.freedesktop.org/show_bug.cgi?id=88508.
2015-02-09 18:22:34 +03:00
</varlistentry>
networkd: add support to set route table networkd: add support to set route table 1. add support to configure the table id. if id is less than 256 we can fit this in the header of route as netlink property is a char. But in kernel this proepty is a unsigned 32. Hence if greater that 256 add this as RTA_TABLE attribute. 2. we are not setting the address family now. Now set this property.
2016-05-03 20:48:21 +03:00
<varlistentry>
network: also assume Table=local for ipv6 route if Type=local, broadcast, anycast or nat (#14148) Also, if Type=multicast and scope is not set, then assume Scope=link. Fixes #14122.
2019-11-26 06:41:54 +03:00
<term><varname>Table=</varname></term>
networkd: add support to set route table networkd: add support to set route table 1. add support to configure the table id. if id is less than 256 we can fit this in the header of route as netlink property is a char. But in kernel this proepty is a unsigned 32. Hence if greater that 256 add this as RTA_TABLE attribute. 2. we are not setting the address family now. Now set this property.
2016-05-03 20:48:21 +03:00
<listitem>
network: add support to RoutingPolicyRule lookup table name
2021-01-19 14:58:53 +03: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.
network: also assume Table=local for ipv6 route if Type=local, broadcast, anycast or nat (#14148) Also, if Type=multicast and scope is not set, then assume Scope=link. Fixes #14122.
2019-11-26 06:41:54 +03:00
In other cases, defaults to <literal>main</literal>.
networkd: add support to set route table networkd: add support to set route table 1. add support to configure the table id. if id is less than 256 we can fit this in the header of route as netlink property is a char. But in kernel this proepty is a unsigned 32. Hence if greater that 256 add this as RTA_TABLE attribute. 2. we are not setting the address family now. Now set this property.
2016-05-03 20:48:21 +03:00
</para>
</listitem>
</varlistentry>
networkd: add support to configure route protocol. (#5890) Closes: #5889
2017-05-09 21:01:25 +03:00
<varlistentry>
<term><varname>Protocol=</varname></term>
<listitem>
man: fix spurious uppercasing
2018-10-16 18:19:23 +03:00
<para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values
network: show known route protocol name nicely in debugging logs
2019-07-14 03:51:54 +03:00
<literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>,
<literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>.
networkd: add support to configure route protocol. (#5890) Closes: #5889
2017-05-09 21:01:25 +03:00
</para>
</listitem>
</varlistentry>
networkd: route - support unicast,blackhole,unreachable and prohibited (#6861) Resolves issues #797 and #967. Conf ``` [Route] Type=blackhole Destination=202.54.1.2 ``` ip route ``` blackhole 202.54.1.2 proto static
2017-09-19 17:28:26 +03:00
<varlistentry>
<term><varname>Type=</varname></term>
<listitem>
network: make Route.Type= support local, broadcast, anycast, multicast, nat, and xresolve Closes #12975.
2019-07-07 03:40:17 +03: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
man: an attempt to reword the [Route] Type= man page A follow-up for #10388.
2018-10-16 18:18:30 +03: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>.
networkd: route - support unicast,blackhole,unreachable and prohibited (#6861) Resolves issues #797 and #967. Conf ``` [Route] Type=blackhole Destination=202.54.1.2 ``` ip route ``` blackhole 202.54.1.2 proto static
2017-09-19 17:28:26 +03:00
</para>
</listitem>
</varlistentry>
networkd: allow to configure default/initial send/recv congestion window and store persistentl (#7750) Currently we can only change initcwnd/initrwnd in the following way, and it does not store persistently: sudo ip route change default via 192.168.1.1 dev tun0 initcwnd 20 sudo ip route change default via 192.168.1.1 dev tun0 initrwnd 20 For more details about initcwnd/initrwnd, please look at: http://hjzhao.blogspot.com/2012/05/increase-initcwnd-for-performance.html http://www.cdnplanet.com/blog/tune-tcp-initcwnd-for-optimum-performance or google 'initcwnd initrwnd' This work allows to configure the initcwnd and initrwnd. Closes #2118
2017-12-29 17:18:05 +03:00
<varlistentry>
<term><varname>InitialCongestionWindow=</varname></term>
<listitem>
man: update InitialCongestionWindow= and InitialAdvertisedReceiveWindow= Fixes #16643.
2020-09-17 11:01:36 +03: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>
networkd: allow to configure default/initial send/recv congestion window and store persistentl (#7750) Currently we can only change initcwnd/initrwnd in the following way, and it does not store persistently: sudo ip route change default via 192.168.1.1 dev tun0 initcwnd 20 sudo ip route change default via 192.168.1.1 dev tun0 initrwnd 20 For more details about initcwnd/initrwnd, please look at: http://hjzhao.blogspot.com/2012/05/increase-initcwnd-for-performance.html http://www.cdnplanet.com/blog/tune-tcp-initcwnd-for-optimum-performance or google 'initcwnd initrwnd' This work allows to configure the initcwnd and initrwnd. Closes #2118
2017-12-29 17:18:05 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>InitialAdvertisedReceiveWindow=</varname></term>
<listitem>
man: update InitialCongestionWindow= and InitialAdvertisedReceiveWindow= Fixes #16643.
2020-09-17 11:01:36 +03: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>
networkd: allow to configure default/initial send/recv congestion window and store persistentl (#7750) Currently we can only change initcwnd/initrwnd in the following way, and it does not store persistently: sudo ip route change default via 192.168.1.1 dev tun0 initcwnd 20 sudo ip route change default via 192.168.1.1 dev tun0 initrwnd 20 For more details about initcwnd/initrwnd, please look at: http://hjzhao.blogspot.com/2012/05/increase-initcwnd-for-performance.html http://www.cdnplanet.com/blog/tune-tcp-initcwnd-for-optimum-performance or google 'initcwnd initrwnd' This work allows to configure the initcwnd and initrwnd. Closes #2118
2017-12-29 17:18:05 +03:00
</listitem>
</varlistentry>
networkd: add quickack option to route (#7896) This patch adds quickack option to enable/disable TCP quick ack mode for per-route.
2018-01-20 02:49:15 +03:00
<varlistentry>
<term><varname>QuickAck=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
networkd: add quickack option to route (#7896) This patch adds quickack option to enable/disable TCP quick ack mode for per-route.
2018-01-20 02:49:15 +03:00
</para>
</listitem>
</varlistentry>
networkd: route add support to configure fastopen_no_cookie This patch adds fastopen_no_cookie option to enable/disable TCP fastopen without a cookie on a per-route basis.
2019-05-13 14:15:33 +03: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>
networkd: add quickack option to route (#7896) This patch adds quickack option to enable/disable TCP quick ack mode for per-route.
2018-01-20 02:49:15 +03:00
</varlistentry>
networkd: route add MPLS TTL propagate
2019-05-16 12:49:08 +03: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>
networkd: Support the ability to set MTU in [Route] sections Add support to set the route MTU. Closes #9047
2018-05-21 14:33:36 +03: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>
dhcp4: make IPServiceType configurable IPServiceType set to CS6 (network control) causes problems on some old network setups that continue to interpret the field as IP TOS. Make DHCP work on such networks by allowing this field to be set to CS4 (Realtime) instead, as this maps to IPTOS_LOWDELAY. Signed-off-by: Siddharth Chandrasekaran <csiddharth@vmware.com>
2019-09-23 14:25:21 +03:00
</varlistentry>
<varlistentry>
<term><varname>IPServiceType=</varname></term>
<listitem>
man: use literal tag at one more place
2019-11-28 21:26:57 +03: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>
dhcp4: make IPServiceType configurable IPServiceType set to CS6 (network control) causes problems on some old network setups that continue to interpret the field as IP TOS. Make DHCP work on such networks by allowing this field to be set to CS4 (Realtime) instead, as this maps to IPTOS_LOWDELAY. Signed-off-by: Siddharth Chandrasekaran <csiddharth@vmware.com>
2019-09-23 14:25:21 +03:00
</listitem>
</varlistentry>
network: route - add support to configure tcp advmss
2021-01-07 18:17:17 +03: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
supported and are understood to the base of 1024. An unsigned integer in the range 1–4294967294.
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
network: introduce multipath route Closes #12541.
2019-11-28 18:36:02 +03: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>
network: add NextHop= setting in [Route] section
2021-02-09 12:52:57 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</variablelist>
</refsect1>
<refsect1>
network: rename [DHCP] section to [DHCPv4] To keep the backward compatibility broken by the previous commit.
2019-07-10 11:33:05 +03:00
<title>[DHCPv4] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
<varname>DHCP=</varname> setting described above:</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<variablelist class='network-directives'>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<!-- DHCP packet contents -->
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendHostname=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<listitem>
man: reword descriptions of two DHCPv4 options
2021-05-14 10:04:30 +03:00
<para>When true (the default), the machine's hostname (or the value specified with
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03: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>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
</listitem>
</varlistentry>
man: explain UseDomains a bit more https://bugs.freedesktop.org/show_bug.cgi?id=85397
2015-05-19 05:34:07 +03:00
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
network: add DHCPv4.RoutesToDNS= setting
2019-07-16 20:47:20 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>MUDURL=</varname></term>
network: add DHCPv4.RoutesToDNS= setting
2019-07-16 20:47:20 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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 8520</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>
network: add DHCPv4.RoutesToDNS= setting
2019-07-16 20:47:20 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
network: add UseNTP DHCP option Despite having the internal logic in place to enable/disable using NTP servers provided by DHCP the network config didn't expose the option.
2015-03-13 22:01:29 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>ClientIdentifier=</varname></term>
network: add UseNTP DHCP option Despite having the internal logic in place to enable/disable using NTP servers provided by DHCP the network config didn't expose the option.
2015-03-13 22:01:29 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: add UseNTP DHCP option Despite having the internal logic in place to enable/disable using NTP servers provided by DHCP the network config didn't expose the option.
2015-03-13 22:01:29 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
network: dhcp4: introduce RoutesToNTP= boolean setting
2021-04-20 20:23:00 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>VendorClassIdentifier=</varname></term>
network: dhcp4: introduce RoutesToNTP= boolean setting
2021-04-20 20:23:00 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>The vendor class identifier used to identify vendor
type and configuration.</para>
network: dhcp4: introduce RoutesToNTP= boolean setting
2021-04-20 20:23:00 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
network: DHCP server Add support to transmit SIP server 1. DHCP server trasmit 2. Client parses and saves in leases Implements http://www.rfc-editor.org/rfc/rfc3361.txt ``` Frame 134: 348 bytes on wire (2784 bits), 348 bytes captured (2784 bits) on interface 0 Ethernet II, Src: 42:65:85:d6:4e:32 (42:65:85:d6:4e:32), Dst: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x7cc87cb4 Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.1.1 Option: (120) SIP Servers <=====here Length: 9 SIP Server Encoding: IPv4 Address (1) SIP Server Address: 192.168.1.1 SIP Server Address: 192.168.5.2 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ``` ``` cat /run/systemd/netif/state  ✔  ⚡  3148  16:40:51 OPER_STATE=routable CARRIER_STATE=carrier ADDRESS_STATE=routable DNS=192.168.94.2 192.168.5.1 NTP=192.168.5.1 SIP=192.168.1.1 192.168.5.2 ``` aa
2019-09-18 16:22:47 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UserClass=</varname></term>
network: DHCP server Add support to transmit SIP server 1. DHCP server trasmit 2. Client parses and saves in leases Implements http://www.rfc-editor.org/rfc/rfc3361.txt ``` Frame 134: 348 bytes on wire (2784 bits), 348 bytes captured (2784 bits) on interface 0 Ethernet II, Src: 42:65:85:d6:4e:32 (42:65:85:d6:4e:32), Dst: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x7cc87cb4 Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.1.1 Option: (120) SIP Servers <=====here Length: 9 SIP Server Encoding: IPv4 Address (1) SIP Server Address: 192.168.1.1 SIP Server Address: 192.168.5.2 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ``` ``` cat /run/systemd/netif/state  ✔  ⚡  3148  16:40:51 OPER_STATE=routable CARRIER_STATE=carrier ADDRESS_STATE=routable DNS=192.168.94.2 192.168.5.1 NTP=192.168.5.1 SIP=192.168.1.1 192.168.5.2 ``` aa
2019-09-18 16:22:47 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: DHCP server Add support to transmit SIP server 1. DHCP server trasmit 2. Client parses and saves in leases Implements http://www.rfc-editor.org/rfc/rfc3361.txt ``` Frame 134: 348 bytes on wire (2784 bits), 348 bytes captured (2784 bits) on interface 0 Ethernet II, Src: 42:65:85:d6:4e:32 (42:65:85:d6:4e:32), Dst: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x7cc87cb4 Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.1.1 Option: (120) SIP Servers <=====here Length: 9 SIP Server Encoding: IPv4 Address (1) SIP Server Address: 192.168.1.1 SIP Server Address: 192.168.5.2 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ``` ``` cat /run/systemd/netif/state  ✔  ⚡  3148  16:40:51 OPER_STATE=routable CARRIER_STATE=carrier ADDRESS_STATE=routable DNS=192.168.94.2 192.168.5.1 NTP=192.168.5.1 SIP=192.168.1.1 192.168.5.2 ``` aa
2019-09-18 16:22:47 +03:00
</listitem>
</varlistentry>
DHCP: Add support to emit and retrieve POP3 server
2020-03-27 23:12:07 +03:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned
integer.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
networkd: RFC7844, add configuration variable to enable Anonymity Profiles and document it.
2017-07-30 02:10:40 +03:00
<varlistentry>
<term><varname>Anonymize=</varname></term>
<listitem>
man: update explanation for Anonymize=
2021-04-14 08:13:26 +03: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
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
set to <option>random</option> (see
man: Don't link to a manpage that's within our documentation For example on systemd.network this results in the link taking one to another site with the manpage instead of the document that's on the same site.
2021-06-28 12:44:22 +03:00
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
man: update explanation for Anonymize=
2021-04-14 08:13:26 +03: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>
networkd: RFC7844, add configuration variable to enable Anonymity Profiles and document it.
2017-07-30 02:10:40 +03:00
man: update explanation for Anonymize=
2021-04-14 08:13:26 +03: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>
networkd: RFC7844, add configuration variable to enable Anonymity Profiles and document it.
2017-07-30 02:10:40 +03:00
</listitem>
</varlistentry>
network: DHCPv4 - introduce The Manufacturer Usage Description (MUD)
2020-03-30 17:43:28 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>RequestOptions=</varname></term>
network: DHCPv4 - introduce The Manufacturer Usage Description (MUD)
2020-03-30 17:43:28 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: DHCPv4 - introduce The Manufacturer Usage Description (MUD)
2020-03-30 17:43:28 +03:00
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendOption=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
man: add manual for DHCP override hostname
2015-07-11 06:56:55 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendVendorOption=</varname></term>
man: mention that Hostname= for DHCP must be a valid DNS domain name
2018-08-02 10:32:42 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
man: mention that Hostname= for DHCP must be a valid DNS domain name
2018-08-02 10:32:42 +03:00
</listitem>
</varlistentry>
networkd: optinally use DHCP lease domain info for routing only This changes the UseDomains= setting of .network files to take an optional third value "route", in addition to the boolean values. If set, the passed domain information is used for routing rules only, but not for the search path logic.
2016-01-26 00:27:01 +03:00
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<!-- How to use the DHCP lease -->
networkd: optinally use DHCP lease domain info for routing only This changes the UseDomains= setting of .network files to take an optional third value "route", in addition to the boolean values. If set, the passed domain information is used for routing rules only, but not for the search path logic.
2016-01-26 00:27:01 +03:00
network: add address label on dhcpv4 Fixes: #13967
2021-08-14 23:50:14 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseDNS=</varname></term>
network: add a flag to ignore gateway provided by DHCP server Closes #15117.
2020-03-16 12:55:10 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: add a flag to ignore gateway provided by DHCP server Closes #15117.
2020-03-16 12:55:10 +03:00
</listitem>
</varlistentry>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
networkd: Make DHCP client ID creation configurable
2015-03-03 21:49:48 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>RoutesToDNS=</varname></term>
networkd: Make DHCP client ID creation configurable
2015-03-03 21:49:48 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
networkd: Make DHCP client ID creation configurable
2015-03-03 21:49:48 +03:00
</listitem>
</varlistentry>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseNTP=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>When true (the default), the NTP servers received from the DHCP server will be used by
<filename>systemd-timesyncd.service</filename>.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: clean up DUID code a bit Let's move DUID configuration into the [DHCP] section, since it only makes sense in a DHCP context, and should be close to the configuration of ClientIdentifier= and suchlike. This really shouldn't be a section of its own, we don't have any for any of our other per-protocol specific identifiers... Follow-up for #2890 #2943
2016-04-26 17:19:28 +03:00
networkd: add support to send DHCP user class option (#7499) This patch add support to enables to send User Class option code 77 RFC 3004. This option MAY carry multiple User Classes. The format of this option is as follows: Code Len Value +-----+-----+--------------------- . . . --+ | 77 | N | User Class Data ('Len' octets) | +-----+-----+--------------------- . . . --+ where Value consists of one or more instances of User Class Data. Each instance of User Class Data is formatted as follows: UC_Len_i User_Class_Data_i +--------+------------------------ . . . --+ | L_i | Opaque-Data ('UC_Len_i' octets) | +--------+------------------------ . . . --+ UserClass= 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 an 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. UserClass= hello world how are you Closes: RFC: #5134
2018-05-07 15:21:02 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>RoutesToNTP=</varname></term>
networkd: add support to send DHCP user class option (#7499) This patch add support to enables to send User Class option code 77 RFC 3004. This option MAY carry multiple User Classes. The format of this option is as follows: Code Len Value +-----+-----+--------------------- . . . --+ | 77 | N | User Class Data ('Len' octets) | +-----+-----+--------------------- . . . --+ where Value consists of one or more instances of User Class Data. Each instance of User Class Data is formatted as follows: UC_Len_i User_Class_Data_i +--------+------------------------ . . . --+ | L_i | Opaque-Data ('UC_Len_i' octets) | +--------+------------------------ . . . --+ UserClass= 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 an 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. UserClass= hello world how are you Closes: RFC: #5134
2018-05-07 15:21:02 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
networkd: add support to send DHCP user class option (#7499) This patch add support to enables to send User Class option code 77 RFC 3004. This option MAY carry multiple User Classes. The format of this option is as follows: Code Len Value +-----+-----+--------------------- . . . --+ | 77 | N | User Class Data ('Len' octets) | +-----+-----+--------------------- . . . --+ where Value consists of one or more instances of User Class Data. Each instance of User Class Data is formatted as follows: UC_Len_i User_Class_Data_i +--------+------------------------ . . . --+ | L_i | Opaque-Data ('UC_Len_i' octets) | +--------+------------------------ . . . --+ UserClass= 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 an 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. UserClass= hello world how are you Closes: RFC: #5134
2018-05-07 15:21:02 +03:00
</listitem>
</varlistentry>
networkd: Allow DHCP4 client to set the number to attempt to reconfigure. Otherwise current value is 6 and after 6 it will give up.
2019-05-04 14:40:54 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseSIP=</varname></term>
networkd: Allow DHCP4 client to set the number to attempt to reconfigure. Otherwise current value is 6 and after 6 it will give up.
2019-05-04 14:40:54 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>When true (the default), the SIP servers received from the DHCP server will be collected
and made available to client programs.</para>
networkd: Allow DHCP4 client to set the number to attempt to reconfigure. Otherwise current value is 6 and after 6 it will give up.
2019-05-04 14:40:54 +03:00
</listitem>
</varlistentry>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseMTU=</varname></term>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
</listitem>
</varlistentry>
networkd: clean up DUID code a bit Let's move DUID configuration into the [DHCP] section, since it only makes sense in a DHCP context, and should be close to the configuration of ClientIdentifier= and suchlike. This really shouldn't be a section of its own, we don't have any for any of our other per-protocol specific identifiers... Follow-up for #2890 #2943
2016-04-26 17:19:28 +03:00
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseHostname=</varname></term>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>When true (the default), the hostname received from the DHCP server will be set as the
transient hostname of the system.</para>
networkd: clean up DUID code a bit Let's move DUID configuration into the [DHCP] section, since it only makes sense in a DHCP context, and should be close to the configuration of ClientIdentifier= and suchlike. This really shouldn't be a section of its own, we don't have any for any of our other per-protocol specific identifiers... Follow-up for #2890 #2943
2016-04-26 17:19:28 +03:00
</listitem>
</varlistentry>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
networkd: move the IAID configuration option into the [DHCP] section It's only relevant to DHCP, and it should be where the DUID is configured too.
2016-05-06 18:04:05 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseDomains=</varname></term>
networkd: move the IAID configuration option into the [DHCP] section It's only relevant to DHCP, and it should be where the DUID is configured too.
2016-05-06 18:04:05 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
networkd: move the IAID configuration option into the [DHCP] section It's only relevant to DHCP, and it should be where the DUID is configured too.
2016-05-06 18:04:05 +03:00
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseRoutes=</varname></term>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
man: add a description of DUIDType and DUIDRawData This is essentially a revert of f38e0cce75ff2ffbd99f7e382ed39c160bb7d799 (which removed the documentation of DUIDType on purpose). The description is heavily updated for the new semantics. This addresses #3127 § 4.
2016-04-30 03:16:55 +03:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>RouteMetric=</varname></term>
<listitem>
man: network: mention that RouteMetric= in [DHCPv4] is also applied to the prefix route
2021-08-17 17:53:49 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: Allow specifying RouteTable for DHCP
2016-09-19 05:26:12 +03:00
<varlistentry>
<term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
<listitem>
Merge pull request #4182 from jkoelker/routetable
2016-09-24 17:56:13 +03:00
<para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset).
networkd: Allow specifying RouteTable for DHCP
2016-09-19 05:26:12 +03:00
The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
</para>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>When used in combination with <varname>VRF=</varname>, the
VRF's routing table is used when this parameter is not specified.
man/systemd.network: Added documentation about the DHCP.RouteTable behaviour with VRFs
2017-09-27 02:52:07 +03:00
</para>
networkd: Allow specifying RouteTable for DHCP
2016-09-19 05:26:12 +03:00
</listitem>
</varlistentry>
networkd: support setting dhcp client listen port (#4631) Allow setting custom port for the DHCP client to listen on in networkd. [DHCP] ListenPort=6677
2016-11-11 02:34:19 +03:00
network: Add support to configure DHCPv4 route MTU This is useful for transitioning systems from small frames to jumbo frames. Closes #14302
2019-12-19 13:05:16 +03: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>
networkd: support setting dhcp client listen port (#4631) Allow setting custom port for the DHCP client to listen on in networkd. [DHCP] ListenPort=6677
2016-11-11 02:34:19 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseGateway=</varname></term>
networkd: support setting dhcp client listen port (#4631) Allow setting custom port for the DHCP client to listen on in networkd. [DHCP] ListenPort=6677
2016-11-11 02:34:19 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
networkd: support setting dhcp client listen port (#4631) Allow setting custom port for the DHCP client to listen on in networkd. [DHCP] ListenPort=6677
2016-11-11 02:34:19 +03:00
</listitem>
</varlistentry>
networkd: DHCPv6 client allow to configure Rapid Commit (#6930) The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through a rapid two-message exchange solicit and reply). When the rapid commit option is enabled by both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides faster client configuration and is beneficial in environments in which networks are under a heavy load. Closes #5845
2018-01-22 11:09:18 +03:00
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: DHCPv4- Allow to set DHCP lease lifetime
2020-05-20 07:23:36 +03:00
<term><varname>FallbackLeaseLifetimeSec=</varname></term>
<listitem>
<para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime.
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03:00
Takes one of <literal>forever</literal> or <literal>infinity</literal>. The latter means that the
address never expires. Defaults to unset.</para>
network: DHCPv4- Allow to set DHCP lease lifetime
2020-05-20 07:23:36 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<!-- How to communicate with the server -->
networkd: DHCP client add support to send RELEASE packet closes #10820
2019-05-13 17:30:28 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>RequestBroadcast=</varname></term>
networkd: DHCP client add support to send RELEASE packet closes #10820
2019-05-13 17:30:28 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
networkd: DHCP client add support to send RELEASE packet closes #10820
2019-05-13 17:30:28 +03:00
</listitem>
</varlistentry>
network: DHCP4 introduce send decline
2019-12-20 16:13:18 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>MaxAttempts=</varname></term>
network: DHCP4 introduce send decline
2019-12-20 16:13:18 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: DHCP4 introduce send decline
2019-12-20 16:13:18 +03:00
</listitem>
</varlistentry>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>ListenPort=</varname></term>
<listitem>
man: reword descriptions of two DHCPv4 options
2021-05-14 10:04:30 +03:00
<para>Set the port from which the DHCP client packets originate.</para>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
</listitem>
DHCPv4: client add support for DHCP server allow list
2020-06-26 06:28:52 +03:00
</varlistentry>
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>DenyList=</varname></term>
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03: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
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
rejected. Note that if <varname>AllowList=</varname> is configured then
<varname>DenyList=</varname> is ignored.</para>
</listitem>
network dhcp4: Add support send request options in a generic manner
2019-09-17 15:49:22 +03:00
</varlistentry>
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>AllowList=</varname></term>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03: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
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
accepted.</para>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
</listitem>
</varlistentry>
network: DHCPv4 client: add support to send arbitary option and data
2019-09-26 21:06:02 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendRelease=</varname></term>
network: DHCPv4 client: add support to send arbitary option and data
2019-09-26 21:06:02 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to
true.</para>
network: Fix split in `SendOption=` on client and server When specifying `DHCPv4.SendOption=`, it is used by systemd-networkd to set the value of that option within the DHCP request that is sent out. This differs to setting `DHCPServer.SendOption=`, which will place all the options together as suboptions into the vendor-specific information (code 43) option. This commit adds two new config options, `DHCPv4.SendVendorOption=` and `DHCPServer.SendVendorOption=`. These both have the behaviour of the old `DHCPServer.SendOption=` flag, and set the value of the suboption in the vendor-specific information option. The behaviour of `DHCPServer.SendOption=` is then changed to reflect that of `DHCPv4.SendOption=`. It will set the value of the corresponding option in the DHCP request.
2020-02-28 21:28:49 +03:00
</listitem>
</varlistentry>
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendDecline=</varname></term>
network: Fix split in `SendOption=` on client and server When specifying `DHCPv4.SendOption=`, it is used by systemd-networkd to set the value of that option within the DHCP request that is sent out. This differs to setting `DHCPServer.SendOption=`, which will place all the options together as suboptions into the vendor-specific information (code 43) option. This commit adds two new config options, `DHCPv4.SendVendorOption=` and `DHCPServer.SendVendorOption=`. These both have the behaviour of the old `DHCPServer.SendOption=` flag, and set the value of the suboption in the vendor-specific information option. The behaviour of `DHCPServer.SendOption=` is then changed to reflect that of `DHCPv4.SendOption=`. It will set the value of the corresponding option in the DHCP request.
2020-02-28 21:28:49 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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
man: fix RFC number #19947 didn't fix both.
2021-07-12 05:06:08 +03:00
url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<literal>unset</literal>.</para>
network: DHCPv4 client: add support to send arbitary option and data
2019-09-26 21:06:02 +03:00
</listitem>
</varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
</variablelist>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
</refsect1>
<refsect1>
<title>[DHCPv6] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the
network: rename [DHCP] section to [DHCPv4] To keep the backward compatibility broken by the previous commit.
2019-07-10 11:33:05 +03:00
<varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
<variablelist class='network-directives'>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<!-- DHCP packet contents -->
network: introduce new UseAddress= setting in [DHCPv6] section If it is disabled, then the addresses provided by the DHCPv6 server will be ignored. Closes #18203.
2021-01-11 18:02:09 +03:00
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>MUDURL=</varname></term>
network: make IAID and DUID for DHCPv6 configurable explicitly Closes #18996.
2021-04-10 04:24:17 +03:00
<term><varname>IAID=</varname></term>
<term><varname>DUIDType=</varname></term>
<term><varname>DUIDRawData=</varname></term>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>RequestOptions=</varname></term>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
<listitem>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>As in the [DHCPv4] section.</para>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
</listitem>
</varlistentry>
networkd: DHCPv6 client allow to configure Rapid Commit (#6930) The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through a rapid two-message exchange solicit and reply). When the rapid commit option is enabled by both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides faster client configuration and is beneficial in environments in which networks are under a heavy load. Closes #5845
2018-01-22 11:09:18 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendOption=</varname></term>
network: DHCPv6 Add support to send MUD URL
2020-03-30 17:31:10 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: DHCPv6 Add support to send MUD URL
2020-03-30 17:31:10 +03:00
</listitem>
</varlistentry>
network: DHCPv6 - Add support set arbitary request options
2020-04-23 15:31:47 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>SendVendorOption=</varname></term>
network: DHCPv6 - Add support set arbitary request options
2020-04-23 15:31:47 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: DHCPv6 - Add support set arbitary request options
2020-04-23 15:31:47 +03:00
</listitem>
</varlistentry>
network: Inroduce DHCP6- send vendor options network: Inroduce DHCP6- send vendor options ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | OPTION_VENDOR_OPTS | option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | enterprise-number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . vendor-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ``` ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | sub-opt-code | sub-option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . sub-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 31: Vendor-specific Options Format sub-opt-code The code for the sub-option. A 2-octet field. sub-option-len An unsigned integer giving the length of the sub-option-data field in this sub-option in octets. A 2-octet field. sub-option-data The data area for the sub-option. The length, in octets, is specified by sub-option-len. ```
2020-05-26 11:46:54 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UserClass=</varname></term>
network: Inroduce DHCP6- send vendor options network: Inroduce DHCP6- send vendor options ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | OPTION_VENDOR_OPTS | option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | enterprise-number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . vendor-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ``` ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | sub-opt-code | sub-option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . sub-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 31: Vendor-specific Options Format sub-opt-code The code for the sub-option. A 2-octet field. sub-option-len An unsigned integer giving the length of the sub-option-data field in this sub-option in octets. A 2-octet field. sub-option-data The data area for the sub-option. The length, in octets, is specified by sub-option-len. ```
2020-05-26 11:46:54 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style
network: Inroduce DHCP6- send vendor options network: Inroduce DHCP6- send vendor options ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | OPTION_VENDOR_OPTS | option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | enterprise-number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . vendor-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ``` ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | sub-opt-code | sub-option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . sub-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 31: Vendor-specific Options Format sub-opt-code The code for the sub-option. A 2-octet field. sub-option-len An unsigned integer giving the length of the sub-option-data field in this sub-option in octets. A 2-octet field. sub-option-data The data area for the sub-option. The length, in octets, is specified by sub-option-len. ```
2020-05-26 11:46:54 +03:00
escapes</ulink>. This setting can be specified multiple times. If an empty string is specified,
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
network: Inroduce DHCP6- send vendor options network: Inroduce DHCP6- send vendor options ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | OPTION_VENDOR_OPTS | option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | enterprise-number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . vendor-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ``` ``` 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | sub-opt-code | sub-option-len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ . . . sub-option-data . . . +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 31: Vendor-specific Options Format sub-opt-code The code for the sub-option. A 2-octet field. sub-option-len An unsigned integer giving the length of the sub-option-data field in this sub-option in octets. A 2-octet field. sub-option-data The data area for the sub-option. The length, in octets, is specified by sub-option-len. ```
2020-05-26 11:46:54 +03:00
</listitem>
</varlistentry>
networkd-network: Introduce DHCPv6 PD knob for RFC 7084 WPD-4 RFC 7084, WPD-4, requires Customer Edge end routers to behave according to the following: "WPD-4: By default, the IPv6 CE router MUST initiate DHCPv6 prefix delegation when either the M or O flags are set to 1 in a received Router Advertisement (RA) message. Behavior of the CE router to use DHCPv6 prefix delegation when the CE router has not received any RA or received an RA with the M and the O bits set to zero is out of scope for this document." Since it cannot be automatically detected whether DHCPv6 is to be operated as an CE end router or whether to initiate an Informational exchange to obtain other useful network information via DHCPv6 when the Router Advertisement 'O' bit is set, a 'ForceDHCPv6PDOtherInformation' boolean network configuration option in the '[DHCP]' section of a is introduced. Setting this option causes DHCPv6 to be started in stateful mode, although only the 'O' bit is seen in the Router Advertisement. When 'ForceDHCPv6PDOtherInformation' is set and the Router Advertisement has only the Other information 'O' bit set, disable requests for IA_NA addresses. Fixes #9745.
2018-09-07 23:15:55 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>VendorClass=</varname></term>
networkd-network: Introduce DHCPv6 PD knob for RFC 7084 WPD-4 RFC 7084, WPD-4, requires Customer Edge end routers to behave according to the following: "WPD-4: By default, the IPv6 CE router MUST initiate DHCPv6 prefix delegation when either the M or O flags are set to 1 in a received Router Advertisement (RA) message. Behavior of the CE router to use DHCPv6 prefix delegation when the CE router has not received any RA or received an RA with the M and the O bits set to zero is out of scope for this document." Since it cannot be automatically detected whether DHCPv6 is to be operated as an CE end router or whether to initiate an Informational exchange to obtain other useful network information via DHCPv6 when the Router Advertisement 'O' bit is set, a 'ForceDHCPv6PDOtherInformation' boolean network configuration option in the '[DHCP]' section of a is introduced. Setting this option causes DHCPv6 to be started in stateful mode, although only the 'O' bit is seen in the Router Advertisement. When 'ForceDHCPv6PDOtherInformation' is set and the Router Advertisement has only the Other information 'O' bit set, disable requests for IA_NA addresses. Fixes #9745.
2018-09-07 23:15:55 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03: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>
networkd-network: Introduce DHCPv6 PD knob for RFC 7084 WPD-4 RFC 7084, WPD-4, requires Customer Edge end routers to behave according to the following: "WPD-4: By default, the IPv6 CE router MUST initiate DHCPv6 prefix delegation when either the M or O flags are set to 1 in a received Router Advertisement (RA) message. Behavior of the CE router to use DHCPv6 prefix delegation when the CE router has not received any RA or received an RA with the M and the O bits set to zero is out of scope for this document." Since it cannot be automatically detected whether DHCPv6 is to be operated as an CE end router or whether to initiate an Informational exchange to obtain other useful network information via DHCPv6 when the Router Advertisement 'O' bit is set, a 'ForceDHCPv6PDOtherInformation' boolean network configuration option in the '[DHCP]' section of a is introduced. Setting this option causes DHCPv6 to be started in stateful mode, although only the 'O' bit is seen in the Router Advertisement. When 'ForceDHCPv6PDOtherInformation' is set and the Router Advertisement has only the Other information 'O' bit set, disable requests for IA_NA addresses. Fixes #9745.
2018-09-07 23:15:55 +03:00
</listitem>
</varlistentry>
network: DHCPv6 client add support for prefix delegation hint Add support for prefix hint lenth and prefix hint address ``` Frame 43: 177 bytes on wire (1416 bits), 177 bytes captured (1416 bits) on interface 0 Ethernet II, Src: f6:c1:08:4d:45:f1 (f6:c1:08:4d:45:f1), Dst: IPv6mcast_01:00:02 (33:33:00:01:00:02) Internet Protocol Version 6, Src: fe80::d250:c82:7f6e:28d6, Dst: ff02::1:2 User Datagram Protocol, Src Port: 546, Dst Port: 547 DHCPv6 Message type: Solicit (1) Transaction ID: 0x5c7902 Rapid Commit Identity Association for Non-temporary Address Fully Qualified Domain Name Identity Association for Prefix Delegation Option: Identity Association for Prefix Delegation (25) Length: 41 Value: 1b97b1690000000000000000001a0019ffffffffffffffff… IAID: 1b97b169 T1: 0 T2: 0 IA Prefix Option: IA Prefix (26) Length: 25 Value: ffffffffffffffff3c000000000000000000000000000000… Preferred lifetime: infinity Valid lifetime: infinity Prefix length: 60 Prefix address: :: Option Request Client Identifier Elapsed time ```
2019-09-25 06:14:12 +03:00
<varlistentry>
<term><varname>PrefixDelegationHint=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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
1–128. Defaults to unset.</para>
network: DHCPv6 client add support for prefix delegation hint Add support for prefix hint lenth and prefix hint address ``` Frame 43: 177 bytes on wire (1416 bits), 177 bytes captured (1416 bits) on interface 0 Ethernet II, Src: f6:c1:08:4d:45:f1 (f6:c1:08:4d:45:f1), Dst: IPv6mcast_01:00:02 (33:33:00:01:00:02) Internet Protocol Version 6, Src: fe80::d250:c82:7f6e:28d6, Dst: ff02::1:2 User Datagram Protocol, Src Port: 546, Dst Port: 547 DHCPv6 Message type: Solicit (1) Transaction ID: 0x5c7902 Rapid Commit Identity Association for Non-temporary Address Fully Qualified Domain Name Identity Association for Prefix Delegation Option: Identity Association for Prefix Delegation (25) Length: 41 Value: 1b97b1690000000000000000001a0019ffffffffffffffff… IAID: 1b97b169 T1: 0 T2: 0 IA Prefix Option: IA Prefix (26) Length: 25 Value: ffffffffffffffff3c000000000000000000000000000000… Preferred lifetime: infinity Valid lifetime: infinity Prefix length: 60 Prefix address: :: Option Request Client Identifier Elapsed time ```
2019-09-25 06:14:12 +03:00
</listitem>
</varlistentry>
network: Allow DHCPv6 client to start without router's managed flag.
2020-02-15 15:51:34 +03:00
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<!-- How to use the DHCP lease -->
network: Allow DHCPv6 client to start without router's managed flag.
2020-02-15 15:51:34 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseAddress=</varname></term>
network: Allow DHCPv6 client to start without router's managed flag.
2020-02-15 15:51:34 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>When true (the default), the IP addresses provided by the DHCPv6 server will be
assigned.</para>
network: Allow DHCPv6 client to start without router's managed flag.
2020-02-15 15:51:34 +03:00
</listitem>
</varlistentry>
DHCP client: make SendOption work for DHCPv6 too.
2020-05-01 17:30:31 +03:00
network: dhcp6: introduce UseDelegatedPrefix= setting and enable by default Previously, the prefix delegation is enabled when at least one downstream interfaces request it. But, when the DHCPv6 client on the upstream interface is configured, some downstream interfaces may not exist yet, nor have .network file assigned. Also, if a system has thousands of interfaces, then the previous logic introduce O(n^2) search. This makes the prefix delegation is always enabled, except when it is explicitly disabled. Hopefully, that should not break anything, as the DHCPv6 server should ignore the prefix delegation request if the server do not have any prefix to delegate.
2021-10-13 10:26:09 +03: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>
DHCP client: make SendOption work for DHCPv6 too.
2020-05-01 17:30:31 +03:00
<varlistentry>
network: do not use RouteTable= in [DHCPv4] section for DHCPv6 routes We forgot to add RouteTable= in [DHCPv6] section when we split [DHCP] into two.
2021-09-08 03:35:34 +03:00
<term><varname>RouteMetric=</varname></term>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>UseDNS=</varname></term>
<term><varname>UseNTP=</varname></term>
<term><varname>UseHostname=</varname></term>
<term><varname>UseDomains=</varname></term>
DHCP client: make SendOption work for DHCPv6 too.
2020-05-01 17:30:31 +03:00
<listitem>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<para>As in the [DHCPv4] section.</para>
DHCP client: make SendOption work for DHCPv6 too.
2020-05-01 17:30:31 +03:00
</listitem>
</varlistentry>
network: DHCPv6 - Add support to send user class Frame 115: 171 bytes on wire (1368 bits), 171 bytes captured (1368 bits) on interface veth-peer, id 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01:00:02 (33:33:00:01:00:02) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1:2 User Datagram Protocol, Src Port: 546, Dst Port: 547 DHCPv6 Message type: Solicit (1) Transaction ID: 0x673257 Rapid Commit Option: Rapid Commit (14) Length: 0 Identity Association for Non-temporary Address Option: Identity Association for Non-temporary Address (3) Length: 12 Value: d0cc94090000000000000000 IAID: d0cc9409 T1: 0 T2: 0 Fully Qualified Domain Name Option: Fully Qualified Domain Name (39) Length: 6 Value: 01045a657573 0000 0... = Reserved: 0x00 .... .0.. = N bit: Server should perform DNS updates .... ..0. = O bit: Server has not overridden client's S bit preference .... ...1 = S bit: Server should perform forward DNS updates Client FQDN: Zeus User Class Option: User Class (15) Length: 17 Value: 000f68656c6c6f30313233343031323334 Identity Association for Prefix Delegation Option: Identity Association for Prefix Delegation (25) Length: 12 Value: d0cc94090000000000000000 IAID: d0cc9409 T1: 0 T2: 0 Option Request Option: Option Request (6) Length: 10 Value: 001700180038001f000e Requested Option code: DNS recursive name server (23) Requested Option code: Domain Search List (24) Requested Option code: NTP Server (56) Requested Option code: Simple Network Time Protocol Server (31) Requested Option code: Rapid Commit (14) Client Identifier Option: Client Identifier (1) Length: 14 Value: 00020000ab11d258482fc7eee651 DUID: 00020000ab11d258482fc7eee651 DUID Type: assigned by vendor based on Enterprise number (2) Enterprise ID: Tom Gundersen (systemd) (43793) Identifier: d258482fc7eee651 Elapsed time Option: Elapsed time (8) Length: 2 Value: 0bd0 Elapsed time: 30240ms
2020-05-18 15:49:47 +03:00
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<!-- How to communicate with the server -->
network: DHCPv6 - Add support to send vendor class information Frame 1: 177 bytes on wire (1416 bits), 177 bytes captured (1416 bits) on interface veth-peer, id 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01:00:02 (33:33:00:01:00:02) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1:2 User Datagram Protocol, Src Port: 546, Dst Port: 547 DHCPv6 Message type: Solicit (1) Transaction ID: 0x5ca46b Rapid Commit Identity Association for Non-temporary Address Fully Qualified Domain Name Vendor Class Option: Vendor Class (16) Length: 23 Value: 0000ab11000048656c6c6f3a686f773a6172653a796f75 Enterprise ID: Tom Gundersen (systemd) (43793) vendor-class-data: Hello:how:are:you Identity Association for Prefix Delegation Option Request Client Identifier Elapsed time
2020-05-17 18:14:47 +03:00
<varlistentry>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
<term><varname>WithoutRA=</varname></term>
<listitem>
man: adjust the explanations related to the DHCPv6 client starting mode
2021-10-14 13:27:08 +03: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>
man: reorder items in [DHCPv4] and [DHCPv6] sections The settings were listen in a completely random order, also different between the v4 and v6 sections. Order by "options sent", "options received", "communication settings" in both sections. Also minor formatting changes are done, e.g. "=" is added in various places.
2021-05-14 09:58:44 +03:00
</listitem>
</varlistentry>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
</variablelist>
networkd: DHCPv6 - separate DHCPv6 options from DHCPv4 options Closes https://github.com/systemd/systemd/issues/12917
2019-07-09 17:23:28 +03:00
</refsect1>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03:00
<refsect1>
<title>[DHCPv6PrefixDelegation] Section Options</title>
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03:00
<variablelist class='network-directives'>
network: dhcp6: introduce UplinkInterface= for DHCP6 prefix delegation
2021-10-13 12:00:52 +03: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
man: adjust the explanations related to the DHCPv6 client starting mode
2021-10-14 13:27:08 +03: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>
network: dhcp6: introduce UplinkInterface= for DHCP6 prefix delegation
2021-10-13 12:00:52 +03:00
</listitem>
</varlistentry>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03: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
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03: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
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Token=</varname></term>
<listitem>
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03:00
<para>Specifies an optional address generation mode for assigning an address in each
network: extend Token= setting in [DHCPv6PrefixDelegation] Now the setting supports the same syntax as the one in the [IPv6AcceptRA] section.
2021-09-24 22:10:34 +03: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>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03:00
</listitem>
</varlistentry>
network: introduce ManageTemporaryAddress= setting in [DHCPv6PrefixDelegation] section The setting is enabled by default, as NDisc also enabled the flag by default. Closes #18208.
2021-01-13 00:34:32 +03:00
<varlistentry>
<term><varname>ManageTemporaryAddress=</varname></term>
<listitem>
<para>As in the [Address] section, but defaults to true.</para>
</listitem>
</varlistentry>
network: dhcp6-pd: add RouteMetric= setting in [DHCPv6PrefixDelegation]
2021-04-17 20:32:51 +03:00
<varlistentry>
<term><varname>RouteMetric=</varname></term>
<listitem>
<para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in
network: dhcp6pd: set default metric 256 for delegated prefix When Assign= in [DHCPv6PrefixDelegation] is enabled, then the kernel will create the prefix route for the assigned address with metric 256. When Assign= is disabled, then the kernel will create the route with metric 1024. For the default value, we should choose a smaller value (higher priority) than 1024, as the unreachable routes for delegated prefix will be configured with 1024.
2021-10-14 23:57:30 +03:00
the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256.
</para>
network: dhcp6-pd: add RouteMetric= setting in [DHCPv6PrefixDelegation]
2021-04-17 20:32:51 +03:00
</listitem>
</varlistentry>
network: rename settings about DHCPv6 Prefix Delegation Closes #16602.
2020-07-28 23:50:04 +03:00
</variablelist>
</refsect1>
DHCP DUID, IAID configuration options
2016-03-31 02:33:55 +03: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 21:38:12 +03:00
<refsect1>
networkd: rename IPv6AcceptRouterAdvertisements to IPv6AcceptRA The long name is just too hard to type. We generally should avoid using acronyms too liberally, if they aren't established enough, but it appears that "RA" is known well enough. Internally we call the option "ipv6_accept_ra" anyway, and the kernel also exposes it under this name. Hence, let's rename the IPv6AcceptRouterAdvertisements= setting and the [IPv6AcceptRouterAdvertisements] section to IPv6AcceptRA= and [IPv6AcceptRA]. The old setting IPv6AcceptRouterAdvertisements= is kept for compatibility with older configuration. (However the section [IPv6AcceptRouterAdvertisements] is not, as it was never available in a published version of systemd.
2016-06-07 12:19:26 +03:00
<title>[IPv6AcceptRA] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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 21:38:12 +03:00
<variablelist class='network-directives'>
network: rename IPv6Token= in [Network] -> Token= in [IPv6AcceptRA] The token is only used by received prefixes through RA.
2021-09-24 22:52:47 +03:00
<varlistentry>
<term><varname>Token=</varname></term>
<listitem>
<para>Specifies an optional address generation mode for the Stateless Address
network: introduce Token=eui64 So, now user can explicitly request EUI-64 algorithm to generate addresses.
2021-09-24 22:04:09 +03:00
Autoconfiguration (SLAAC). Supported modes are <literal>eui64</literal>,
<literal>static</literal>, and <literal>prefixstable</literal>.</para>
<para>When the mode is set to <literal>eui64</literal>, then the EUI-64 algorithm will be
used to generate an address for that prefix.</para>
network: rename IPv6Token= in [Network] -> Token= in [IPv6AcceptRA] The token is only used by received prefixes through RA.
2021-09-24 22:52:47 +03:00
<para>When the mode is set to <literal>static</literal>, 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>
<para>When the mode is set to <literal>prefixstable</literal> the
<ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> algorithm for generating
interface identifiers will be used. 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>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>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>
<para>This setting can be specified multiple times. If an empty string is assigned, then
the all previous assignments are cleared.</para>
<para>Examples:
network: introduce Token=eui64 So, now user can explicitly request EUI-64 algorithm to generate addresses.
2021-09-24 22:04:09 +03:00
<programlisting>Token=eui64
Token=::1a:2b:3c:4d
network: rename IPv6Token= in [Network] -> Token= in [IPv6AcceptRA] The token is only used by received prefixes through RA.
2021-09-24 22:52:47 +03:00
Token=static:::1a:2b:3c:4d
Token=prefixstable
Token=prefixstable:2002:da8:1::</programlisting></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 21:38:12 +03:00
<varlistentry>
<term><varname>UseDNS=</varname></term>
<listitem>
man: DNS/NTP servers received from DHCP server are concatenated with the statically configured ones Prompted by #9473.
2021-03-13 13:56:30 +03:00
<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 21:38:12 +03: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>
<varlistentry>
<term><varname>UseDomains=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name
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 21:38:12 +03:00
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
tree-wide: use "hostname" spelling everywhere It's not that I think that "hostname" is vastly superior to "host name". Quite the opposite — the difference is small, and in some context the two-word version does fit better. But in the tree, there are ~200 occurrences of the first, and >1600 of the other, and consistent spelling is more important than any particular spelling choice.
2020-04-14 11:37:40 +03:00
of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain
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 21:38:12 +03:00
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>
networkd: Allow specifying RouteTable for RAs
2016-09-19 05:59:11 +03:00
<varlistentry>
<term><varname>RouteTable=<replaceable>num</replaceable></varname></term>
<listitem>
Merge pull request #4182 from jkoelker/routetable
2016-09-24 17:56:13 +03:00
<para>The table identifier for the routes received in the Router Advertisement
(a number between 1 and 4294967295, or 0 to unset).
networkd: Allow specifying RouteTable for RAs
2016-09-19 05:59:11 +03:00
The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>.
</para>
</listitem>
</varlistentry>
networkd: ipv6ra allow to ignore addresses Allows to ignore prefixes. ``` UseAutonomousPrefix= UseOnLinkPrefix= ``` closes #9582
2019-02-14 18:35:17 +03:00
network: move RouteMetric= from [DHCPv6] to [IPv6AcceptRA] As the value is used in the routes in RA.
2021-04-17 20:31:13 +03: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>
network: add UseMTU= in [IPv6AcceptRA] Note that kernel has similar knob in sysctl: accept_ra_mtu. Closes #18868.
2021-08-20 03:41:34 +03: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>
networkd: ipv6ra allow to ignore addresses Allows to ignore prefixes. ``` UseAutonomousPrefix= UseOnLinkPrefix= ``` closes #9582
2019-02-14 18:35:17 +03: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>
<varlistentry>
<term><varname>UseOnLinkPrefix=</varname></term>
<listitem>
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03:00
<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>
networkd: ipv6ra allow to ignore addresses Allows to ignore prefixes. ``` UseAutonomousPrefix= UseOnLinkPrefix= ``` closes #9582
2019-02-14 18:35:17 +03:00
</listitem>
</varlistentry>
network: introduce RouterAllowList= and RouterDenyList= in [IPv6AcceptRA]
2020-12-24 08:27:25 +03:00
<varlistentry>
<term><varname>RouterDenyList=</varname></term>
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03:00
<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>
network: introduce RouterAllowList= and RouterDenyList= in [IPv6AcceptRA]
2020-12-24 08:27:25 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RouterAllowList=</varname></term>
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03:00
<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>
network: introduce RouterAllowList= and RouterDenyList= in [IPv6AcceptRA]
2020-12-24 08:27:25 +03:00
</listitem>
</varlistentry>
networkd: Ability to selectively ignore IPv6 prefixes supplied via router advertisement Closes https://github.com/systemd/systemd/issues/10647
2019-05-17 19:21:20 +03:00
<varlistentry>
network: rename DenyList= -> PrefixDenyList=
2020-12-24 08:00:24 +03:00
<term><varname>PrefixDenyList=</varname></term>
networkd: Ability to selectively ignore IPv6 prefixes supplied via router advertisement Closes https://github.com/systemd/systemd/issues/10647
2019-05-17 19:21:20 +03:00
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03:00
<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>
networkd: add RouteDenyList Allow configuration for IPv6 discovered routes to be ignored instead of adding them as a route. This can be used to block unwanted routes, for example, you may wish to not receive some set of routes on an interface if they are causing issues.
2020-12-14 09:23:17 +03:00
</listitem>
</varlistentry>
networkd: add support for prefix allow-list and route allow-list
2020-12-18 22:28:38 +03:00
<varlistentry>
<term><varname>PrefixAllowList=</varname></term>
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03:00
<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>
networkd: add support for prefix allow-list and route allow-list
2020-12-18 22:28:38 +03:00
</listitem>
</varlistentry>
networkd: add RouteDenyList Allow configuration for IPv6 discovered routes to be ignored instead of adding them as a route. This can be used to block unwanted routes, for example, you may wish to not receive some set of routes on an interface if they are causing issues.
2020-12-14 09:23:17 +03:00
<varlistentry>
<term><varname>RouteDenyList=</varname></term>
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03:00
<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>
networkd: Ability to selectively ignore IPv6 prefixes supplied via router advertisement Closes https://github.com/systemd/systemd/issues/10647
2019-05-17 19:21:20 +03:00
</listitem>
</varlistentry>
networkd: add support for prefix allow-list and route allow-list
2020-12-18 22:28:38 +03:00
<varlistentry>
<term><varname>RouteAllowList=</varname></term>
<listitem>
network: dhcp4,ndisc: make addresses in Allow/DenyList= optionally take prefix length Closes #20505.
2021-08-22 19:36:21 +03:00
<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
networkd: add support for prefix allow-list and route allow-list
2020-12-18 22:28:38 +03:00
configured then <varname>RouteDenyList=</varname> is ignored.</para>
</listitem>
</varlistentry>
network: add setting to support RA without DHCPv6 client Closes #13991.
2020-02-15 19:32:49 +03:00
<varlistentry>
<term><varname>DHCPv6Client=</varname></term>
<listitem>
man: adjust the explanations related to the DHCPv6 client starting mode
2021-10-14 13:27:08 +03:00
<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>
network: add setting to support RA without DHCPv6 client Closes #13991.
2020-02-15 19:32:49 +03: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 21:38:12 +03:00
</variablelist>
</refsect1>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
<refsect1>
<title>[DHCPServer] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
<varname>DHCPServer=</varname> option described above:</para>
<variablelist class='network-directives'>
network: dhcp-server: introduce ServerAddress= setting This may be useful when the link which DHCP server running on has multiple static addresses.
2021-05-14 14:27:33 +03:00
<varlistentry>
<term><varname>ServerAddress=</varname></term>
<listitem><para>Specifies server address for the DHCP server. Takes an IPv4 address with prefix
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03: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>
network: dhcp-server: introduce ServerAddress= setting This may be useful when the link which DHCP server running on has multiple static addresses.
2021-05-14 14:27:33 +03:00
</varlistentry>
networkd: dhcp-server - allow configuration of the pool The constraints we place on the pool is that it is a contiguous sequence of addresses in the same subnet as the server address, not including the subnet nor broadcast addresses, but possibly including the server address itself. If the server address is included in the pool it is (obviously) reserved and not handed out to clients.
2015-08-29 01:18:20 +03: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
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
pool or zero to use the default value. By default, the pool starts at
networkd: dhcp-server - allow configuration of the pool The constraints we place on the pool is that it is a contiguous sequence of addresses in the same subnet as the server address, not including the subnet nor broadcast addresses, but possibly including the server address itself. If the server address is included in the pool it is (obviously) reserved and not handed out to clients.
2015-08-29 01:18:20 +03: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>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03: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
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
maximum lease time, it is automatically shortened to the
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03: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>
network: introduce UplinkInterface= setting for DHCP server
2021-05-17 21:42:19 +03:00
<varlistentry>
<term><varname>UplinkInterface=</varname></term>
network: update comment and man page
2021-07-13 15:27:51 +03: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>
network: introduce UplinkInterface= setting for DHCP server
2021-05-17 21:42:19 +03:00
</varlistentry>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
<varlistentry>
<term><varname>EmitDNS=</varname></term>
<term><varname>DNS=</varname></term>
network: clean-up DHCP lease server data configuration This is an attempt to clean up the POP3/SMTP/LPR/… DHCP lease server data logic in networkd. This reduces code duplication and fixes a number of bugs. This removes any support for collecting POP3/SMPT/LPR servers acquired via local DHCP client releases since noone uses that, and given how old these protocols are I doubt this will change. It keeps support for configuring them for the dhcp server however. The differences between the DNS/NTP/SIP/POP3/SMTP/LPR configuration logics are minimized. This removes the relevant symbols from sd-network.h (which is an internal API only at this point after all). This is unfortunately not well test, given the old code for this had barely any tests. But the new code should not perform worse at least, and allow us to release, since it corrects some interfaces visible in the .network configuration format. Fixes: #15943
2020-06-16 21:35:18 +03: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
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03:00
suitable uplink interface is found the DNS server data from <filename>/etc/resolv.conf</filename> is
network: clean-up DHCP lease server data configuration This is an attempt to clean up the POP3/SMTP/LPR/… DHCP lease server data logic in networkd. This reduces code duplication and fixes a number of bugs. This removes any support for collecting POP3/SMPT/LPR servers acquired via local DHCP client releases since noone uses that, and given how old these protocols are I doubt this will change. It keeps support for configuring them for the dhcp server however. The differences between the DNS/NTP/SIP/POP3/SMTP/LPR configuration logics are minimized. This removes the relevant symbols from sd-network.h (which is an internal API only at this point after all). This is unfortunately not well test, given the old code for this had barely any tests. But the new code should not perform worse at least, and allow us to release, since it corrects some interfaces visible in the .network configuration format. Fixes: #15943
2020-06-16 21:35:18 +03: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
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
above.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>EmitNTP=</varname></term>
<term><varname>NTP=</varname></term>
network: DHCP server Add support to transmit SIP server 1. DHCP server trasmit 2. Client parses and saves in leases Implements http://www.rfc-editor.org/rfc/rfc3361.txt ``` Frame 134: 348 bytes on wire (2784 bits), 348 bytes captured (2784 bits) on interface 0 Ethernet II, Src: 42:65:85:d6:4e:32 (42:65:85:d6:4e:32), Dst: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x7cc87cb4 Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.1.1 Option: (120) SIP Servers <=====here Length: 9 SIP Server Encoding: IPv4 Address (1) SIP Server Address: 192.168.1.1 SIP Server Address: 192.168.5.2 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ``` ``` cat /run/systemd/netif/state  ✔  ⚡  3148  16:40:51 OPER_STATE=routable CARRIER_STATE=carrier ADDRESS_STATE=routable DNS=192.168.94.2 192.168.5.1 NTP=192.168.5.1 SIP=192.168.1.1 192.168.5.2 ``` aa
2019-09-18 16:22:47 +03:00
<term><varname>EmitSIP=</varname></term>
<term><varname>SIP=</varname></term>
network: clean-up DHCP lease server data configuration This is an attempt to clean up the POP3/SMTP/LPR/… DHCP lease server data logic in networkd. This reduces code duplication and fixes a number of bugs. This removes any support for collecting POP3/SMPT/LPR servers acquired via local DHCP client releases since noone uses that, and given how old these protocols are I doubt this will change. It keeps support for configuring them for the dhcp server however. The differences between the DNS/NTP/SIP/POP3/SMTP/LPR configuration logics are minimized. This removes the relevant symbols from sd-network.h (which is an internal API only at this point after all). This is unfortunately not well test, given the old code for this had barely any tests. But the new code should not perform worse at least, and allow us to release, since it corrects some interfaces visible in the .network configuration format. Fixes: #15943
2020-06-16 21:35:18 +03: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>
DHCP: Add support to emit and retrieve POP3 server
2020-03-27 23:12:07 +03:00
</varlistentry>
networkd: Add EmitRouter= option for DHCP Server (#3251) Add an option to disable appending DHCP option 3 (Router) to the DHCP OFFER and ACK packets. This commit adds the boolean option EmitRouter= for the [DHCPServer] section in .network files. Rationale: On embedded devices, it is very useful to have a DHCP server running on an USB OTG ethernet gadget interface to avoid manual setup on the client PCs, but it should only serve IP addresses, no route(r)s. Otherwise, Windows clients experience network connectivity issues, due to them using the address set in DHCP option 3 as default gateway. Signed-off-by: Clemens Gruber <clemens.gruber@pqgruber.com>
2016-05-18 02:34:25 +03:00
<varlistentry>
<term><varname>EmitRouter=</varname></term>
<listitem><para>Similar to the <varname>EmitDNS=</varname>
setting described above, this setting configures whether the
DHCP lease should contain the router option. The same syntax,
propagation semantics and defaults apply as for
<varname>EmitDNS=</varname>.</para></listitem>
</varlistentry>
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
<varlistentry>
<term><varname>EmitTimezone=</varname></term>
<term><varname>Timezone=</varname></term>
man: update explanation for boolean options
2018-11-27 09:07:58 +03: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
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03: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
doc: correct punctuation and improve typography in documentation
2014-08-03 09:11:12 +04:00
timezone is set, the system timezone of the local host is
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
propagated, as determined by the
<filename>/etc/localtime</filename> symlink.</para></listitem>
</varlistentry>
networkd: dhcp server Support Vendor specific 43 Implementes https://tools.ietf.org/html/rfc2132 ``` [DHCPServer] SendRawOption=26:uint32:1400 SendRawOption=23:uint8:10 ``` Frame 448: 350 bytes on wire (2800 bits), 350 bytes captured (2800 bits) on interface 0 Linux cooked capture Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x71f8de9d Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.5.1 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (43) Vendor-Specific Information Length: 9 Value: 1701311a0431343030 Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ```
2019-09-20 05:22:17 +03:00
<varlistentry>
network: rename SendRawOption= to SendOption= As DHCPv4.SendOption= and DHCPServer.SendRawOption= take the same format.
2019-11-18 11:33:58 +03: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>).
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
DHCP client: make SendOption work for DHCPv6 too.
2020-05-01 17:30:31 +03:00
<literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or
network: Fix split in `SendOption=` on client and server When specifying `DHCPv4.SendOption=`, it is used by systemd-networkd to set the value of that option within the DHCP request that is sent out. This differs to setting `DHCPServer.SendOption=`, which will place all the options together as suboptions into the vendor-specific information (code 43) option. This commit adds two new config options, `DHCPv4.SendVendorOption=` and `DHCPServer.SendVendorOption=`. These both have the behaviour of the old `DHCPServer.SendOption=` flag, and set the value of the suboption in the vendor-specific information option. The behaviour of `DHCPServer.SendOption=` is then changed to reflect that of `DHCPv4.SendOption=`. It will set the value of the corresponding option in the DHCP request.
2020-02-28 21:28:49 +03: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>).
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>,
network: rename SendRawOption= to SendOption= As DHCPv4.SendOption= and DHCPServer.SendRawOption= take the same format.
2019-11-18 11:33:58 +03: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>
networkd: dhcp server Support Vendor specific 43 Implementes https://tools.ietf.org/html/rfc2132 ``` [DHCPServer] SendRawOption=26:uint32:1400 SendRawOption=23:uint8:10 ``` Frame 448: 350 bytes on wire (2800 bits), 350 bytes captured (2800 bits) on interface 0 Linux cooked capture Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x71f8de9d Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.5.1 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (43) Vendor-Specific Information Length: 9 Value: 1701311a0431343030 Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ```
2019-09-20 05:22:17 +03:00
</varlistentry>
dhcp: Implemented BindToInterface= configuration option
2021-03-09 14:57:37 +03:00
<varlistentry>
<term><varname>BindToInterface=</varname></term>
rfc3046 implementation
2021-04-21 06:51:07 +03: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),
in which case it defaults defaults to <literal>no</literal>.</para>
</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>
dhcp: Implemented BindToInterface= configuration option
2021-03-09 14:57:37 +03:00
</listitem>
</varlistentry>
networkd: dhcp server Support Vendor specific 43 Implementes https://tools.ietf.org/html/rfc2132 ``` [DHCPServer] SendRawOption=26:uint32:1400 SendRawOption=23:uint8:10 ``` Frame 448: 350 bytes on wire (2800 bits), 350 bytes captured (2800 bits) on interface 0 Linux cooked capture Internet Protocol Version 4, Src: 192.168.5.1, Dst: 192.168.5.11 User Datagram Protocol, Src Port: 67, Dst Port: 68 Dynamic Host Configuration Protocol (ACK) Message type: Boot Reply (2) Hardware type: Ethernet (0x01) Hardware address length: 6 Hops: 0 Transaction ID: 0x71f8de9d Seconds elapsed: 0 Bootp flags: 0x0000 (Unicast) Client IP address: 0.0.0.0 Your (client) IP address: 192.168.5.11 Next server IP address: 0.0.0.0 Relay agent IP address: 0.0.0.0 Client MAC address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) Client hardware address padding: 00000000000000000000 Server host name not given Boot file name not given Magic cookie: DHCP Option: (53) DHCP Message Type (ACK) Length: 1 DHCP: ACK (5) Option: (51) IP Address Lease Time Length: 4 IP Address Lease Time: (3600s) 1 hour Option: (1) Subnet Mask (255.255.255.0) Length: 4 Subnet Mask: 255.255.255.0 Option: (3) Router Length: 4 Router: 192.168.5.1 Option: (6) Domain Name Server Length: 4 Domain Name Server: 192.168.5.1 Option: (42) Network Time Protocol Servers Length: 4 Network Time Protocol Server: 192.168.5.1 Option: (101) TCode Length: 13 TZ TCode: Europe/Berlin Option: (43) Vendor-Specific Information Length: 9 Value: 1701311a0431343030 Option: (54) DHCP Server Identifier (192.168.5.1) Length: 4 DHCP Server Identifier: 192.168.5.1 Option: (255) End Option End: 255 ```
2019-09-20 05:22:17 +03:00
man: document the new DHCP settings added in the past commits
2015-08-27 18:32:30 +03:00
</variablelist>
</refsect1>
network: dhcp-server: introduce [DHCPServerStaticLease] section
2020-10-20 22:46:15 +03:00
<refsect1>
<title>[DHCPServerStaticLease] Section Options</title>
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03: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>
network: dhcp-server: introduce [DHCPServerStaticLease] section
2020-10-20 22:46:15 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>MACAddress=</varname></term>
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03:00
<listitem><para>The hardware address of a device to match. This key is mandatory.</para></listitem>
network: dhcp-server: introduce [DHCPServerStaticLease] section
2020-10-20 22:46:15 +03:00
</varlistentry>
<varlistentry>
<term><varname>Address=</varname></term>
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 10:37:29 +03: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>
network: dhcp-server: introduce [DHCPServerStaticLease] section
2020-10-20 22:46:15 +03:00
</varlistentry>
</variablelist>
</refsect1>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<refsect1>
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Managed=</varname></term>
<term><varname>OtherInformation=</varname></term>
man: update explanation for boolean options
2018-11-27 09:07:58 +03: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>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
is set to <literal>true</literal> or if only additional network
information can be obtained via DHCPv6 for the network link when
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<varname>OtherInformation=</varname> is set to
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03: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>
network: make default router lifetime to 30min Closes #17527.
2020-11-09 10:29:32 +03:00
<listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. When set to
0, the host is not acting as a router. Defaults to 30 minutes.</para>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03: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>
network: introduce UplinkInterface= in [IPv6SendRA]
2021-06-15 21:51:57 +03: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>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<varlistentry>
man: Add EmitDNS= and EmitDomains= to the IPv6PrefixDelegation section
2017-09-29 20:48:07 +03:00
<term><varname>EmitDNS=</varname></term>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<term><varname>DNS=</varname></term>
network: introduce UplinkInterface= in [IPv6SendRA]
2021-06-15 21:51:57 +03: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>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
</varlistentry>
man: Document Domains for Router Advertisement network configuration
2017-09-07 12:24:00 +03:00
<varlistentry>
man: Add EmitDNS= and EmitDomains= to the IPv6PrefixDelegation section
2017-09-29 20:48:07 +03:00
<term><varname>EmitDomains=</varname></term>
man: Document Domains for Router Advertisement network configuration
2017-09-07 12:24:00 +03:00
<term><varname>Domains=</varname></term>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<listitem><para>A list of DNS search domains distributed via Router Advertisement messages when
network: introduce UplinkInterface= in [IPv6SendRA]
2021-06-15 21:51:57 +03: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>
man: Document Domains for Router Advertisement network configuration
2017-09-07 12:24:00 +03:00
</varlistentry>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<varlistentry>
<term><varname>DNSLifetimeSec=</varname></term>
network: radv: set non-zero lifetime for DNS servers and domains by default Closes #20850.
2021-09-28 05:44:27 +03: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
604800 seconds (one week).</para></listitem>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
</varlistentry>
</variablelist>
</refsect1>
network: Add support to advertie ipv6 route Implements https://tools.ietf.org/html/rfc4191 cat veth99.network ``` [Match] Name=veth99 [Network] DHCP=no IPv6PrefixDelegation=yes Address=2001:db8:0:1::1/64 [IPv6Prefix] Prefix=2001:db8:0:1::4/64 [IPv6RoutePrefix] Route=2001:db0:fff::/48 ``` Wireshark ``` Frame 481: 142 bytes on wire (1136 bits), 142 bytes captured (1136 bits) on interface 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01 (33:33:00:00:00:01) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1 Internet Control Message Protocol v6 Type: Router Advertisement (134) Code: 0 Checksum: 0xec77 [correct] [Checksum Status: Good] Cur hop limit: 0 Flags: 0x00, Prf (Default Router Preference): Medium Router lifetime (s): 0 Reachable time (ms): 0 Retrans timer (ms): 0 ICMPv6 Option (Source link-layer address : 1e:04:f8:b8:2f:d4) Type: Source link-layer address (1) Length: 1 (8 bytes) Link-layer address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) ICMPv6 Option (MTU : 1500) Type: MTU (5) Length: 1 (8 bytes) Reserved MTU: 1500 ICMPv6 Option (Prefix information : 2001:db8:0:1::4/64) Type: Prefix information (3) Length: 4 (32 bytes) Prefix Length: 64 Flag: 0xc0, On-link flag(L), Autonomous address-configuration flag(A) Valid Lifetime: 2592000 Preferred Lifetime: 604800 Reserved Prefix: 2001:db8:0:1::4 ICMPv6 Option (Route Information : Medium 2001:db0:fff::/48) Type: Route Information (24) Length: 3 (24 bytes) Prefix Length: 48 Flag: 0x00, Route Preference: Medium ...0 0... = Route Preference: Medium (0) 000. .000 = Reserved: 0 Route Lifetime: 604800 Prefix: 2001:db0:fff:: ```
2019-09-14 14:14:22 +03:00
<refsect1>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<title>[IPv6Prefix] Section Options</title>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>AddressAutoconfiguration=</varname></term>
<term><varname>OnLink=</varname></term>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<listitem><para>Takes a boolean to specify whether IPv6 addresses can be
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03: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>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
</varlistentry>
<varlistentry>
<term><varname>PreferredLifetimeSec=</varname></term>
<term><varname>ValidLifetimeSec=</varname></term>
<listitem><para>Preferred and valid lifetimes for the prefix measured in
seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800
seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults
to 2592000 seconds (30 days).</para></listitem>
network: Add support to advertie ipv6 route Implements https://tools.ietf.org/html/rfc4191 cat veth99.network ``` [Match] Name=veth99 [Network] DHCP=no IPv6PrefixDelegation=yes Address=2001:db8:0:1::1/64 [IPv6Prefix] Prefix=2001:db8:0:1::4/64 [IPv6RoutePrefix] Route=2001:db0:fff::/48 ``` Wireshark ``` Frame 481: 142 bytes on wire (1136 bits), 142 bytes captured (1136 bits) on interface 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01 (33:33:00:00:00:01) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1 Internet Control Message Protocol v6 Type: Router Advertisement (134) Code: 0 Checksum: 0xec77 [correct] [Checksum Status: Good] Cur hop limit: 0 Flags: 0x00, Prf (Default Router Preference): Medium Router lifetime (s): 0 Reachable time (ms): 0 Retrans timer (ms): 0 ICMPv6 Option (Source link-layer address : 1e:04:f8:b8:2f:d4) Type: Source link-layer address (1) Length: 1 (8 bytes) Link-layer address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) ICMPv6 Option (MTU : 1500) Type: MTU (5) Length: 1 (8 bytes) Reserved MTU: 1500 ICMPv6 Option (Prefix information : 2001:db8:0:1::4/64) Type: Prefix information (3) Length: 4 (32 bytes) Prefix Length: 64 Flag: 0xc0, On-link flag(L), Autonomous address-configuration flag(A) Valid Lifetime: 2592000 Preferred Lifetime: 604800 Reserved Prefix: 2001:db8:0:1::4 ICMPv6 Option (Route Information : Medium 2001:db0:fff::/48) Type: Route Information (24) Length: 3 (24 bytes) Prefix Length: 48 Flag: 0x00, Route Preference: Medium ...0 0... = Route Preference: Medium (0) 000. .000 = Reserved: 0 Route Lifetime: 604800 Prefix: 2001:db0:fff:: ```
2019-09-14 14:14:22 +03:00
</varlistentry>
network: introduce IPv6 prefix assign Expose a boolean flag to automatically add an address from the delegated prefix to the interface
2020-02-27 15:32:43 +03: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>
network: radv: add RouteMetric= setting in [IPv6Prefix]
2021-04-17 20:49:15 +03:00
network: introduce Token= setting in [IPv6Prefix] Closes #20149.
2021-09-24 22:12:31 +03: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>
network: radv: add RouteMetric= setting in [IPv6Prefix]
2021-04-17 20:49:15 +03: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>
network: Add support to advertie ipv6 route Implements https://tools.ietf.org/html/rfc4191 cat veth99.network ``` [Match] Name=veth99 [Network] DHCP=no IPv6PrefixDelegation=yes Address=2001:db8:0:1::1/64 [IPv6Prefix] Prefix=2001:db8:0:1::4/64 [IPv6RoutePrefix] Route=2001:db0:fff::/48 ``` Wireshark ``` Frame 481: 142 bytes on wire (1136 bits), 142 bytes captured (1136 bits) on interface 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01 (33:33:00:00:00:01) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1 Internet Control Message Protocol v6 Type: Router Advertisement (134) Code: 0 Checksum: 0xec77 [correct] [Checksum Status: Good] Cur hop limit: 0 Flags: 0x00, Prf (Default Router Preference): Medium Router lifetime (s): 0 Reachable time (ms): 0 Retrans timer (ms): 0 ICMPv6 Option (Source link-layer address : 1e:04:f8:b8:2f:d4) Type: Source link-layer address (1) Length: 1 (8 bytes) Link-layer address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) ICMPv6 Option (MTU : 1500) Type: MTU (5) Length: 1 (8 bytes) Reserved MTU: 1500 ICMPv6 Option (Prefix information : 2001:db8:0:1::4/64) Type: Prefix information (3) Length: 4 (32 bytes) Prefix Length: 64 Flag: 0xc0, On-link flag(L), Autonomous address-configuration flag(A) Valid Lifetime: 2592000 Preferred Lifetime: 604800 Reserved Prefix: 2001:db8:0:1::4 ICMPv6 Option (Route Information : Medium 2001:db0:fff::/48) Type: Route Information (24) Length: 3 (24 bytes) Prefix Length: 48 Flag: 0x00, Route Preference: Medium ...0 0... = Route Preference: Medium (0) 000. .000 = Reserved: 0 Route Lifetime: 604800 Prefix: 2001:db0:fff:: ```
2019-09-14 14:14:22 +03:00
</variablelist>
</refsect1>
<refsect1>
<title>[IPv6RoutePrefix] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>One or more [IPv6RoutePrefix] sections contain the IPv6
network: Add support to advertie ipv6 route Implements https://tools.ietf.org/html/rfc4191 cat veth99.network ``` [Match] Name=veth99 [Network] DHCP=no IPv6PrefixDelegation=yes Address=2001:db8:0:1::1/64 [IPv6Prefix] Prefix=2001:db8:0:1::4/64 [IPv6RoutePrefix] Route=2001:db0:fff::/48 ``` Wireshark ``` Frame 481: 142 bytes on wire (1136 bits), 142 bytes captured (1136 bits) on interface 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01 (33:33:00:00:00:01) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1 Internet Control Message Protocol v6 Type: Router Advertisement (134) Code: 0 Checksum: 0xec77 [correct] [Checksum Status: Good] Cur hop limit: 0 Flags: 0x00, Prf (Default Router Preference): Medium Router lifetime (s): 0 Reachable time (ms): 0 Retrans timer (ms): 0 ICMPv6 Option (Source link-layer address : 1e:04:f8:b8:2f:d4) Type: Source link-layer address (1) Length: 1 (8 bytes) Link-layer address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) ICMPv6 Option (MTU : 1500) Type: MTU (5) Length: 1 (8 bytes) Reserved MTU: 1500 ICMPv6 Option (Prefix information : 2001:db8:0:1::4/64) Type: Prefix information (3) Length: 4 (32 bytes) Prefix Length: 64 Flag: 0xc0, On-link flag(L), Autonomous address-configuration flag(A) Valid Lifetime: 2592000 Preferred Lifetime: 604800 Reserved Prefix: 2001:db8:0:1::4 ICMPv6 Option (Route Information : Medium 2001:db0:fff::/48) Type: Route Information (24) Length: 3 (24 bytes) Prefix Length: 48 Flag: 0x00, Route Preference: Medium ...0 0... = Route Preference: Medium (0) 000. .000 = Reserved: 0 Route Lifetime: 604800 Prefix: 2001:db0:fff:: ```
2019-09-14 14:14:22 +03: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>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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>
network: Add support to advertie ipv6 route Implements https://tools.ietf.org/html/rfc4191 cat veth99.network ``` [Match] Name=veth99 [Network] DHCP=no IPv6PrefixDelegation=yes Address=2001:db8:0:1::1/64 [IPv6Prefix] Prefix=2001:db8:0:1::4/64 [IPv6RoutePrefix] Route=2001:db0:fff::/48 ``` Wireshark ``` Frame 481: 142 bytes on wire (1136 bits), 142 bytes captured (1136 bits) on interface 0 Ethernet II, Src: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4), Dst: IPv6mcast_01 (33:33:00:00:00:01) Internet Protocol Version 6, Src: fe80::1c04:f8ff:feb8:2fd4, Dst: ff02::1 Internet Control Message Protocol v6 Type: Router Advertisement (134) Code: 0 Checksum: 0xec77 [correct] [Checksum Status: Good] Cur hop limit: 0 Flags: 0x00, Prf (Default Router Preference): Medium Router lifetime (s): 0 Reachable time (ms): 0 Retrans timer (ms): 0 ICMPv6 Option (Source link-layer address : 1e:04:f8:b8:2f:d4) Type: Source link-layer address (1) Length: 1 (8 bytes) Link-layer address: 1e:04:f8:b8:2f:d4 (1e:04:f8:b8:2f:d4) ICMPv6 Option (MTU : 1500) Type: MTU (5) Length: 1 (8 bytes) Reserved MTU: 1500 ICMPv6 Option (Prefix information : 2001:db8:0:1::4/64) Type: Prefix information (3) Length: 4 (32 bytes) Prefix Length: 64 Flag: 0xc0, On-link flag(L), Autonomous address-configuration flag(A) Valid Lifetime: 2592000 Preferred Lifetime: 604800 Reserved Prefix: 2001:db8:0:1::4 ICMPv6 Option (Route Information : Medium 2001:db0:fff::/48) Type: Route Information (24) Length: 3 (24 bytes) Prefix Length: 48 Flag: 0x00, Route Preference: Medium ...0 0... = Route Preference: Medium (0) 000. .000 = Reserved: 0 Route Lifetime: 604800 Prefix: 2001:db0:fff:: ```
2019-09-14 14:14:22 +03:00
</varlistentry>
<varlistentry>
<term><varname>LifetimeSec=</varname></term>
<listitem><para>Lifetime for the route prefix measured in
seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week).
</para></listitem>
man: Document prefix delegation in systemd.network Add prefix delegation documentation covering IPv6PrefixDelegation= setting in the Network section as well as all the parameters and the IPv6PrefixDelegation and IPv6Prefix sections implemented so far, including DNS= and DNSLifetimeSec= settings.
2017-09-06 14:20:08 +03:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<title>[Bridge] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [Bridge] section accepts the following keys:</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<variablelist class='network-directives'>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
<varlistentry>
<term><varname>UnicastFlood=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Controls whether the bridge should flood
networkd: turn UnicastFlood on by default Looking at the kernel commit, "on" seems to be the default value: commit 867a59436fc35593ae0e0efcd56cc6d2f8506586 Author: Vlad Yasevich <vyasevic@redhat.com> Date: Wed Jun 5 10:08:01 2013 -0400 bridge: Add a flag to control unicast packet flood. Add a flag to control flood of unicast traffic. By default, flood is on and the bridge will flood unicast traffic if it doesn't know the destination. When the flag is turned off, unicast traffic without an FDB will not be forwarded to the specified port. ... and it seems to be the reasonable thing to do by default.
2015-07-25 06:04:57 +03:00
traffic for which an FDB entry is missing and the destination
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
is unknown through this port. When unset, the kernel's default will be used.
man: reword new Bridge descriptions
2015-07-25 05:37:04 +03:00
</para>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
</listitem>
</varlistentry>
networkd: Add bridge port capabilities This PR adds the configuration switches for multicast flooding, neighbor suppression and learning of a bridge port.
2019-03-10 23:25:24 +03: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>
networkd: bridge add support to configure multicast_to_unicast closes #10649
2018-12-03 13:47:36 +03: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>
networkd: Add bridge port capabilities This PR adds the configuration switches for multicast flooding, neighbor suppression and learning of a bridge port.
2019-03-10 23:25:24 +03: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>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
<varlistentry>
<term><varname>HairPin=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
</listitem>
</varlistentry>
<varlistentry>
networkd: rename BPDUGuard to UseBPDU Rename to follow the follow the style of other options. In general "positive" options are preferred to "negative" ones, because they are easier to describe and easier for humans to parse (c.f. the shortening on the man page entry).
2015-07-25 05:52:26 +03:00
<term><varname>UseBPDU=</varname></term>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
processed by the bridge port. When unset, the kernel's default will be used.</para>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>FastLeave=</varname></term>
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. This flag allows the bridge to immediately stop multicast
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
traffic on a port that receives an IGMP Leave message. It is only used with
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
</listitem>
</varlistentry>
<varlistentry>
networkd: rename RootBlock to AllowPortToBeRoot Justification is similar to BPDUGuard rename. "Positive" values are easier. This is a rather uncommon option, so using a slightly longer name should not be a problem, and may in fact may make it easier to guess what the option does without reading the documentation.
2015-07-25 06:12:20 +03:00
<term><varname>AllowPortToBeRoot=</varname></term>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
<listitem>
man: update explanation for boolean options
2018-11-27 09:07:58 +03:00
<para>Takes a boolean. Configures whether a given port is allowed to
man: reword new Bridge descriptions
2015-07-25 05:37:04 +03:00
become a root port. Only used when STP is enabled on the bridge.
man: improve the explanation of "Defaults to unset"
2018-11-27 08:40:25 +03:00
When unset, the kernel's default will be used.</para>
man: add man for bridge params
2015-07-23 21:03:40 +03:00
</listitem>
</varlistentry>
networkd: Add support to configure proxy ARP and proxy ARP Wifi
2019-05-04 17:51:13 +03: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>
network: add support to configure proxy ARP/WIFI
2019-05-09 03:32:12 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>Cost=</varname></term>
<listitem>
man: reword new Bridge descriptions
2015-07-25 05:37:04 +03:00
<para>Sets the "cost" of sending packets of this interface.
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
Each port in a bridge may have a different speed and the cost
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
is used to decide which link to use. Faster interfaces
man: fix typos (#6532)
2017-08-04 00:36:21 +03:00
should have lower costs. It is an integer value between 1 and
networkd: Add bridge port priority setting (#5545) Allow setting bridge port priority in the Bridge section of the network file, similar to e.g. port path cost setting. Set the default to an invalid value of 128, and only set the port priority when it's not 128. Unlike e.g. path cost, zero is a valid priority value. Add a networkd-test.py to check that bridge port priority is correctly set. Incidently, fix bridge port cost type and document valid ranges.
2017-04-12 00:17:31 +03: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.
man: fix typos (#6532)
2017-08-04 00:36:21 +03:00
It is an integer value between 0 to 63. Networkd does not set any
networkd: Add bridge port priority setting (#5545) Allow setting bridge port priority in the Bridge section of the network file, similar to e.g. port path cost setting. Set the default to an invalid value of 128, and only set the port priority when it's not 128. Unlike e.g. path cost, zero is a valid priority value. Add a networkd-test.py to check that bridge port priority is correctly set. Incidently, fix bridge port cost type and document valid ranges.
2017-04-12 00:17:31 +03:00
default, meaning the kernel default value of 32 is used.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[BridgeFDB] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>MACAddress=</varname></term>
<listitem>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>As in the [Network] section. This key is mandatory.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</listitem>
</varlistentry>
networkd: Add support to configure destination address for bridge FDB Closes #5145. Example conf: ``` [Match] Name=vxlan1309 [BridgeFDB] MACAddress=00:00:00:00:00:00 Destination=10.0.0.2 [BridgeFDB] MACAddress=00:00:00:00:00:00 Destination=10.0.0.4 [BridgeFDB] MACAddress=00:00:00:00:00:00 Destination=10.0.0.5 ```
2019-04-30 12:23:39 +03:00
<varlistentry>
<term><varname>Destination=</varname></term>
<listitem>
<para>Takes an IP address of the destination VXLAN tunnel endpoint.</para>
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<varlistentry>
<term><varname>VLANId=</varname></term>
<listitem>
doc: correct orthography, word forms and missing/extraneous words
2014-08-03 09:11:37 +04:00
<para>The VLAN ID for the new static MAC table entry. If
man: convert info to information or informational
2017-12-04 15:05:18 +03:00
omitted, no VLAN ID information is appended to the new static MAC
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
table entry.</para>
</listitem>
</varlistentry>
networkd: bridge fdb add support to configure VXLAN VNI
2019-05-06 17:28:52 +03:00
<varlistentry>
<term><varname>VNI=</varname></term>
<listitem>
<para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215.
networkd: bridge fdb add support to configure VXLAN VNI
2019-05-06 17:28:52 +03:00
Defaults to unset.</para>
</listitem>
</varlistentry>
networkd: bridge FDB support more NTF_* flags Add support to configure NTF_ROUTER and NTF_USE
2019-05-08 17:13:21 +03: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>
network: bridge-fdb: add support to specify outgoing interface
2021-05-14 08:28:18 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</variablelist>
</refsect1>
man: document new Network.BridgeMDB config options
2020-09-09 15:14:44 +03: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>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03:00
LLDP: Add support to transmit MUD URL
2020-03-30 22:57:58 +03:00
<refsect1>
<title>[LLDP] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03:00
keys:</para>
LLDP: Add support to transmit MUD URL
2020-03-30 22:57:58 +03:00
<variablelist class='network-directives'>
<varlistentry>
<term><varname>MUDURL=</varname></term>
<listitem>
man/systemd.network(5): unify descriptions of MUDURL= Let's write one good description and refer to it from the other two spots.
2020-09-29 13:27:19 +03: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
LLDP: Add support to transmit MUD URL
2020-03-30 22:57:58 +03:00
<function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03:00
<refsect1>
<title>[CAN] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the
following keys:</para>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03: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
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
be used here. Takes a number in the range 1…4294967295.</para>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SamplePoint=</varname></term>
<listitem>
<para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>,
network: SamplePoint= should be specified only when BitRate= is specified See can_get_bittiming() in drivers/net/can/dev/bittiming.c of kernel.
2021-08-15 20:41:15 +03:00
<literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when
<varname>BitRate=</varname> is unspecified.</para>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03:00
</listitem>
</varlistentry>
network: can: allow to specify bit-timing with TimeQuantaNSec= and friends Closes #19424 and #20435.
2021-08-15 21:36:58 +03: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>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03:00
</listitem>
</varlistentry>
network: can: add support for CAN-FD related properties
2020-03-27 00:27:41 +03: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>
network: can: allow to specify bit-timing with TimeQuantaNSec= and friends Closes #19424 and #20435.
2021-08-15 21:36:58 +03: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>
network: can: add support for CAN-FD related properties
2020-03-27 00:27:41 +03: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
network: can: allow to specify bit-timing with TimeQuantaNSec= and friends Closes #19424 and #20435.
2021-08-15 21:36:58 +03:00
the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or
<varname>DataTimeQuanta=</varname> and related settings.</para>
network: can: add support for CAN-FD related properties
2020-03-27 00:27:41 +03: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>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03: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>
network: add CAN Termination tristate option
2020-02-12 05:13:45 +03:00
<varlistentry>
<term><varname>Termination=</varname></term>
<listitem>
network: can: make Termination= optionally take a raw resistor value Note that this slightly breaks backward compatibility when Termination=1. Previously, this is handled as boolean true, then 120 ohm was used. But now with this commit, it is handled as 1 ohm.
2021-08-15 20:16:53 +03:00
<para>Takes a boolean or a termination resistor value in ohm in the range 0–65535. When
<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>
network: add CAN Termination tristate option
2020-02-12 05:13:45 +03:00
</listitem>
</varlistentry>
network: introduce TripleSampling= option in CAN section When enabled, three samples are used to determine the value of a received bit by majority rule. This patch adds support for the TripleSampling= option in the [CAN] section of .network files.
2019-03-11 17:25:20 +03: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>
network: can: add support for bus error reporting Enhance systemd-networkd to be able to control a CAN device's berr-reporting flag via the new boolean directive BusErrorReporting= to be used in network files.
2021-01-05 20:53:44 +03: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>
network: can: add support for listen-only mode Closes #15129.
2020-03-16 07:40:30 +03: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>
network: can: add missing control modes
2021-08-15 19:53:26 +03: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>
networkd-link: add support to configure CAN interfaces This patch adds support for kind "can". Fixes: #4042.
2018-04-10 18:26:20 +03:00
</variablelist>
</refsect1>
network: introduce new [QDisc] section to support Parent=ingress Follow-up for 18de0969c5763ce119692b59f8622c379e79c6cc.
2020-02-05 13:10:33 +03:00
<refsect1>
<title>[QDisc] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para>
network: introduce new [QDisc] section to support Parent=ingress Follow-up for 18de0969c5763ce119692b59f8622c379e79c6cc.
2020-02-05 13:10:33 +03: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>
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: introduce new [QDisc] section to support Parent=ingress Follow-up for 18de0969c5763ce119692b59f8622c379e79c6cc.
2020-02-05 13:10:33 +03:00
</variablelist>
</refsect1>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03:00
<refsect1>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<title>[NetworkEmulator] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>DelaySec=</varname></term>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>DelayJitterSec=</varname></term>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>PacketLimit=</varname></term>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03:00
<listitem>
<para>Specifies the maximum number of packets the qdisc may hold queued at a time.
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
An unsigned integer in the range 0–4294967294. Defaults to 1000.</para>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03:00
</listitem>
</varlistentry>
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>LossRate=</varname></term>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03: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>
qdisc: netem add support to duplicate packets. using this option the chosen percent of packets is duplicated before queuing them
2019-10-30 20:58:02 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>DuplicateRate=</varname></term>
qdisc: netem add support to duplicate packets. using this option the chosen percent of packets is duplicated before queuing them
2019-10-30 20:58:02 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
</variablelist>
</refsect1>
qdisc: netem add support to duplicate packets. using this option the chosen percent of packets is duplicated before queuing them
2019-10-30 20:58:02 +03:00
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<refsect1>
network: TokenBufferFilter→TokenBucketFilter This never made into a release, so we can change the name with impunity. Noticed by Davide Pesavento.
2020-02-04 19:22:41 +03:00
<title>[TokenBucketFilter] Section Options</title>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter
(tbf).</para>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<varlistentry>
<term><varname>LatencySec=</varname></term>
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03:00
<listitem>
<para>Specifies the latency parameter, which specifies the maximum amount of time a
network: TokenBufferFilter→TokenBucketFilter This never made into a release, so we can change the name with impunity. Noticed by Davide Pesavento.
2020-02-04 19:22:41 +03:00
packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para>
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03:00
</listitem>
</varlistentry>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>LimitBytes=</varname></term>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03: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,
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
respectively, to the base of 1024. Defaults to unset.</para>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
</listitem>
</varlistentry>
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03:00
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>BurstBytes=</varname></term>
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03: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
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03:00
unset.</para>
</listitem>
</varlistentry>
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>Rate=</varname></term>
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03:00
<listitem>
<para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified
man: XxxRate= are in bps
2020-01-12 10:01:25 +03:00
bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000.
networkd tc: introduce tbf See https://linux.die.net/man/8/tc-tbf
2019-11-17 09:30:03 +03:00
Defaults to unset.</para>
</listitem>
</varlistentry>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>MPUBytes=</varname></term>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03: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,
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
</listitem>
</varlistentry>
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>PeakRate=</varname></term>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
<listitem>
<para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the
man: XxxRate= are in bps
2020-01-12 10:01:25 +03:00
specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
1000. Defaults to unset.</para>
</listitem>
</varlistentry>
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>MTUBytes=</varname></term>
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
<listitem>
<para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.
network: tc: add more options for TBF
2019-12-07 23:54:33 +03:00
Defaults to unset.</para>
</listitem>
</varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
</variablelist>
</refsect1>
network: tc- introduce PIE Proportional Integral controller-Enhanced (PIE) is a control theoretic active queue management scheme. It is based on the proportional integral controller but aims to control delay. http://man7.org/linux/man-pages/man8/tc-pie.8.html
2020-03-09 12:48:03 +03:00
<refsect1>
<title>[PIE] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral
controller-Enhanced (PIE).</para>
network: tc- introduce PIE Proportional Integral controller-Enhanced (PIE) is a control theoretic active queue management scheme. It is based on the proportional integral controller but aims to control delay. http://man7.org/linux/man-pages/man8/tc-pie.8.html
2020-03-09 12:48:03 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: tc- introduce PIE Proportional Integral controller-Enhanced (PIE) is a control theoretic active queue management scheme. It is based on the proportional integral controller but aims to control delay. http://man7.org/linux/man-pages/man8/tc-pie.8.html
2020-03-09 12:48:03 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
<listitem>
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03: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>
network: TC - introduce fq pie see https://patchwork.ozlabs.org/patch/1233253/
2020-03-09 16:03:49 +03: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>
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03: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>
network: tc- introduce PIE Proportional Integral controller-Enhanced (PIE) is a control theoretic active queue management scheme. It is based on the proportional integral controller but aims to control delay. http://man7.org/linux/man-pages/man8/tc-pie.8.html
2020-03-09 12:48:03 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
network: TC introduce sfb - Stochastic Fair Blue Please see https://www.systutorials.com/docs/linux/man/8-tc-sfb/
2020-02-11 10:24:27 +03:00
<refsect1>
<title>[StochasticFairBlue] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue
(sfb).</para>
network: TC introduce sfb - Stochastic Fair Blue Please see https://www.systutorials.com/docs/linux/man/8-tc-sfb/
2020-02-11 10:24:27 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC introduce sfb - Stochastic Fair Blue Please see https://www.systutorials.com/docs/linux/man/8-tc-sfb/
2020-02-11 10:24:27 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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 0–4294967294. Defaults to unset and
kernel's default is used.</para>
network: TC introduce sfb - Stochastic Fair Blue Please see https://www.systutorials.com/docs/linux/man/8-tc-sfb/
2020-02-11 10:24:27 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<refsect1>
<title>[StochasticFairnessQueueing] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic
fairness queueing (sfq).</para>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network: tc introduce sfq - Stochastic Fairness Queueing Stochastic Fairness Queueing is a classless queueing discipline. SFQ does not shape traffic but only schedules the transmission of packets, based on 'flows'. The goal is to ensure fairness so that each flow is able to send data in turn, thus preventing any single flow from drowning out the rest.
2019-11-27 14:42:21 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>PerturbPeriodSec=</varname></term>
network: tc introduce sfq - Stochastic Fairness Queueing Stochastic Fairness Queueing is a classless queueing discipline. SFQ does not shape traffic but only schedules the transmission of packets, based on 'flows'. The goal is to ensure fairness so that each flow is able to send data in turn, thus preventing any single flow from drowning out the rest.
2019-11-27 14:42:21 +03:00
<listitem>
<para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para>
</listitem>
</varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
</variablelist>
</refsect1>
network: TC - introduce BFIFO bfifo - Byte limited First In, First Out queue
2020-03-10 14:53:32 +03:00
<refsect1>
<title>[BFIFO] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First
Out (bfifo).</para>
network: TC - introduce BFIFO bfifo - Byte limited First In, First Out queue
2020-03-10 14:53:32 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC - introduce BFIFO bfifo - Byte limited First In, First Out queue
2020-03-10 14:53:32 +03:00
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>LimitBytes=</varname></term>
network: TC - introduce BFIFO bfifo - Byte limited First In, First Out queue
2020-03-10 14:53:32 +03:00
<listitem>
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03: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>
network: TC - introduce BFIFO bfifo - Byte limited First In, First Out queue
2020-03-10 14:53:32 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
network: TC introduce PFIFO
2020-02-10 18:12:21 +03:00
<refsect1>
<title>[PFIFO] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out
(pfifo).</para>
network: TC introduce PFIFO
2020-02-10 18:12:21 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC introduce PFIFO
2020-02-10 18:12:21 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
<listitem>
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03: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
0–4294967294. Defaults to unset and kernel's default is used.</para>
network: TC introduce PFIFO
2020-02-10 18:12:21 +03:00
</listitem>
</varlistentry>
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
</variablelist>
</refsect1>
network: TC - introduce pfifo_head_drop This adds the required changes to gain access to the head drop classfull queuing discipline named pfifo_head_drop.
2020-03-10 15:19:56 +03:00
<refsect1>
<title>[PFIFOHeadDrop] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out
Head Drop (pfifo_head_drop).</para>
network: TC - introduce pfifo_head_drop This adds the required changes to gain access to the head drop classfull queuing discipline named pfifo_head_drop.
2020-03-10 15:19:56 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC - introduce pfifo_head_drop This adds the required changes to gain access to the head drop classfull queuing discipline named pfifo_head_drop.
2020-03-10 15:19:56 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
<listitem>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>As in [PFIFO] section.</para></listitem>
network: TC - introduce pfifo_head_drop This adds the required changes to gain access to the head drop classfull queuing discipline named pfifo_head_drop.
2020-03-10 15:19:56 +03:00
</varlistentry>
</variablelist>
</refsect1>
network: TC - introduce pfifo_fast pfifo_fast - three-band first in, first out queue Please see https://linux.die.net/man/8/tc-pfifo_fast
2020-03-11 13:02:20 +03:00
<refsect1>
<title>[PFIFOFast] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast
(pfifo_fast).</para>
network: TC - introduce pfifo_fast pfifo_fast - three-band first in, first out queue Please see https://linux.die.net/man/8/tc-pfifo_fast
2020-03-11 13:02:20 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC - introduce pfifo_fast pfifo_fast - three-band first in, first out queue Please see https://linux.die.net/man/8/tc-pfifo_fast
2020-03-11 13:02:20 +03:00
</variablelist>
</refsect1>
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
<refsect1>
<title>[CAKE] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced
(CAKE).</para>
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC introduce PFIFO
2020-02-10 18:12:21 +03:00
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>OverheadBytes=</varname></term>
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. Takes
an integer in the range from -64 to 256. Defaults to unset and kernel's default is used.</para>
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
</listitem>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
</varlistentry>
network: tc: introduce cake CAKE (Common Applications Kept Enhanced) Please see http://man7.org/linux/man-pages/man8/tc-cake.8.html
2020-03-02 09:54:17 +03:00
<varlistentry>
<term><varname>Bandwidth=</varname></term>
<listitem>
<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>
</listitem>
</varlistentry>
network: TC introduce PFIFO
2020-02-10 18:12:21 +03:00
</variablelist>
</refsect1>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<refsect1>
<title>[ControlledDelay] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [ControlledDelay] section manages the queueing discipline (qdisc) of
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
controlled delay (CoDel).</para>
network: tc introduce sfq - Stochastic Fairness Queueing Stochastic Fairness Queueing is a classless queueing discipline. SFQ does not shape traffic but only schedules the transmission of packets, based on 'flows'. The goal is to ensure fairness so that each flow is able to send data in turn, thus preventing any single flow from drowning out the rest.
2019-11-27 14:42:21 +03:00
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
network: tc introduce codel Please see http://man7.org/linux/man-pages/man8/tc-codel.8.html
2019-12-21 22:18:09 +03:00
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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 0–4294967294. Defaults to unset and
kernel's default is used.</para>
network: tc introduce codel Please see http://man7.org/linux/man-pages/man8/tc-codel.8.html
2019-12-21 22:18:09 +03:00
</listitem>
</varlistentry>
network: add more settings for CoDel
2019-12-28 16:07:24 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>TargetSec=</varname></term>
network: add more settings for CoDel
2019-12-28 16:07:24 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>IntervalSec=</varname></term>
network: add more settings for CoDel
2019-12-28 16:07:24 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>ECN=</varname></term>
network: add more settings for CoDel
2019-12-28 16:07:24 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>CEThresholdSec=</varname></term>
network: add more settings for CoDel
2019-12-28 16:07:24 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
</variablelist>
</refsect1>
network: add more settings for CoDel
2019-12-28 16:07:24 +03:00
network: TC - introduce DRR Introduce the Deficit Round Robin Scheduler is a classful queuing discipline as a more flexible replacement for Stochastic Fairness Queuing. http://man7.org/linux/man-pages/man8/tc-drr.8.html
2020-03-10 10:46:40 +03:00
<refsect1>
<title>[DeficitRoundRobinScheduler] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round
Robin Scheduler (DRR).</para>
network: TC - introduce DRR Introduce the Deficit Round Robin Scheduler is a classful queuing discipline as a more flexible replacement for Stochastic Fairness Queuing. http://man7.org/linux/man-pages/man8/tc-drr.8.html
2020-03-10 10:46:40 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC - introduce DRR Introduce the Deficit Round Robin Scheduler is a classful queuing discipline as a more flexible replacement for Stochastic Fairness Queuing. http://man7.org/linux/man-pages/man8/tc-drr.8.html
2020-03-10 10:46:40 +03:00
</variablelist>
</refsect1>
network: tc: introduce DRR class
2020-03-11 18:36:08 +03:00
<refsect1>
<title>[DeficitRoundRobinSchedulerClass] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round
Robin Scheduler (DRR).</para>
network: tc: introduce DRR class
2020-03-11 18:36:08 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="tclass-parent" />
<xi:include href="tc.xml" xpointer="tclass-classid" />
network: tc: introduce DRR class
2020-03-11 18:36:08 +03:00
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>QuantumBytes=</varname></term>
network: tc: introduce DRR class
2020-03-11 18:36:08 +03:00
<listitem>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03: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>
network: tc: introduce DRR class
2020-03-11 18:36:08 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
network: tc: introduce Enhanced Transmission Selection (ETS) Closes #15264.
2020-06-09 11:23:11 +03:00
<refsect1>
<title>[EnhancedTransmissionSelection] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced
Transmission Selection (ETS).</para>
network: tc: introduce Enhanced Transmission Selection (ETS) Closes #15264.
2020-06-09 11:23:11 +03: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>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>Specifies the number of bands. An unsigned integer in the range 1–16. This value has to be at
least large enough to cover the strict bands specified through the <varname>StrictBands=</varname>
and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para>
network: tc: introduce Enhanced Transmission Selection (ETS) Closes #15264.
2020-06-09 11:23:11 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>StrictBands=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>Specifies the number of bands that should be created in strict mode. An unsigned integer in
the range 1–16.</para>
network: tc: introduce Enhanced Transmission Selection (ETS) Closes #15264.
2020-06-09 11:23:11 +03: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>
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03: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
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
the last one. Each band number must be in the range 0…255. This setting can be specified multiple
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03:00
times. If an empty string is assigned, then the all previous assignments are cleared.</para>
network: tc: introduce Enhanced Transmission Selection (ETS) Closes #15264.
2020-06-09 11:23:11 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
network: TC introduce GRED, Generic Random Early Detection http://tldp.org/en/Traffic-Control-HOWTO/ar01s06.html
2020-02-10 15:24:02 +03:00
<refsect1>
<title>[GenericRandomEarlyDetection] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random
Early Detection (GRED).</para>
network: TC introduce GRED, Generic Random Early Detection http://tldp.org/en/Traffic-Control-HOWTO/ar01s06.html
2020-02-10 15:24:02 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: TC introduce GRED, Generic Random Early Detection http://tldp.org/en/Traffic-Control-HOWTO/ar01s06.html
2020-02-10 15:24:02 +03:00
<varlistentry>
<term><varname>VirtualQueues=</varname></term>
<listitem>
tree-wide: "a" -> "an"
2021-06-30 15:26:47 +03:00
<para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
and kernel's default is used.</para>
network: TC introduce GRED, Generic Random Early Detection http://tldp.org/en/Traffic-Control-HOWTO/ar01s06.html
2020-02-10 15:24:02 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<refsect1>
<title>[FairQueueingControlledDelay] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing
controlled delay (FQ-CoDel).</para>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
network tc: Add support to conkfigure CoDel - Controlled-Delay Active Queue Management algorithm ``` $ tc qdisc show dev dummy99 qdisc fq_codel 8005: dev dummy99 root refcnt 2 limit 1000p flows 1024 quantum 1514 target 5.0ms interval 100.0ms memory_limit 32Mb ecn $ network cat dumm99.network [Match] Name=dummy99 [TrafficControlQueueingDiscipline] Parent=root FairQueuingControlledDelayPacketLimit=1000 ```
2019-12-07 22:48:18 +03: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>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03:00
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>MemoryLimitBytes=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>Flows=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>TargetSec=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>IntervalSec=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>QuantumBytes=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03:00
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03:00
<para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan.
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>ECN=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>CEThresholdSec=</varname></term>
network: tc: support more attributes for FQ-CoDel
2019-12-12 11:25:29 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
</variablelist>
</refsect1>
<refsect1>
network: FairQueueTrafficPolicing→FairQueueing This never made into a release, so we can change the name with impunity. Suggested by Davide Pesavento. I opted to add the "ing" ending. "Fair queuing" is the name of the general concept and algorithm, and "Fair queue" is mostly used for the implementation name.
2020-02-04 19:35:12 +03:00
<title>[FairQueueing] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing
(FQ).</para>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network tc: inroduce FQ - Fair Queue traffic policing Please see http://man7.org/linux/man-pages/man8/tc-fq.8.html
2019-12-11 12:52:51 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>PacketLimit=</varname></term>
network tc: inroduce FQ - Fair Queue traffic policing Please see http://man7.org/linux/man-pages/man8/tc-fq.8.html
2019-12-11 12:52:51 +03: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>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03:00
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>FlowLimit=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>QuantumBytes=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>InitialQuantumBytes=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>MaximumRate=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03:00
<listitem>
<para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the
man: XxxRate= are in bps
2020-01-12 10:01:25 +03:00
specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03:00
1000. Defaults to unset and kernel's default is used.</para>
</listitem>
</varlistentry>
<varlistentry>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>Buckets=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>OrphanMask=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>Pacing=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: split TrafficControlQueueingDiscipline section into small pieces Closes #14763.
2020-02-04 15:45:29 +03:00
<term><varname>CEThresholdSec=</varname></term>
network: tc: add more settings for FQ
2019-12-13 14:55:33 +03: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>
network: introduce TrafficControl Add network delay to a interface
2019-10-07 17:19:00 +03:00
</variablelist>
</refsect1>
network: tc: support teql Closes #14792.
2020-02-06 11:52:24 +03:00
<refsect1>
<title>[TrivialLinkEqualizer] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link
equalizer (teql).</para>
network: tc: support teql Closes #14792.
2020-02-06 11:52:24 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: add support for qdisc handle
2020-02-10 10:05:35 +03:00
network: tc: support teql Closes #14792.
2020-02-06 11:52:24 +03: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>
network: tc: support Hierarchy Token Bucket (HTB)
2020-02-10 13:41:12 +03:00
<refsect1>
<title>[HierarchyTokenBucket] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token
bucket (htb).</para>
network: tc: support Hierarchy Token Bucket (HTB)
2020-02-10 13:41:12 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: tc: support Hierarchy Token Bucket (HTB)
2020-02-10 13:41:12 +03: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>
network: tc: add more settings for HTB Closes #15213.
2020-06-08 11:36:52 +03: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>
network: tc: support Hierarchy Token Bucket (HTB)
2020-02-10 13:41:12 +03:00
</variablelist>
</refsect1>
network: tc: support HTB class
2020-02-12 03:52:56 +03:00
<refsect1>
<title>[HierarchyTokenBucketClass] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket
(htb).</para>
network: tc: support HTB class
2020-02-12 03:52:56 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="tclass-parent" />
<xi:include href="tc.xml" xpointer="tclass-classid" />
network: tc: support HTB class
2020-02-12 03:52:56 +03:00
<varlistentry>
<term><varname>Priority=</varname></term>
<listitem>
<para>Specifies the priority of the class. In the round-robin process, classes with the lowest
network: tc: add more settings for HTB Closes #15213.
2020-06-08 11:36:52 +03: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>
network: tc: support HTB class
2020-02-12 03:52:56 +03: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>
network: tc: add more settings for HTB Closes #15213.
2020-06-08 11:36:52 +03: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>
network: TC - introduce HHF Please see https://lwn.net/Articles/577208/
2020-03-11 13:55:13 +03:00
</variablelist>
</refsect1>
<refsect1>
<title>[HeavyHitterFilter] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter
(hhf).</para>
network: TC - introduce HHF Please see https://lwn.net/Articles/577208/
2020-03-11 13:55:13 +03:00
<variablelist class='network-directives'>
man: use include directive for Parent= or friends
2020-03-12 12:33:15 +03:00
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
network: tc: support HTB class
2020-02-12 03:52:56 +03:00
network: TC - introduce HHF Please see https://lwn.net/Articles/577208/
2020-03-11 13:55:13 +03:00
<varlistentry>
<term><varname>PacketLimit=</varname></term>
<listitem>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 11:49:59 +03: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 0–4294967294. Defaults to unset and
kernel's default is used.</para>
network: TC - introduce HHF Please see https://lwn.net/Articles/577208/
2020-03-11 13:55:13 +03:00
</listitem>
</varlistentry>
network: tc: support HTB class
2020-02-12 03:52:56 +03:00
</variablelist>
</refsect1>
network: tc: introduce Quick Fair Queueing (QFQ)
2020-03-20 00:41:57 +03:00
<refsect1>
<title>[QuickFairQueueing] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing
(QFQ).</para>
network: tc: introduce Quick Fair Queueing (QFQ)
2020-03-20 00:41:57 +03:00
<variablelist class='network-directives'>
<xi:include href="tc.xml" xpointer="qdisc-parent" />
<xi:include href="tc.xml" xpointer="qdisc-handle" />
</variablelist>
</refsect1>
network: tc: introduce [QuickFairQueueingClass] section
2020-06-03 09:07:45 +03:00
<refsect1>
<title>[QuickFairQueueingClass] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03:00
<para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing
(qfq).</para>
network: tc: introduce [QuickFairQueueingClass] section
2020-06-03 09:07:45 +03: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>
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-28 22:42:37 +03:00
<para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to
network: tc: introduce [QuickFairQueueingClass] section
2020-06-03 09:07:45 +03:00
unset in which case the kernel default is used.</para>
</listitem>
</varlistentry>
<varlistentry>
network: tc: rename several settings which take size in bytes
2020-07-01 10:05:32 +03:00
<term><varname>MaxPacketBytes=</varname></term>
network: tc: introduce [QuickFairQueueingClass] section
2020-06-03 09:07:45 +03:00
<listitem>
man: various typos and other small issues Fixes #18397.
2021-01-28 22:38:27 +03: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>
network: tc: introduce [QuickFairQueueingClass] section
2020-06-03 09:07:45 +03:00
</listitem>
</varlistentry>
</variablelist>
</refsect1>
networkd: add support to configure VLAN on bridge ports
2016-06-01 16:18:21 +03:00
<refsect1>
<title>[BridgeVLAN] Section Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 12:00:06 +03: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
networkd: add support to configure VLAN on bridge ports
2016-06-01 16:18:21 +03:00
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>VLAN=</varname></term>
<listitem>
<para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid
from 1 to 4094.</para>
</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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<refsect1>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title>Examples</title>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title>Static network configuration</title>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/50-static.network
[Match]
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
Name=enp2s0
[Network]
Address=192.168.0.15/24
Gateway=192.168.0.1</programlisting>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<para>This brings interface <literal>enp2s0</literal> up with a static address. The
specified gateway will be used for a default route.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</example>
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title>DHCP on ethernet links</title>
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/80-dhcp.network
[Match]
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
Name=en*
[Network]
man: update example 2 in systemd.network(5) none/both/v4/v6 are deprecated in favour of no/yes/ipv4/ipv6. https://bugs.freedesktop.org/show_bug.cgi?id=89221
2015-03-13 07:25:31 +03:00
DHCP=yes</programlisting>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with
<literal>en</literal> (i.e. ethernet interfaces).</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</example>
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
man: add example for IPv6 Prefix Delegation
2019-08-09 13:09:26 +03: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]
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03:00
IPv6SendRA=yes
DHCPv6PrefixDelegation=yes</programlisting>
man: add example for IPv6 Prefix Delegation
2019-08-09 13:09:26 +03:00
man: update documents about IPv6 RA and DHCPv6-PD
2020-10-19 06:48:39 +03: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>
man: add example for IPv6 Prefix Delegation
2019-08-09 13:09:26 +03:00
</example>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title>A bridge with two enslaved links</title>
man: networkd - additional examples related to bridging
2014-03-18 00:08:40 +04:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/25-bridge-static.network
[Match]
man: networkd - additional examples related to bridging
2014-03-18 00:08:40 +04:00
Name=bridge0
[Network]
Address=192.168.0.15/24
Gateway=192.168.0.1
DNS=192.168.0.1</programlisting>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network
[Match]
man: networkd - additional examples related to bridging
2014-03-18 00:08:40 +04:00
Name=enp2s0
[Network]
Bridge=bridge0</programlisting>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03: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>
networkd: add support to configure VLAN on bridge ports
2016-06-01 16:18:21 +03:00
</example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
networkd: add support to configure VLAN on bridge ports
2016-06-01 16:18:21 +03:00
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title></title>
networkd: add support to configure VLAN on bridge ports
2016-06-01 16:18:21 +03:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting>
# /etc/systemd/network/20-bridge-slave-interface-vlan.network
[Match]
networkd: add support to configure VLAN on bridge ports
2016-06-01 16:18:21 +03:00
Name=enp2s0
[Network]
Bridge=bridge0
[BridgeVLAN]
VLAN=1-32
PVID=42
EgressUntagged=42
[BridgeVLAN]
VLAN=100-200
[BridgeVLAN]
EgressUntagged=300-400</programlisting>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</example>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title>Various tunnels</title>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting>/etc/systemd/network/25-tunnels.network
[Match]
Name=ens1
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
[Network]
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</example>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<title>A bond device</title>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/30-bond1.network
[Match]
Name=bond1
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
[Network]
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
DHCP=ipv6
</programlisting>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/30-bond1.netdev
[NetDev]
Name=bond1
Kind=bond
</programlisting>
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
man: fix typos (#5109)
2017-01-19 18:54:22 +03:00
<programlisting># /etc/systemd/network/30-bond1-dev1.network
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
[Match]
MACAddress=52:54:00:e9:64:41
man: bring systemd.network(5) up-to-date Based on diff by 'poma'.
2014-07-01 23:49:28 +04:00
[Network]
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
Bond=bond1
</programlisting>
Adding bonding examples for systemd-networkd This commit provides some basic bonding configuration examples for .netdev and .network files.
2015-08-21 06:14:49 +03:00
man: fix typos (#5109)
2017-01-19 18:54:22 +03:00
<programlisting># /etc/systemd/network/30-bond1-dev2.network
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
[Match]
MACAddress=52:54:00:e9:64:42
Adding bonding examples for systemd-networkd This commit provides some basic bonding configuration examples for .netdev and .network files.
2015-08-21 06:14:49 +03:00
[Network]
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
Bond=bond1
networkd: vrf: add support for enslaving devices to VRFs
2016-06-13 02:05:49 +03:00
</programlisting>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03: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>
networkd: vrf: add support for enslaving devices to VRFs
2016-06-13 02:05:49 +03:00
</example>
<example>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03: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
man/systemd.network: Updated documentation about VRF traffic redirection Starting with kernel version 4.8 the kernel has a single `l3mdev` rule that handles this. This rule will be created when the first VRF device is added.
2017-09-27 02:54:20 +03: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>
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
<programlisting># /etc/systemd/network/25-vrf.network
[Match]
networkd: vrf: add support for enslaving devices to VRFs
2016-06-13 02:05:49 +03:00
Name=bond1
[Network]
man: make the examples in systemd.network(5) more useful We shouldn't just have snippets of configuration, but instead examples which show all the parts necessary to build a certain kind of setup, with short explanations.
2016-12-02 22:00:46 +03:00
VRF=vrf1
Adding bonding examples for systemd-networkd This commit provides some basic bonding configuration examples for .netdev and .network files.
2015-08-21 06:14:49 +03:00
</programlisting>
</example>
networkd: Add example to create MACVTAP and attach it to a link (#4946) Fixes: #4914
2016-12-23 20:09:29 +03:00
<example>
<title>MacVTap</title>
<para>This brings up a network interface <literal>macvtap-test</literal>
and attaches it to <literal>enp0s25</literal>.</para>
man: change /lib to /usr/lib (#5618) Per man:file-hierarchy(7), /lib is just a compatibility symlink; the other manpages also refer to /usr/lib. Found with: git grep -P '(?<!/usr|/var|local)/lib' man/
2017-03-21 03:32:23 +03:00
<programlisting># /usr/lib/systemd/network/25-macvtap.network
networkd: Add example to create MACVTAP and attach it to a link (#4946) Fixes: #4914
2016-12-23 20:09:29 +03:00
[Match]
Name=enp0s25
[Network]
MACVTAP=macvtap-test
</programlisting>
</example>
Added support for xfrm interfaces
2019-07-08 18:09:46 +03: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>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: document that DNS= and Domains= is implemented by resolved
2016-01-05 19:40:51 +03:00
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
networkd,resolved: add a per-interface mdns configuration option
2016-01-05 19:32:25 +03:00
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</para>
</refsect1>
man: split out systemd.net{work,dev}(5) from systemd-networkd(8)
2014-02-25 22:30:40 +04:00
</refentry>
Copy Permalink