| | 1 | <?xml version='1.0'?> |
| | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
| | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| | 4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
| | 5 | |
| | 6 | <refentry id="systemd.network" conditional='ENABLE_NETWORKD' |
| | 7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
| | 8 | |
| | 9 | <refentryinfo> |
| | 10 | <title>systemd.network</title> |
| | 11 | <productname>systemd</productname> |
| | 12 | </refentryinfo> |
| | 13 | |
| | 14 | <refmeta> |
| | 15 | <refentrytitle>systemd.network</refentrytitle> |
| | 16 | <manvolnum>5</manvolnum> |
| | 17 | </refmeta> |
| | 18 | |
| | 19 | <refnamediv> |
| | 20 | <refname>systemd.network</refname> |
| | 21 | <refpurpose>Network configuration</refpurpose> |
| | 22 | </refnamediv> |
| | 23 | |
| | 24 | <refsynopsisdiv> |
| | 25 | <para><filename><replaceable>network</replaceable>.network</filename></para> |
| | 26 | </refsynopsisdiv> |
| | 27 | |
| | 28 | <refsect1> |
| | 29 | <title>Description</title> |
| | 30 | |
| | 31 | <para>A plain ini-style text file that encodes network configuration for matching network interfaces, |
| | 32 | used by |
| | 33 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. |
| | 34 | See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
| | 35 | for a general description of the syntax.</para> |
| | 36 | |
| | 37 | <para>The main network file must have the extension <filename>.network</filename>; other |
| | 38 | extensions are ignored. Networks are applied to links whenever the links appear.</para> |
| | 39 | |
| | 40 | <para>The <filename>.network</filename> files are read from the files located in the system network |
| | 41 | directories <filename>/usr/lib/systemd/network</filename> and |
| | 42 | <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory |
| | 43 | <filename>/run/systemd/network</filename> and the local administration network directory |
| | 44 | <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and processed |
| | 45 | in lexical order, regardless of the directories in which they live. However, files with identical |
| | 46 | filenames replace each other. Files in <filename>/etc</filename> have the highest priority, files in |
| | 47 | <filename>/run</filename> take precedence over files with the same name under |
| | 48 | <filename>/usr</filename>. This can be used to override a system-supplied configuration file with a local |
| | 49 | file if needed. As a special case, an empty file (file size 0) or symlink with the same name pointing to |
| | 50 | <filename>/dev/null</filename> disables the configuration file entirely (it is "masked").</para> |
| | 51 | |
| | 52 | <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory |
| | 53 | <filename>foo.network.d/</filename> may exist. All files with the suffix |
| | 54 | <literal>.conf</literal> from this directory will be parsed after the file itself is |
| | 55 | parsed. This is useful to alter or add configuration settings, without having to modify the main |
| | 56 | configuration file. Each drop-in file must have appropriate section headers.</para> |
| | 57 | |
| | 58 | <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal> |
| | 59 | directories can be placed in <filename>/usr/lib/systemd/network</filename> or |
| | 60 | <filename>/run/systemd/network</filename> directories. Drop-in files in |
| | 61 | <filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn |
| | 62 | take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these |
| | 63 | directories take precedence over the main network file wherever located.</para> |
| | 64 | |
| | 65 | <para>Note that an interface without any static IPv6 addresses configured, and neither DHCPv6 |
| | 66 | nor IPv6LL enabled, shall be considered to have no IPv6 support. IPv6 will be automatically |
| | 67 | disabled for that interface by writing "1" to |
| | 68 | <filename>/proc/sys/net/ipv6/conf/<replaceable>ifname</replaceable>/disable_ipv6</filename>. |
| | 69 | </para> |
| | 70 | </refsect1> |
| | 71 | |
| | 72 | <refsect1> |
| | 73 | <title>[Match] Section Options</title> |
| | 74 | |
| | 75 | <para>The network file contains a <literal>[Match]</literal> |
| | 76 | section, which determines if a given network file may be applied |
| | 77 | to a given device; and a <literal>[Network]</literal> section |
| | 78 | specifying how the device should be configured. The first (in |
| | 79 | lexical order) of the network files that matches a given device |
| | 80 | is applied, all later files are ignored, even if they match as |
| | 81 | well.</para> |
| | 82 | |
| | 83 | <para>A network file is said to match a network interface if all matches specified by the |
| | 84 | <literal>[Match]</literal> section are satisfied. When a network file does not contain valid |
| | 85 | settings in <literal>[Match]</literal> section, then the file will match all interfaces and |
| | 86 | <command>systemd-networkd</command> warns about that. Hint: to avoid the warning and to make it |
| | 87 | clear that all interfaces shall be matched, add the following: |
| | 88 | <programlisting>Name=*</programlisting> |
| | 89 | The following keys are accepted:</para> |
| | 90 | |
| | 91 | <variablelist class='network-directives'> |
| | 92 | <xi:include href="systemd.link.xml" xpointer="mac-address" /> |
| | 93 | <xi:include href="systemd.link.xml" xpointer="permanent-mac-address" /> |
| | 94 | <xi:include href="systemd.link.xml" xpointer="path" /> |
| | 95 | <xi:include href="systemd.link.xml" xpointer="driver" /> |
| | 96 | <xi:include href="systemd.link.xml" xpointer="type" /> |
| | 97 | <xi:include href="systemd.link.xml" xpointer="property" /> |
| | 98 | |
| | 99 | <varlistentry> |
| | 100 | <term><varname>Name=</varname></term> |
| | 101 | <listitem> |
| | 102 | <para>A whitespace-separated list of shell-style globs matching the device name, as exposed |
| | 103 | by the udev property <literal>INTERFACE</literal>, or device's alternative names. If the |
| | 104 | list is prefixed with a "!", the test is inverted.</para> |
| | 105 | </listitem> |
| | 106 | </varlistentry> |
| | 107 | |
| | 108 | <varlistentry> |
| | 109 | <term><varname>WLANInterfaceType=</varname></term> |
| | 110 | <listitem> |
| | 111 | <para>A whitespace-separated list of wireless network type. Supported values are |
| | 112 | <literal>ad-hoc</literal>, <literal>station</literal>, <literal>ap</literal>, |
| | 113 | <literal>ap-vlan</literal>, <literal>wds</literal>, <literal>monitor</literal>, |
| | 114 | <literal>mesh-point</literal>, <literal>p2p-client</literal>, <literal>p2p-go</literal>, |
| | 115 | <literal>p2p-device</literal>, <literal>ocb</literal>, and <literal>nan</literal>. If the |
| | 116 | list is prefixed with a "!", the test is inverted. |
| | 117 | </para> |
| | 118 | </listitem> |
| | 119 | </varlistentry> |
| | 120 | |
| | 121 | <varlistentry> |
| | 122 | <term><varname>SSID=</varname></term> |
| | 123 | <listitem> |
| | 124 | <para>A whitespace-separated list of shell-style globs matching the SSID of the currently |
| | 125 | connected wireless LAN. If the list is prefixed with a "!", the test is inverted. |
| | 126 | </para> |
| | 127 | </listitem> |
| | 128 | </varlistentry> |
| | 129 | |
| | 130 | <varlistentry> |
| | 131 | <term><varname>BSSID=</varname></term> |
| | 132 | <listitem> |
| | 133 | <para>A whitespace-separated list of hardware address of the currently connected wireless |
| | 134 | LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in |
| | 135 | <varname>MACAddress=</varname>. This option may appear more than one, in which case the |
| | 136 | lists are merged. If the empty string is assigned to this option, the list of BSSID defined |
| | 137 | prior to this is reset.</para> |
| | 138 | </listitem> |
| | 139 | </varlistentry> |
| | 140 | |
| | 141 | <xi:include href="systemd.link.xml" xpointer="host" /> |
| | 142 | <xi:include href="systemd.link.xml" xpointer="virtualization" /> |
| | 143 | <xi:include href="systemd.link.xml" xpointer="kernel-command-line" /> |
| | 144 | <xi:include href="systemd.link.xml" xpointer="kernel-version" /> |
| | 145 | <xi:include href="systemd.link.xml" xpointer="architecture" /> |
| | 146 | </variablelist> |
| | 147 | |
| | 148 | </refsect1> |
| | 149 | |
| | 150 | <refsect1> |
| | 151 | <title>[Link] Section Options</title> |
| | 152 | |
| | 153 | <para> The <literal>[Link]</literal> section accepts the following keys:</para> |
| | 154 | |
| | 155 | <variablelist class='network-directives'> |
| | 156 | <varlistentry> |
| | 157 | <term><varname>MACAddress=</varname></term> |
| | 158 | <listitem> |
| | 159 | <para>The hardware address to set for the device.</para> |
| | 160 | </listitem> |
| | 161 | </varlistentry> |
| | 162 | <varlistentry> |
| | 163 | <term><varname>MTUBytes=</varname></term> |
| | 164 | <listitem> |
| | 165 | <para>The maximum transmission unit in bytes to set for the |
| | 166 | device. The usual suffixes K, M, G, are supported and are |
| | 167 | understood to the base of 1024.</para> |
| | 168 | <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen |
| | 169 | below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para> |
| | 170 | </listitem> |
| | 171 | </varlistentry> |
| | 172 | <varlistentry> |
| | 173 | <term><varname>ARP=</varname></term> |
| | 174 | <listitem> |
| | 175 | <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol) |
| | 176 | for this interface is enabled. When unset, the kernel's default will be used.</para> |
| | 177 | <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual |
| | 178 | interfaces atop a single lower-level physical interface, which will then only serve as a |
| | 179 | link/"bridge" device aggregating traffic to the same physical link and not participate in |
| | 180 | the network otherwise.</para> |
| | 181 | </listitem> |
| | 182 | </varlistentry> |
| | 183 | <varlistentry> |
| | 184 | <term><varname>Multicast=</varname></term> |
| | 185 | <listitem> |
| | 186 | <para>Takes a boolean. If set to true, the multicast flag on the device is enabled.</para> |
| | 187 | </listitem> |
| | 188 | </varlistentry> |
| | 189 | <varlistentry> |
| | 190 | <term><varname>AllMulticast=</varname></term> |
| | 191 | <listitem> |
| | 192 | <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the network. |
| | 193 | This happens when multicast routing is enabled.</para> |
| | 194 | </listitem> |
| | 195 | </varlistentry> |
| | 196 | <varlistentry> |
| | 197 | <term><varname>Unmanaged=</varname></term> |
| | 198 | <listitem> |
| | 199 | <para>Takes a boolean. When <literal>yes</literal>, no attempts are |
| | 200 | made to bring up or configure matching links, equivalent to |
| | 201 | when there are no matching network files. Defaults to |
| | 202 | <literal>no</literal>.</para> |
| | 203 | <para>This is useful for preventing later matching network |
| | 204 | files from interfering with certain interfaces that are fully |
| | 205 | controlled by other applications.</para> |
| | 206 | </listitem> |
| | 207 | </varlistentry> |
| | 208 | <varlistentry> |
| | 209 | <term><varname>Group=</varname></term> |
| | 210 | <listitem> |
| | 211 | <para>Link groups are similar to port ranges found in managed switches. |
| | 212 | When network interfaces are added to a numbered group, operations on |
| | 213 | all the interfaces from that group can be performed at once. An unsigned |
| | 214 | integer ranges 0 to 4294967294. Default to unset.</para> |
| | 215 | </listitem> |
| | 216 | </varlistentry> |
| | 217 | <varlistentry> |
| | 218 | <term><varname>RequiredForOnline=</varname></term> |
| | 219 | <listitem> |
| | 220 | <para>Takes a boolean or a minimum operational state and an optional maximum operational state. |
| | 221 | Please see <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
| | 222 | for possible operational states. When <literal>yes</literal>, the network is deemed required when |
| | 223 | determining whether the system is online when running |
| | 224 | <command>systemd-networkd-wait-online</command>. When <literal>no</literal>, the network is ignored |
| | 225 | when checking for online state. When a minimum operational state and an optional maximum operational |
| | 226 | state are set, <literal>yes</literal> is implied, and this controls the minimum and maximum |
| | 227 | operational state required for the network interface to be considered online. |
| | 228 | Defaults to <literal>yes</literal>.</para> |
| | 229 | |
| | 230 | <para>The network will be brought up normally in all cases, but in |
| | 231 | the event that there is no address being assigned by DHCP or the |
| | 232 | cable is not plugged in, the link will simply remain offline and be |
| | 233 | skipped automatically by <command>systemd-networkd-wait-online</command> |
| | 234 | if <literal>RequiredForOnline=no</literal>.</para> |
| | 235 | </listitem> |
| | 236 | </varlistentry> |
| | 237 | </variablelist> |
| | 238 | </refsect1> |
| | 239 | |
| | 240 | <refsect1> |
| | 241 | <title>[SR-IOV] Section Options</title> |
| | 242 | <para>The <literal>[SR-IOV]</literal> section accepts the |
| | 243 | following keys. Specify several <literal>[SR-IOV]</literal> |
| | 244 | sections to configure several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource |
| | 245 | into virtual PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves |
| | 246 | north-south network performance (that is, traffic with endpoints outside the host machine) by allowing traffic to |
| | 247 | bypass the host machine’s network stack.</para> |
| | 248 | |
| | 249 | <variablelist class='network-directives'> |
| | 250 | <varlistentry> |
| | 251 | <term><varname>VirtualFunction=</varname></term> |
| | 252 | <listitem> |
| | 253 | <para>Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data |
| | 254 | in and out. Takes an unsigned integer in the range 0..2147483646. This option is compulsory.</para> |
| | 255 | </listitem> |
| | 256 | </varlistentry> |
| | 257 | |
| | 258 | <varlistentry> |
| | 259 | <term><varname>VLANId=</varname></term> |
| | 260 | <listitem> |
| | 261 | <para>Specifies VLAN ID of the virtual function. Takes an unsigned integer in the range 1..4095.</para> |
| | 262 | </listitem> |
| | 263 | </varlistentry> |
| | 264 | |
| | 265 | <varlistentry> |
| | 266 | <term><varname>QualityOfService=</varname></term> |
| | 267 | <listitem> |
| | 268 | <para>Specifies quality of service of the virtual function. Takes an unsigned integer in the range 1..4294967294.</para> |
| | 269 | </listitem> |
| | 270 | </varlistentry> |
| | 271 | |
| | 272 | <varlistentry> |
| | 273 | <term><varname>VLANProtocol=</varname></term> |
| | 274 | <listitem> |
| | 275 | <para>Specifies VLAN protocol of the virtual function. Takes <literal>802.1Q</literal> or |
| | 276 | <literal>802.1ad</literal>.</para> |
| | 277 | </listitem> |
| | 278 | </varlistentry> |
| | 279 | |
| | 280 | <varlistentry> |
| | 281 | <term><varname>MACSpoofCheck=</varname></term> |
| | 282 | <listitem> |
| | 283 | <para>Takes a boolean. Controls the MAC spoof checking. When unset, the kernel's default will be used.</para> |
| | 284 | </listitem> |
| | 285 | </varlistentry> |
| | 286 | |
| | 287 | <varlistentry> |
| | 288 | <term><varname>QueryReceiveSideScaling=</varname></term> |
| | 289 | <listitem> |
| | 290 | <para>Takes a boolean. Toggle the ability of querying the receive side scaling (RSS) |
| | 291 | configuration of the virtual function (VF). The VF RSS information like RSS hash key may be |
| | 292 | considered sensitive on some devices where this information is shared between VF and the |
| | 293 | physical function (PF). When unset, the kernel's default will be used.</para> |
| | 294 | </listitem> |
| | 295 | </varlistentry> |
| | 296 | |
| | 297 | <varlistentry> |
| | 298 | <term><varname>Trust=</varname></term> |
| | 299 | <listitem> |
| | 300 | <para>Takes a boolean. Allows to set trust mode of the virtual function (VF). When set, VF |
| | 301 | users can set a specific feature which may impact security and/or performance. When unset, |
| | 302 | the kernel's default will be used.</para> |
| | 303 | </listitem> |
| | 304 | </varlistentry> |
| | 305 | |
| | 306 | <varlistentry> |
| | 307 | <term><varname>LinkState=</varname></term> |
| | 308 | <listitem> |
| | 309 | <para>Allows to set the link state of the virtual function (VF). Takes a boolean or a |
| | 310 | special value <literal>auto</literal>. Setting to <literal>auto</literal> means a |
| | 311 | reflection of the physical function (PF) link state, <literal>yes</literal> lets the VF to |
| | 312 | communicate with other VFs on this host even if the PF link state is down, |
| | 313 | <literal>no</literal> causes the hardware to drop any packets sent by the VF. When unset, |
| | 314 | the kernel's default will be used.</para> |
| | 315 | </listitem> |
| | 316 | </varlistentry> |
| | 317 | |
| | 318 | <varlistentry> |
| | 319 | <term><varname>MACAddress=</varname></term> |
| | 320 | <listitem> |
| | 321 | <para>Specifies the MAC address for the virtual function.</para> |
| | 322 | </listitem> |
| | 323 | </varlistentry> |
| | 324 | </variablelist> |
| | 325 | </refsect1> |
| | 326 | |
| | 327 | <refsect1> |
| | 328 | <title>[Network] Section Options</title> |
| | 329 | |
| | 330 | <para>The <literal>[Network]</literal> section accepts the following keys:</para> |
| | 331 | |
| | 332 | <variablelist class='network-directives'> |
| | 333 | <varlistentry> |
| | 334 | <term><varname>Description=</varname></term> |
| | 335 | <listitem> |
| | 336 | <para>A description of the device. This is only used for |
| | 337 | presentation purposes.</para> |
| | 338 | </listitem> |
| | 339 | </varlistentry> |
| | 340 | <varlistentry> |
| | 341 | <term><varname>DHCP=</varname></term> |
| | 342 | <listitem> |
| | 343 | <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts |
| | 344 | <literal>yes</literal>, <literal>no</literal>, |
| | 345 | <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults |
| | 346 | to <literal>no</literal>.</para> |
| | 347 | |
| | 348 | <para>Note that DHCPv6 will by default be triggered by Router |
| | 349 | Advertisement, if that is enabled, regardless of this parameter. |
| | 350 | By enabling DHCPv6 support explicitly, the DHCPv6 client will |
| | 351 | be started regardless of the presence of routers on the link, |
| | 352 | or what flags the routers pass. See |
| | 353 | <literal>IPv6AcceptRA=</literal>.</para> |
| | 354 | |
| | 355 | <para>Furthermore, note that by default the domain name |
| | 356 | specified through DHCP is not used for name resolution. |
| | 357 | See option <option>UseDomains=</option> below.</para> |
| | 358 | |
| | 359 | <para>See the <literal>[DHCPv4]</literal> or <literal>[DHCPv6]</literal> section below for |
| | 360 | further configuration options for the DHCP client support.</para> |
| | 361 | </listitem> |
| | 362 | </varlistentry> |
| | 363 | <varlistentry> |
| | 364 | <term><varname>DHCPServer=</varname></term> |
| | 365 | <listitem> |
| | 366 | <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults |
| | 367 | to <literal>no</literal>. Further settings for the DHCP |
| | 368 | server may be set in the <literal>[DHCPServer]</literal> |
| | 369 | section described below.</para> |
| | 370 | </listitem> |
| | 371 | </varlistentry> |
| | 372 | <varlistentry> |
| | 373 | <term><varname>LinkLocalAddressing=</varname></term> |
| | 374 | <listitem> |
| | 375 | <para>Enables link-local address autoconfiguration. Accepts <literal>yes</literal>, |
| | 376 | <literal>no</literal>, <literal>ipv4</literal>, <literal>ipv6</literal>, |
| | 377 | <literal>fallback</literal>, or <literal>ipv4-fallback</literal>. If |
| | 378 | <literal>fallback</literal> or <literal>ipv4-fallback</literal> is specified, then an IPv4 |
| | 379 | link-local address is configured only when DHCPv4 fails. If <literal>fallback</literal>, |
| | 380 | an IPv6 link-local address is always configured, and if <literal>ipv4-fallback</literal>, |
| | 381 | the address is not configured. Note that, the fallback mechanism works only when DHCPv4 |
| | 382 | client is enabled, that is, it requires <literal>DHCP=yes</literal> or |
| | 383 | <literal>DHCP=ipv4</literal>. If <varname>Bridge=</varname> is set, defaults to |
| | 384 | <literal>no</literal>, and if not, defaults to <literal>ipv6</literal>. |
| | 385 | </para> |
| | 386 | </listitem> |
| | 387 | </varlistentry> |
| | 388 | <varlistentry> |
| | 389 | <term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term> |
| | 390 | <listitem> |
| | 391 | <para>Specifies how IPv6 link local address is generated. Takes one of <literal>eui64</literal>, |
| | 392 | <literal>none</literal>, <literal>stable-privacy</literal> and <literal>random</literal>. |
| | 393 | When unset, the kernel's default will be used. Note that if <varname>LinkLocalAdressing=</varname> |
| | 394 | not configured as <literal>ipv6</literal> then <varname>IPv6LinkLocalAddressGenerationMode=</varname> |
| | 395 | is ignored.</para> |
| | 396 | </listitem> |
| | 397 | </varlistentry> |
| | 398 | <varlistentry> |
| | 399 | <term><varname>IPv4LLRoute=</varname></term> |
| | 400 | <listitem> |
| | 401 | <para>Takes a boolean. If set to true, sets up the route needed for |
| | 402 | non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults |
| | 403 | to false. |
| | 404 | </para> |
| | 405 | </listitem> |
| | 406 | </varlistentry> |
| | 407 | <varlistentry> |
| | 408 | <term><varname>DefaultRouteOnDevice=</varname></term> |
| | 409 | <listitem> |
| | 410 | <para>Takes a boolean. If set to true, sets up the default route bound to the interface. |
| | 411 | Defaults to false. This is useful when creating routes on point-to-point interfaces. |
| | 412 | This is equivalent to e.g. the following. |
| | 413 | <programlisting>ip route add default dev veth99</programlisting></para> |
| | 414 | </listitem> |
| | 415 | </varlistentry> |
| | 416 | <varlistentry> |
| | 417 | <term><varname>IPv6Token=</varname></term> |
| | 418 | <listitem> |
| | 419 | <para>Specifies an optional address generation mode and a required IPv6 address. If |
| | 420 | the mode is present, the two parts must be separated with a colon |
| | 421 | <literal><replaceable>mode</replaceable>:<replaceable>address</replaceable></literal>. The |
| | 422 | address generation mode may be either <constant>prefixstable</constant> or |
| | 423 | <constant>static</constant>. If not specified, <constant>static</constant> is assumed. |
| | 424 | </para> |
| | 425 | <para>When the mode is set to <constant>static</constant>, or unspecified, the lower bits of |
| | 426 | the supplied address are combined with the upper bits of a prefix received in a Router Advertisement |
| | 427 | message to form a complete address. Note that if multiple prefixes are received in an RA message, or in |
| | 428 | multiple RA messages, addresses will be formed from each of them using the supplied address. This |
| | 429 | mode implements SLAAC but uses a static interface identifier instead of an identifier generated |
| | 430 | using the EUI-64 algorithm. Because the interface identifier is static, if Duplicate Address Detection |
| | 431 | detects that the computed address is a duplicate (in use by another node on the link), then this |
| | 432 | mode will fail to provide an address for that prefix. |
| | 433 | </para> |
| | 434 | <para>When the mode is set to <literal>prefixstable</literal> the RFC 7217 algorithm for generating |
| | 435 | interface identifiers will be used, but only when a prefix received in an RA message matches the supplied address. |
| | 436 | See <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink>. Prefix matching will be attempted |
| | 437 | against each <constant>prefixstable</constant> IPv6Token variable provided in the configuration; if a received |
| | 438 | prefix does not match any of the provided addresses, then the EUI-64 algorithm will be used to form |
| | 439 | an interface identifier for that prefix. This mode is also SLAAC, but with a potentially stable interface |
| | 440 | identifier which does not directly map to the interface's hardware address. |
| | 441 | |
| | 442 | Note that the <constant>prefixstable</constant> algorithm includes both the interface's name and |
| | 443 | MAC address in the hash used to compute the interface identifier, so if either of those are changed the resulting |
| | 444 | interface identifier (and address) will change, even if the prefix received in the RA message has not changed. |
| | 445 | |
| | 446 | Note that if multiple <constant>prefixstable</constant> IPv6Token variables are supplied with addresses that |
| | 447 | match a prefix received in an RA message, only the first one will be used to generate addresses. |
| | 448 | </para> |
| | 449 | </listitem> |
| | 450 | </varlistentry> |
| | 451 | <varlistentry> |
| | 452 | <term><varname>LLMNR=</varname></term> |
| | 453 | <listitem> |
| | 454 | <para>Takes a boolean or <literal>resolve</literal>. When true, |
| | 455 | enables <ulink |
| | 456 | url="https://tools.ietf.org/html/rfc4795">Link-Local |
| | 457 | Multicast Name Resolution</ulink> on the link. When set to |
| | 458 | <literal>resolve</literal>, only resolution is enabled, |
| | 459 | but not host registration and announcement. Defaults to |
| | 460 | true. This setting is read by |
| | 461 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 462 | </listitem> |
| | 463 | </varlistentry> |
| | 464 | <varlistentry> |
| | 465 | <term><varname>MulticastDNS=</varname></term> |
| | 466 | <listitem> |
| | 467 | <para>Takes a boolean or <literal>resolve</literal>. When true, |
| | 468 | enables <ulink |
| | 469 | url="https://tools.ietf.org/html/rfc6762">Multicast |
| | 470 | DNS</ulink> support on the link. When set to |
| | 471 | <literal>resolve</literal>, only resolution is enabled, |
| | 472 | but not host or service registration and |
| | 473 | announcement. Defaults to false. This setting is read by |
| | 474 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 475 | </listitem> |
| | 476 | </varlistentry> |
| | 477 | <varlistentry> |
| | 478 | <term><varname>DNSOverTLS=</varname></term> |
| | 479 | <listitem> |
| | 480 | <para>Takes a boolean or <literal>opportunistic</literal>. |
| | 481 | When true, enables |
| | 482 | <ulink |
| | 483 | url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink> |
| | 484 | support on the link. |
| | 485 | When set to <literal>opportunistic</literal>, compatibility with |
| | 486 | non-DNS-over-TLS servers is increased, by automatically |
| | 487 | turning off DNS-over-TLS servers in this case. |
| | 488 | This option defines a per-interface setting for |
| | 489 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s |
| | 490 | global <varname>DNSOverTLS=</varname> option. Defaults to |
| | 491 | false. This setting is read by |
| | 492 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 493 | </listitem> |
| | 494 | </varlistentry> |
| | 495 | <varlistentry> |
| | 496 | <term><varname>DNSSEC=</varname></term> |
| | 497 | <listitem> |
| | 498 | <para>Takes a boolean. or |
| | 499 | <literal>allow-downgrade</literal>. When true, enables |
| | 500 | <ulink |
| | 501 | url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> |
| | 502 | DNS validation support on the link. When set to |
| | 503 | <literal>allow-downgrade</literal>, compatibility with |
| | 504 | non-DNSSEC capable networks is increased, by automatically |
| | 505 | turning off DNSSEC in this case. This option defines a |
| | 506 | per-interface setting for |
| | 507 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s |
| | 508 | global <varname>DNSSEC=</varname> option. Defaults to |
| | 509 | false. This setting is read by |
| | 510 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 511 | </listitem> |
| | 512 | </varlistentry> |
| | 513 | <varlistentry> |
| | 514 | <term><varname>DNSSECNegativeTrustAnchors=</varname></term> |
| | 515 | <listitem><para>A space-separated list of DNSSEC negative |
| | 516 | trust anchor domains. If specified and DNSSEC is enabled, |
| | 517 | look-ups done via the interface's DNS server will be subject |
| | 518 | to the list of negative trust anchors, and not require |
| | 519 | authentication for the specified domains, or anything below |
| | 520 | it. Use this to disable DNSSEC authentication for specific |
| | 521 | private domains, that cannot be proven valid using the |
| | 522 | Internet DNS hierarchy. Defaults to the empty list. This |
| | 523 | setting is read by |
| | 524 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 525 | </listitem> |
| | 526 | </varlistentry> |
| | 527 | <varlistentry> |
| | 528 | <term><varname>LLDP=</varname></term> |
| | 529 | <listitem> |
| | 530 | <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol commonly |
| | 531 | implemented on professional routers and bridges which announces which physical port a system is connected |
| | 532 | to, as well as other related data. Accepts a boolean or the special value |
| | 533 | <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a database of all LLDP |
| | 534 | neighbors maintained. If <literal>routers-only</literal> is set only LLDP data of various types of routers |
| | 535 | is collected and LLDP data about other types of devices ignored (such as stations, telephones and |
| | 536 | others). If false, LLDP reception is disabled. Defaults to <literal>routers-only</literal>. Use |
| | 537 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to query the |
| | 538 | collected neighbor data. LLDP is only available on Ethernet links. See <varname>EmitLLDP=</varname> below |
| | 539 | for enabling LLDP packet emission from the local system. |
| | 540 | </para> |
| | 541 | </listitem> |
| | 542 | </varlistentry> |
| | 543 | <varlistentry> |
| | 544 | <term><varname>EmitLLDP=</varname></term> |
| | 545 | <listitem> |
| | 546 | <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the special values |
| | 547 | <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and |
| | 548 | <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission. If not false, |
| | 549 | a short LLDP packet with information about the local system is sent out in regular intervals on the |
| | 550 | link. The LLDP packet will contain information about the local hostname, the local machine ID (as stored |
| | 551 | in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) and the |
| | 552 | local interface name, as well as the pretty hostname of the system (as set in |
| | 553 | <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). LLDP |
| | 554 | emission is only available on Ethernet links. Note that this setting passes data suitable for |
| | 555 | identification of host to the network and should thus not be enabled on untrusted networks, where such |
| | 556 | identification data should not be made available. Use this option to permit other systems to identify on |
| | 557 | which interfaces they are connected to this system. The three special values control propagation of the |
| | 558 | LLDP packets. The <literal>nearest-bridge</literal> setting permits propagation only to the nearest |
| | 559 | connected bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, but |
| | 560 | not any other bridges, and <literal>customer-bridge</literal> permits propagation until a customer bridge |
| | 561 | is reached. For details about these concepts, see <ulink |
| | 562 | url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>. Note that |
| | 563 | configuring this setting to true is equivalent to <literal>nearest-bridge</literal>, the recommended and |
| | 564 | most restricted level of propagation. See <varname>LLDP=</varname> above for an option to enable LLDP |
| | 565 | reception.</para> |
| | 566 | </listitem> |
| | 567 | </varlistentry> |
| | 568 | |
| | 569 | <varlistentry> |
| | 570 | <term><varname>BindCarrier=</varname></term> |
| | 571 | <listitem> |
| | 572 | <para>A link name or a list of link names. When set, controls the behavior of the current |
| | 573 | link. When all links in the list are in an operational down state, the current link is brought |
| | 574 | down. When at least one link has carrier, the current interface is brought up. |
| | 575 | </para> |
| | 576 | </listitem> |
| | 577 | </varlistentry> |
| | 578 | <varlistentry> |
| | 579 | <term><varname>Address=</varname></term> |
| | 580 | <listitem> |
| | 581 | <para>A static IPv4 or IPv6 address and its prefix length, |
| | 582 | separated by a <literal>/</literal> character. Specify |
| | 583 | this key more than once to configure several addresses. |
| | 584 | The format of the address must be as described in |
| | 585 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
| | 586 | This is a short-hand for an [Address] section only |
| | 587 | containing an Address key (see below). This option may be |
| | 588 | specified more than once. |
| | 589 | </para> |
| | 590 | |
| | 591 | <para>If the specified address is <literal>0.0.0.0</literal> (for IPv4) or <literal>::</literal> |
| | 592 | (for IPv6), a new address range of the requested size is automatically allocated from a |
| | 593 | system-wide pool of unused ranges. Note that the prefix length must be equal or larger than 8 for |
| | 594 | IPv4, and 64 for IPv6. The allocated range is checked against all current network interfaces and |
| | 595 | all known network configuration files to avoid address range conflicts. The default system-wide |
| | 596 | 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. |
| | 597 | This functionality is useful to manage a large number of dynamically created network interfaces |
| | 598 | with the same network configuration and automatic address range assignment.</para> |
| | 599 | |
| | 600 | </listitem> |
| | 601 | </varlistentry> |
| | 602 | <varlistentry> |
| | 603 | <term><varname>Gateway=</varname></term> |
| | 604 | <listitem> |
| | 605 | <para>The gateway address, which must be in the format |
| | 606 | described in |
| | 607 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
| | 608 | This is a short-hand for a [Route] section only containing |
| | 609 | a Gateway key. This option may be specified more than |
| | 610 | once.</para> |
| | 611 | </listitem> |
| | 612 | </varlistentry> |
| | 613 | <varlistentry> |
| | 614 | <term><varname>DNS=</varname></term> |
| | 615 | <listitem> |
| | 616 | <para>A DNS server address, which must be in the format |
| | 617 | described in |
| | 618 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
| | 619 | This option may be specified more than once. This setting is read by |
| | 620 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 621 | </listitem> |
| | 622 | </varlistentry> |
| | 623 | <varlistentry> |
| | 624 | <term><varname>Domains=</varname></term> |
| | 625 | <listitem> |
| | 626 | <para>A whitespace-separated list of domains which should be resolved using the DNS servers on |
| | 627 | this link. Each item in the list should be a domain name, optionally prefixed with a tilde |
| | 628 | (<literal>~</literal>). The domains with the prefix are called "routing-only domains". The |
| | 629 | domains without the prefix are called "search domains" and are first used as search suffixes for |
| | 630 | extending single-label hostnames (hostnames containing no dots) to become fully qualified |
| | 631 | domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the |
| | 632 | specified search domains are appended to it in turn, converting it into a fully qualified domain |
| | 633 | name, until one of them may be successfully resolved.</para> |
| | 634 | |
| | 635 | <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups for hostnames |
| | 636 | ending in those domains (hence also single label names, if any "search domains" are listed), are routed to |
| | 637 | the DNS servers configured for this interface. The domain routing logic is particularly useful on |
| | 638 | multi-homed hosts with DNS servers serving particular private DNS zones on each interface.</para> |
| | 639 | |
| | 640 | <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a routing domain, |
| | 641 | the dot referring to the DNS root domain which is the implied suffix of all valid DNS names) has special |
| | 642 | effect. It causes all DNS traffic which does not match another configured domain routing entry to be routed |
| | 643 | to DNS servers specified for this interface. This setting is useful to prefer a certain set of DNS servers |
| | 644 | if a link on which they are connected is available.</para> |
| | 645 | |
| | 646 | <para>This setting is read by |
| | 647 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. |
| | 648 | "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname> entries in |
| | 649 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 650 | Domain name routing has no equivalent in the traditional glibc API, which has no concept of domain |
| | 651 | name servers limited to a specific link.</para> |
| | 652 | </listitem> |
| | 653 | </varlistentry> |
| | 654 | <varlistentry> |
| | 655 | <term><varname>DNSDefaultRoute=</varname></term> |
| | 656 | <listitem> |
| | 657 | <para>Takes a boolean argument. If true, this link's configured DNS servers are used for resolving domain |
| | 658 | names that do not match any link's configured <varname>Domains=</varname> setting. If false, this link's |
| | 659 | configured DNS servers are never used for such domains, and are exclusively used for resolving names that |
| | 660 | match at least one of the domains configured on this link. If not specified defaults to an automatic mode: |
| | 661 | queries not matching any link's configured domains will be routed to this link if it has no routing-only |
| | 662 | domains configured.</para> |
| | 663 | </listitem> |
| | 664 | </varlistentry> |
| | 665 | <varlistentry> |
| | 666 | <term><varname>NTP=</varname></term> |
| | 667 | <listitem> |
| | 668 | <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 |
| | 669 | <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| | 670 | </listitem> |
| | 671 | </varlistentry> |
| | 672 | <varlistentry> |
| | 673 | <term><varname>IPForward=</varname></term> |
| | 674 | <listitem><para>Configures IP packet forwarding for the |
| | 675 | system. If enabled, incoming packets on any network |
| | 676 | interface will be forwarded to any other interfaces |
| | 677 | according to the routing table. Takes a boolean, |
| | 678 | or the values <literal>ipv4</literal> or |
| | 679 | <literal>ipv6</literal>, which only enable IP packet |
| | 680 | forwarding for the specified address family. This controls |
| | 681 | the <filename>net.ipv4.ip_forward</filename> and |
| | 682 | <filename>net.ipv6.conf.all.forwarding</filename> sysctl |
| | 683 | options of the network interface (see <ulink |
| | 684 | url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> |
| | 685 | for details about sysctl options). Defaults to |
| | 686 | <literal>no</literal>.</para> |
| | 687 | |
| | 688 | <para>Note: this setting controls a global kernel option, |
| | 689 | and does so one way only: if a network that has this setting |
| | 690 | enabled is set up the global setting is turned on. However, |
| | 691 | it is never turned off again, even after all networks with |
| | 692 | this setting enabled are shut down again.</para> |
| | 693 | |
| | 694 | <para>To allow IP packet forwarding only between specific |
| | 695 | network interfaces use a firewall.</para> |
| | 696 | </listitem> |
| | 697 | </varlistentry> |
| | 698 | <varlistentry> |
| | 699 | <term><varname>IPMasquerade=</varname></term> |
| | 700 | <listitem><para>Configures IP masquerading for the network |
| | 701 | interface. If enabled, packets forwarded from the network |
| | 702 | interface will be appear as coming from the local host. |
| | 703 | Takes a boolean argument. Implies |
| | 704 | <varname>IPForward=ipv4</varname>. Defaults to |
| | 705 | <literal>no</literal>.</para></listitem> |
| | 706 | </varlistentry> |
| | 707 | <varlistentry> |
| | 708 | <term><varname>IPv6PrivacyExtensions=</varname></term> |
| | 709 | <listitem><para>Configures use of stateless temporary |
| | 710 | addresses that change over time (see <ulink |
| | 711 | url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>, |
| | 712 | Privacy Extensions for Stateless Address Autoconfiguration |
| | 713 | in IPv6). Takes a boolean or the special values |
| | 714 | <literal>prefer-public</literal> and |
| | 715 | <literal>kernel</literal>. When true, enables the privacy |
| | 716 | extensions and prefers temporary addresses over public |
| | 717 | addresses. When <literal>prefer-public</literal>, enables the |
| | 718 | privacy extensions, but prefers public addresses over |
| | 719 | temporary addresses. When false, the privacy extensions |
| | 720 | remain disabled. When <literal>kernel</literal>, the kernel's |
| | 721 | default setting will be left in place. Defaults to |
| | 722 | <literal>no</literal>.</para></listitem> |
| | 723 | </varlistentry> |
| | 724 | <varlistentry> |
| | 725 | <term><varname>IPv6AcceptRA=</varname></term> |
| | 726 | <listitem><para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the |
| | 727 | interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may |
| | 728 | trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no |
| | 729 | routers are found on the link. The default is to disable RA reception for bridge devices or when IP |
| | 730 | forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link |
| | 731 | local addressing is disabled.</para> |
| | 732 | |
| | 733 | <para>Further settings for the IPv6 RA support may be configured in the |
| | 734 | <literal>[IPv6AcceptRA]</literal> section, see below.</para> |
| | 735 | |
| | 736 | <para>Also see <ulink |
| | 737 | url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel |
| | 738 | documentation regarding <literal>accept_ra</literal>, but note that systemd's setting of |
| | 739 | <constant>1</constant> (i.e. true) corresponds to kernel's setting of <constant>2</constant>.</para> |
| | 740 | |
| | 741 | <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled, |
| | 742 | regardless of this setting. If this option is enabled, a userspace implementation of the IPv6 |
| | 743 | RA protocol is used, and the kernel's own implementation remains disabled, since |
| | 744 | <command>systemd-networkd</command> needs to know all details supplied in the advertisements, |
| | 745 | and these are not available from the kernel if the kernel's own implementation is used.</para> |
| | 746 | </listitem> |
| | 747 | </varlistentry> |
| | 748 | <varlistentry> |
| | 749 | <term><varname>IPv6DuplicateAddressDetection=</varname></term> |
| | 750 | <listitem><para>Configures the amount of IPv6 Duplicate |
| | 751 | Address Detection (DAD) probes to send. When unset, the kernel's default will be used. |
| | 752 | </para></listitem> |
| | 753 | </varlistentry> |
| | 754 | <varlistentry> |
| | 755 | <term><varname>IPv6HopLimit=</varname></term> |
| | 756 | <listitem><para>Configures IPv6 Hop Limit. For each router that |
| | 757 | forwards the packet, the hop limit is decremented by 1. When the |
| | 758 | hop limit field reaches zero, the packet is discarded. |
| | 759 | When unset, the kernel's default will be used. |
| | 760 | </para></listitem> |
| | 761 | </varlistentry> |
| | 762 | <varlistentry> |
| | 763 | <term><varname>IPv4AcceptLocal=</varname></term> |
| | 764 | <listitem><para>Takes a boolean. Accept packets with local source addresses. In combination |
| | 765 | with suitable routing, this can be used to direct packets between two local interfaces over |
| | 766 | the wire and have them accepted properly. When unset, the kernel's default will be used. |
| | 767 | </para></listitem> |
| | 768 | </varlistentry> |
| | 769 | <varlistentry> |
| | 770 | <term><varname>IPv4ProxyARP=</varname></term> |
| | 771 | <listitem><para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host, |
| | 772 | usually a router, answers ARP requests intended for another machine. By "faking" its identity, |
| | 773 | the router accepts responsibility for routing packets to the "real" destination. (see <ulink |
| | 774 | url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. |
| | 775 | When unset, the kernel's default will be used. |
| | 776 | </para></listitem> |
| | 777 | </varlistentry> |
| | 778 | <varlistentry> |
| | 779 | <term><varname>IPv6ProxyNDP=</varname></term> |
| | 780 | <listitem><para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery |
| | 781 | Protocol) is a technique for IPv6 to allow routing of addresses to a different |
| | 782 | destination when peers expect them to be present on a certain physical link. |
| | 783 | In this case a router answers Neighbour Advertisement messages intended for |
| | 784 | another machine by offering its own MAC address as destination. |
| | 785 | Unlike proxy ARP for IPv4, it is not enabled globally, but will only send Neighbour |
| | 786 | Advertisement messages for addresses in the IPv6 neighbor proxy table, |
| | 787 | which can also be shown by <command>ip -6 neighbour show proxy</command>. |
| | 788 | systemd-networkd will control the per-interface `proxy_ndp` switch for each configured |
| | 789 | interface depending on this option. |
| | 790 | When unset, the kernel's default will be used. |
| | 791 | </para></listitem> |
| | 792 | </varlistentry> |
| | 793 | <varlistentry> |
| | 794 | <term><varname>IPv6ProxyNDPAddress=</varname></term> |
| | 795 | <listitem><para>An IPv6 address, for which Neighbour Advertisement messages will be |
| | 796 | proxied. This option may be specified more than once. systemd-networkd will add the |
| | 797 | <option>IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table. |
| | 798 | This option implies <option>IPv6ProxyNDP=yes</option> but has no effect if |
| | 799 | <option>IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used. |
| | 800 | </para></listitem> |
| | 801 | </varlistentry> |
| | 802 | <varlistentry> |
| | 803 | <term><varname>IPv6PrefixDelegation=</varname></term> |
| | 804 | <listitem><para>Whether to enable or disable Router Advertisement sending on a link. |
| | 805 | Allowed values are <literal>static</literal> which distributes prefixes as defined in |
| | 806 | the <literal>[IPv6PrefixDelegation]</literal> and any <literal>[IPv6Prefix]</literal> |
| | 807 | sections, <literal>dhcpv6</literal> which requests prefixes using a DHCPv6 client |
| | 808 | configured for another link and any values configured in the |
| | 809 | <literal>[IPv6PrefixDelegation]</literal> section while ignoring all static prefix |
| | 810 | configuration sections, <literal>yes</literal> which uses both static configuration |
| | 811 | and DHCPv6, and <literal>false</literal> which turns off IPv6 prefix delegation |
| | 812 | altogether. Defaults to <literal>false</literal>. See the |
| | 813 | <literal>[IPv6PrefixDelegation]</literal> and the <literal>[IPv6Prefix]</literal> |
| | 814 | sections for more configuration options. |
| | 815 | </para></listitem> |
| | 816 | </varlistentry> |
| | 817 | <varlistentry> |
| | 818 | <term><varname>IPv6PDSubnetId=</varname></term> |
| | 819 | <listitem><para>Configure a specific subnet ID on the interface from a (previously) received prefix delegation. |
| | 820 | You can either set "auto" (the default) or a specific subnet ID |
| | 821 | (as defined in <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section 2.5.4), |
| | 822 | in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff inclusive. |
| | 823 | This option is only effective when used together with <varname>IPv6PrefixDelegation=</varname> |
| | 824 | and the corresponding configuration on the upstream interface. |
| | 825 | </para></listitem> |
| | 826 | </varlistentry> |
| | 827 | <varlistentry> |
| | 828 | <term><varname>IPv6MTUBytes=</varname></term> |
| | 829 | <listitem><para>Configures IPv6 maximum transmission unit (MTU). |
| | 830 | An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used. |
| | 831 | </para></listitem> |
| | 832 | </varlistentry> |
| | 833 | <varlistentry> |
| | 834 | <term><varname>Bridge=</varname></term> |
| | 835 | <listitem> |
| | 836 | <para>The name of the bridge to add the link to. See |
| | 837 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 838 | </para> |
| | 839 | </listitem> |
| | 840 | </varlistentry> |
| | 841 | <varlistentry> |
| | 842 | <term><varname>Bond=</varname></term> |
| | 843 | <listitem> |
| | 844 | <para>The name of the bond to add the link to. See |
| | 845 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 846 | </para> |
| | 847 | </listitem> |
| | 848 | </varlistentry> |
| | 849 | <varlistentry> |
| | 850 | <term><varname>VRF=</varname></term> |
| | 851 | <listitem> |
| | 852 | <para>The name of the VRF to add the link to. See |
| | 853 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 854 | </para> |
| | 855 | </listitem> |
| | 856 | </varlistentry> |
| | 857 | <varlistentry> |
| | 858 | <term><varname>VLAN=</varname></term> |
| | 859 | <listitem> |
| | 860 | <para>The name of a VLAN to create on the link. See |
| | 861 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 862 | This option may be specified more than once.</para> |
| | 863 | </listitem> |
| | 864 | </varlistentry> |
| | 865 | <varlistentry> |
| | 866 | <term><varname>IPVLAN=</varname></term> |
| | 867 | <listitem> |
| | 868 | <para>The name of a IPVLAN to create on the link. See |
| | 869 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 870 | This option may be specified more than once.</para> |
| | 871 | </listitem> |
| | 872 | </varlistentry> |
| | 873 | <varlistentry> |
| | 874 | <term><varname>MACVLAN=</varname></term> |
| | 875 | <listitem> |
| | 876 | <para>The name of a MACVLAN to create on the link. See |
| | 877 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 878 | This option may be specified more than once.</para> |
| | 879 | </listitem> |
| | 880 | </varlistentry> |
| | 881 | <varlistentry> |
| | 882 | <term><varname>VXLAN=</varname></term> |
| | 883 | <listitem> |
| | 884 | <para>The name of a VXLAN to create on the link. See |
| | 885 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 886 | This option may be specified more than once.</para> |
| | 887 | </listitem> |
| | 888 | </varlistentry> |
| | 889 | <varlistentry> |
| | 890 | <term><varname>Tunnel=</varname></term> |
| | 891 | <listitem> |
| | 892 | <para>The name of a Tunnel to create on the link. See |
| | 893 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 894 | This option may be specified more than once.</para> |
| | 895 | </listitem> |
| | 896 | </varlistentry> |
| | 897 | <varlistentry> |
| | 898 | <term><varname>MACsec=</varname></term> |
| | 899 | <listitem> |
| | 900 | <para>The name of a MACsec device to create on the link. See |
| | 901 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 902 | This option may be specified more than once.</para> |
| | 903 | </listitem> |
| | 904 | </varlistentry> |
| | 905 | <varlistentry> |
| | 906 | <term><varname>ActiveSlave=</varname></term> |
| | 907 | <listitem> |
| | 908 | <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal> |
| | 909 | option is only valid for following modes: |
| | 910 | <literal>active-backup</literal>, |
| | 911 | <literal>balance-alb</literal> and |
| | 912 | <literal>balance-tlb</literal>. Defaults to false. |
| | 913 | </para> |
| | 914 | </listitem> |
| | 915 | </varlistentry> |
| | 916 | <varlistentry> |
| | 917 | <term><varname>PrimarySlave=</varname></term> |
| | 918 | <listitem> |
| | 919 | <para>Takes a boolean. Specifies which slave is the primary device. The specified |
| | 920 | device will always be the active slave while it is available. Only when the |
| | 921 | primary is off-line will alternate devices be used. This is useful when |
| | 922 | one slave is preferred over another, e.g. when one slave has higher throughput |
| | 923 | than another. The <literal>PrimarySlave=</literal> option is only valid for |
| | 924 | following modes: |
| | 925 | <literal>active-backup</literal>, |
| | 926 | <literal>balance-alb</literal> and |
| | 927 | <literal>balance-tlb</literal>. Defaults to false. |
| | 928 | </para> |
| | 929 | </listitem> |
| | 930 | </varlistentry> |
| | 931 | <varlistentry> |
| | 932 | <term><varname>ConfigureWithoutCarrier=</varname></term> |
| | 933 | <listitem> |
| | 934 | <para>Takes a boolean. Allows networkd to configure a specific link even if it has no carrier. |
| | 935 | Defaults to false. If <option>IgnoreCarrierLoss=</option> is not explicitly set, it will |
| | 936 | default to this value. |
| | 937 | </para> |
| | 938 | </listitem> |
| | 939 | </varlistentry> |
| | 940 | <varlistentry> |
| | 941 | <term><varname>IgnoreCarrierLoss=</varname></term> |
| | 942 | <listitem> |
| | 943 | <para>Takes a boolean. Allows networkd to retain both the static and dynamic configuration |
| | 944 | of the interface even if its carrier is lost. When unset, the value specified with |
| | 945 | <option>ConfigureWithoutCarrier=</option> is used. |
| | 946 | </para> |
| | 947 | </listitem> |
| | 948 | </varlistentry> |
| | 949 | <varlistentry> |
| | 950 | <term><varname>Xfrm=</varname></term> |
| | 951 | <listitem> |
| | 952 | <para>The name of the xfrm to create on the link. See |
| | 953 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
| | 954 | This option may be specified more than once.</para> |
| | 955 | </listitem> |
| | 956 | </varlistentry> |
| | 957 | <varlistentry> |
| | 958 | <term><varname>KeepConfiguration=</varname></term> |
| | 959 | <listitem> |
| | 960 | <para>Takes a boolean or one of <literal>static</literal>, <literal>dhcp-on-stop</literal>, |
| | 961 | <literal>dhcp</literal>. When <literal>static</literal>, <command>systemd-networkd</command> |
| | 962 | will not drop static addresses and routes on starting up process. When set to |
| | 963 | <literal>dhcp-on-stop</literal>, <command>systemd-networkd</command> will not drop addresses |
| | 964 | and routes on stopping the daemon. When <literal>dhcp</literal>, |
| | 965 | the addresses and routes provided by a DHCP server will never be dropped even if the DHCP |
| | 966 | lease expires. This is contrary to the DHCP specification, but may be the best choice if, |
| | 967 | e.g., the root filesystem relies on this connection. The setting <literal>dhcp</literal> |
| | 968 | implies <literal>dhcp-on-stop</literal>, and <literal>yes</literal> implies |
| | 969 | <literal>dhcp</literal> and <literal>static</literal>. Defaults to <literal>no</literal>. |
| | 970 | </para> |
| | 971 | </listitem> |
| | 972 | </varlistentry> |
| | 973 | |
| | 974 | </variablelist> |
| | 975 | |
| | 976 | </refsect1> |
| | 977 | |
| | 978 | <refsect1> |
| | 979 | <title>[Address] Section Options</title> |
| | 980 | |
| | 981 | <para>An <literal>[Address]</literal> section accepts the |
| | 982 | following keys. Specify several <literal>[Address]</literal> |
| | 983 | sections to configure several addresses.</para> |
| | 984 | |
| | 985 | <variablelist class='network-directives'> |
| | 986 | <varlistentry> |
| | 987 | <term><varname>Address=</varname></term> |
| | 988 | <listitem> |
| | 989 | <para>As in the <literal>[Network]</literal> section. This key is mandatory. Each |
| | 990 | <literal>[Address]</literal> section can contain one <varname>Address=</varname> setting.</para> |
| | 991 | </listitem> |
| | 992 | </varlistentry> |
| | 993 | <varlistentry> |
| | 994 | <term><varname>Peer=</varname></term> |
| | 995 | <listitem> |
| | 996 | <para>The peer address in a point-to-point connection. |
| | 997 | Accepts the same format as the <varname>Address=</varname> |
| | 998 | key.</para> |
| | 999 | </listitem> |
| | 1000 | </varlistentry> |
| | 1001 | <varlistentry> |
| | 1002 | <term><varname>Broadcast=</varname></term> |
| | 1003 | <listitem> |
| | 1004 | <para>The broadcast address, which must be in the format |
| | 1005 | described in |
| | 1006 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
| | 1007 | This key only applies to IPv4 addresses. If it is not |
| | 1008 | given, it is derived from the <varname>Address=</varname> |
| | 1009 | key.</para> |
| | 1010 | </listitem> |
| | 1011 | </varlistentry> |
| | 1012 | <varlistentry> |
| | 1013 | <term><varname>Label=</varname></term> |
| | 1014 | <listitem> |
| | 1015 | <para>An address label.</para> |
| | 1016 | </listitem> |
| | 1017 | </varlistentry> |
| | 1018 | <varlistentry> |
| | 1019 | <term><varname>PreferredLifetime=</varname></term> |
| | 1020 | <listitem> |
| | 1021 | <para>Allows the default "preferred lifetime" of the address to be overridden. |
| | 1022 | Only three settings are accepted: <literal>forever</literal> or <literal>infinity</literal> |
| | 1023 | which is the default and means that the address never expires, and <literal>0</literal> which means |
| | 1024 | that the address is considered immediately "expired" and will not be used, |
| | 1025 | unless explicitly requested. A setting of PreferredLifetime=0 is useful for |
| | 1026 | addresses which are added to be used only by a specific application, |
| | 1027 | which is then configured to use them explicitly.</para> |
| | 1028 | </listitem> |
| | 1029 | </varlistentry> |
| | 1030 | <varlistentry> |
| | 1031 | <term><varname>Scope=</varname></term> |
| | 1032 | <listitem> |
| | 1033 | <para>The scope of the address, which can be <literal>global</literal>, |
| | 1034 | <literal>link</literal> or <literal>host</literal> or an unsigned integer ranges 0 to 255. |
| | 1035 | Defaults to <literal>global</literal>.</para> |
| | 1036 | </listitem> |
| | 1037 | </varlistentry> |
| | 1038 | <varlistentry> |
| | 1039 | <term><varname>HomeAddress=</varname></term> |
| | 1040 | <listitem> |
| | 1041 | <para>Takes a boolean. Designates this address the "home address" as defined in |
| | 1042 | <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>. |
| | 1043 | Supported only on IPv6. Defaults to false.</para> |
| | 1044 | </listitem> |
| | 1045 | </varlistentry> |
| | 1046 | <varlistentry> |
| | 1047 | <term><varname>DuplicateAddressDetection=</varname></term> |
| | 1048 | <listitem> |
| | 1049 | <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, |
| | 1050 | <literal>both</literal>, <literal>none</literal>. When <literal>ipv4</literal>, |
| | 1051 | performs IPv4 Duplicate Address Detection. See |
| | 1052 | <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>. |
| | 1053 | When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See |
| | 1054 | <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>. |
| | 1055 | Defaults to <literal>ipv6</literal>.</para> |
| | 1056 | </listitem> |
| | 1057 | </varlistentry> |
| | 1058 | <varlistentry> |
| | 1059 | <term><varname>ManageTemporaryAddress=</varname></term> |
| | 1060 | <listitem> |
| | 1061 | <para>Takes a boolean. If true the kernel manage temporary addresses created |
| | 1062 | from this one as template on behalf of Privacy Extensions |
| | 1063 | <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become |
| | 1064 | active, the use_tempaddr sysctl setting has to be set to a value greater than zero. |
| | 1065 | The given address needs to have a prefix length of 64. This flag allows using privacy |
| | 1066 | extensions in a manually configured network, just like if stateless auto-configuration |
| | 1067 | was active. Defaults to false. </para> |
| | 1068 | </listitem> |
| | 1069 | </varlistentry> |
| | 1070 | <varlistentry> |
| | 1071 | <term><varname>AddPrefixRoute=</varname></term> |
| | 1072 | <listitem> |
| | 1073 | <para>Takes a boolean. When true, the prefix route for the address is automatically added. |
| | 1074 | Defaults to true.</para> |
| | 1075 | </listitem> |
| | 1076 | </varlistentry> |
| | 1077 | <varlistentry> |
| | 1078 | <term><varname>AutoJoin=</varname></term> |
| | 1079 | <listitem> |
| | 1080 | <para>Takes a boolean. Joining multicast group on ethernet level via |
| | 1081 | <command>ip maddr</command> command would not work if we have an Ethernet switch that does |
| | 1082 | IGMP snooping since the switch would not replicate multicast packets on ports that did not |
| | 1083 | have IGMP reports for the multicast addresses. Linux vxlan interfaces created via |
| | 1084 | <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option |
| | 1085 | that enables then to do the required join. By extending ip address command with option |
| | 1086 | <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) vxlan |
| | 1087 | interfaces as well as other tunneling mechanisms that need to receive multicast traffic. |
| | 1088 | Defaults to <literal>no</literal>.</para> |
| | 1089 | </listitem> |
| | 1090 | </varlistentry> |
| | 1091 | </variablelist> |
| | 1092 | </refsect1> |
| | 1093 | |
| | 1094 | <refsect1> |
| | 1095 | <title>[Neighbor] Section Options</title> |
| | 1096 | <para>A <literal>[Neighbor]</literal> section accepts the |
| | 1097 | following keys. The neighbor section adds a permanent, static |
| | 1098 | entry to the neighbor table (IPv6) or ARP table (IPv4) for |
| | 1099 | the given hardware address on the links matched for the network. |
| | 1100 | Specify several <literal>[Neighbor]</literal> sections to configure |
| | 1101 | several static neighbors.</para> |
| | 1102 | |
| | 1103 | <variablelist class='network-directives'> |
| | 1104 | <varlistentry> |
| | 1105 | <term><varname>Address=</varname></term> |
| | 1106 | <listitem> |
| | 1107 | <para>The IP address of the neighbor.</para> |
| | 1108 | </listitem> |
| | 1109 | </varlistentry> |
| | 1110 | <varlistentry> |
| | 1111 | <term><varname>LinkLayerAddress=</varname></term> |
| | 1112 | <listitem> |
| | 1113 | <para>The link layer address (MAC address or IP address) of the neighbor.</para> |
| | 1114 | </listitem> |
| | 1115 | </varlistentry> |
| | 1116 | </variablelist> |
| | 1117 | </refsect1> |
| | 1118 | |
| | 1119 | <refsect1> |
| | 1120 | <title>[IPv6AddressLabel] Section Options</title> |
| | 1121 | |
| | 1122 | <para>An <literal>[IPv6AddressLabel]</literal> section accepts the |
| | 1123 | following keys. Specify several <literal>[IPv6AddressLabel]</literal> |
| | 1124 | sections to configure several address labels. IPv6 address labels are |
| | 1125 | used for address selection. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. |
| | 1126 | Precedence is managed by userspace, and only the label itself is stored in the kernel</para> |
| | 1127 | |
| | 1128 | <variablelist class='network-directives'> |
| | 1129 | <varlistentry> |
| | 1130 | <term><varname>Label=</varname></term> |
| | 1131 | <listitem> |
| | 1132 | <para> The label for the prefix (an unsigned integer) ranges 0 to 4294967294. |
| | 1133 | 0xffffffff is reserved. This key is mandatory.</para> |
| | 1134 | </listitem> |
| | 1135 | </varlistentry> |
| | 1136 | <varlistentry> |
| | 1137 | <term><varname>Prefix=</varname></term> |
| | 1138 | <listitem> |
| | 1139 | <para>IPv6 prefix is an address with a prefix length, separated by a slash <literal>/</literal> character. |
| | 1140 | This key is mandatory. </para> |
| | 1141 | </listitem> |
| | 1142 | </varlistentry> |
| | 1143 | </variablelist> |
| | 1144 | </refsect1> |
| | 1145 | |
| | 1146 | <refsect1> |
| | 1147 | <title>[RoutingPolicyRule] Section Options</title> |
| | 1148 | |
| | 1149 | <para>An <literal>[RoutingPolicyRule]</literal> section accepts the |
| | 1150 | following keys. Specify several <literal>[RoutingPolicyRule]</literal> |
| | 1151 | sections to configure several rules.</para> |
| | 1152 | |
| | 1153 | <variablelist class='network-directives'> |
| | 1154 | <varlistentry> |
| | 1155 | <term><varname>TypeOfService=</varname></term> |
| | 1156 | <listitem> |
| | 1157 | <para>Specifies the type of service to match a number between 0 to 255.</para> |
| | 1158 | </listitem> |
| | 1159 | </varlistentry> |
| | 1160 | <varlistentry> |
| | 1161 | <term><varname>From=</varname></term> |
| | 1162 | <listitem> |
| | 1163 | <para>Specifies the source address prefix to match. Possibly followed by a slash and the prefix length.</para> |
| | 1164 | </listitem> |
| | 1165 | </varlistentry> |
| | 1166 | <varlistentry> |
| | 1167 | <term><varname>To=</varname></term> |
| | 1168 | <listitem> |
| | 1169 | <para>Specifies the destination address prefix to match. Possibly followed by a slash and the prefix length.</para> |
| | 1170 | </listitem> |
| | 1171 | </varlistentry> |
| | 1172 | <varlistentry> |
| | 1173 | <term><varname>FirewallMark=</varname></term> |
| | 1174 | <listitem> |
| | 1175 | <para>Specifies the iptables firewall mark value to match (a number between 1 and 4294967295).</para> |
| | 1176 | </listitem> |
| | 1177 | </varlistentry> |
| | 1178 | <varlistentry> |
| | 1179 | <term><varname>Table=</varname></term> |
| | 1180 | <listitem> |
| | 1181 | <para>Specifies the routing table identifier to lookup if the rule selector matches. Takes |
| | 1182 | one of <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, |
| | 1183 | or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para> |
| | 1184 | </listitem> |
| | 1185 | </varlistentry> |
| | 1186 | <varlistentry> |
| | 1187 | <term><varname>Priority=</varname></term> |
| | 1188 | <listitem> |
| | 1189 | <para>Specifies the priority of this rule. <varname>Priority=</varname> is an unsigned |
| | 1190 | integer. Higher number means lower priority, and rules get processed in order of increasing number.</para> |
| | 1191 | </listitem> |
| | 1192 | </varlistentry> |
| | 1193 | <varlistentry> |
| | 1194 | <term><varname>IncomingInterface=</varname></term> |
| | 1195 | <listitem> |
| | 1196 | <para>Specifies incoming device to match. If the interface is loopback, the rule only matches packets originating from this host.</para> |
| | 1197 | </listitem> |
| | 1198 | </varlistentry> |
| | 1199 | <varlistentry> |
| | 1200 | <term><varname>OutgoingInterface=</varname></term> |
| | 1201 | <listitem> |
| | 1202 | <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> |
| | 1203 | </listitem> |
| | 1204 | </varlistentry> |
| | 1205 | <varlistentry> |
| | 1206 | <term><varname>SourcePort=</varname></term> |
| | 1207 | <listitem> |
| | 1208 | <para>Specifies the source IP port or IP port range match in forwarding information base (FIB) rules. |
| | 1209 | A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para> |
| | 1210 | </listitem> |
| | 1211 | </varlistentry> |
| | 1212 | <varlistentry> |
| | 1213 | <term><varname>DestinationPort=</varname></term> |
| | 1214 | <listitem> |
| | 1215 | <para>Specifies the destination IP port or IP port range match in forwarding information base (FIB) rules. |
| | 1216 | A port range is specified by the lower and upper port separated by a dash. Defaults to unset.</para> |
| | 1217 | </listitem> |
| | 1218 | </varlistentry> |
| | 1219 | <varlistentry> |
| | 1220 | <term><varname>IPProtocol=</varname></term> |
| | 1221 | <listitem> |
| | 1222 | <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP protocol name such as <literal>tcp</literal>, |
| | 1223 | <literal>udp</literal> or <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for <literal>tcp</literal> or |
| | 1224 | <literal>17</literal> for <literal>udp</literal>. |
| | 1225 | Defaults to unset.</para> |
| | 1226 | </listitem> |
| | 1227 | </varlistentry> |
| | 1228 | <varlistentry> |
| | 1229 | <term><varname>InvertRule=</varname></term> |
| | 1230 | <listitem> |
| | 1231 | <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para> |
| | 1232 | </listitem> |
| | 1233 | </varlistentry> |
| | 1234 | <varlistentry> |
| | 1235 | <term><varname>Family=</varname></term> |
| | 1236 | <listitem> |
| | 1237 | <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or |
| | 1238 | <literal>both</literal>. By default, the address family is determined by the address |
| | 1239 | specified in <varname>To=</varname> or <varname>From=</varname>. If neither |
| | 1240 | <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to |
| | 1241 | <literal>ipv4</literal>.</para> |
| | 1242 | </listitem> |
| | 1243 | </varlistentry> |
| | 1244 | <varlistentry> |
| | 1245 | <term><varname>User=</varname></term> |
| | 1246 | <listitem> |
| | 1247 | <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to |
| | 1248 | unset.</para> |
| | 1249 | </listitem> |
| | 1250 | </varlistentry> |
| | 1251 | <varlistentry> |
| | 1252 | <term><varname>SuppressPrefixLength=</varname></term> |
| | 1253 | <listitem> |
| | 1254 | <para>Takes a number <replaceable>N</replaceable> in the range 0-128 and rejects routing |
| | 1255 | decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to |
| | 1256 | unset.</para> |
| | 1257 | </listitem> |
| | 1258 | </varlistentry> |
| | 1259 | </variablelist> |
| | 1260 | </refsect1> |
| | 1261 | |
| | 1262 | <refsect1> |
| | 1263 | <title>[NextHop] Section Options</title> |
| | 1264 | <para>The <literal>[NextHop]</literal> section accepts the |
| | 1265 | following keys. Specify several <literal>[NextHop]</literal> |
| | 1266 | sections to configure several nexthop. Nexthop is used to manipulate entries in the kernel's nexthop |
| | 1267 | tables.</para> |
| | 1268 | |
| | 1269 | <variablelist class='network-directives'> |
| | 1270 | <varlistentry> |
| | 1271 | <term><varname>Gateway=</varname></term> |
| | 1272 | <listitem> |
| | 1273 | <para>As in the <literal>[Network]</literal> section. This is mandatory.</para> |
| | 1274 | </listitem> |
| | 1275 | </varlistentry> |
| | 1276 | <varlistentry> |
| | 1277 | <term><varname>Id=</varname></term> |
| | 1278 | <listitem> |
| | 1279 | <para>The id of the nexthop (an unsigned integer). If unspecified or '0' then automatically chosen by kernel.</para> |
| | 1280 | </listitem> |
| | 1281 | </varlistentry> |
| | 1282 | </variablelist> |
| | 1283 | </refsect1> |
| | 1284 | |
| | 1285 | <refsect1> |
| | 1286 | <title>[Route] Section Options</title> |
| | 1287 | <para>The <literal>[Route]</literal> section accepts the |
| | 1288 | following keys. Specify several <literal>[Route]</literal> |
| | 1289 | sections to configure several routes.</para> |
| | 1290 | |
| | 1291 | <variablelist class='network-directives'> |
| | 1292 | <varlistentry> |
| | 1293 | <term><varname>Gateway=</varname></term> |
| | 1294 | <listitem> |
| | 1295 | <para>Takes the gateway address or special value <literal>_dhcp</literal>. If |
| | 1296 | <literal>_dhcp</literal>, then the gateway address provided by DHCP (or in the IPv6 case, |
| | 1297 | provided by IPv6 RA) is used.</para> |
| | 1298 | </listitem> |
| | 1299 | </varlistentry> |
| | 1300 | <varlistentry> |
| | 1301 | <term><varname>GatewayOnLink=</varname></term> |
| | 1302 | <listitem> |
| | 1303 | <para>Takes a boolean. If set to true, the kernel does not have |
| | 1304 | to check if the gateway is reachable directly by the current machine (i.e., the kernel does |
| | 1305 | not need to check if the gateway is attached to the local network), so that we can insert the |
| | 1306 | route in the kernel table without it being complained about. Defaults to <literal>no</literal>. |
| | 1307 | </para> |
| | 1308 | </listitem> |
| | 1309 | </varlistentry> |
| | 1310 | <varlistentry> |
| | 1311 | <term><varname>Destination=</varname></term> |
| | 1312 | <listitem> |
| | 1313 | <para>The destination prefix of the route. Possibly |
| | 1314 | followed by a slash and the prefix length. If omitted, a |
| | 1315 | full-length host route is assumed.</para> |
| | 1316 | </listitem> |
| | 1317 | </varlistentry> |
| | 1318 | <varlistentry> |
| | 1319 | <term><varname>Source=</varname></term> |
| | 1320 | <listitem> |
| | 1321 | <para>The source prefix of the route. Possibly followed by |
| | 1322 | a slash and the prefix length. If omitted, a full-length |
| | 1323 | host route is assumed.</para> |
| | 1324 | </listitem> |
| | 1325 | </varlistentry> |
| | 1326 | <varlistentry> |
| | 1327 | <term><varname>Metric=</varname></term> |
| | 1328 | <listitem> |
| | 1329 | <para>The metric of the route (an unsigned integer).</para> |
| | 1330 | </listitem> |
| | 1331 | </varlistentry> |
| | 1332 | <varlistentry> |
| | 1333 | <term><varname>IPv6Preference=</varname></term> |
| | 1334 | <listitem> |
| | 1335 | <para>Specifies the route preference as defined in <ulink |
| | 1336 | url="https://tools.ietf.org/html/rfc4191">RFC4191</ulink> for Router Discovery messages. |
| | 1337 | Which can be one of <literal>low</literal> the route has a lowest priority, |
| | 1338 | <literal>medium</literal> the route has a default priority or |
| | 1339 | <literal>high</literal> the route has a highest priority.</para> |
| | 1340 | </listitem> |
| | 1341 | </varlistentry> |
| | 1342 | <varlistentry> |
| | 1343 | <term><varname>Scope=</varname></term> |
| | 1344 | <listitem> |
| | 1345 | <para>The scope of the route, which can be <literal>global</literal>, <literal>site</literal>, |
| | 1346 | <literal>link</literal>, <literal>host</literal>, or <literal>nowhere</literal>. For IPv4 route, |
| | 1347 | defaults to <literal>host</literal> if <varname>Type=</varname> is <literal>local</literal> |
| | 1348 | or <literal>nat</literal>, and <literal>link</literal> if <varname>Type=</varname> is |
| | 1349 | <literal>broadcast</literal>, <literal>multicast</literal>, or <literal>anycast</literal>. |
| | 1350 | In other cases, defaults to <literal>global</literal>.</para> |
| | 1351 | </listitem> |
| | 1352 | </varlistentry> |
| | 1353 | <varlistentry> |
| | 1354 | <term><varname>PreferredSource=</varname></term> |
| | 1355 | <listitem> |
| | 1356 | <para>The preferred source address of the route. The address |
| | 1357 | must be in the format described in |
| | 1358 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> |
| | 1359 | </listitem> |
| | 1360 | </varlistentry> |
| | 1361 | <varlistentry> |
| | 1362 | <term><varname>Table=</varname></term> |
| | 1363 | <listitem> |
| | 1364 | <para>The table identifier for the route. Takes <literal>default</literal>, |
| | 1365 | <literal>main</literal>, <literal>local</literal> or a number between 1 and 4294967295. |
| | 1366 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. |
| | 1367 | If unset and <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>, |
| | 1368 | <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used. |
| | 1369 | In other cases, defaults to <literal>main</literal>. |
| | 1370 | </para> |
| | 1371 | </listitem> |
| | 1372 | </varlistentry> |
| | 1373 | <varlistentry> |
| | 1374 | <term><varname>Protocol=</varname></term> |
| | 1375 | <listitem> |
| | 1376 | <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special values |
| | 1377 | <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>, |
| | 1378 | <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>. |
| | 1379 | </para> |
| | 1380 | </listitem> |
| | 1381 | </varlistentry> |
| | 1382 | <varlistentry> |
| | 1383 | <term><varname>Type=</varname></term> |
| | 1384 | <listitem> |
| | 1385 | <para>Specifies the type for the route. Takes one of <literal>unicast</literal>, |
| | 1386 | <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>, |
| | 1387 | <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>, |
| | 1388 | <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and |
| | 1389 | <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e. a |
| | 1390 | route indicating the path to take to a destination network address. If <literal>blackhole</literal>, packets |
| | 1391 | to the defined route are discarded silently. If <literal>unreachable</literal>, packets to the defined route |
| | 1392 | are discarded and the ICMP message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets |
| | 1393 | to the defined route are discarded and the ICMP message "Communication Administratively Prohibited" is |
| | 1394 | generated. If <literal>throw</literal>, route lookup in the current routing table will fail and the route |
| | 1395 | selection process will return to Routing Policy Database (RPDB). Defaults to <literal>unicast</literal>. |
| | 1396 | </para> |
| | 1397 | </listitem> |
| | 1398 | </varlistentry> |
| | 1399 | <varlistentry> |
| | 1400 | <term><varname>InitialCongestionWindow=</varname></term> |
| | 1401 | <listitem> |
| | 1402 | <para>The TCP initial congestion window is used during the start of a TCP connection. During the start of a TCP |
| | 1403 | session, when a client requests a resource, the server's initial congestion window determines how many data bytes |
| | 1404 | will be sent during the initial burst of data. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual |
| | 1405 | suffixes K, M, G are supported and are understood to the base of 1024. When unset, the kernel's default will be used. |
| | 1406 | </para> |
| | 1407 | </listitem> |
| | 1408 | </varlistentry> |
| | 1409 | <varlistentry> |
| | 1410 | <term><varname>InitialAdvertisedReceiveWindow=</varname></term> |
| | 1411 | <listitem> |
| | 1412 | <para>The TCP initial advertised receive window is the amount of receive data (in bytes) that can initially be buffered at one time |
| | 1413 | on a connection. The sending host can send only that amount of data before waiting for an acknowledgment and window update |
| | 1414 | from the receiving host. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual suffixes K, M, G are supported |
| | 1415 | and are understood to the base of 1024. When unset, the kernel's default will be used. |
| | 1416 | </para> |
| | 1417 | </listitem> |
| | 1418 | </varlistentry> |
| | 1419 | <varlistentry> |
| | 1420 | <term><varname>QuickAck=</varname></term> |
| | 1421 | <listitem> |
| | 1422 | <para>Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used. |
| | 1423 | </para> |
| | 1424 | </listitem> |
| | 1425 | </varlistentry> |
| | 1426 | <varlistentry> |
| | 1427 | <term><varname>FastOpenNoCookie=</varname></term> |
| | 1428 | <listitem> |
| | 1429 | <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis. |
| | 1430 | When unset, the kernel's default will be used. |
| | 1431 | </para> |
| | 1432 | </listitem> |
| | 1433 | </varlistentry> |
| | 1434 | <varlistentry> |
| | 1435 | <term><varname>TTLPropagate=</varname></term> |
| | 1436 | <listitem> |
| | 1437 | <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress. |
| | 1438 | When unset, the kernel's default will be used. |
| | 1439 | </para> |
| | 1440 | </listitem> |
| | 1441 | </varlistentry> |
| | 1442 | <varlistentry> |
| | 1443 | <term><varname>MTUBytes=</varname></term> |
| | 1444 | <listitem> |
| | 1445 | <para>The maximum transmission unit in bytes to set for the |
| | 1446 | route. The usual suffixes K, M, G, are supported and are |
| | 1447 | understood to the base of 1024.</para> |
| | 1448 | <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen |
| | 1449 | below 1280 (the minimum MTU for IPv6) it will automatically be increased to this value.</para> |
| | 1450 | </listitem> |
| | 1451 | </varlistentry> |
| | 1452 | <varlistentry> |
| | 1453 | <term><varname>IPServiceType=</varname></term> |
| | 1454 | <listitem> |
| | 1455 | <para>Takes string; <literal>CS6</literal> or <literal>CS4</literal>. Used to set IP |
| | 1456 | service type to CS6 (network control) or CS4 (Realtime). Defaults to CS6.</para> |
| | 1457 | </listitem> |
| | 1458 | </varlistentry> |
| | 1459 | <varlistentry> |
| | 1460 | <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term> |
| | 1461 | <listitem> |
| | 1462 | <para>Configures multipath route. Multipath routing is the technique of using multiple |
| | 1463 | alternative paths through a network. Takes gateway address. Optionally, takes a network |
| | 1464 | interface name or index separated with <literal>@</literal>, and a weight in 1..256 for |
| | 1465 | this multipath route separated with whitespace. This setting can be specified multiple |
| | 1466 | times. If an empty string is assigned, then the all previous assignments are cleared.</para> |
| | 1467 | </listitem> |
| | 1468 | </varlistentry> |
| | 1469 | </variablelist> |
| | 1470 | </refsect1> |
| | 1471 | |
| | 1472 | <refsect1> |
| | 1473 | <title>[DHCPv4] Section Options</title> |
| | 1474 | <para>The <literal>[DHCPv4]</literal> section configures the |
| | 1475 | DHCPv4 client, if it is enabled with the |
| | 1476 | <varname>DHCP=</varname> setting described above:</para> |
| | 1477 | |
| | 1478 | <variablelist class='network-directives'> |
| | 1479 | <varlistentry> |
| | 1480 | <term><varname>UseDNS=</varname></term> |
| | 1481 | <listitem> |
| | 1482 | <para>When true (the default), the DNS servers received |
| | 1483 | from the DHCP server will be used and take precedence over |
| | 1484 | any statically configured ones.</para> |
| | 1485 | |
| | 1486 | <para>This corresponds to the <option>nameserver</option> |
| | 1487 | option in <citerefentry |
| | 1488 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
| | 1489 | </listitem> |
| | 1490 | </varlistentry> |
| | 1491 | <varlistentry> |
| | 1492 | <term><varname>RoutesToDNS=</varname></term> |
| | 1493 | <listitem> |
| | 1494 | <para>When true, the routes to the DNS servers received from the DHCP server will be |
| | 1495 | configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored. |
| | 1496 | Defaults to false.</para> |
| | 1497 | </listitem> |
| | 1498 | </varlistentry> |
| | 1499 | <varlistentry> |
| | 1500 | <term><varname>UseNTP=</varname></term> |
| | 1501 | <listitem> |
| | 1502 | <para>When true (the default), the NTP servers received from the DHCP server will be used by |
| | 1503 | <filename>systemd-timesyncd.service</filename> and take precedence over any statically configured |
| | 1504 | ones.</para> |
| | 1505 | </listitem> |
| | 1506 | </varlistentry> |
| | 1507 | <varlistentry> |
| | 1508 | <term><varname>UseSIP=</varname></term> |
| | 1509 | <listitem> |
| | 1510 | <para>When true (the default), the SIP servers received from the DHCP server will be collected |
| | 1511 | and made available to client programs.</para> |
| | 1512 | </listitem> |
| | 1513 | </varlistentry> |
| | 1514 | |
| | 1515 | <varlistentry> |
| | 1516 | <term><varname>UseMTU=</varname></term> |
| | 1517 | <listitem> |
| | 1518 | <para>When true, the interface maximum transmission unit |
| | 1519 | from the DHCP server will be used on the current link. |
| | 1520 | If <varname>MTUBytes=</varname> is set, then this setting is ignored. |
| | 1521 | Defaults to false.</para> |
| | 1522 | </listitem> |
| | 1523 | </varlistentry> |
| | 1524 | <varlistentry> |
| | 1525 | <term><varname>Anonymize=</varname></term> |
| | 1526 | <listitem> |
| | 1527 | <para>Takes a boolean. When true, the options sent to the DHCP server will |
| | 1528 | follow the <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> |
| | 1529 | (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information. |
| | 1530 | Defaults to false.</para> |
| | 1531 | |
| | 1532 | <para>This option should only be set to true when |
| | 1533 | <varname>MACAddressPolicy=</varname> is set to <literal>random</literal> |
| | 1534 | (see <citerefentry |
| | 1535 | project='man-pages'><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para> |
| | 1536 | |
| | 1537 | <para>Note that this configuration will overwrite others. |
| | 1538 | In concrete, the following variables will be ignored: |
| | 1539 | <varname>SendHostname=</varname>, <varname>ClientIdentifier=</varname>, |
| | 1540 | <varname>UseRoutes=</varname>, <varname>UseMTU=</varname>, |
| | 1541 | <varname>VendorClassIdentifier=</varname>, <varname>UseTimezone=</varname>.</para> |
| | 1542 | |
| | 1543 | <para>With this option enabled DHCP requests will mimic those generated by Microsoft Windows, in |
| | 1544 | order to reduce the ability to fingerprint and recognize installations. This means DHCP request |
| | 1545 | sizes will grow and lease data will be more comprehensive than normally, though most of the |
| | 1546 | requested data is not actually used.</para> |
| | 1547 | </listitem> |
| | 1548 | </varlistentry> |
| | 1549 | <varlistentry> |
| | 1550 | <term><varname>SendHostname=</varname></term> |
| | 1551 | <listitem> |
| | 1552 | <para>When true (the default), the machine's hostname will be sent to the DHCP server. |
| | 1553 | Note that the machine's hostname must consist only of 7-bit ASCII lower-case characters and |
| | 1554 | no spaces or dots, and be formatted as a valid DNS domain name. Otherwise, the hostname is not |
| | 1555 | sent even if this is set to true.</para> |
| | 1556 | </listitem> |
| | 1557 | </varlistentry> |
| | 1558 | |
| | 1559 | <varlistentry> |
| | 1560 | <term><varname>MUDURL=</varname></term> |
| | 1561 | <listitem> |
| | 1562 | <para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the |
| | 1563 | DHCPv4 server. Takes an URL of length up to 255 characters. A superficial verification that |
| | 1564 | the string is a valid URL will be performed. DHCPv4 clients are intended to have at most one |
| | 1565 | MUD URL associated with them. See |
| | 1566 | <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para> |
| | 1567 | </listitem> |
| | 1568 | </varlistentry> |
| | 1569 | |
| | 1570 | <varlistentry> |
| | 1571 | <term><varname>UseHostname=</varname></term> |
| | 1572 | <listitem> |
| | 1573 | <para>When true (the default), the hostname received from |
| | 1574 | the DHCP server will be set as the transient hostname of the system. |
| | 1575 | </para> |
| | 1576 | </listitem> |
| | 1577 | </varlistentry> |
| | 1578 | <varlistentry> |
| | 1579 | <term><varname>Hostname=</varname></term> |
| | 1580 | <listitem> |
| | 1581 | <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's hostname. |
| | 1582 | Note that the specified hostname must consist only of 7-bit ASCII lower-case characters and |
| | 1583 | no spaces or dots, and be formatted as a valid DNS domain name.</para> |
| | 1584 | </listitem> |
| | 1585 | </varlistentry> |
| | 1586 | <varlistentry> |
| | 1587 | <term><varname>UseDomains=</varname></term> |
| | 1588 | <listitem> |
| | 1589 | <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name |
| | 1590 | received from the DHCP server will be used as DNS search domain over this link, similar to the effect of |
| | 1591 | the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name received from |
| | 1592 | the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of |
| | 1593 | the <option>Domains=</option> setting when the argument is prefixed with <literal>~</literal>. Defaults to |
| | 1594 | false.</para> |
| | 1595 | |
| | 1596 | <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution |
| | 1597 | of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain |
| | 1598 | only as routing domain, rather than as search domain, in order to not have it affect local resolution of |
| | 1599 | single-label names.</para> |
| | 1600 | |
| | 1601 | <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry |
| | 1602 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
| | 1603 | </listitem> |
| | 1604 | </varlistentry> |
| | 1605 | <varlistentry> |
| | 1606 | <term><varname>UseRoutes=</varname></term> |
| | 1607 | <listitem> |
| | 1608 | <para>When true (the default), the static routes will be requested from the DHCP server and added to the |
| | 1609 | routing table with a metric of 1024, and a scope of "global", "link" or "host", depending on the route's |
| | 1610 | destination and gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the |
| | 1611 | link's own address, the scope will be set to "host". Otherwise if the gateway is null (a direct route), a |
| | 1612 | "link" scope will be used. For anything else, scope defaults to "global".</para> |
| | 1613 | </listitem> |
| | 1614 | </varlistentry> |
| | 1615 | <varlistentry> |
| | 1616 | <term><varname>UseGateway=</varname></term> |
| | 1617 | <listitem> |
| | 1618 | <para>When true, the gateway will be requested from the DHCP server and added to the routing table with a |
| | 1619 | metric of 1024, and a scope of "link". When unset, the value specified with <option>UseRoutes=</option> |
| | 1620 | is used.</para> |
| | 1621 | </listitem> |
| | 1622 | </varlistentry> |
| | 1623 | <varlistentry> |
| | 1624 | <term><varname>UseTimezone=</varname></term> |
| | 1625 | |
| | 1626 | <listitem><para>When true, the timezone received from the |
| | 1627 | DHCP server will be set as timezone of the local |
| | 1628 | system. Defaults to <literal>no</literal>.</para></listitem> |
| | 1629 | </varlistentry> |
| | 1630 | |
| | 1631 | <varlistentry> |
| | 1632 | <term><varname>ClientIdentifier=</varname></term> |
| | 1633 | <listitem> |
| | 1634 | <para>The DHCPv4 client identifier to use. Takes one of <literal>mac</literal>, <literal>duid</literal> or <literal>duid-only</literal>. |
| | 1635 | If set to <literal>mac</literal>, the MAC address of the link is used. |
| | 1636 | If set to <literal>duid</literal>, an RFC4361-compliant Client ID, which is the combination of IAID and DUID (see below), is used. |
| | 1637 | If set to <literal>duid-only</literal>, only DUID is used, this may not be RFC compliant, but some setups may require to use this. |
| | 1638 | Defaults to <literal>duid</literal>.</para> |
| | 1639 | </listitem> |
| | 1640 | </varlistentry> |
| | 1641 | |
| | 1642 | <varlistentry> |
| | 1643 | <term><varname>VendorClassIdentifier=</varname></term> |
| | 1644 | <listitem> |
| | 1645 | <para>The vendor class identifier used to identify vendor |
| | 1646 | type and configuration.</para> |
| | 1647 | </listitem> |
| | 1648 | </varlistentry> |
| | 1649 | |
| | 1650 | <varlistentry> |
| | 1651 | <term><varname>UserClass=</varname></term> |
| | 1652 | <listitem> |
| | 1653 | <para>A DHCPv4 client can use UserClass option to identify the type or category of user or applications |
| | 1654 | it represents. The information contained in this option is a string that represents the user class of which |
| | 1655 | the client is a member. Each class sets an identifying string of information to be used by the DHCP |
| | 1656 | service to classify clients. Takes a whitespace-separated list of strings.</para> |
| | 1657 | </listitem> |
| | 1658 | </varlistentry> |
| | 1659 | |
| | 1660 | <varlistentry> |
| | 1661 | <term><varname>MaxAttempts=</varname></term> |
| | 1662 | <listitem> |
| | 1663 | <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a |
| | 1664 | number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. |
| | 1665 | Note that the time between retries is increased exponentially, so the network will not be |
| | 1666 | overloaded even if this number is high.</para> |
| | 1667 | </listitem> |
| | 1668 | </varlistentry> |
| | 1669 | |
| | 1670 | <varlistentry> |
| | 1671 | <term><varname>DUIDType=</varname></term> |
| | 1672 | <listitem> |
| | 1673 | <para>Override the global <varname>DUIDType</varname> setting for this network. See |
| | 1674 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
| | 1675 | for a description of possible values.</para> |
| | 1676 | </listitem> |
| | 1677 | </varlistentry> |
| | 1678 | |
| | 1679 | <varlistentry> |
| | 1680 | <term><varname>DUIDRawData=</varname></term> |
| | 1681 | <listitem> |
| | 1682 | <para>Override the global <varname>DUIDRawData</varname> setting for this network. See |
| | 1683 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
| | 1684 | for a description of possible values.</para> |
| | 1685 | </listitem> |
| | 1686 | </varlistentry> |
| | 1687 | |
| | 1688 | <varlistentry> |
| | 1689 | <term><varname>IAID=</varname></term> |
| | 1690 | <listitem> |
| | 1691 | <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned integer.</para> |
| | 1692 | </listitem> |
| | 1693 | </varlistentry> |
| | 1694 | |
| | 1695 | <varlistentry> |
| | 1696 | <term><varname>RequestBroadcast=</varname></term> |
| | 1697 | <listitem> |
| | 1698 | <para>Request the server to use broadcast messages before |
| | 1699 | the IP address has been configured. This is necessary for |
| | 1700 | devices that cannot receive RAW packets, or that cannot |
| | 1701 | receive packets at all before an IP address has been |
| | 1702 | configured. On the other hand, this must not be enabled on |
| | 1703 | networks where broadcasts are filtered out.</para> |
| | 1704 | </listitem> |
| | 1705 | </varlistentry> |
| | 1706 | |
| | 1707 | <varlistentry> |
| | 1708 | <term><varname>RouteMetric=</varname></term> |
| | 1709 | <listitem> |
| | 1710 | <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para> |
| | 1711 | </listitem> |
| | 1712 | </varlistentry> |
| | 1713 | |
| | 1714 | <varlistentry> |
| | 1715 | <term><varname>RouteTable=<replaceable>num</replaceable></varname></term> |
| | 1716 | <listitem> |
| | 1717 | <para>The table identifier for DHCP routes (a number between 1 and 4294967295, or 0 to unset). |
| | 1718 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. |
| | 1719 | </para> |
| | 1720 | <para>When used in combination with <varname>VRF=</varname> the |
| | 1721 | VRF's routing table is used unless this parameter is specified. |
| | 1722 | </para> |
| | 1723 | </listitem> |
| | 1724 | </varlistentry> |
| | 1725 | |
| | 1726 | <varlistentry> |
| | 1727 | <term><varname>RouteMTUBytes=</varname></term> |
| | 1728 | <listitem> |
| | 1729 | <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further details.</para> |
| | 1730 | </listitem> |
| | 1731 | </varlistentry> |
| | 1732 | |
| | 1733 | <varlistentry> |
| | 1734 | <term><varname>ListenPort=</varname></term> |
| | 1735 | <listitem> |
| | 1736 | <para>Allow setting custom port for the DHCP client to listen on.</para> |
| | 1737 | </listitem> |
| | 1738 | </varlistentry> |
| | 1739 | |
| | 1740 | <varlistentry> |
| | 1741 | <term><varname>FallbackLeaseLifetimeSec=</varname></term> |
| | 1742 | <listitem> |
| | 1743 | <para>Allows to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease lifetime. |
| | 1744 | Takes one of <literal>forever</literal> or <literal>infinity</literal> means that the address |
| | 1745 | never expires. Defaults to unset.</para> |
| | 1746 | </listitem> |
| | 1747 | </varlistentry> |
| | 1748 | |
| | 1749 | <varlistentry> |
| | 1750 | <term><varname>SendRelease=</varname></term> |
| | 1751 | <listitem> |
| | 1752 | <para>When true, the DHCPv4 client sends a DHCP release packet when it stops. |
| | 1753 | Defaults to true.</para> |
| | 1754 | </listitem> |
| | 1755 | </varlistentry> |
| | 1756 | |
| | 1757 | <varlistentry> |
| | 1758 | <term><varname>SendDecline=</varname></term> |
| | 1759 | <listitem> |
| | 1760 | <para>A boolean. When <literal>true</literal>, DHCPv4 clients receives IP address from DHCP server. |
| | 1761 | After new IP is received, DHCPv4 performs IPv4 Duplicate Address Detection. If duplicate use of IP is detected |
| | 1762 | the DHCPv4 client rejects the IP by sending a DHCPDECLINE packet DHCP clients try to obtain an IP address again. |
| | 1763 | See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5224</ulink>. |
| | 1764 | Defaults to <literal>unset</literal>.</para> |
| | 1765 | </listitem> |
| | 1766 | </varlistentry> |
| | 1767 | |
| | 1768 | <varlistentry> |
| | 1769 | <term><varname>DenyList=</varname></term> |
| | 1770 | <listitem> |
| | 1771 | <para>A whitespace-separated list of IPv4 addresses. DHCP offers from servers in the list are rejected.</para> |
| | 1772 | </listitem> |
| | 1773 | </varlistentry> |
| | 1774 | |
| | 1775 | <varlistentry> |
| | 1776 | <term><varname>RequestOptions=</varname></term> |
| | 1777 | <listitem> |
| | 1778 | <para>When configured, allows to set arbitrary request options in the DHCPv4 request options list and will be |
| | 1779 | sent to the DHCPV4 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para> |
| | 1780 | </listitem> |
| | 1781 | </varlistentry> |
| | 1782 | |
| | 1783 | <varlistentry> |
| | 1784 | <term><varname>SendOption=</varname></term> |
| | 1785 | <listitem> |
| | 1786 | <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data type |
| | 1787 | and data separated with a colon |
| | 1788 | (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). |
| | 1789 | The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>, |
| | 1790 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or |
| | 1791 | <literal>string</literal>. Special characters in the data string may be escaped using |
| | 1792 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style |
| | 1793 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, |
| | 1794 | then all options specified earlier are cleared. Defaults to unset.</para> |
| | 1795 | </listitem> |
| | 1796 | </varlistentry> |
| | 1797 | |
| | 1798 | <varlistentry> |
| | 1799 | <term><varname>SendVendorOption=</varname></term> |
| | 1800 | <listitem> |
| | 1801 | <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data type |
| | 1802 | and data separated with a colon |
| | 1803 | (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). |
| | 1804 | The option number must be an integer in the range 1..254. The type takes one of <literal>uint8</literal>, |
| | 1805 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or |
| | 1806 | <literal>string</literal>. Special characters in the data string may be escaped using |
| | 1807 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style |
| | 1808 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, |
| | 1809 | then all options specified earlier are cleared. Defaults to unset.</para> |
| | 1810 | </listitem> |
| | 1811 | </varlistentry> |
| | 1812 | </variablelist> |
| | 1813 | </refsect1> |
| | 1814 | |
| | 1815 | <refsect1> |
| | 1816 | <title>[DHCPv6] Section Options</title> |
| | 1817 | <para>The <literal>[DHCPv6]</literal> section configures the DHCPv6 client, if it is enabled with the |
| | 1818 | <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para> |
| | 1819 | |
| | 1820 | <variablelist class='network-directives'> |
| | 1821 | <varlistentry> |
| | 1822 | <term><varname>UseDNS=</varname></term> |
| | 1823 | <term><varname>UseNTP=</varname></term> |
| | 1824 | <listitem> |
| | 1825 | <para>As in the <literal>[DHCPv4]</literal> section.</para> |
| | 1826 | </listitem> |
| | 1827 | </varlistentry> |
| | 1828 | |
| | 1829 | <varlistentry> |
| | 1830 | <term><varname>RouteMetric=</varname></term> |
| | 1831 | <listitem> |
| | 1832 | <para>Set the routing metric for routes specified by the DHCP server. Defaults to 1024.</para> |
| | 1833 | </listitem> |
| | 1834 | </varlistentry> |
| | 1835 | |
| | 1836 | <varlistentry> |
| | 1837 | <term><varname>RapidCommit=</varname></term> |
| | 1838 | <listitem> |
| | 1839 | <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through |
| | 1840 | a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both |
| | 1841 | the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default |
| | 1842 | four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides |
| | 1843 | faster client configuration and is beneficial in environments in which networks are under a heavy load. |
| | 1844 | See <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details. |
| | 1845 | Defaults to true.</para> |
| | 1846 | </listitem> |
| | 1847 | </varlistentry> |
| | 1848 | |
| | 1849 | <varlistentry> |
| | 1850 | <term><varname>MUDURL=</varname></term> |
| | 1851 | <listitem> |
| | 1852 | <para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the DHCPV6 server. |
| | 1853 | Takes an URL of length up to 255 characters. A superficial verification that the string is a valid URL |
| | 1854 | will be performed. DHCPv6 clients are intended to have at most one MUD URL associated with them. See |
| | 1855 | <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para> |
| | 1856 | </listitem> |
| | 1857 | </varlistentry> |
| | 1858 | |
| | 1859 | <varlistentry> |
| | 1860 | <term><varname>RequestOptions=</varname></term> |
| | 1861 | <listitem> |
| | 1862 | <para>When configured, allows to set arbitrary request options in the DHCPv6 request options list and will |
| | 1863 | sent to the DHCPV6 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para> |
| | 1864 | </listitem> |
| | 1865 | </varlistentry> |
| | 1866 | |
| | 1867 | <varlistentry> |
| | 1868 | <term><varname>SendVendorOption=</varname></term> |
| | 1869 | <listitem> |
| | 1870 | <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, DHCP option number, |
| | 1871 | data type, and data separated with a colon |
| | 1872 | (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>: |
| | 1873 | <replaceable>value</replaceable></literal>). Enterprise identifier is an unsigned integer ranges 1..4294967294. |
| | 1874 | The option number must be an integer in the range 1..254. Data type takes one of <literal>uint8</literal>, |
| | 1875 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or |
| | 1876 | <literal>string</literal>. Special characters in the data string may be escaped using |
| | 1877 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style |
| | 1878 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, |
| | 1879 | then all options specified earlier are cleared. Defaults to unset.</para> |
| | 1880 | </listitem> |
| | 1881 | </varlistentry> |
| | 1882 | |
| | 1883 | <varlistentry> |
| | 1884 | <term><varname>ForceDHCPv6PDOtherInformation=</varname></term> |
| | 1885 | <listitem> |
| | 1886 | <para>Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in |
| | 1887 | Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements |
| | 1888 | makes DHCPv6 request network information in a stateless manner using a two-message Information |
| | 1889 | Request and Information Reply message exchange. |
| | 1890 | <ulink url="https://tools.ietf.org/html/rfc7084">RFC 7084</ulink>, requirement WPD-4, updates |
| | 1891 | this behavior for a Customer Edge router so that stateful DHCPv6 Prefix Delegation is also |
| | 1892 | requested when only the 'O' bit is set in Router Advertisements. This option enables such a CE |
| | 1893 | behavior as it is impossible to automatically distinguish the intention of the 'O' bit otherwise. |
| | 1894 | By default this option is set to 'false', enable it if no prefixes are delegated when the device |
| | 1895 | should be acting as a CE router.</para> |
| | 1896 | </listitem> |
| | 1897 | </varlistentry> |
| | 1898 | |
| | 1899 | <varlistentry> |
| | 1900 | <term><varname>AssignAcquiredDelegatedPrefixAddress=</varname></term> |
| | 1901 | <listitem> |
| | 1902 | <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which are received |
| | 1903 | from the WAN interface by the <varname>IPv6PrefixDelegation=</varname>. When true (on LAN interfce), the EUI-64 |
| | 1904 | algorithm will be used to form an interface identifier from the delegated prefixes. Defaults to true.</para> |
| | 1905 | </listitem> |
| | 1906 | </varlistentry> |
| | 1907 | |
| | 1908 | <varlistentry> |
| | 1909 | <term><varname>AssignAcquiredDelegatedPrefixToken=</varname></term> |
| | 1910 | <listitem> |
| | 1911 | <para>Specifies an optional address generation mode for <varname>AssignAcquiredDelegatedPrefixAddress=</varname>. |
| | 1912 | Takes an IPv6 address. When set, the lower bits of the supplied address are combined with the upper bits of a |
| | 1913 | delegatad prefix received from the WAN interface by the <varname>IPv6PrefixDelegation=</varname> prefixes to |
| | 1914 | form a complete address.</para> |
| | 1915 | </listitem> |
| | 1916 | </varlistentry> |
| | 1917 | |
| | 1918 | <varlistentry> |
| | 1919 | <term><varname>PrefixDelegationHint=</varname></term> |
| | 1920 | <listitem> |
| | 1921 | <para>Takes an IPv6 address with prefix length as <varname>Address=</varname> in |
| | 1922 | the "[Network]" section. Specifies the DHCPv6 client for the requesting router to include |
| | 1923 | a prefix-hint in the DHCPv6 solicitation. Prefix ranges 1..128. Defaults to unset.</para> |
| | 1924 | </listitem> |
| | 1925 | </varlistentry> |
| | 1926 | |
| | 1927 | <varlistentry> |
| | 1928 | <term><varname>WithoutRA=</varname></term> |
| | 1929 | <listitem> |
| | 1930 | <para>Allows DHCPv6 client to start without router advertisements's managed or other address configuration flag. |
| | 1931 | Takes one of <literal>solicit</literal> or <literal>information-request</literal>. Defaults to unset.</para> |
| | 1932 | </listitem> |
| | 1933 | </varlistentry> |
| | 1934 | |
| | 1935 | <varlistentry> |
| | 1936 | <term><varname>SendOption=</varname></term> |
| | 1937 | <listitem> |
| | 1938 | <para>As in the <literal>[DHCPv4]</literal> section, however because DHCPv6 uses 16-bit fields to store |
| | 1939 | option numbers, the option number is an integer in the range 1..65536.</para> |
| | 1940 | </listitem> |
| | 1941 | </varlistentry> |
| | 1942 | |
| | 1943 | <varlistentry> |
| | 1944 | <term><varname>UserClass=</varname></term> |
| | 1945 | <listitem> |
| | 1946 | <para>A DHCPv6 client can use User Class option to identify the type or category of user or applications |
| | 1947 | it represents. The information contained in this option is a string that represents the user class of which |
| | 1948 | the client is a member. Each class sets an identifying string of information to be used by the DHCP |
| | 1949 | service to classify clients. Special characters in the data string may be escaped using |
| | 1950 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style |
| | 1951 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, |
| | 1952 | then all options specified earlier are cleared. Takes a whitespace-separated list of strings. Note that |
| | 1953 | currently NUL bytes are not allowed.</para> |
| | 1954 | </listitem> |
| | 1955 | </varlistentry> |
| | 1956 | |
| | 1957 | <varlistentry> |
| | 1958 | <term><varname>VendorClass=</varname></term> |
| | 1959 | <listitem> |
| | 1960 | <para>A DHCPv6 client can use VendorClass option to identify the vendor that |
| | 1961 | manufactured the hardware on which the client is running. The information |
| | 1962 | contained in the data area of this option is contained in one or more opaque |
| | 1963 | fields that identify details of the hardware configuration. Takes a |
| | 1964 | whitespace-separated list of strings.</para> |
| | 1965 | </listitem> |
| | 1966 | </varlistentry> |
| | 1967 | </variablelist> |
| | 1968 | </refsect1> |
| | 1969 | |
| | 1970 | <refsect1> |
| | 1971 | <title>[IPv6AcceptRA] Section Options</title> |
| | 1972 | <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement |
| | 1973 | (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described |
| | 1974 | above:</para> |
| | 1975 | |
| | 1976 | <variablelist class='network-directives'> |
| | 1977 | <varlistentry> |
| | 1978 | <term><varname>UseDNS=</varname></term> |
| | 1979 | <listitem> |
| | 1980 | <para>When true (the default), the DNS servers received in the Router Advertisement will be used and take |
| | 1981 | precedence over any statically configured ones.</para> |
| | 1982 | |
| | 1983 | <para>This corresponds to the <option>nameserver</option> option in <citerefentry |
| | 1984 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
| | 1985 | </listitem> |
| | 1986 | </varlistentry> |
| | 1987 | |
| | 1988 | <varlistentry> |
| | 1989 | <term><varname>UseDomains=</varname></term> |
| | 1990 | <listitem> |
| | 1991 | <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name |
| | 1992 | received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to |
| | 1993 | the effect of the <option>Domains=</option> setting. If set to <literal>route</literal>, the domain name |
| | 1994 | received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the |
| | 1995 | effect of the <option>Domains=</option> setting when the argument is prefixed with |
| | 1996 | <literal>~</literal>. Defaults to false.</para> |
| | 1997 | |
| | 1998 | <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution |
| | 1999 | of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain |
| | 2000 | only as routing domain, rather than as search domain, in order to not have it affect local resolution of |
| | 2001 | single-label names.</para> |
| | 2002 | |
| | 2003 | <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry |
| | 2004 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
| | 2005 | </listitem> |
| | 2006 | </varlistentry> |
| | 2007 | |
| | 2008 | <varlistentry> |
| | 2009 | <term><varname>RouteTable=<replaceable>num</replaceable></varname></term> |
| | 2010 | <listitem> |
| | 2011 | <para>The table identifier for the routes received in the Router Advertisement |
| | 2012 | (a number between 1 and 4294967295, or 0 to unset). |
| | 2013 | The table can be retrieved using <command>ip route show table <replaceable>num</replaceable></command>. |
| | 2014 | </para> |
| | 2015 | </listitem> |
| | 2016 | </varlistentry> |
| | 2017 | |
| | 2018 | <varlistentry> |
| | 2019 | <term><varname>UseAutonomousPrefix=</varname></term> |
| | 2020 | <listitem> |
| | 2021 | <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take |
| | 2022 | precedence over any statically configured ones.</para> |
| | 2023 | </listitem> |
| | 2024 | </varlistentry> |
| | 2025 | |
| | 2026 | <varlistentry> |
| | 2027 | <term><varname>UseOnLinkPrefix=</varname></term> |
| | 2028 | <listitem> |
| | 2029 | <para>When true (the default), the onlink prefix received in the Router Advertisement will be used and take |
| | 2030 | precedence over any statically configured ones.</para> |
| | 2031 | </listitem> |
| | 2032 | </varlistentry> |
| | 2033 | |
| | 2034 | <varlistentry> |
| | 2035 | <term><varname>DenyList=</varname></term> |
| | 2036 | <listitem> |
| | 2037 | <para>A whitespace-separated list of IPv6 prefixes. IPv6 prefixes supplied via router advertisements in the list are ignored.</para> |
| | 2038 | </listitem> |
| | 2039 | </varlistentry> |
| | 2040 | |
| | 2041 | <varlistentry> |
| | 2042 | <term><varname>DHCPv6Client=</varname></term> |
| | 2043 | <listitem> |
| | 2044 | <para>Takes a boolean, or the special value <literal>always</literal>. When true (the default), the DHCPv6 client will be started when the |
| | 2045 | RA has the managed or other information flag. If set to <literal>always</literal>, the DHCPv6 client will be started even if there is no |
| | 2046 | managed or other information flag in the RA.</para> |
| | 2047 | </listitem> |
| | 2048 | </varlistentry> |
| | 2049 | </variablelist> |
| | 2050 | </refsect1> |
| | 2051 | |
| | 2052 | <refsect1> |
| | 2053 | <title>[DHCPServer] Section Options</title> |
| | 2054 | <para>The <literal>[DHCPServer]</literal> section contains |
| | 2055 | settings for the DHCP server, if enabled via the |
| | 2056 | <varname>DHCPServer=</varname> option described above:</para> |
| | 2057 | |
| | 2058 | <variablelist class='network-directives'> |
| | 2059 | |
| | 2060 | <varlistentry> |
| | 2061 | <term><varname>PoolOffset=</varname></term> |
| | 2062 | <term><varname>PoolSize=</varname></term> |
| | 2063 | |
| | 2064 | <listitem><para>Configures the pool of addresses to hand out. The pool |
| | 2065 | is a contiguous sequence of IP addresses in the subnet configured for |
| | 2066 | the server address, which does not include the subnet nor the broadcast |
| | 2067 | address. <varname>PoolOffset=</varname> takes the offset of the pool |
| | 2068 | from the start of subnet, or zero to use the default value. |
| | 2069 | <varname>PoolSize=</varname> takes the number of IP addresses in the |
| | 2070 | pool or zero to use the default value. By default, the pool starts at |
| | 2071 | the first address after the subnet address and takes up the rest of |
| | 2072 | the subnet, excluding the broadcast address. If the pool includes |
| | 2073 | the server address (the default), this is reserved and not handed |
| | 2074 | out to clients.</para></listitem> |
| | 2075 | </varlistentry> |
| | 2076 | |
| | 2077 | <varlistentry> |
| | 2078 | <term><varname>DefaultLeaseTimeSec=</varname></term> |
| | 2079 | <term><varname>MaxLeaseTimeSec=</varname></term> |
| | 2080 | |
| | 2081 | <listitem><para>Control the default and maximum DHCP lease |
| | 2082 | time to pass to clients. These settings take time values in seconds or |
| | 2083 | another common time unit, depending on the suffix. The default |
| | 2084 | lease time is used for clients that did not ask for a specific |
| | 2085 | lease time. If a client asks for a lease time longer than the |
| | 2086 | maximum lease time, it is automatically shortened to the |
| | 2087 | specified time. The default lease time defaults to 1h, the |
| | 2088 | maximum lease time to 12h. Shorter lease times are beneficial |
| | 2089 | if the configuration data in DHCP leases changes frequently |
| | 2090 | and clients shall learn the new settings with shorter |
| | 2091 | latencies. Longer lease times reduce the generated DHCP |
| | 2092 | network traffic.</para></listitem> |
| | 2093 | </varlistentry> |
| | 2094 | |
| | 2095 | <varlistentry> |
| | 2096 | <term><varname>EmitDNS=</varname></term> |
| | 2097 | <term><varname>DNS=</varname></term> |
| | 2098 | |
| | 2099 | <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases |
| | 2100 | handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>. The |
| | 2101 | DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option, which takes |
| | 2102 | a list of IPv4 addresses. If the <varname>EmitDNS=</varname> option is enabled but no servers |
| | 2103 | configured, the servers are automatically propagated from an "uplink" interface that has appropriate |
| | 2104 | servers set. The "uplink" interface is determined by the default route of the system with the highest |
| | 2105 | priority. Note that this information is acquired at the time the lease is handed out, and does not |
| | 2106 | take uplink interfaces into account that acquire DNS server information at a later point. If no |
| | 2107 | suitable uplinkg interface is found the DNS server data from <filename>/etc/resolv.conf</filename> is |
| | 2108 | used. Also, note that the leases are not refreshed if the uplink network configuration changes. To |
| | 2109 | ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable |
| | 2110 | to shorten the DHCP lease time via <varname>MaxLeaseTimeSec=</varname> described |
| | 2111 | above.</para></listitem> |
| | 2112 | </varlistentry> |
| | 2113 | |
| | 2114 | <varlistentry> |
| | 2115 | <term><varname>EmitNTP=</varname></term> |
| | 2116 | <term><varname>NTP=</varname></term> |
| | 2117 | <term><varname>EmitSIP=</varname></term> |
| | 2118 | <term><varname>SIP=</varname></term> |
| | 2119 | <term><varname>EmitPOP3=</varname></term> |
| | 2120 | <term><varname>POP3=</varname></term> |
| | 2121 | <term><varname>EmitSMTP=</varname></term> |
| | 2122 | <term><varname>SMTP=</varname></term> |
| | 2123 | <term><varname>EmitLPR=</varname></term> |
| | 2124 | <term><varname>LPR=</varname></term> |
| | 2125 | |
| | 2126 | <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings |
| | 2127 | described above, these settings configure whether and what server information for the indicate |
| | 2128 | protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and |
| | 2129 | defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para></listitem> |
| | 2130 | </varlistentry> |
| | 2131 | |
| | 2132 | <varlistentry> |
| | 2133 | <term><varname>EmitRouter=</varname></term> |
| | 2134 | |
| | 2135 | <listitem><para>Similar to the <varname>EmitDNS=</varname> |
| | 2136 | setting described above, this setting configures whether the |
| | 2137 | DHCP lease should contain the router option. The same syntax, |
| | 2138 | propagation semantics and defaults apply as for |
| | 2139 | <varname>EmitDNS=</varname>.</para></listitem> |
| | 2140 | </varlistentry> |
| | 2141 | |
| | 2142 | <varlistentry> |
| | 2143 | <term><varname>EmitTimezone=</varname></term> |
| | 2144 | <term><varname>Timezone=</varname></term> |
| | 2145 | |
| | 2146 | <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out |
| | 2147 | to clients shall contain timezone information. Defaults to <literal>yes</literal>. The |
| | 2148 | <varname>Timezone=</varname> setting takes a timezone string |
| | 2149 | (such as <literal>Europe/Berlin</literal> or |
| | 2150 | <literal>UTC</literal>) to pass to clients. If no explicit |
| | 2151 | timezone is set, the system timezone of the local host is |
| | 2152 | propagated, as determined by the |
| | 2153 | <filename>/etc/localtime</filename> symlink.</para></listitem> |
| | 2154 | </varlistentry> |
| | 2155 | |
| | 2156 | <varlistentry> |
| | 2157 | <term><varname>SendOption=</varname></term> |
| | 2158 | <listitem> |
| | 2159 | <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type |
| | 2160 | and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). |
| | 2161 | The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>, |
| | 2162 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or |
| | 2163 | <literal>string</literal>. Special characters in the data string may be escaped using |
| | 2164 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style |
| | 2165 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, |
| | 2166 | then all options specified earlier are cleared. Defaults to unset.</para> |
| | 2167 | </listitem> |
| | 2168 | </varlistentry> |
| | 2169 | |
| | 2170 | <varlistentry> |
| | 2171 | <term><varname>SendVendorOption=</varname></term> |
| | 2172 | <listitem> |
| | 2173 | <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type |
| | 2174 | and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). |
| | 2175 | The option number is an integer in the range 1..254. The type takes one of <literal>uint8</literal>, |
| | 2176 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or |
| | 2177 | <literal>string</literal>. Special characters in the data string may be escaped using |
| | 2178 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style |
| | 2179 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, |
| | 2180 | then all options specified earlier are cleared. Defaults to unset.</para> |
| | 2181 | </listitem> |
| | 2182 | </varlistentry> |
| | 2183 | |
| | 2184 | </variablelist> |
| | 2185 | </refsect1> |
| | 2186 | |
| | 2187 | <refsect1> |
| | 2188 | <title>[IPv6PrefixDelegation] Section Options</title> |
| | 2189 | <para>The <literal>[IPv6PrefixDelegation]</literal> section contains |
| | 2190 | settings for sending IPv6 Router Advertisements and whether to act as |
| | 2191 | a router, if enabled via the <varname>IPv6PrefixDelegation=</varname> |
| | 2192 | option described above. IPv6 network prefixes are defined with one or |
| | 2193 | more <literal>[IPv6Prefix]</literal> sections.</para> |
| | 2194 | |
| | 2195 | <variablelist class='network-directives'> |
| | 2196 | |
| | 2197 | <varlistentry> |
| | 2198 | <term><varname>Managed=</varname></term> |
| | 2199 | <term><varname>OtherInformation=</varname></term> |
| | 2200 | |
| | 2201 | <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6 |
| | 2202 | addresses on the network link when <varname>Managed=</varname> |
| | 2203 | is set to <literal>true</literal> or if only additional network |
| | 2204 | information can be obtained via DHCPv6 for the network link when |
| | 2205 | <varname>OtherInformation=</varname> is set to |
| | 2206 | <literal>true</literal>. Both settings default to |
| | 2207 | <literal>false</literal>, which means that a DHCPv6 server is not being |
| | 2208 | used.</para></listitem> |
| | 2209 | </varlistentry> |
| | 2210 | |
| | 2211 | <varlistentry> |
| | 2212 | <term><varname>RouterLifetimeSec=</varname></term> |
| | 2213 | |
| | 2214 | <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. If set, |
| | 2215 | this host also announces itself in Router Advertisements as an IPv6 |
| | 2216 | router for the network link. When unset, the host is not acting as a router.</para> |
| | 2217 | </listitem> |
| | 2218 | </varlistentry> |
| | 2219 | |
| | 2220 | <varlistentry> |
| | 2221 | <term><varname>RouterPreference=</varname></term> |
| | 2222 | |
| | 2223 | <listitem><para>Configures IPv6 router preference if |
| | 2224 | <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are |
| | 2225 | <literal>high</literal>, <literal>medium</literal> and |
| | 2226 | <literal>low</literal>, with <literal>normal</literal> and |
| | 2227 | <literal>default</literal> added as synonyms for |
| | 2228 | <literal>medium</literal> just to make configuration easier. See |
| | 2229 | <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> |
| | 2230 | for details. Defaults to <literal>medium</literal>.</para></listitem> |
| | 2231 | </varlistentry> |
| | 2232 | |
| | 2233 | <varlistentry> |
| | 2234 | <term><varname>EmitDNS=</varname></term> |
| | 2235 | <term><varname>DNS=</varname></term> |
| | 2236 | |
| | 2237 | <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses |
| | 2238 | that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is |
| | 2239 | true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that |
| | 2240 | case the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS |
| | 2241 | servers are read from the <literal>[Network]</literal> section. If the |
| | 2242 | <literal>[Network]</literal> section does not contain any DNS servers either, DNS servers from |
| | 2243 | the uplink with the highest priority default route are used. When <varname>EmitDNS=</varname> |
| | 2244 | is false, no DNS server information is sent in Router Advertisement messages. |
| | 2245 | <varname>EmitDNS=</varname> defaults to true. |
| | 2246 | </para></listitem> |
| | 2247 | </varlistentry> |
| | 2248 | |
| | 2249 | <varlistentry> |
| | 2250 | <term><varname>EmitDomains=</varname></term> |
| | 2251 | <term><varname>Domains=</varname></term> |
| | 2252 | |
| | 2253 | <listitem><para>A list of DNS search domains distributed via Router |
| | 2254 | Advertisement messages when <varname>EmitDomains=</varname> is true. If |
| | 2255 | <varname>Domains=</varname> is empty, DNS search domains are read from the |
| | 2256 | <literal>[Network]</literal> section. If the <literal>[Network]</literal> |
| | 2257 | section does not contain any DNS search domains either, DNS search |
| | 2258 | domains from the uplink with the highest priority default route are |
| | 2259 | used. When <varname>EmitDomains=</varname> is false, no DNS search domain |
| | 2260 | information is sent in Router Advertisement messages. |
| | 2261 | <varname>EmitDomains=</varname> defaults to true. |
| | 2262 | </para></listitem> |
| | 2263 | </varlistentry> |
| | 2264 | |
| | 2265 | <varlistentry> |
| | 2266 | <term><varname>DNSLifetimeSec=</varname></term> |
| | 2267 | |
| | 2268 | <listitem><para>Lifetime in seconds for the DNS server addresses listed |
| | 2269 | in <varname>DNS=</varname> and search domains listed in |
| | 2270 | <varname>Domains=</varname>.</para></listitem> |
| | 2271 | </varlistentry> |
| | 2272 | |
| | 2273 | </variablelist> |
| | 2274 | </refsect1> |
| | 2275 | |
| | 2276 | <refsect1> |
| | 2277 | <title>[IPv6Prefix] Section Options</title> |
| | 2278 | <para>One or more <literal>[IPv6Prefix]</literal> sections contain the IPv6 |
| | 2279 | prefixes that are announced via Router Advertisements. See |
| | 2280 | <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> |
| | 2281 | for further details.</para> |
| | 2282 | |
| | 2283 | <variablelist class='network-directives'> |
| | 2284 | |
| | 2285 | <varlistentry> |
| | 2286 | <term><varname>AddressAutoconfiguration=</varname></term> |
| | 2287 | <term><varname>OnLink=</varname></term> |
| | 2288 | |
| | 2289 | <listitem><para>Takes a boolean to specify whether IPv6 addresses can be |
| | 2290 | autoconfigured with this prefix and whether the prefix can be used for |
| | 2291 | onlink determination. Both settings default to <literal>true</literal> |
| | 2292 | in order to ease configuration. |
| | 2293 | </para></listitem> |
| | 2294 | </varlistentry> |
| | 2295 | |
| | 2296 | <varlistentry> |
| | 2297 | <term><varname>Prefix=</varname></term> |
| | 2298 | |
| | 2299 | <listitem><para>The IPv6 prefix that is to be distributed to hosts. |
| | 2300 | Similarly to configuring static IPv6 addresses, the setting is |
| | 2301 | configured as an IPv6 prefix and its prefix length, separated by a |
| | 2302 | <literal>/</literal> character. Use multiple |
| | 2303 | <literal>[IPv6Prefix]</literal> sections to configure multiple IPv6 |
| | 2304 | prefixes since prefix lifetimes, address autoconfiguration and onlink |
| | 2305 | status may differ from one prefix to another.</para></listitem> |
| | 2306 | </varlistentry> |
| | 2307 | |
| | 2308 | <varlistentry> |
| | 2309 | <term><varname>PreferredLifetimeSec=</varname></term> |
| | 2310 | <term><varname>ValidLifetimeSec=</varname></term> |
| | 2311 | |
| | 2312 | <listitem><para>Preferred and valid lifetimes for the prefix measured in |
| | 2313 | seconds. <varname>PreferredLifetimeSec=</varname> defaults to 604800 |
| | 2314 | seconds (one week) and <varname>ValidLifetimeSec=</varname> defaults |
| | 2315 | to 2592000 seconds (30 days).</para></listitem> |
| | 2316 | </varlistentry> |
| | 2317 | |
| | 2318 | <varlistentry> |
| | 2319 | <term><varname>Assign=</varname></term> |
| | 2320 | <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false. |
| | 2321 | </para></listitem> |
| | 2322 | </varlistentry> |
| | 2323 | </variablelist> |
| | 2324 | </refsect1> |
| | 2325 | |
| | 2326 | <refsect1> |
| | 2327 | <title>[IPv6RoutePrefix] Section Options</title> |
| | 2328 | <para>One or more <literal>[IPv6RoutePrefix]</literal> sections contain the IPv6 |
| | 2329 | prefix routes that are announced via Router Advertisements. See |
| | 2330 | <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> |
| | 2331 | for further details.</para> |
| | 2332 | |
| | 2333 | <variablelist class='network-directives'> |
| | 2334 | |
| | 2335 | <varlistentry> |
| | 2336 | <term><varname>Route=</varname></term> |
| | 2337 | |
| | 2338 | <listitem><para>The IPv6 route that is to be distributed to hosts. |
| | 2339 | Similarly to configuring static IPv6 routes, the setting is |
| | 2340 | configured as an IPv6 prefix routes and its prefix route length, |
| | 2341 | separated by a<literal>/</literal> character. Use multiple |
| | 2342 | <literal>[IPv6PrefixRoutes]</literal> sections to configure multiple IPv6 |
| | 2343 | prefix routes.</para></listitem> |
| | 2344 | </varlistentry> |
| | 2345 | |
| | 2346 | <varlistentry> |
| | 2347 | <term><varname>LifetimeSec=</varname></term> |
| | 2348 | |
| | 2349 | <listitem><para>Lifetime for the route prefix measured in |
| | 2350 | seconds. <varname>LifetimeSec=</varname> defaults to 604800 seconds (one week). |
| | 2351 | </para></listitem> |
| | 2352 | </varlistentry> |
| | 2353 | |
| | 2354 | </variablelist> |
| | 2355 | </refsect1> |
| | 2356 | |
| | 2357 | <refsect1> |
| | 2358 | <title>[Bridge] Section Options</title> |
| | 2359 | <para>The <literal>[Bridge]</literal> section accepts the |
| | 2360 | following keys.</para> |
| | 2361 | <variablelist class='network-directives'> |
| | 2362 | <varlistentry> |
| | 2363 | <term><varname>UnicastFlood=</varname></term> |
| | 2364 | <listitem> |
| | 2365 | <para>Takes a boolean. Controls whether the bridge should flood |
| | 2366 | traffic for which an FDB entry is missing and the destination |
| | 2367 | is unknown through this port. When unset, the kernel's default will be used. |
| | 2368 | </para> |
| | 2369 | </listitem> |
| | 2370 | </varlistentry> |
| | 2371 | <varlistentry> |
| | 2372 | <term><varname>MulticastFlood=</varname></term> |
| | 2373 | <listitem> |
| | 2374 | <para>Takes a boolean. Controls whether the bridge should flood |
| | 2375 | traffic for which an MDB entry is missing and the destination |
| | 2376 | is unknown through this port. When unset, the kernel's default will be used. |
| | 2377 | </para> |
| | 2378 | </listitem> |
| | 2379 | </varlistentry> |
| | 2380 | <varlistentry> |
| | 2381 | <term><varname>MulticastToUnicast=</varname></term> |
| | 2382 | <listitem> |
| | 2383 | <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of |
| | 2384 | the bridge. Which means unicast copies are only delivered to hosts which are interested in it. |
| | 2385 | When unset, the kernel's default will be used. |
| | 2386 | </para> |
| | 2387 | </listitem> |
| | 2388 | </varlistentry> |
| | 2389 | <varlistentry> |
| | 2390 | <term><varname>NeighborSuppression=</varname></term> |
| | 2391 | <listitem> |
| | 2392 | <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for |
| | 2393 | this port. When unset, the kernel's default will be used. |
| | 2394 | </para> |
| | 2395 | </listitem> |
| | 2396 | </varlistentry> |
| | 2397 | <varlistentry> |
| | 2398 | <term><varname>Learning=</varname></term> |
| | 2399 | <listitem> |
| | 2400 | <para>Takes a boolean. Configures whether MAC address learning is enabled for |
| | 2401 | this port. When unset, the kernel's default will be used. |
| | 2402 | </para> |
| | 2403 | </listitem> |
| | 2404 | </varlistentry> |
| | 2405 | <varlistentry> |
| | 2406 | <term><varname>HairPin=</varname></term> |
| | 2407 | <listitem> |
| | 2408 | <para>Takes a boolean. Configures whether traffic may be sent back |
| | 2409 | out of the port on which it was received. When this flag is false, and the bridge |
| | 2410 | will not forward traffic back out of the receiving port. |
| | 2411 | When unset, the kernel's default will be used.</para> |
| | 2412 | </listitem> |
| | 2413 | </varlistentry> |
| | 2414 | <varlistentry> |
| | 2415 | <term><varname>UseBPDU=</varname></term> |
| | 2416 | <listitem> |
| | 2417 | <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be |
| | 2418 | processed by the bridge port. When unset, the kernel's default will be used.</para> |
| | 2419 | </listitem> |
| | 2420 | </varlistentry> |
| | 2421 | <varlistentry> |
| | 2422 | <term><varname>FastLeave=</varname></term> |
| | 2423 | <listitem> |
| | 2424 | <para>Takes a boolean. This flag allows the bridge to immediately stop multicast |
| | 2425 | traffic on a port that receives an IGMP Leave message. It is only used with |
| | 2426 | IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para> |
| | 2427 | </listitem> |
| | 2428 | </varlistentry> |
| | 2429 | <varlistentry> |
| | 2430 | <term><varname>AllowPortToBeRoot=</varname></term> |
| | 2431 | <listitem> |
| | 2432 | <para>Takes a boolean. Configures whether a given port is allowed to |
| | 2433 | become a root port. Only used when STP is enabled on the bridge. |
| | 2434 | When unset, the kernel's default will be used.</para> |
| | 2435 | </listitem> |
| | 2436 | </varlistentry> |
| | 2437 | <varlistentry> |
| | 2438 | <term><varname>ProxyARP=</varname></term> |
| | 2439 | <listitem> |
| | 2440 | <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port. |
| | 2441 | When unset, the kernel's default will be used.</para> |
| | 2442 | </listitem> |
| | 2443 | </varlistentry> |
| | 2444 | <varlistentry> |
| | 2445 | <term><varname>ProxyARPWiFi=</varname></term> |
| | 2446 | <listitem> |
| | 2447 | <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port |
| | 2448 | which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications. |
| | 2449 | When unset, the kernel's default will be used.</para> |
| | 2450 | </listitem> |
| | 2451 | </varlistentry> |
| | 2452 | <varlistentry> |
| | 2453 | <term><varname>MulticastRouter=</varname></term> |
| | 2454 | <listitem> |
| | 2455 | <para>Configures this port for having multicast routers attached. A port with a multicast |
| | 2456 | router will receive all multicast traffic. Takes one of <literal>no</literal> |
| | 2457 | to disable multicast routers on this port, <literal>query</literal> to let the system detect |
| | 2458 | the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic |
| | 2459 | forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily |
| | 2460 | on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para> |
| | 2461 | </listitem> |
| | 2462 | </varlistentry> |
| | 2463 | <varlistentry> |
| | 2464 | <term><varname>Cost=</varname></term> |
| | 2465 | <listitem> |
| | 2466 | <para>Sets the "cost" of sending packets of this interface. |
| | 2467 | Each port in a bridge may have a different speed and the cost |
| | 2468 | is used to decide which link to use. Faster interfaces |
| | 2469 | should have lower costs. It is an integer value between 1 and |
| | 2470 | 65535.</para> |
| | 2471 | </listitem> |
| | 2472 | </varlistentry> |
| | 2473 | <varlistentry> |
| | 2474 | <term><varname>Priority=</varname></term> |
| | 2475 | <listitem> |
| | 2476 | <para>Sets the "priority" of sending packets on this interface. |
| | 2477 | Each port in a bridge may have a different priority which is used |
| | 2478 | to decide which link to use. Lower value means higher priority. |
| | 2479 | It is an integer value between 0 to 63. Networkd does not set any |
| | 2480 | default, meaning the kernel default value of 32 is used.</para> |
| | 2481 | </listitem> |
| | 2482 | </varlistentry> |
| | 2483 | </variablelist> |
| | 2484 | </refsect1> |
| | 2485 | <refsect1> |
| | 2486 | <title>[BridgeFDB] Section Options</title> |
| | 2487 | <para>The <literal>[BridgeFDB]</literal> section manages the |
| | 2488 | forwarding database table of a port and accepts the following |
| | 2489 | keys. Specify several <literal>[BridgeFDB]</literal> sections to |
| | 2490 | configure several static MAC table entries.</para> |
| | 2491 | |
| | 2492 | <variablelist class='network-directives'> |
| | 2493 | <varlistentry> |
| | 2494 | <term><varname>MACAddress=</varname></term> |
| | 2495 | <listitem> |
| | 2496 | <para>As in the <literal>[Network]</literal> section. This |
| | 2497 | key is mandatory.</para> |
| | 2498 | </listitem> |
| | 2499 | </varlistentry> |
| | 2500 | <varlistentry> |
| | 2501 | <term><varname>Destination=</varname></term> |
| | 2502 | <listitem> |
| | 2503 | <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para> |
| | 2504 | </listitem> |
| | 2505 | </varlistentry> |
| | 2506 | <varlistentry> |
| | 2507 | <term><varname>VLANId=</varname></term> |
| | 2508 | <listitem> |
| | 2509 | <para>The VLAN ID for the new static MAC table entry. If |
| | 2510 | omitted, no VLAN ID information is appended to the new static MAC |
| | 2511 | table entry.</para> |
| | 2512 | </listitem> |
| | 2513 | </varlistentry> |
| | 2514 | <varlistentry> |
| | 2515 | <term><varname>VNI=</varname></term> |
| | 2516 | <listitem> |
| | 2517 | <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to |
| | 2518 | the remote VXLAN tunnel endpoint. Takes a number in the range 1-16777215. |
| | 2519 | Defaults to unset.</para> |
| | 2520 | </listitem> |
| | 2521 | </varlistentry> |
| | 2522 | <varlistentry> |
| | 2523 | <term><varname>AssociatedWith=</varname></term> |
| | 2524 | <listitem> |
| | 2525 | <para>Specifies where the address is associated with. Takes one of <literal>use</literal>, |
| | 2526 | <literal>self</literal>, <literal>master</literal> or <literal>router</literal>. |
| | 2527 | <literal>use</literal> means the address is in use. User space can use this option to |
| | 2528 | indicate to the kernel that the fdb entry is in use. <literal>self</literal> means |
| | 2529 | the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal> |
| | 2530 | means the address is associated with master devices fdb. <literal>router</literal> means |
| | 2531 | the destination address is associated with a router. Note that it's valid if the referenced |
| | 2532 | device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para> |
| | 2533 | </listitem> |
| | 2534 | </varlistentry> |
| | 2535 | </variablelist> |
| | 2536 | </refsect1> |
| | 2537 | |
| | 2538 | <refsect1> |
| | 2539 | <title>[LLDP] Section Options</title> |
| | 2540 | <para>The <literal>[LLDP]</literal> section manages the Link Layer Discovery Protocol (LLDP) and accepts the |
| | 2541 | following keys.</para> |
| | 2542 | <variablelist class='network-directives'> |
| | 2543 | <varlistentry> |
| | 2544 | <term><varname>MUDURL=</varname></term> |
| | 2545 | <listitem> |
| | 2546 | <para>Controls support for Ethernet LLDP packet's Manufacturer Usage Description (MUD). MUD is an embedded software |
| | 2547 | standard defined by the IETF that allows IoT Device makers to advertise device specifications, including the intended |
| | 2548 | communication patterns for their device when it connects to the network. The network can then use this intent to author |
| | 2549 | a context-specific access policy, so the device functions only within those parameters. Takes an URL of length up to 255 |
| | 2550 | characters. A superficial verification that the string is a valid URL |
| | 2551 | will be performed. See |
| | 2552 | <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink> for details. The MUD URL received |
| | 2553 | from the LLDP packets will be saved at the state files and can be read via |
| | 2554 | <function>sd_lldp_neighbor_get_mud_url()</function> function.</para> |
| | 2555 | </listitem> |
| | 2556 | </varlistentry> |
| | 2557 | </variablelist> |
| | 2558 | </refsect1> |
| | 2559 | |
| | 2560 | <refsect1> |
| | 2561 | <title>[CAN] Section Options</title> |
| | 2562 | <para>The <literal>[CAN]</literal> section manages the Controller Area Network (CAN bus) and accepts the |
| | 2563 | following keys.</para> |
| | 2564 | <variablelist class='network-directives'> |
| | 2565 | <varlistentry> |
| | 2566 | <term><varname>BitRate=</varname></term> |
| | 2567 | <listitem> |
| | 2568 | <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can |
| | 2569 | be used here. Takes a number in the range 1..4294967295.</para> |
| | 2570 | </listitem> |
| | 2571 | </varlistentry> |
| | 2572 | <varlistentry> |
| | 2573 | <term><varname>SamplePoint=</varname></term> |
| | 2574 | <listitem> |
| | 2575 | <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>, |
| | 2576 | <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>).</para> |
| | 2577 | </listitem> |
| | 2578 | </varlistentry> |
| | 2579 | <varlistentry> |
| | 2580 | <term><varname>DataBitRate=</varname></term> |
| | 2581 | <term><varname>DataSamplePoint=</varname></term> |
| | 2582 | <listitem> |
| | 2583 | <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are |
| | 2584 | analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para> |
| | 2585 | </listitem> |
| | 2586 | </varlistentry> |
| | 2587 | <varlistentry> |
| | 2588 | <term><varname>FDMode=</varname></term> |
| | 2589 | <listitem> |
| | 2590 | <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface. |
| | 2591 | Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using |
| | 2592 | the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys.</para> |
| | 2593 | </listitem> |
| | 2594 | </varlistentry> |
| | 2595 | <varlistentry> |
| | 2596 | <term><varname>FDNonISO=</varname></term> |
| | 2597 | <listitem> |
| | 2598 | <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the |
| | 2599 | interface. When unset, the kernel's default will be used.</para> |
| | 2600 | </listitem> |
| | 2601 | </varlistentry> |
| | 2602 | <varlistentry> |
| | 2603 | <term><varname>RestartSec=</varname></term> |
| | 2604 | <listitem> |
| | 2605 | <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be |
| | 2606 | triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can |
| | 2607 | be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or |
| | 2608 | <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the |
| | 2609 | automatic restart off. By default automatic restart is disabled.</para> |
| | 2610 | </listitem> |
| | 2611 | </varlistentry> |
| | 2612 | <varlistentry> |
| | 2613 | <term><varname>Termination=</varname></term> |
| | 2614 | <listitem> |
| | 2615 | <para>Takes a boolean. When <literal>yes</literal>, the termination resistor will be selected for |
| | 2616 | the bias network. When unset, the kernel's default will be used.</para> |
| | 2617 | </listitem> |
| | 2618 | </varlistentry> |
| | 2619 | <varlistentry> |
| | 2620 | <term><varname>TripleSampling=</varname></term> |
| | 2621 | <listitem> |
| | 2622 | <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine |
| | 2623 | the value of a received bit by majority rule. When unset, the kernel's default will be used.</para> |
| | 2624 | </listitem> |
| | 2625 | </varlistentry> |
| | 2626 | <varlistentry> |
| | 2627 | <term><varname>ListenOnly=</varname></term> |
| | 2628 | <listitem> |
| | 2629 | <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the |
| | 2630 | interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK |
| | 2631 | bit. Listen-only mode is important to debug CAN networks without interfering with the |
| | 2632 | communication or acknowledge the CAN frame. When unset, the kernel's default will be used. |
| | 2633 | </para> |
| | 2634 | </listitem> |
| | 2635 | </varlistentry> |
| | 2636 | </variablelist> |
| | 2637 | </refsect1> |
| | 2638 | |
| | 2639 | <refsect1> |
| | 2640 | <title>[QDisc] Section Options</title> |
| | 2641 | <para>The <literal>[QDisc]</literal> section manages the traffic control queueing discipline (qdisc).</para> |
| | 2642 | |
| | 2643 | <variablelist class='network-directives'> |
| | 2644 | <varlistentry> |
| | 2645 | <term><varname>Parent=</varname></term> |
| | 2646 | <listitem> |
| | 2647 | <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal> |
| | 2648 | or <literal>ingress</literal>. This is mandatory.</para> |
| | 2649 | </listitem> |
| | 2650 | </varlistentry> |
| | 2651 | |
| | 2652 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2653 | </variablelist> |
| | 2654 | </refsect1> |
| | 2655 | |
| | 2656 | <refsect1> |
| | 2657 | <title>[NetworkEmulator] Section Options</title> |
| | 2658 | <para>The <literal>[NetworkEmulator]</literal> section manages the queueing discipline (qdisc) of |
| | 2659 | the network emulator. It can be used to configure the kernel packet scheduler and simulate packet |
| | 2660 | delay and loss for UDP or TCP applications, or limit the bandwidth usage of a particular service to |
| | 2661 | simulate internet connections.</para> |
| | 2662 | |
| | 2663 | <variablelist class='network-directives'> |
| | 2664 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2665 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2666 | |
| | 2667 | <varlistentry> |
| | 2668 | <term><varname>DelaySec=</varname></term> |
| | 2669 | <listitem> |
| | 2670 | <para>Specifies the fixed amount of delay to be added to all packets going out of the |
| | 2671 | interface. Defaults to unset.</para> |
| | 2672 | </listitem> |
| | 2673 | </varlistentry> |
| | 2674 | |
| | 2675 | <varlistentry> |
| | 2676 | <term><varname>DelayJitterSec=</varname></term> |
| | 2677 | <listitem> |
| | 2678 | <para>Specifies the chosen delay to be added to the packets outgoing to the network |
| | 2679 | interface. Defaults to unset.</para> |
| | 2680 | </listitem> |
| | 2681 | </varlistentry> |
| | 2682 | |
| | 2683 | <varlistentry> |
| | 2684 | <term><varname>PacketLimit=</varname></term> |
| | 2685 | <listitem> |
| | 2686 | <para>Specifies the maximum number of packets the qdisc may hold queued at a time. |
| | 2687 | An unsigned integer ranges 0 to 4294967294. Defaults to 1000.</para> |
| | 2688 | </listitem> |
| | 2689 | </varlistentry> |
| | 2690 | |
| | 2691 | <varlistentry> |
| | 2692 | <term><varname>LossRate=</varname></term> |
| | 2693 | <listitem> |
| | 2694 | <para>Specifies an independent loss probability to be added to the packets outgoing from the |
| | 2695 | network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para> |
| | 2696 | </listitem> |
| | 2697 | </varlistentry> |
| | 2698 | |
| | 2699 | <varlistentry> |
| | 2700 | <term><varname>DuplicateRate=</varname></term> |
| | 2701 | <listitem> |
| | 2702 | <para>Specifies that the chosen percent of packets is duplicated before queuing them. |
| | 2703 | Takes a percentage value, suffixed with "%". Defaults to unset.</para> |
| | 2704 | </listitem> |
| | 2705 | </varlistentry> |
| | 2706 | </variablelist> |
| | 2707 | </refsect1> |
| | 2708 | |
| | 2709 | <refsect1> |
| | 2710 | <title>[TokenBucketFilter] Section Options</title> |
| | 2711 | <para>The <literal>[TokenBucketFilter]</literal> section manages the queueing discipline (qdisc) of |
| | 2712 | token bucket filter (tbf).</para> |
| | 2713 | |
| | 2714 | <variablelist class='network-directives'> |
| | 2715 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2716 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2717 | |
| | 2718 | <varlistentry> |
| | 2719 | <term><varname>LatencySec=</varname></term> |
| | 2720 | <listitem> |
| | 2721 | <para>Specifies the latency parameter, which specifies the maximum amount of time a |
| | 2722 | packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para> |
| | 2723 | </listitem> |
| | 2724 | </varlistentry> |
| | 2725 | |
| | 2726 | <varlistentry> |
| | 2727 | <term><varname>LimitBytes=</varname></term> |
| | 2728 | <listitem> |
| | 2729 | <para>Takes the number of bytes that can be queued waiting for tokens to become available. |
| | 2730 | When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, |
| | 2731 | respectively, to the base of 1024. Defaults to unset.</para> |
| | 2732 | </listitem> |
| | 2733 | </varlistentry> |
| | 2734 | |
| | 2735 | <varlistentry> |
| | 2736 | <term><varname>BurstBytes=</varname></term> |
| | 2737 | <listitem> |
| | 2738 | <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens |
| | 2739 | can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is |
| | 2740 | parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to |
| | 2741 | unset.</para> |
| | 2742 | </listitem> |
| | 2743 | </varlistentry> |
| | 2744 | |
| | 2745 | <varlistentry> |
| | 2746 | <term><varname>Rate=</varname></term> |
| | 2747 | <listitem> |
| | 2748 | <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified |
| | 2749 | bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. |
| | 2750 | Defaults to unset.</para> |
| | 2751 | </listitem> |
| | 2752 | </varlistentry> |
| | 2753 | |
| | 2754 | <varlistentry> |
| | 2755 | <term><varname>MPUBytes=</varname></term> |
| | 2756 | <listitem> |
| | 2757 | <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes) |
| | 2758 | for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, |
| | 2759 | Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para> |
| | 2760 | </listitem> |
| | 2761 | </varlistentry> |
| | 2762 | |
| | 2763 | <varlistentry> |
| | 2764 | <term><varname>PeakRate=</varname></term> |
| | 2765 | <listitem> |
| | 2766 | <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the |
| | 2767 | specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of |
| | 2768 | 1000. Defaults to unset.</para> |
| | 2769 | </listitem> |
| | 2770 | </varlistentry> |
| | 2771 | |
| | 2772 | <varlistentry> |
| | 2773 | <term><varname>MTUBytes=</varname></term> |
| | 2774 | <listitem> |
| | 2775 | <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified |
| | 2776 | size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. |
| | 2777 | Defaults to unset.</para> |
| | 2778 | </listitem> |
| | 2779 | </varlistentry> |
| | 2780 | </variablelist> |
| | 2781 | </refsect1> |
| | 2782 | |
| | 2783 | <refsect1> |
| | 2784 | <title>[PIE] Section Options</title> |
| | 2785 | <para>The <literal>[PIE]</literal> section manages the queueing discipline |
| | 2786 | (qdisc) of Proportional Integral controller-Enhanced (PIE).</para> |
| | 2787 | |
| | 2788 | <variablelist class='network-directives'> |
| | 2789 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2790 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2791 | |
| | 2792 | <varlistentry> |
| | 2793 | <term><varname>PacketLimit=</varname></term> |
| | 2794 | <listitem> |
| | 2795 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are |
| | 2796 | dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and kernel's default is used.</para> |
| | 2797 | </listitem> |
| | 2798 | </varlistentry> |
| | 2799 | </variablelist> |
| | 2800 | </refsect1> |
| | 2801 | |
| | 2802 | <refsect1> |
| | 2803 | <title>[StochasticFairBlue] Section Options</title> |
| | 2804 | <para>The <literal>[StochasticFairBlue]</literal> section manages the queueing discipline |
| | 2805 | (qdisc) of stochastic fair blue (sfb).</para> |
| | 2806 | |
| | 2807 | <variablelist class='network-directives'> |
| | 2808 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2809 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2810 | |
| | 2811 | <varlistentry> |
| | 2812 | <term><varname>PacketLimit=</varname></term> |
| | 2813 | <listitem> |
| | 2814 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are |
| | 2815 | dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> |
| | 2816 | </listitem> |
| | 2817 | </varlistentry> |
| | 2818 | </variablelist> |
| | 2819 | </refsect1> |
| | 2820 | |
| | 2821 | <refsect1> |
| | 2822 | <title>[StochasticFairnessQueueing] Section Options</title> |
| | 2823 | <para>The <literal>[StochasticFairnessQueueing]</literal> section manages the queueing discipline |
| | 2824 | (qdisc) of stochastic fairness queueing (sfq).</para> |
| | 2825 | |
| | 2826 | <variablelist class='network-directives'> |
| | 2827 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2828 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2829 | |
| | 2830 | <varlistentry> |
| | 2831 | <term><varname>PerturbPeriodSec=</varname></term> |
| | 2832 | <listitem> |
| | 2833 | <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para> |
| | 2834 | </listitem> |
| | 2835 | </varlistentry> |
| | 2836 | </variablelist> |
| | 2837 | </refsect1> |
| | 2838 | |
| | 2839 | <refsect1> |
| | 2840 | <title>[BFIFO] Section Options</title> |
| | 2841 | <para>The <literal>[BFIFO]</literal> section manages the queueing discipline (qdisc) of |
| | 2842 | Byte limited Packet First In First Out (bfifo).</para> |
| | 2843 | |
| | 2844 | <variablelist class='network-directives'> |
| | 2845 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2846 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2847 | |
| | 2848 | <varlistentry> |
| | 2849 | <term><varname>LimitBytes=</varname></term> |
| | 2850 | <listitem> |
| | 2851 | <para>Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent it |
| | 2852 | from overflowing in case it is unable to dequeue packets as quickly as it receives them. When this limit |
| | 2853 | is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed as |
| | 2854 | Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> |
| | 2855 | </listitem> |
| | 2856 | </varlistentry> |
| | 2857 | </variablelist> |
| | 2858 | </refsect1> |
| | 2859 | |
| | 2860 | <refsect1> |
| | 2861 | <title>[PFIFO] Section Options</title> |
| | 2862 | <para>The <literal>[PFIFO]</literal> section manages the queueing discipline (qdisc) of |
| | 2863 | Packet First In First Out (pfifo).</para> |
| | 2864 | |
| | 2865 | <variablelist class='network-directives'> |
| | 2866 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2867 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2868 | |
| | 2869 | <varlistentry> |
| | 2870 | <term><varname>PacketLimit=</varname></term> |
| | 2871 | <listitem> |
| | 2872 | <para>Specifies the hard limit on the FIFO size in number of packets. The size limit (a buffer size) to prevent it |
| | 2873 | from overflowing in case it is unable to dequeue packets as quickly as it receives them. When this limit is reached, |
| | 2874 | incoming packets are dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> |
| | 2875 | </listitem> |
| | 2876 | </varlistentry> |
| | 2877 | </variablelist> |
| | 2878 | </refsect1> |
| | 2879 | |
| | 2880 | <refsect1> |
| | 2881 | <title>[PFIFOHeadDrop] Section Options</title> |
| | 2882 | <para>The <literal>[PFIFOHeadDrop]</literal> section manages the queueing discipline (qdisc) of |
| | 2883 | Packet First In First Out Head Drop (pfifo_head_drop).</para> |
| | 2884 | |
| | 2885 | <variablelist class='network-directives'> |
| | 2886 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2887 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2888 | |
| | 2889 | <varlistentry> |
| | 2890 | <term><varname>PacketLimit=</varname></term> |
| | 2891 | <listitem> |
| | 2892 | <para>As in <literal>[PFIFO]</literal> section.</para></listitem> |
| | 2893 | </varlistentry> |
| | 2894 | </variablelist> |
| | 2895 | </refsect1> |
| | 2896 | |
| | 2897 | <refsect1> |
| | 2898 | <title>[PFIFOFast] Section Options</title> |
| | 2899 | <para>The <literal>[PFIFOFast]</literal> section manages the queueing discipline (qdisc) of |
| | 2900 | Packet First In First Out Fast (pfifo_fast).</para> |
| | 2901 | |
| | 2902 | <variablelist class='network-directives'> |
| | 2903 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2904 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2905 | </variablelist> |
| | 2906 | </refsect1> |
| | 2907 | |
| | 2908 | <refsect1> |
| | 2909 | <title>[CAKE] Section Options</title> |
| | 2910 | <para>The <literal>[CAKE]</literal> section manages the queueing discipline (qdisc) of |
| | 2911 | Common Applications Kept Enhanced (CAKE).</para> |
| | 2912 | |
| | 2913 | <variablelist class='network-directives'> |
| | 2914 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2915 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2916 | |
| | 2917 | <varlistentry> |
| | 2918 | <term><varname>OverheadBytes=</varname></term> |
| | 2919 | <listitem> |
| | 2920 | <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. |
| | 2921 | Takes an integer ranges -64 to 256. Defaults to unset and kernel's default is used.</para> |
| | 2922 | </listitem> |
| | 2923 | </varlistentry> |
| | 2924 | |
| | 2925 | <varlistentry> |
| | 2926 | <term><varname>Bandwidth=</varname></term> |
| | 2927 | <listitem> |
| | 2928 | <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is |
| | 2929 | parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to |
| | 2930 | unset and kernel's default is used.</para> |
| | 2931 | </listitem> |
| | 2932 | </varlistentry> |
| | 2933 | </variablelist> |
| | 2934 | </refsect1> |
| | 2935 | |
| | 2936 | <refsect1> |
| | 2937 | <title>[ControlledDelay] Section Options</title> |
| | 2938 | <para>The <literal>[ControlledDelay]</literal> section manages the queueing discipline (qdisc) of |
| | 2939 | controlled delay (CoDel).</para> |
| | 2940 | |
| | 2941 | <variablelist class='network-directives'> |
| | 2942 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2943 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2944 | |
| | 2945 | <varlistentry> |
| | 2946 | <term><varname>PacketLimit=</varname></term> |
| | 2947 | <listitem> |
| | 2948 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are |
| | 2949 | dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> |
| | 2950 | </listitem> |
| | 2951 | </varlistentry> |
| | 2952 | |
| | 2953 | <varlistentry> |
| | 2954 | <term><varname>TargetSec=</varname></term> |
| | 2955 | <listitem> |
| | 2956 | <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay. |
| | 2957 | Defaults to unset and kernel's default is used.</para> |
| | 2958 | </listitem> |
| | 2959 | </varlistentry> |
| | 2960 | |
| | 2961 | <varlistentry> |
| | 2962 | <term><varname>IntervalSec=</varname></term> |
| | 2963 | <listitem> |
| | 2964 | <para>Takes a timespan. This is used to ensure that the measured minimum delay does not |
| | 2965 | become too stale. Defaults to unset and kernel's default is used.</para> |
| | 2966 | </listitem> |
| | 2967 | </varlistentry> |
| | 2968 | |
| | 2969 | <varlistentry> |
| | 2970 | <term><varname>ECN=</varname></term> |
| | 2971 | <listitem> |
| | 2972 | <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to |
| | 2973 | unset and kernel's default is used.</para> |
| | 2974 | </listitem> |
| | 2975 | </varlistentry> |
| | 2976 | |
| | 2977 | <varlistentry> |
| | 2978 | <term><varname>CEThresholdSec=</varname></term> |
| | 2979 | <listitem> |
| | 2980 | <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN |
| | 2981 | Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para> |
| | 2982 | </listitem> |
| | 2983 | </varlistentry> |
| | 2984 | </variablelist> |
| | 2985 | </refsect1> |
| | 2986 | |
| | 2987 | <refsect1> |
| | 2988 | <title>[DeficitRoundRobinScheduler] Section Options</title> |
| | 2989 | <para>The <literal>[DeficitRoundRobinScheduler]</literal> section manages the queueing discipline (qdisc) of |
| | 2990 | Deficit Round Robin Scheduler (DRR).</para> |
| | 2991 | |
| | 2992 | <variablelist class='network-directives'> |
| | 2993 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 2994 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 2995 | </variablelist> |
| | 2996 | </refsect1> |
| | 2997 | |
| | 2998 | <refsect1> |
| | 2999 | <title>[DeficitRoundRobinSchedulerClass] Section Options</title> |
| | 3000 | <para>The <literal>[DeficitRoundRobinSchedulerClass]</literal> section manages the traffic control class of |
| | 3001 | Deficit Round Robin Scheduler (DRR).</para> |
| | 3002 | |
| | 3003 | <variablelist class='network-directives'> |
| | 3004 | <xi:include href="tc.xml" xpointer="tclass-parent" /> |
| | 3005 | <xi:include href="tc.xml" xpointer="tclass-classid" /> |
| | 3006 | |
| | 3007 | <varlistentry> |
| | 3008 | <term><varname>QuantumBytes=</varname></term> |
| | 3009 | <listitem> |
| | 3010 | <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves |
| | 3011 | to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, |
| | 3012 | Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the |
| | 3013 | interface.</para> |
| | 3014 | </listitem> |
| | 3015 | </varlistentry> |
| | 3016 | |
| | 3017 | </variablelist> |
| | 3018 | </refsect1> |
| | 3019 | |
| | 3020 | <refsect1> |
| | 3021 | <title>[EnhancedTransmissionSelection] Section Options</title> |
| | 3022 | <para>The <literal>[EnhancedTransmissionSelection]</literal> section manages the queueing discipline (qdisc) of |
| | 3023 | Enhanced Transmission Selection (ETS).</para> |
| | 3024 | |
| | 3025 | <variablelist class='network-directives'> |
| | 3026 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3027 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3028 | |
| | 3029 | <varlistentry> |
| | 3030 | <term><varname>Bands=</varname></term> |
| | 3031 | <listitem> |
| | 3032 | <para>Specifies the number of bands. An unsigned integer ranges 1 to 16. This value has to be |
| | 3033 | at least large enough to cover the strict bands specified through the |
| | 3034 | <varname>StrictBands=</varname> and bandwidth-sharing bands specified in |
| | 3035 | <varname>QuantumBytes=</varname>.</para> |
| | 3036 | </listitem> |
| | 3037 | </varlistentry> |
| | 3038 | |
| | 3039 | <varlistentry> |
| | 3040 | <term><varname>StrictBands=</varname></term> |
| | 3041 | <listitem> |
| | 3042 | <para>Specifies the number of bands that should be created in strict mode. An unsigned integer |
| | 3043 | ranges 1 to 16.</para> |
| | 3044 | </listitem> |
| | 3045 | </varlistentry> |
| | 3046 | |
| | 3047 | <varlistentry> |
| | 3048 | <term><varname>QuantumBytes=</varname></term> |
| | 3049 | <listitem> |
| | 3050 | <para>Specifies the white-space separated list of quantum used in band-sharing bands. When |
| | 3051 | suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, |
| | 3052 | respectively, to the base of 1024. This setting can be specified multiple times. If an empty |
| | 3053 | string is assigned, then the all previous assignments are cleared.</para> |
| | 3054 | </listitem> |
| | 3055 | </varlistentry> |
| | 3056 | |
| | 3057 | <varlistentry> |
| | 3058 | <term><varname>PriorityMap=</varname></term> |
| | 3059 | <listitem> |
| | 3060 | <para>The priority map maps the priority of a packet to a band. The argument is a white-space |
| | 3061 | separated list of numbers. The first number indicates which band the packets with priority |
| | 3062 | 0 should be put to, the second is for priority 1, and so on. There can be up to 16 numbers in |
| | 3063 | the list. If there are fewer, the default band that traffic with one of the unmentioned |
| | 3064 | priorities goes to is the last one. Each band number must be 0..255. This setting can be |
| | 3065 | specified multiple times. If an empty string is assigned, then the all previous assignments |
| | 3066 | are cleared.</para> |
| | 3067 | </listitem> |
| | 3068 | </varlistentry> |
| | 3069 | </variablelist> |
| | 3070 | </refsect1> |
| | 3071 | |
| | 3072 | <refsect1> |
| | 3073 | <title>[GenericRandomEarlyDetection] Section Options</title> |
| | 3074 | <para>The <literal>[GenericRandomEarlyDetection]</literal> section manages the queueing discipline |
| | 3075 | (qdisc) of Generic Random Early Detection (GRED).</para> |
| | 3076 | |
| | 3077 | <variablelist class='network-directives'> |
| | 3078 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3079 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3080 | |
| | 3081 | <varlistentry> |
| | 3082 | <term><varname>VirtualQueues=</varname></term> |
| | 3083 | <listitem> |
| | 3084 | <para>Specifies the number of virtual queues. Takes a integer in the range 1-16. Defaults to unset and kernel's default is used.</para> |
| | 3085 | </listitem> |
| | 3086 | </varlistentry> |
| | 3087 | |
| | 3088 | <varlistentry> |
| | 3089 | <term><varname>DefaultVirtualQueue=</varname></term> |
| | 3090 | <listitem> |
| | 3091 | <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>. |
| | 3092 | Defaults to unset and kernel's default is used.</para> |
| | 3093 | </listitem> |
| | 3094 | </varlistentry> |
| | 3095 | |
| | 3096 | <varlistentry> |
| | 3097 | <term><varname>GenericRIO=</varname></term> |
| | 3098 | <listitem> |
| | 3099 | <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to |
| | 3100 | unset and kernel's default is used.</para> |
| | 3101 | </listitem> |
| | 3102 | </varlistentry> |
| | 3103 | </variablelist> |
| | 3104 | </refsect1> |
| | 3105 | |
| | 3106 | <refsect1> |
| | 3107 | <title>[FairQueueingControlledDelay] Section Options</title> |
| | 3108 | <para>The <literal>[FairQueueingControlledDelay]</literal> section manages the queueing discipline |
| | 3109 | (qdisc) of fair queuing controlled delay (FQ-CoDel).</para> |
| | 3110 | |
| | 3111 | <variablelist class='network-directives'> |
| | 3112 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3113 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3114 | |
| | 3115 | <varlistentry> |
| | 3116 | <term><varname>PacketLimit=</varname></term> |
| | 3117 | <listitem> |
| | 3118 | <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are |
| | 3119 | dropped. Defaults to unset and kernel's default is used.</para> |
| | 3120 | </listitem> |
| | 3121 | </varlistentry> |
| | 3122 | |
| | 3123 | <varlistentry> |
| | 3124 | <term><varname>MemoryLimitBytes=</varname></term> |
| | 3125 | <listitem> |
| | 3126 | <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance. |
| | 3127 | When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, |
| | 3128 | respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> |
| | 3129 | </listitem> |
| | 3130 | </varlistentry> |
| | 3131 | |
| | 3132 | <varlistentry> |
| | 3133 | <term><varname>Flows=</varname></term> |
| | 3134 | <listitem> |
| | 3135 | <para>Specifies the number of flows into which the incoming packets are classified. |
| | 3136 | Defaults to unset and kernel's default is used.</para> |
| | 3137 | </listitem> |
| | 3138 | </varlistentry> |
| | 3139 | |
| | 3140 | <varlistentry> |
| | 3141 | <term><varname>TargetSec=</varname></term> |
| | 3142 | <listitem> |
| | 3143 | <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay. |
| | 3144 | Defaults to unset and kernel's default is used.</para> |
| | 3145 | </listitem> |
| | 3146 | </varlistentry> |
| | 3147 | |
| | 3148 | <varlistentry> |
| | 3149 | <term><varname>IntervalSec=</varname></term> |
| | 3150 | <listitem> |
| | 3151 | <para>Takes a timespan. This is used to ensure that the measured minimum delay does not |
| | 3152 | become too stale. Defaults to unset and kernel's default is used.</para> |
| | 3153 | </listitem> |
| | 3154 | </varlistentry> |
| | 3155 | |
| | 3156 | <varlistentry> |
| | 3157 | <term><varname>QuantumBytes=</varname></term> |
| | 3158 | <listitem> |
| | 3159 | <para>Specifies the number of bytes used as 'deficit' in the fair queuing algorithmtimespan. |
| | 3160 | When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, |
| | 3161 | respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> |
| | 3162 | </listitem> |
| | 3163 | </varlistentry> |
| | 3164 | |
| | 3165 | <varlistentry> |
| | 3166 | <term><varname>ECN=</varname></term> |
| | 3167 | <listitem> |
| | 3168 | <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to |
| | 3169 | unset and kernel's default is used.</para> |
| | 3170 | </listitem> |
| | 3171 | </varlistentry> |
| | 3172 | |
| | 3173 | <varlistentry> |
| | 3174 | <term><varname>CEThresholdSec=</varname></term> |
| | 3175 | <listitem> |
| | 3176 | <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN |
| | 3177 | Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para> |
| | 3178 | </listitem> |
| | 3179 | </varlistentry> |
| | 3180 | </variablelist> |
| | 3181 | </refsect1> |
| | 3182 | |
| | 3183 | <refsect1> |
| | 3184 | <title>[FairQueueing] Section Options</title> |
| | 3185 | <para>The <literal>[FairQueueing]</literal> section manages the queueing discipline |
| | 3186 | (qdisc) of fair queue traffic policing (FQ).</para> |
| | 3187 | |
| | 3188 | <variablelist class='network-directives'> |
| | 3189 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3190 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3191 | |
| | 3192 | <varlistentry> |
| | 3193 | <term><varname>PacketLimit=</varname></term> |
| | 3194 | <listitem> |
| | 3195 | <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are |
| | 3196 | dropped. Defaults to unset and kernel's default is used.</para> |
| | 3197 | </listitem> |
| | 3198 | </varlistentry> |
| | 3199 | |
| | 3200 | <varlistentry> |
| | 3201 | <term><varname>FlowLimit=</varname></term> |
| | 3202 | <listitem> |
| | 3203 | <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to |
| | 3204 | unset and kernel's default is used.</para> |
| | 3205 | </listitem> |
| | 3206 | </varlistentry> |
| | 3207 | |
| | 3208 | <varlistentry> |
| | 3209 | <term><varname>QuantumBytes=</varname></term> |
| | 3210 | <listitem> |
| | 3211 | <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed |
| | 3212 | to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, |
| | 3213 | Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's |
| | 3214 | default is used.</para> |
| | 3215 | </listitem> |
| | 3216 | </varlistentry> |
| | 3217 | |
| | 3218 | <varlistentry> |
| | 3219 | <term><varname>InitialQuantumBytes=</varname></term> |
| | 3220 | <listitem> |
| | 3221 | <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is |
| | 3222 | allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as |
| | 3223 | Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and |
| | 3224 | kernel's default is used.</para> |
| | 3225 | </listitem> |
| | 3226 | </varlistentry> |
| | 3227 | |
| | 3228 | <varlistentry> |
| | 3229 | <term><varname>MaximumRate=</varname></term> |
| | 3230 | <listitem> |
| | 3231 | <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the |
| | 3232 | specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of |
| | 3233 | 1000. Defaults to unset and kernel's default is used.</para> |
| | 3234 | </listitem> |
| | 3235 | </varlistentry> |
| | 3236 | |
| | 3237 | <varlistentry> |
| | 3238 | <term><varname>Buckets=</varname></term> |
| | 3239 | <listitem> |
| | 3240 | <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and |
| | 3241 | kernel's default is used.</para> |
| | 3242 | </listitem> |
| | 3243 | </varlistentry> |
| | 3244 | |
| | 3245 | <varlistentry> |
| | 3246 | <term><varname>OrphanMask=</varname></term> |
| | 3247 | <listitem> |
| | 3248 | <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part |
| | 3249 | of hash and reduce number of buckets associated with the traffic. Defaults to unset and |
| | 3250 | kernel's default is used.</para> |
| | 3251 | </listitem> |
| | 3252 | </varlistentry> |
| | 3253 | |
| | 3254 | <varlistentry> |
| | 3255 | <term><varname>Pacing=</varname></term> |
| | 3256 | <listitem> |
| | 3257 | <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's |
| | 3258 | default is used.</para> |
| | 3259 | </listitem> |
| | 3260 | </varlistentry> |
| | 3261 | |
| | 3262 | <varlistentry> |
| | 3263 | <term><varname>CEThresholdSec=</varname></term> |
| | 3264 | <listitem> |
| | 3265 | <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN |
| | 3266 | Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para> |
| | 3267 | </listitem> |
| | 3268 | </varlistentry> |
| | 3269 | </variablelist> |
| | 3270 | </refsect1> |
| | 3271 | |
| | 3272 | <refsect1> |
| | 3273 | <title>[TrivialLinkEqualizer] Section Options</title> |
| | 3274 | <para>The <literal>[TrivialLinkEqualizer]</literal> section manages the queueing discipline (qdisc) of |
| | 3275 | trivial link equalizer (teql).</para> |
| | 3276 | |
| | 3277 | <variablelist class='network-directives'> |
| | 3278 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3279 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3280 | |
| | 3281 | <varlistentry> |
| | 3282 | <term><varname>Id=</varname></term> |
| | 3283 | <listitem> |
| | 3284 | <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>. |
| | 3285 | Note that when teql is used, currently, the module <constant>sch_teql</constant> with |
| | 3286 | <constant>max_equalizers=N+1</constant> option must be loaded before |
| | 3287 | <command>systemd-networkd</command> is started.</para> |
| | 3288 | </listitem> |
| | 3289 | </varlistentry> |
| | 3290 | </variablelist> |
| | 3291 | </refsect1> |
| | 3292 | |
| | 3293 | <refsect1> |
| | 3294 | <title>[HierarchyTokenBucket] Section Options</title> |
| | 3295 | <para>The <literal>[HierarchyTokenBucket]</literal> section manages the queueing discipline (qdisc) of |
| | 3296 | hierarchy token bucket (htb).</para> |
| | 3297 | |
| | 3298 | <variablelist class='network-directives'> |
| | 3299 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3300 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3301 | |
| | 3302 | <varlistentry> |
| | 3303 | <term><varname>DefaultClass=</varname></term> |
| | 3304 | <listitem> |
| | 3305 | <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent |
| | 3306 | to the class. Defaults to unset.</para> |
| | 3307 | </listitem> |
| | 3308 | </varlistentry> |
| | 3309 | |
| | 3310 | <varlistentry> |
| | 3311 | <term><varname>RateToQuantum=</varname></term> |
| | 3312 | <listitem> |
| | 3313 | <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value |
| | 3314 | configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para> |
| | 3315 | </listitem> |
| | 3316 | </varlistentry> |
| | 3317 | </variablelist> |
| | 3318 | </refsect1> |
| | 3319 | |
| | 3320 | <refsect1> |
| | 3321 | <title>[HierarchyTokenBucketClass] Section Options</title> |
| | 3322 | <para>The <literal>[HierarchyTokenBucketClass]</literal> section manages the traffic control class of |
| | 3323 | hierarchy token bucket (htb).</para> |
| | 3324 | |
| | 3325 | <variablelist class='network-directives'> |
| | 3326 | <xi:include href="tc.xml" xpointer="tclass-parent" /> |
| | 3327 | <xi:include href="tc.xml" xpointer="tclass-classid" /> |
| | 3328 | |
| | 3329 | <varlistentry> |
| | 3330 | <term><varname>Priority=</varname></term> |
| | 3331 | <listitem> |
| | 3332 | <para>Specifies the priority of the class. In the round-robin process, classes with the lowest |
| | 3333 | priority field are tried for packets first.</para> |
| | 3334 | </listitem> |
| | 3335 | </varlistentry> |
| | 3336 | |
| | 3337 | <varlistentry> |
| | 3338 | <term><varname>QuantumBytes=</varname></term> |
| | 3339 | <listitem> |
| | 3340 | <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the |
| | 3341 | specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of |
| | 3342 | 1024.</para> |
| | 3343 | </listitem> |
| | 3344 | </varlistentry> |
| | 3345 | |
| | 3346 | <varlistentry> |
| | 3347 | <term><varname>MTUBytes=</varname></term> |
| | 3348 | <listitem> |
| | 3349 | <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified |
| | 3350 | size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para> |
| | 3351 | </listitem> |
| | 3352 | </varlistentry> |
| | 3353 | |
| | 3354 | <varlistentry> |
| | 3355 | <term><varname>OverheadBytes=</varname></term> |
| | 3356 | <listitem> |
| | 3357 | <para>Takes an unsigned integer which specifies per-packet size overhead used in rate |
| | 3358 | computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, |
| | 3359 | Megabytes, or Gigabytes, respectively, to the base of 1024.</para> |
| | 3360 | </listitem> |
| | 3361 | </varlistentry> |
| | 3362 | |
| | 3363 | <varlistentry> |
| | 3364 | <term><varname>Rate=</varname></term> |
| | 3365 | <listitem> |
| | 3366 | <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed |
| | 3367 | with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, |
| | 3368 | to the base of 1000. This setting is mandatory.</para> |
| | 3369 | </listitem> |
| | 3370 | </varlistentry> |
| | 3371 | |
| | 3372 | <varlistentry> |
| | 3373 | <term><varname>CeilRate=</varname></term> |
| | 3374 | <listitem> |
| | 3375 | <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare. |
| | 3376 | When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, |
| | 3377 | respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname> |
| | 3378 | is used.</para> |
| | 3379 | </listitem> |
| | 3380 | </varlistentry> |
| | 3381 | |
| | 3382 | <varlistentry> |
| | 3383 | <term><varname>BufferBytes=</varname></term> |
| | 3384 | <listitem> |
| | 3385 | <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed |
| | 3386 | with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, |
| | 3387 | to the base of 1024.</para> |
| | 3388 | </listitem> |
| | 3389 | </varlistentry> |
| | 3390 | |
| | 3391 | <varlistentry> |
| | 3392 | <term><varname>CeilBufferBytes=</varname></term> |
| | 3393 | <listitem> |
| | 3394 | <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period. |
| | 3395 | When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, |
| | 3396 | respectively, to the base of 1024.</para> |
| | 3397 | </listitem> |
| | 3398 | </varlistentry> |
| | 3399 | </variablelist> |
| | 3400 | </refsect1> |
| | 3401 | |
| | 3402 | <refsect1> |
| | 3403 | <title>[HeavyHitterFilter] Section Options</title> |
| | 3404 | <para>The <literal>[HeavyHitterFilter]</literal> section manages the queueing discipline |
| | 3405 | (qdisc) of Heavy Hitter Filter (hhf).</para> |
| | 3406 | |
| | 3407 | <variablelist class='network-directives'> |
| | 3408 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3409 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3410 | |
| | 3411 | <varlistentry> |
| | 3412 | <term><varname>PacketLimit=</varname></term> |
| | 3413 | <listitem> |
| | 3414 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are |
| | 3415 | dropped. An unsigned integer ranges 0 to 4294967294. Defaults to unset and kernel's default is used.</para> |
| | 3416 | </listitem> |
| | 3417 | </varlistentry> |
| | 3418 | </variablelist> |
| | 3419 | </refsect1> |
| | 3420 | |
| | 3421 | <refsect1> |
| | 3422 | <title>[QuickFairQueueing] Section Options</title> |
| | 3423 | <para>The <literal>[QuickFairQueueing]</literal> section manages the queueing discipline |
| | 3424 | (qdisc) of Quick Fair Queueing (QFQ).</para> |
| | 3425 | |
| | 3426 | <variablelist class='network-directives'> |
| | 3427 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
| | 3428 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
| | 3429 | </variablelist> |
| | 3430 | </refsect1> |
| | 3431 | |
| | 3432 | <refsect1> |
| | 3433 | <title>[QuickFairQueueingClass] Section Options</title> |
| | 3434 | <para>The <literal>[QuickFairQueueingClass]</literal> section manages the traffic control class of |
| | 3435 | Quick Fair Queueing (qfq).</para> |
| | 3436 | |
| | 3437 | <variablelist class='network-directives'> |
| | 3438 | <xi:include href="tc.xml" xpointer="tclass-parent" /> |
| | 3439 | <xi:include href="tc.xml" xpointer="tclass-classid" /> |
| | 3440 | |
| | 3441 | <varlistentry> |
| | 3442 | <term><varname>Weight=</varname></term> |
| | 3443 | <listitem> |
| | 3444 | <para>Specifies the weight of the class. Takes an integer in the range 1..1023. Defaults to |
| | 3445 | unset in which case the kernel default is used.</para> |
| | 3446 | </listitem> |
| | 3447 | </varlistentry> |
| | 3448 | |
| | 3449 | <varlistentry> |
| | 3450 | <term><varname>MaxPacketBytes=</varname></term> |
| | 3451 | <listitem> |
| | 3452 | <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the specified |
| | 3453 | size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. When unset, |
| | 3454 | the kernel default is used.</para> |
| | 3455 | </listitem> |
| | 3456 | </varlistentry> |
| | 3457 | </variablelist> |
| | 3458 | </refsect1> |
| | 3459 | |
| | 3460 | <refsect1> |
| | 3461 | <title>[BridgeVLAN] Section Options</title> |
| | 3462 | <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts |
| | 3463 | the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries. |
| | 3464 | The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in |
| | 3465 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
| | 3466 | |
| | 3467 | <variablelist class='network-directives'> |
| | 3468 | <varlistentry> |
| | 3469 | <term><varname>VLAN=</varname></term> |
| | 3470 | <listitem> |
| | 3471 | <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. VLAN IDs are valid |
| | 3472 | from 1 to 4094.</para> |
| | 3473 | </listitem> |
| | 3474 | </varlistentry> |
| | 3475 | <varlistentry> |
| | 3476 | <term><varname>EgressUntagged=</varname></term> |
| | 3477 | <listitem> |
| | 3478 | <para>The VLAN ID specified here will be used to untag frames on egress. Configuring |
| | 3479 | <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the |
| | 3480 | VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para> |
| | 3481 | </listitem> |
| | 3482 | </varlistentry> |
| | 3483 | <varlistentry> |
| | 3484 | <term><varname>PVID=</varname></term> |
| | 3485 | <listitem> |
| | 3486 | <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress. |
| | 3487 | <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of |
| | 3488 | <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para> |
| | 3489 | </listitem> |
| | 3490 | </varlistentry> |
| | 3491 | </variablelist> |
| | 3492 | </refsect1> |
| | 3493 | |
| | 3494 | <refsect1> |
| | 3495 | <title>Examples</title> |
| | 3496 | <example> |
| | 3497 | <title>Static network configuration</title> |
| | 3498 | |
| | 3499 | <programlisting># /etc/systemd/network/50-static.network |
| | 3500 | [Match] |
| | 3501 | Name=enp2s0 |
| | 3502 | |
| | 3503 | [Network] |
| | 3504 | Address=192.168.0.15/24 |
| | 3505 | Gateway=192.168.0.1</programlisting> |
| | 3506 | |
| | 3507 | <para>This brings interface <literal>enp2s0</literal> up with a static address. The |
| | 3508 | specified gateway will be used for a default route.</para> |
| | 3509 | </example> |
| | 3510 | |
| | 3511 | <example> |
| | 3512 | <title>DHCP on ethernet links</title> |
| | 3513 | |
| | 3514 | <programlisting># /etc/systemd/network/80-dhcp.network |
| | 3515 | [Match] |
| | 3516 | Name=en* |
| | 3517 | |
| | 3518 | [Network] |
| | 3519 | DHCP=yes</programlisting> |
| | 3520 | |
| | 3521 | <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with |
| | 3522 | <literal>en</literal> (i.e. ethernet interfaces).</para> |
| | 3523 | </example> |
| | 3524 | |
| | 3525 | <example> |
| | 3526 | <title>IPv6 Prefix Delegation</title> |
| | 3527 | |
| | 3528 | <programlisting># /etc/systemd/network/55-ipv6-pd-upstream.network |
| | 3529 | [Match] |
| | 3530 | Name=enp1s0 |
| | 3531 | |
| | 3532 | [Network] |
| | 3533 | DHCP=ipv6</programlisting> |
| | 3534 | |
| | 3535 | <programlisting># /etc/systemd/network/56-ipv6-pd-downstream.network |
| | 3536 | [Match] |
| | 3537 | Name=enp2s0 |
| | 3538 | |
| | 3539 | [Network] |
| | 3540 | IPv6PrefixDelegation=dhcpv6 |
| | 3541 | |
| | 3542 | [DHCPv6] |
| | 3543 | AssignAcquiredDelegatedPrefixAddress=yes</programlisting> |
| | 3544 | |
| | 3545 | <para>This will enable IPv6 PD on the interface enp1s0 as an upstream interface where the |
| | 3546 | DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to.</para> |
| | 3547 | </example> |
| | 3548 | |
| | 3549 | <example> |
| | 3550 | <title>A bridge with two enslaved links</title> |
| | 3551 | |
| | 3552 | <programlisting># /etc/systemd/network/25-bridge-static.network |
| | 3553 | [Match] |
| | 3554 | Name=bridge0 |
| | 3555 | |
| | 3556 | [Network] |
| | 3557 | Address=192.168.0.15/24 |
| | 3558 | Gateway=192.168.0.1 |
| | 3559 | DNS=192.168.0.1</programlisting> |
| | 3560 | |
| | 3561 | <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network |
| | 3562 | [Match] |
| | 3563 | Name=enp2s0 |
| | 3564 | |
| | 3565 | [Network] |
| | 3566 | Bridge=bridge0</programlisting> |
| | 3567 | |
| | 3568 | <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network |
| | 3569 | [Match] |
| | 3570 | Name=wlp3s0 |
| | 3571 | |
| | 3572 | [Network] |
| | 3573 | Bridge=bridge0</programlisting> |
| | 3574 | |
| | 3575 | <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and |
| | 3576 | <literal>wlp3s0</literal> to it. The bridge will have the specified static address |
| | 3577 | and network assigned, and a default route via the specified gateway will be |
| | 3578 | added. The specified DNS server will be added to the global list of DNS resolvers. |
| | 3579 | </para> |
| | 3580 | </example> |
| | 3581 | |
| | 3582 | <example> |
| | 3583 | <title></title> |
| | 3584 | |
| | 3585 | <programlisting> |
| | 3586 | # /etc/systemd/network/20-bridge-slave-interface-vlan.network |
| | 3587 | [Match] |
| | 3588 | Name=enp2s0 |
| | 3589 | |
| | 3590 | [Network] |
| | 3591 | Bridge=bridge0 |
| | 3592 | |
| | 3593 | [BridgeVLAN] |
| | 3594 | VLAN=1-32 |
| | 3595 | PVID=42 |
| | 3596 | EgressUntagged=42 |
| | 3597 | |
| | 3598 | [BridgeVLAN] |
| | 3599 | VLAN=100-200 |
| | 3600 | |
| | 3601 | [BridgeVLAN] |
| | 3602 | EgressUntagged=300-400</programlisting> |
| | 3603 | |
| | 3604 | <para>This overrides the configuration specified in the previous example for the |
| | 3605 | interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs |
| | 3606 | 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be |
| | 3607 | untagged when they leave on this interface. Untagged packets which arrive on this |
| | 3608 | interface will be assigned VLAN ID 42.</para> |
| | 3609 | </example> |
| | 3610 | |
| | 3611 | <example> |
| | 3612 | <title>Various tunnels</title> |
| | 3613 | |
| | 3614 | <programlisting>/etc/systemd/network/25-tunnels.network |
| | 3615 | [Match] |
| | 3616 | Name=ens1 |
| | 3617 | |
| | 3618 | [Network] |
| | 3619 | Tunnel=ipip-tun |
| | 3620 | Tunnel=sit-tun |
| | 3621 | Tunnel=gre-tun |
| | 3622 | Tunnel=vti-tun |
| | 3623 | </programlisting> |
| | 3624 | |
| | 3625 | <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev |
| | 3626 | [NetDev] |
| | 3627 | Name=ipip-tun |
| | 3628 | Kind=ipip |
| | 3629 | </programlisting> |
| | 3630 | |
| | 3631 | <programlisting>/etc/systemd/network/25-tunnel-sit.netdev |
| | 3632 | [NetDev] |
| | 3633 | Name=sit-tun |
| | 3634 | Kind=sit |
| | 3635 | </programlisting> |
| | 3636 | |
| | 3637 | <programlisting>/etc/systemd/network/25-tunnel-gre.netdev |
| | 3638 | [NetDev] |
| | 3639 | Name=gre-tun |
| | 3640 | Kind=gre |
| | 3641 | </programlisting> |
| | 3642 | |
| | 3643 | <programlisting>/etc/systemd/network/25-tunnel-vti.netdev |
| | 3644 | [NetDev] |
| | 3645 | Name=vti-tun |
| | 3646 | Kind=vti |
| | 3647 | </programlisting> |
| | 3648 | |
| | 3649 | <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel, |
| | 3650 | a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para> |
| | 3651 | </example> |
| | 3652 | |
| | 3653 | <example> |
| | 3654 | <title>A bond device</title> |
| | 3655 | |
| | 3656 | <programlisting># /etc/systemd/network/30-bond1.network |
| | 3657 | [Match] |
| | 3658 | Name=bond1 |
| | 3659 | |
| | 3660 | [Network] |
| | 3661 | DHCP=ipv6 |
| | 3662 | </programlisting> |
| | 3663 | |
| | 3664 | <programlisting># /etc/systemd/network/30-bond1.netdev |
| | 3665 | [NetDev] |
| | 3666 | Name=bond1 |
| | 3667 | Kind=bond |
| | 3668 | </programlisting> |
| | 3669 | |
| | 3670 | <programlisting># /etc/systemd/network/30-bond1-dev1.network |
| | 3671 | [Match] |
| | 3672 | MACAddress=52:54:00:e9:64:41 |
| | 3673 | |
| | 3674 | [Network] |
| | 3675 | Bond=bond1 |
| | 3676 | </programlisting> |
| | 3677 | |
| | 3678 | <programlisting># /etc/systemd/network/30-bond1-dev2.network |
| | 3679 | [Match] |
| | 3680 | MACAddress=52:54:00:e9:64:42 |
| | 3681 | |
| | 3682 | [Network] |
| | 3683 | Bond=bond1 |
| | 3684 | </programlisting> |
| | 3685 | |
| | 3686 | <para>This will create a bond device <literal>bond1</literal> and enslave the two |
| | 3687 | devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP |
| | 3688 | will be used to acquire an address.</para> |
| | 3689 | </example> |
| | 3690 | |
| | 3691 | <example> |
| | 3692 | <title>Virtual Routing and Forwarding (VRF)</title> |
| | 3693 | <para>Add the <literal>bond1</literal> interface to the VRF master interface |
| | 3694 | <literal>vrf1</literal>. This will redirect routes generated on this interface to be |
| | 3695 | within the routing table defined during VRF creation. For kernels before 4.8 traffic |
| | 3696 | won't be redirected towards the VRFs routing table unless specific ip-rules are added. |
| | 3697 | </para> |
| | 3698 | <programlisting># /etc/systemd/network/25-vrf.network |
| | 3699 | [Match] |
| | 3700 | Name=bond1 |
| | 3701 | |
| | 3702 | [Network] |
| | 3703 | VRF=vrf1 |
| | 3704 | </programlisting> |
| | 3705 | </example> |
| | 3706 | |
| | 3707 | <example> |
| | 3708 | <title>MacVTap</title> |
| | 3709 | <para>This brings up a network interface <literal>macvtap-test</literal> |
| | 3710 | and attaches it to <literal>enp0s25</literal>.</para> |
| | 3711 | <programlisting># /usr/lib/systemd/network/25-macvtap.network |
| | 3712 | [Match] |
| | 3713 | Name=enp0s25 |
| | 3714 | |
| | 3715 | [Network] |
| | 3716 | MACVTAP=macvtap-test |
| | 3717 | </programlisting> |
| | 3718 | </example> |
| | 3719 | |
| | 3720 | <example> |
| | 3721 | <title>A Xfrm interface with physical underlying device.</title> |
| | 3722 | |
| | 3723 | <programlisting># /etc/systemd/network/27-xfrm.netdev |
| | 3724 | [NetDev] |
| | 3725 | Name=xfrm0 |
| | 3726 | |
| | 3727 | [Xfrm] |
| | 3728 | InterfaceId=7</programlisting> |
| | 3729 | |
| | 3730 | <programlisting># /etc/systemd/network/27-eth0.network |
| | 3731 | [Match] |
| | 3732 | Name=eth0 |
| | 3733 | |
| | 3734 | [Network] |
| | 3735 | Xfrm=xfrm0</programlisting> |
| | 3736 | |
| | 3737 | <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device. |
| | 3738 | This allows hardware based ipsec offloading to the <literal>eth0</literal> nic. |
| | 3739 | If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device. |
| | 3740 | </para> |
| | 3741 | </example> |
| | 3742 | </refsect1> |
| | 3743 | |
| | 3744 | <refsect1> |
| | 3745 | <title>See Also</title> |
| | 3746 | <para> |
| | 3747 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
| | 3748 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
| | 3749 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
| | 3750 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
| | 3751 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
| | 3752 | </para> |
| | 3753 | </refsect1> |
| | 3754 | |
| | 3755 | </refentry> |
projects / thirdparty / systemd.git / blame_incremental