HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/systemd.network.xml
Git blob: e2c51fab906918295d81d99c105f64e31fc8a207
Lines 1001–2000 of 7,055
<xi:include href="version-info.xml" xpointer="v231"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv6DuplicateAddressDetection=</varname></term>
<listitem>
<para>Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send. When
unset, the kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v228"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv6HopLimit=</varname></term>
<listitem>
<para>Configures IPv6 Hop Limit. Takes an integer in the range 1…255. 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. When unset, the kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v228"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv6RetransmissionTimeSec=</varname></term>
<listitem>
<para>Configures IPv6 Retransmission Time. The time between retransmitted Neighbor
Solicitation messages. Used by address resolution and the Neighbor Unreachability
Detection algorithm. A value of zero is ignored and the kernel's current value
will be used. Defaults to unset, and the kernel's current value will be used.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv4DuplicateAddressDetectionTimeoutSec=</varname></term>
<listitem>
<para>Configures the maximum timeout for IPv4 Duplicate Address Detection (RFC 5227). Must be a
value between 1 millisecond and 60 seconds. If set, Duplicate Address Detection takes a randomized
time between 57% (4/7) and 100% of the given value. If unset, defaults to 200 milliseconds.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv4ReversePathFilter=</varname></term>
<listitem>
<para>Configure IPv4 Reverse Path Filtering. If enabled, when an IPv4 packet is received, the machine will first check
whether the <emphasis>source</emphasis> of the packet would be routed through the interface it came in. If there is no
route to the source on that interface, the machine will drop the packet. Takes one of
<literal>no</literal>, <literal>strict</literal>, or <literal>loose</literal>. When <literal>no</literal>,
no source validation will be done. When <literal>strict</literal>, each incoming packet is tested against the FIB and
if the incoming interface is not the best reverse path, the packet check will fail. By default, failed packets are discarded.
When <literal>loose</literal>, each incoming packet's source address is tested against the FIB. The packet is dropped
only if the source address is not reachable via any interface on that router.
See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 3704</ulink>.
When unset, the kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>MulticastIGMPVersion=</varname></term>
<listitem>
<para>Configures IPv4 Multicast IGMP Version to be used, and controls the value of
<filename>/proc/sys/net/ipv4/conf/<replaceable>INTERFACE</replaceable>/force_igmp_version</filename>.
Takes one of <literal>no</literal>,
<literal>v1</literal>, <literal>v2</literal>, or <literal>v3</literal>.
When <literal>no</literal>, no enforcement of an IGMP version is applied. IGMPv1/v2 fallbacks are allowed, and
<command>systemd-networkd</command> will return to
IGMPv3 mode after all IGMPv1/v2 Querier Present timers have expired.
When <literal>v1</literal>, use of IGMP version 1 is enforced. An IGMPv1 report will be returned even if IGMPv2/v3
queries are received.
When <literal>v2</literal>, use of IGMP version 2 is enforced. An IGMPv2 report will be returned if an IGMPv2/v3 query
is received. <command>systemd-networkd</command> will fall back to IGMPv1 if an IGMPv1 query is received.
When <literal>v3</literal>, use of IGMP version 3 is enforced, and the response is the same as with <literal>no</literal>.
Defaults to unset — the sysctl is not set.
</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv4SrcValidMark=</varname></term>
<listitem>
<para>Takes a boolean. When enabled, the packet's firewall mark (fwmark) is included in the
reverse path filter route lookup for source address validation on this interface. This is
particularly useful for policy routing setups where packets may arrive with source addresses
that are only valid in routing tables selected by their fwmark. When unset, the kernel's
default will be used.</para>
<xi:include href="version-info.xml" xpointer="v261"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv4ProxyARP=</varname></term>
<listitem>
<para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one
host, usually a router, answers ARP requests intended for another machine. By "faking" its
identity, the router accepts responsibility for routing packets to the "real" destination.
See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. When unset, the
kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v233"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv4ProxyARPPrivateVLAN=</varname></term>
<listitem>
<para>Takes a boolean. Configures proxy ARP private VLAN for IPv4, also known as VLAN aggregation,
private VLAN, source-port filtering, port-isolation, or MAC-forced forwarding.</para>
<para>This variant of the ARP proxy technique will allow the ARP proxy to reply back to the same
interface.</para>
<para>See <ulink url="https://tools.ietf.org/html/rfc3069">RFC 3069</ulink>. When unset,
the kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv6ProxyNDP=</varname></term>
<listitem>
<para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery 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. In this case, a router answers Neighbour
Advertisement messages intended for another machine by offering its own MAC address as
destination. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send
Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can
also be shown by <command>ip -6 neighbour show proxy</command>.
<command>systemd-networkd</command> will control the per-interface `proxy_ndp` switch for each
configured interface depending on this option. When unset, the kernel's default will be used.
</para>
<xi:include href="version-info.xml" xpointer="v234"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ProxyNeighbor=</varname></term>
<listitem>
<para>Takes an IPv4 or IPv6 address for which ARP requests or Neighbour Advertisement messages will
be proxied. This option may be specified more than once. <command>systemd-networkd</command> will
add the specified address to the kernel's neighbour proxy table. For an IPv4 address, a proxy ARP
entry will be added. For an IPv6 address, a proxy NDP entry will be added. When an IPv6 address is
specified, <varname>IPv6ProxyNDP=yes</varname> is implied. If <varname>IPv6ProxyNDP=</varname> is
explicitly disabled, IPv6 addresses specified with <varname>ProxyNeighbor=</varname> are ignored.
Note, unlike IPv6, specifying an IPv4 address does <emphasis>not</emphasis> imply
<varname>IPv4ProxyARP=</varname>.</para>
<xi:include href="version-info.xml" xpointer="v262"/>
</listitem>
</varlistentry>
<varlistentry>
<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
the [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA] section. If
<varname>DHCPPrefixDelegation=</varname> is enabled, then the delegated prefixes are also
distributed. See <varname>DHCPPrefixDelegation=</varname> setting and the [IPv6SendRA],
[IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration
options.</para>
<para>If enabled, <varname>IPv6Forwarding=</varname> on this interface is also enabled, unless
the setting is explicitly specified. See <varname>IPv6Forwarding=</varname> in the above for more
details.</para>
<xi:include href="version-info.xml" xpointer="v247"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DHCPPrefixDelegation=</varname></term>
<listitem>
<para>Takes a boolean value. When enabled, requests subnet prefixes on another link via the DHCPv6
protocol or via the 6RD option in the DHCPv4 protocol. An address within each delegated prefix will
be assigned, and the prefixes will be announced through IPv6 Router Advertisement if
<varname>IPv6SendRA=</varname> is enabled. This behaviour can be configured in the
[DHCPPrefixDelegation] section. Defaults to disabled.</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPv6MTUBytes=</varname></term>
<listitem>
<para>Configures IPv6 maximum transmission unit (MTU). An integer greater than or equal to
1280 bytes. When unset, the kernel's default will be used.</para>
<xi:include href="version-info.xml" xpointer="v239"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>MPLSRouting=</varname></term>
<listitem>
<para>Control whether Multi-protocol Label Switching (MPLS) routing is enabled on this interface.
This configures <filename>/proc/sys/net/mpls/conf/<replaceable>INTERFACE</replaceable>/input</filename>.
Takes a boolean. Defaults to unset, and the kernel's default will be used.</para>
<para>Note, <command>systemd-networkd</command> does <emphasis>not</emphasis> load any required
kernel modules for MPLS. To enable the feature, <filename>mpls_router</filename> kernel module must
be loaded before <filename>systemd-networkd.service</filename> is started. Consider adding the
kernel module to
<citerefentry><refentrytitle>modules-load.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>KeepMaster=</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>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>BatmanAdvanced=</varname></term>
<term><varname>Bond=</varname></term>
<term><varname>Bridge=</varname></term>
<term><varname>VRF=</varname></term>
<listitem>
<para>The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link
to. See
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<xi:include href="version-info.xml" xpointer="v211"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPoIB=</varname></term>
<term><varname>IPVLAN=</varname></term>
<term><varname>IPVTAP=</varname></term>
<term><varname>MACsec=</varname></term>
<term><varname>MACVLAN=</varname></term>
<term><varname>MACVTAP=</varname></term>
<term><varname>Tunnel=</varname></term>
<term><varname>VLAN=</varname></term>
<term><varname>VXLAN=</varname></term>
<term><varname>Xfrm=</varname></term>
<listitem>
<para>Takes a space-separated list of stacked netdevs to be created on the interface. See
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
This option may be specified more than once. If an empty string is specified, previous assignments
for all netdev types are cleared.</para>
<xi:include href="version-info.xml" xpointer="v211"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ActiveSlave=</varname></term>
<listitem>
<para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</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>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>PrimarySlave=</varname></term>
<listitem>
<para>Takes a boolean. Specifies which slave is the primary device. The specified 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>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ConfigureWithoutCarrier=</varname></term>
<listitem>
<para>Takes a boolean. Allows <command>systemd-networkd</command> to configure a specific link even
if it has no carrier. Defaults to false. If enabled, and the <varname>IgnoreCarrierLoss=</varname>
setting is not explicitly set, then it is enabled as well.</para>
<para>With this enabled, to make the interface enter the <literal>configured</literal> state,
which is required to make <command>systemd-networkd-wait-online</command> work properly for the
interface, all dynamic address configuration mechanisms like <varname>DHCP=</varname> and
<varname>IPv6AcceptRA=</varname> (which is enabled by default in most cases) need to be disabled.
Also, <varname>DuplicateAddressDetection=</varname> (which is enabled by default for IPv4
link-local addresses and all IPv6 addresses) needs to be disabled for all static address
configurations. Otherwise, without carrier, the interface will be stuck in the
<literal>configuring</literal> state, and <command>systemd-networkd-wait-online</command> for the
interface will timeout. Also, it is recommended to set
<varname>RequiredForOnline=no-carrier</varname> to make
<command>systemd-networkd-wait-online</command> work for the interface.</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IgnoreCarrierLoss=</varname></term>
<listitem>
<para>Takes a boolean or a timespan. When true, <command>systemd-networkd</command> retains
both the static and dynamic configuration of the interface even if its carrier is lost. When
false, <command>systemd-networkd</command> drops both the static and dynamic configuration of
the interface. When a timespan is specified, <command>systemd-networkd</command> waits for
the specified timespan, and ignores the carrier loss if the link regain its carrier within
the timespan. Setting 0 seconds is equivalent to <literal>no</literal>, and
<literal>infinite</literal> is equivalent to <literal>yes</literal>.</para>
<para>Setting a finite timespan may be useful when e.g. in the following cases:
<itemizedlist>
<listitem>
<para>A wireless interface connecting to a network which has multiple access points with
the same SSID.</para>
</listitem>
<listitem>
<para>Enslaving a wireless interface to a bond interface, which may disconnect from the
connected access point and causes its carrier to be lost.</para>
</listitem>
<listitem>
<para>The driver of the interface resets when the MTU is changed.</para>
</listitem>
</itemizedlist>
</para>
<para>When <varname>Bond=</varname> is specified to a wireless interface, defaults to 3
seconds. When the DHCPv4 client is enabled and <varname>UseMTU=</varname> in the [DHCPv4]
section enabled, defaults to 5 seconds. Otherwise, defaults to the value specified with
<varname>ConfigureWithoutCarrier=</varname>. When <varname>ActivationPolicy=</varname> is set
to <literal>always-up</literal>, this is forced to <literal>yes</literal>, and ignored any
user specified values.</para>
<xi:include href="version-info.xml" xpointer="v242"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>KeepConfiguration=</varname></term>
<listitem>
<para>Takes a boolean or one of <literal>static</literal>, <literal>dynamic-on-stop</literal>, and
<literal>dynamic</literal>. When <literal>static</literal>, <command>systemd-networkd</command>
will not drop statically configured addresses and routes on starting up process. When
<literal>dynamic-on-stop</literal>, the dynamically configured addresses and routes, such as
DHCPv4, DHCPv6, SLAAC, and IPv4 link-local address, will not be dropped when
<command>systemd-networkd</command> is being stopped. When <literal>dynamic</literal>, the
dynamically configured addresses and routes will never be dropped, and the lifetime of DHCPv4
leases will be ignored. 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>dynamic</literal> implies
<literal>dynamic-on-stop</literal>, and <literal>yes</literal> implies <literal>dynamic</literal>
and <literal>static</literal>. Defaults to <literal>dynamic-on-stop</literal> when
<command>systemd-networkd</command> is running in initrd, <literal>yes</literal> when the root
filesystem is a network filesystem, and <literal>no</literal> otherwise.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[Address] Section Options</title>
<para>An [Address] section accepts the following keys. Specify several [Address] sections to
configure several addresses.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Address=</varname></term>
<listitem>
<para>As in the [Network] section. This setting is mandatory. Each [Address] section can
contain one <varname>Address=</varname> setting.</para>
<xi:include href="version-info.xml" xpointer="v211"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Peer=</varname></term>
<listitem>
<para>The peer address in a point-to-point connection. Accepts the same format as the
<varname>Address=</varname> setting.</para>
<xi:include href="version-info.xml" xpointer="v216"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Broadcast=</varname></term>
<listitem>
<para>Takes an IPv4 address or boolean value. The address must be in the format described in
<citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
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 defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v211"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Label=</varname></term>
<listitem>
<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>
<xi:include href="version-info.xml" xpointer="v211"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>PreferredLifetime=</varname></term>
<listitem>
<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>
<xi:include href="version-info.xml" xpointer="v230"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Scope=</varname></term>
<listitem>
<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) or an integer in the range 0…255. Defaults to <literal>global</literal>.
IPv4 only - IPv6 scope is automatically assigned by the kernel and cannot be set manually.
</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v246"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>HomeAddress=</varname></term>
<listitem>
<para>Takes a boolean. Designates this address the "home address" as defined in
<ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>. Supported only on IPv6.
Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>DuplicateAddressDetection=</varname></term>
<listitem>
<para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>,
or <literal>none</literal>. When <literal>ipv4</literal>, performs IPv4 Address Conflict
Detection. See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>.
When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See
<ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>. Defaults to
<literal>ipv4</literal> for IPv4 link-local addresses (169.254.0.0/16), <literal>ipv6</literal>
for IPv6 addresses, and <literal>none</literal> otherwise.</para>
<para>When enabled, regardless implicitly or not, <varname>ARP=</varname> is enabled unless it is
explicitly configured.</para>
<xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ManageTemporaryAddress=</varname></term>
<listitem>
<para>Takes a boolean. If true the kernel manage temporary addresses created from this one as
template on behalf of Privacy Extensions
<ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become active,
the use_tempaddr sysctl setting has to be set to a value greater than zero. The given address
needs to have a prefix length of 64. This flag allows using privacy extensions in a manually
configured network, just like if stateless auto-configuration was active. Defaults to false.
</para>
<xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>AddPrefixRoute=</varname></term>
<listitem>
<para>Takes a boolean. When true, the prefix route for the address is automatically added.
Defaults to true.</para>
<xi:include href="version-info.xml" xpointer="v245"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>AutoJoin=</varname></term>
<listitem>
<para>Takes a boolean. Joining multicast group on ethernet level via
<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 <command>systemd-networkd</command>'s netdev kind vxlan
have the group option that enables them to do the required join. By extending
<command>ip address</command> 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>
<xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NetLabel=</varname><replaceable>label</replaceable></term>
<listitem>
<para>This setting provides a method for integrating static and dynamic network configuration into
Linux <ulink url="https://docs.kernel.org/netlabel/index.html">NetLabel</ulink> subsystem rules,
used by <ulink url="https://en.wikipedia.org/wiki/Linux_Security_Modules">Linux Security Modules
(LSMs)</ulink> for network access control. The label, with suitable LSM rules, can be used to
control connectivity of (for example) a service with peers in the local network. At least with
SELinux, only the ingress can be controlled but not egress. The benefit of using this setting is
that it may be possible to apply interface independent part of NetLabel configuration at very early
stage of system boot sequence, at the time when the network interfaces are not available yet, with
<citerefentry
project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
and the per-interface configuration with <command>systemd-networkd</command> once the interfaces
appear later. Currently this feature is only implemented for SELinux.</para>
<para>The option expects a single NetLabel label. The label must conform to lexicographic restrictions of
LSM labels. When an interface is configured with IP addresses, the addresses and subnetwork masks
will be appended to the <ulink
url="https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md">NetLabel
Fallback Peer Labeling</ulink> rules. They will be removed when the interface is
deconfigured. Failures to manage the labels will be ignored.</para>
<warning>
<para>Once labeling is enabled for network traffic, a lot of LSM access control points in
Linux networking stack go from dormant to active. Care should be taken to avoid getting into a
situation where for example remote connectivity is broken, when the security policy has not been
updated to consider LSM per-packet access controls and no rules would allow any network
traffic. Also note that additional configuration with <citerefentry
project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
is needed.</para>
</warning>
<para>Example:
<programlisting>[Address]
NetLabel=system_u:object_r:localnet_peer_t:s0</programlisting>
With the example rules applying for interface <literal>eth0</literal>, when the interface is
configured with an IPv4 address of 10.0.0.123/8, <command>systemd-networkd</command> performs the
equivalent of <command>netlabelctl</command> operation
<programlisting>netlabelctl unlbl add interface eth0 address:10.0.0.0/8 label:system_u:object_r:localnet_peer_t:s0</programlisting>
and the reverse operation when the IPv4 address is deconfigured. The configuration can be used with
LSM rules; in case of SELinux to allow a SELinux domain to receive data from objects of SELinux
<literal>peer</literal> class. For example:
<programlisting>type localnet_peer_t;
allow my_server_t localnet_peer_t:peer recv;</programlisting>
The effect of the above configuration and rules (in absence of other rules as may be the case) is
to only allow <literal>my_server_t</literal> (and nothing else) to receive data from local subnet
10.0.0.0/8 of interface <literal>eth0</literal>.
</para>
<xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>NFTSet=</varname><replaceable>source</replaceable>:<replaceable>family</replaceable>:<replaceable>table</replaceable>:<replaceable>set</replaceable></term>
<listitem>
<para>This setting provides a method for integrating network configuration into firewall rules with
<ulink url="https://netfilter.org/projects/nftables/index.html">NFT</ulink> sets. The benefit of
using the setting is that static network configuration (or dynamically obtained network addresses,
see similar directives in other sections) can be used in firewall rules with the indirection of NFT
set types. For example, access could be granted for hosts in the local subnetwork only. Firewall
rules using IP address of an interface are also instantly updated when the network configuration
changes, for example via DHCP.</para>
<para>This option expects a whitespace separated list of NFT set definitions. Each definition
consists of a colon-separated tuple of source type (one of <literal>address</literal>,
<literal>prefix</literal> or <literal>ifindex</literal>), NFT address family (one of
<literal>arp</literal>, <literal>bridge</literal>, <literal>inet</literal>, <literal>ip</literal>,
<literal>ip6</literal>, or <literal>netdev</literal>), table name and set name. The names of tables
and sets must conform to lexicographic restrictions of NFT table names. The type of the element used in
the NFT filter must match the type implied by the directive (<literal>address</literal>,
<literal>prefix</literal> or <literal>ifindex</literal>) and address type (IPv4 or IPv6) as shown
in the table below.</para>
<table>
<title>Defined <varname>source type</varname> values</title>
<tgroup cols='3'>
<colspec colname='source type'/>
<colspec colname='description'/>
<colspec colname='NFT type name'/>
<thead>
<row>
<entry>Source type</entry>
<entry>Description</entry>
<entry>Corresponding NFT type name</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>address</literal></entry>
<entry>host IP address</entry>
<entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal></entry>
</row>
<row>
<entry><literal>prefix</literal></entry>
<entry>network prefix</entry>
<entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal>, with <literal>flags interval</literal></entry>
</row>
<row>
<entry><literal>ifindex</literal></entry>
<entry>interface index</entry>
<entry><literal>iface_index</literal></entry>
</row>
</tbody>
</tgroup>
</table>
<para>When an interface is configured with IP addresses, the addresses, subnetwork masks or
interface index will be appended to the NFT sets. The information will be removed when the
interface is deconfigured. <command>systemd-networkd</command> only inserts elements to (or removes
from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in
advance. Failures to manage the sets will be ignored.</para>
<para>Example:
<programlisting>[Address]
NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting>
Corresponding NFT rules:
<programlisting>table netdev filter {
set eth_ipv4_prefix {
type ipv4_addr
flags interval
}
chain eth_ingress {
type filter hook ingress device "eth0" priority filter; policy drop;
ip daddr != @eth_ipv4_prefix drop
accept
}
}</programlisting>
</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[Neighbor] Section Options</title>
<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>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Address=</varname></term>
<listitem>
<para>The IP address of the neighbor.</para>
<xi:include href="version-info.xml" xpointer="v240"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>LinkLayerAddress=</varname></term>
<listitem>
<para>The link layer address (MAC address or IP address) of the neighbor.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[IPv6AddressLabel] Section Options</title>
<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, and only the label itself is stored in the kernel.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>Label=</varname></term>
<listitem>
<para>The label for the prefix. Takes an unsigned integer in the range 0…4294967294 (0xfffffffe).
4294967295 (0xffffffff) is reserved. This setting is mandatory.</para>
<xi:include href="version-info.xml" xpointer="v234"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Prefix=</varname></term>
<listitem>
<para>Takes an IPv6 address with a prefix length, separated by a slash
<literal>/</literal> character. This setting is mandatory.</para>
<xi:include href="version-info.xml" xpointer="v234"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>[RoutingPolicyRule] Section Options</title>
<para>An [RoutingPolicyRule] section accepts the following settings. Specify several
[RoutingPolicyRule] sections to configure several rules.</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>TypeOfService=</varname></term>
<listitem>
<para>
This specifies the Type of Service (ToS) field of packets to match;
it takes an unsigned integer in the range 0…255.
The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits).
The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and
Explicit Congestion Notification (ECN) (the last 2 bits).
See <ulink url="https://en.wikipedia.org/wiki/Type_of_service">Type of Service</ulink>
and <ulink url="https://en.wikipedia.org/wiki/Differentiated_services">Differentiated services</ulink>
for more details.
</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</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>
<xi:include href="version-info.xml" xpointer="v235"/>
</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>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>FirewallMark=</varname></term>
<listitem>
<para>Specifies the iptables firewall mark value to match (a number in the range
0…4294967295). Optionally, the firewall mask (also a number between 0…4294967295) can be
suffixed with a slash (<literal>/</literal>), e.g., <literal>7/255</literal>. When the
mark value is non-zero and no mask is explicitly specified, all bits of the mark are
compared. </para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Table=</varname></term>
<listitem>
<para>Specifies the routing table identifier to look up 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>,
or a number between 1 and 4294967295. Defaults to <literal>main</literal>.
Ignored if <varname>L3MasterDevice=</varname> is true.</para>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Priority=</varname></term>
<listitem>
<para>Specifies the priority of this rule. <varname>Priority=</varname> is an 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>
<xi:include href="version-info.xml" xpointer="v235"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>GoTo=</varname></term>
<listitem>
<para>Specifies the target priority used by the <literal>goto</literal> type of rule. Takes an
integer in the range 1…4294967295. This must be larger than the priority of the rule specified in
<varname>Priority=</varname>. When specified, <varname>Type=goto</varname> is implied. This is
mandatory when <varname>Type=goto</varname>.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v236"/>
</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>
<xi:include href="version-info.xml" xpointer="v236"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>L3MasterDevice=</varname></term>
<listitem>
<para>Takes a boolean. Specifies whether the rule is to direct lookups to the tables associated with
level 3 master devices (also known as Virtual Routing and Forwarding or VRF devices).
For further details see <ulink url="https://docs.kernel.org/networking/vrf.html">
Virtual Routing and Forwarding (VRF)</ulink>. Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v240"/>
</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>
<xi:include href="version-info.xml" xpointer="v240"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>IPProtocol=</varname></term>
<listitem>
<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>. Defaults to unset.
</para>
<xi:include href="version-info.xml" xpointer="v240"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>InvertRule=</varname></term>
<listitem>
<para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para>
<xi:include href="version-info.xml" xpointer="v240"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<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>
<xi:include href="version-info.xml" xpointer="v245"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SuppressPrefixLength=</varname></term>
<listitem>
<para>Takes a number <replaceable>N</replaceable> in the range 0…128 and rejects routing
decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to
unset.</para>
<xi:include href="version-info.xml" xpointer="v245"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>SuppressInterfaceGroup=</varname></term>
<listitem>
<para>Takes an integer in the range 0…2147483647 and rejects routing decisions that have
an interface with the same group id. It has the same meaning as
<option>suppress_ifgroup</option> in <command>ip rule</command>. Defaults to unset.</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Type=</varname></term>
<listitem>
<para>Specifies Routing Policy Database (RPDB) rule type. Takes one of
<literal>table</literal>, <literal>goto</literal>, <literal>nop</literal>,
<literal>blackhole</literal>, <literal>unreachable</literal>, or <literal>prohibit</literal>.
When <literal>goto</literal>, the target priority must be specified in <varname>GoTo=</varname>.
Defaults to <literal>table</literal>.</para>
<xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>