]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
db9ecf05 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
eac684ef | 5 | |
d9b20454 ZJS |
6 | <refentry id="systemd.network" conditional='ENABLE_NETWORKD' |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
eac684ef | 8 | |
798d3a52 ZJS |
9 | <refentryinfo> |
10 | <title>systemd.network</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
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 | ||
add469f5 YW |
31 | <para>A plain ini-style text file that encodes network configuration for matching network |
32 | interfaces, used by | |
798d3a52 | 33 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. |
675fa6ea | 34 | See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
d4de2b2a | 35 | for a general description of the syntax.</para> |
798d3a52 | 36 | |
bac150e9 ZJS |
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 | ||
dc0d4078 ZJS |
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 | |
add469f5 | 44 | <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and |
cc9b6bdc YW |
45 | processed in alphanumeric order, regardless of the directories in which they live. However, files |
46 | with identical filenames replace each other. It is recommended that each filename is prefixed with | |
2c453485 YW |
47 | a number smaller than <literal>70</literal> (e.g. <filename>10-eth0.network</filename>). Otherwise, the |
48 | default <filename>.network</filename> files or those generated by | |
cc9b6bdc YW |
49 | <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
50 | may take precedence over user configured files. Files in <filename>/etc/</filename> have the highest | |
add469f5 YW |
51 | priority, files in <filename>/run/</filename> take precedence over files with the same name under |
52 | <filename>/usr/</filename>. This can be used to override a system-supplied configuration file with | |
53 | a local file if needed. As a special case, an empty file (file size 0) or symlink with the same | |
54 | name pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is | |
55 | "masked").</para> | |
bac150e9 ZJS |
56 | |
57 | <para>Along with the network file <filename>foo.network</filename>, a "drop-in" directory | |
58 | <filename>foo.network.d/</filename> may exist. All files with the suffix | |
e6655fbe YW |
59 | <literal>.conf</literal> from this directory will be merged in the alphanumeric order and parsed |
60 | after the main file itself has been parsed. This is useful to alter or add configuration settings, | |
61 | without having to modify the main configuration file. Each drop-in file must have appropriate | |
62 | section headers.</para> | |
bac150e9 ZJS |
63 | |
64 | <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal> | |
65 | directories can be placed in <filename>/usr/lib/systemd/network</filename> or | |
66 | <filename>/run/systemd/network</filename> directories. Drop-in files in | |
3b121157 ZJS |
67 | <filename>/etc/</filename> take precedence over those in <filename>/run/</filename> which in turn |
68 | take precedence over those in <filename>/usr/lib/</filename>. Drop-in files under any of these | |
b1e91af8 | 69 | directories take precedence over the main network file wherever located.</para> |
798d3a52 ZJS |
70 | </refsect1> |
71 | ||
72 | <refsect1> | |
73 | <title>[Match] Section Options</title> | |
74 | ||
add469f5 | 75 | <para>The network file contains a [Match] section, which determines if a given network file may |
cc9b6bdc YW |
76 | be applied to a given interface; and a [Network] section specifying how the interface should be |
77 | configured. The first (in alphanumeric order) of the network files that matches a given interface | |
78 | is applied, all later files are ignored, even if they match as well.</para> | |
798d3a52 | 79 | |
ba87a61d YW |
80 | <para>Note that any network interfaces that have the <varname>ID_NET_MANAGED_BY=</varname> udev property |
81 | set will never be matched by any .network files – unless the property's value is the string | |
82 | <literal>io.systemd.Network</literal> – even if the [Match] section would otherwise match. This may be | |
83 | used to exclude specific network interfaces from <command>systemd-networkd</command>'s management, while | |
2a94838b | 84 | keeping the [Match] section generic. The <varname>ID_NET_MANAGED_BY=</varname> property thus declares |
ba87a61d YW |
85 | intended <emphasis>ownership</emphasis> of the device, and permits ensuring that concurrent network |
86 | management implementations do not compete for management of specific devices.</para> | |
87 | ||
add469f5 YW |
88 | <para>A network file is said to match a network interface if all matches specified by the [Match] |
89 | section are satisfied. When a network file does not contain valid settings in [Match] section, then | |
90 | the file will match all interfaces and <command>systemd-networkd</command> warns about that. Hint: | |
91 | to avoid the warning and to make it clear that all interfaces shall be matched, add the following: | |
92 | <programlisting>Name=*</programlisting> The following keys are accepted:</para> | |
93 | ||
94 | <variablelist class='network-directives'> | |
95 | <xi:include href="systemd.link.xml" xpointer="mac-address" /> | |
96 | <xi:include href="systemd.link.xml" xpointer="permanent-mac-address" /> | |
97 | <xi:include href="systemd.link.xml" xpointer="path" /> | |
98 | <xi:include href="systemd.link.xml" xpointer="driver" /> | |
99 | <xi:include href="systemd.link.xml" xpointer="type" /> | |
65022cd7 | 100 | <xi:include href="systemd.link.xml" xpointer="kind" /> |
add469f5 YW |
101 | <xi:include href="systemd.link.xml" xpointer="property" /> |
102 | ||
103 | <varlistentry> | |
104 | <term><varname>Name=</varname></term> | |
105 | <listitem> | |
106 | <para>A whitespace-separated list of shell-style globs matching the device name, as exposed | |
107 | by the udev property <literal>INTERFACE</literal>, or device's alternative names. If the | |
108 | list is prefixed with a "!", the test is inverted.</para> | |
aefdc112 AK |
109 | |
110 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
111 | </listitem> |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term><varname>WLANInterfaceType=</varname></term> | |
116 | <listitem> | |
117 | <para>A whitespace-separated list of wireless network type. Supported values are | |
118 | <literal>ad-hoc</literal>, <literal>station</literal>, <literal>ap</literal>, | |
119 | <literal>ap-vlan</literal>, <literal>wds</literal>, <literal>monitor</literal>, | |
120 | <literal>mesh-point</literal>, <literal>p2p-client</literal>, <literal>p2p-go</literal>, | |
121 | <literal>p2p-device</literal>, <literal>ocb</literal>, and <literal>nan</literal>. If the | |
122 | list is prefixed with a "!", the test is inverted. </para> | |
ec07c3c8 AK |
123 | |
124 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
125 | </listitem> |
126 | </varlistentry> | |
127 | ||
128 | <varlistentry> | |
129 | <term><varname>SSID=</varname></term> | |
130 | <listitem> | |
131 | <para>A whitespace-separated list of shell-style globs matching the SSID of the currently | |
132 | connected wireless LAN. If the list is prefixed with a "!", the test is inverted.</para> | |
ec07c3c8 AK |
133 | |
134 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
135 | </listitem> |
136 | </varlistentry> | |
137 | ||
138 | <varlistentry> | |
139 | <term><varname>BSSID=</varname></term> | |
140 | <listitem> | |
141 | <para>A whitespace-separated list of hardware address of the currently connected wireless | |
142 | LAN. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example in | |
143 | <varname>MACAddress=</varname>. This option may appear more than once, in which case the | |
144 | lists are merged. If the empty string is assigned to this option, the list is reset.</para> | |
ec07c3c8 AK |
145 | |
146 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
147 | </listitem> |
148 | </varlistentry> | |
149 | ||
150 | <xi:include href="systemd.link.xml" xpointer="host" /> | |
151 | <xi:include href="systemd.link.xml" xpointer="virtualization" /> | |
152 | <xi:include href="systemd.link.xml" xpointer="kernel-command-line" /> | |
153 | <xi:include href="systemd.link.xml" xpointer="kernel-version" /> | |
4f80cfca | 154 | <xi:include href="systemd.link.xml" xpointer="credential" /> |
add469f5 YW |
155 | <xi:include href="systemd.link.xml" xpointer="architecture" /> |
156 | <xi:include href="systemd.link.xml" xpointer="firmware" /> | |
157 | </variablelist> | |
798d3a52 ZJS |
158 | </refsect1> |
159 | ||
160 | <refsect1> | |
161 | <title>[Link] Section Options</title> | |
162 | ||
a94ed9bd | 163 | <para>The [Link] section accepts the following keys:</para> |
798d3a52 ZJS |
164 | |
165 | <variablelist class='network-directives'> | |
166 | <varlistentry> | |
167 | <term><varname>MACAddress=</varname></term> | |
168 | <listitem> | |
de25aae1 | 169 | <para>The hardware address to set for the device.</para> |
aefdc112 AK |
170 | |
171 | <xi:include href="version-info.xml" xpointer="v218"/> | |
798d3a52 ZJS |
172 | </listitem> |
173 | </varlistentry> | |
add469f5 | 174 | |
798d3a52 ZJS |
175 | <varlistentry> |
176 | <term><varname>MTUBytes=</varname></term> | |
177 | <listitem> | |
add469f5 YW |
178 | <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, |
179 | G, are supported and are understood to the base of 1024.</para> | |
180 | <para>Note that if IPv6 is enabled on the interface, and the MTU is chosen below 1280 (the | |
181 | minimum MTU for IPv6) it will automatically be increased to this value.</para> | |
ec07c3c8 AK |
182 | |
183 | <xi:include href="version-info.xml" xpointer="v218"/> | |
798d3a52 ZJS |
184 | </listitem> |
185 | </varlistentry> | |
add469f5 | 186 | |
99d2baa2 SS |
187 | <varlistentry> |
188 | <term><varname>ARP=</varname></term> | |
189 | <listitem> | |
9b6ffef3 YW |
190 | <para>Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol) |
191 | for this interface is enabled. When unset, the kernel's default will be used.</para> | |
99d2baa2 SS |
192 | <para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual |
193 | interfaces atop a single lower-level physical interface, which will then only serve as a | |
194 | link/"bridge" device aggregating traffic to the same physical link and not participate in | |
937e305e | 195 | the network otherwise. Defaults to unset.</para> |
ec07c3c8 AK |
196 | |
197 | <xi:include href="version-info.xml" xpointer="v232"/> | |
99d2baa2 SS |
198 | </listitem> |
199 | </varlistentry> | |
add469f5 | 200 | |
e6ebebbe SS |
201 | <varlistentry> |
202 | <term><varname>Multicast=</varname></term> | |
203 | <listitem> | |
add469f5 YW |
204 | <para>Takes a boolean. If set to true, the multicast flag on the device is enabled. Defaults |
205 | to unset.</para> | |
ec07c3c8 AK |
206 | |
207 | <xi:include href="version-info.xml" xpointer="v239"/> | |
866e6b7a SS |
208 | </listitem> |
209 | </varlistentry> | |
add469f5 | 210 | |
866e6b7a SS |
211 | <varlistentry> |
212 | <term><varname>AllMulticast=</varname></term> | |
213 | <listitem> | |
add469f5 YW |
214 | <para>Takes a boolean. If set to true, the driver retrieves all multicast packets from the |
215 | network. This happens when multicast routing is enabled. Defaults to unset.</para> | |
ec07c3c8 AK |
216 | |
217 | <xi:include href="version-info.xml" xpointer="v239"/> | |
937e305e SS |
218 | </listitem> |
219 | </varlistentry> | |
add469f5 | 220 | |
937e305e SS |
221 | <varlistentry> |
222 | <term><varname>Promiscuous=</varname></term> | |
223 | <listitem> | |
add469f5 YW |
224 | <para>Takes a boolean. If set to true, promiscuous mode of the interface is enabled. Defaults |
225 | to unset.</para> | |
226 | <para>If this is set to false for the underlying link of a <literal>passthru</literal> mode | |
227 | MACVLAN/MACVTAP, the virtual interface will be created with the <literal>nopromisc</literal> | |
228 | flag set.</para> | |
ec07c3c8 AK |
229 | |
230 | <xi:include href="version-info.xml" xpointer="v248"/> | |
e6ebebbe SS |
231 | </listitem> |
232 | </varlistentry> | |
add469f5 | 233 | |
a09dc546 DM |
234 | <varlistentry> |
235 | <term><varname>Unmanaged=</varname></term> | |
236 | <listitem> | |
add469f5 YW |
237 | <para>Takes a boolean. When <literal>yes</literal>, no attempts are made to bring up or |
238 | configure matching links, equivalent to when there are no matching network files. Defaults to | |
a09dc546 | 239 | <literal>no</literal>.</para> |
add469f5 YW |
240 | <para>This is useful for preventing later matching network files from interfering with |
241 | certain interfaces that are fully controlled by other applications.</para> | |
ec07c3c8 AK |
242 | |
243 | <xi:include href="version-info.xml" xpointer="v233"/> | |
a09dc546 DM |
244 | </listitem> |
245 | </varlistentry> | |
add469f5 | 246 | |
89fe6535 SS |
247 | <varlistentry> |
248 | <term><varname>Group=</varname></term> | |
249 | <listitem> | |
add469f5 YW |
250 | <para>Link groups are similar to port ranges found in managed switches. When network |
251 | interfaces are added to a numbered group, operations on all the interfaces from that group | |
252 | can be performed at once. Takes an unsigned integer in the range 0…2147483647. Defaults to | |
253 | unset.</para> | |
ec07c3c8 AK |
254 | |
255 | <xi:include href="version-info.xml" xpointer="v246"/> | |
89fe6535 | 256 | </listitem> |
0a9fb9ba | 257 | </varlistentry> |
add469f5 | 258 | |
c1a38904 MTL |
259 | <varlistentry> |
260 | <term><varname>RequiredForOnline=</varname></term> | |
261 | <listitem> | |
3255bda6 YW |
262 | <para>Takes a boolean, a minimum operational state (e.g., <literal>carrier</literal>), or a range |
263 | of operational state separated with a colon (e.g., <literal>degraded:routable</literal>). | |
264 | Please see | |
add469f5 YW |
265 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
266 | for possible operational states. When <literal>yes</literal>, the network is deemed required | |
267 | when determining whether the system is online (including when running | |
268 | <command>systemd-networkd-wait-online</command>). When <literal>no</literal>, the network is | |
269 | ignored when determining the online state. When a minimum operational state and an optional | |
a853cc99 YW |
270 | maximum operational state are set, <command>systemd-networkd-wait-online</command> deems that the |
271 | interface is online when the operational state is in the specified range.</para> | |
3255bda6 | 272 | |
add469f5 YW |
273 | <para>Defaults to <literal>yes</literal> when <varname>ActivationPolicy=</varname> is not |
274 | set, or set to <literal>up</literal>, <literal>always-up</literal>, or | |
275 | <literal>bound</literal>. Defaults to <literal>no</literal> when | |
276 | <varname>ActivationPolicy=</varname> is set to <literal>manual</literal> or | |
277 | <literal>down</literal>. This is forced to <literal>no</literal> when | |
278 | <varname>ActivationPolicy=</varname> is set to <literal>always-down</literal>.</para> | |
279 | ||
280 | <para>The network will be brought up normally (as configured by | |
281 | <varname>ActivationPolicy=</varname>), but in the event that there is no address being | |
282 | assigned by DHCP or the cable is not plugged in, the link will simply remain offline and be | |
283 | skipped automatically by <command>systemd-networkd-wait-online</command> if | |
284 | <literal>RequiredForOnline=no</literal>.</para> | |
ec07c3c8 | 285 | |
a853cc99 YW |
286 | <para>The boolean value <literal>yes</literal> is translated as follows; |
287 | <variablelist> | |
288 | <varlistentry> | |
289 | <term><option>CAN devices</option></term> | |
290 | <listitem> | |
291 | <para><literal>carrier</literal>,</para> | |
292 | <xi:include href="version-info.xml" xpointer="v256"/> | |
293 | </listitem> | |
294 | </varlistentry> | |
295 | <varlistentry> | |
296 | <term><option>Master devices, e.g. bond or bridge</option></term> | |
297 | <listitem> | |
298 | <para><literal>degraded-carrier</literal> with <varname>RequiredFamilyForOnline=any</varname>,</para> | |
299 | <xi:include href="version-info.xml" xpointer="v256"/> | |
300 | </listitem> | |
301 | </varlistentry> | |
302 | <varlistentry> | |
303 | <term><option>Bonding port interfaces</option></term> | |
304 | <listitem> | |
305 | <para><literal>enslaved</literal>,</para> | |
306 | <xi:include href="version-info.xml" xpointer="v256"/> | |
307 | </listitem> | |
308 | </varlistentry> | |
309 | <varlistentry> | |
310 | <term><option>Other interfaces</option></term> | |
311 | <listitem> | |
312 | <para><literal>degraded</literal>.</para> | |
313 | <xi:include href="version-info.xml" xpointer="v236"/> | |
314 | </listitem> | |
315 | </varlistentry> | |
316 | </variablelist> | |
317 | </para> | |
318 | ||
319 | <para>This setting can be overridden by the command line option for | |
320 | <command>systemd-networkd-wait-online</command>. See | |
321 | <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
322 | for more details.</para> | |
323 | ||
ec07c3c8 | 324 | <xi:include href="version-info.xml" xpointer="v236"/> |
c1a38904 MTL |
325 | </listitem> |
326 | </varlistentry> | |
add469f5 | 327 | |
8430841b L |
328 | <varlistentry> |
329 | <term><varname>RequiredFamilyForOnline=</varname></term> | |
330 | <listitem> | |
add469f5 YW |
331 | <para>Takes an address family. When specified, an IP address in the given family is deemed |
332 | required when determining whether the link is online (including when running | |
553022c4 AŠ |
333 | <command>systemd-networkd-wait-online</command>). Takes one of <literal>ipv4</literal>, |
334 | <literal>ipv6</literal>, <literal>both</literal>, or <literal>any</literal>. Defaults to | |
c89efaf9 YW |
335 | <literal>no</literal>. Note that this option has no effect if |
336 | <literal>RequiredForOnline=no</literal>.</para> | |
ec07c3c8 AK |
337 | |
338 | <xi:include href="version-info.xml" xpointer="v249"/> | |
8430841b L |
339 | </listitem> |
340 | </varlistentry> | |
add469f5 | 341 | |
61135582 DS |
342 | <varlistentry> |
343 | <term><varname>ActivationPolicy=</varname></term> | |
344 | <listitem> | |
345 | <para>Specifies the policy for <command>systemd-networkd</command> managing the link | |
346 | administrative state. Specifically, this controls how <command>systemd-networkd</command> | |
347 | changes the network device's <literal>IFF_UP</literal> flag, which is sometimes | |
add469f5 YW |
348 | controlled by system administrators by running e.g., |
349 | <command>ip link set dev eth0 up</command> or <command>ip link set dev eth0 down</command>, | |
350 | and can also be changed with <command>networkctl up eth0</command> or | |
351 | <command>networkctl down eth0</command>.</para> | |
61135582 DS |
352 | |
353 | <para>Takes one of <literal>up</literal>, <literal>always-up</literal>, | |
354 | <literal>manual</literal>, <literal>always-down</literal>, <literal>down</literal>, | |
add469f5 YW |
355 | or <literal>bound</literal>. When <literal>manual</literal>, |
356 | <command>systemd-networkd</command> will not change the link's admin state automatically; | |
357 | the system administrator must bring the interface up or down manually, as desired. When | |
358 | <literal>up</literal> (the default) or <literal>always-up</literal>, or | |
359 | <literal>down</literal> or <literal>always-down</literal>, | |
360 | <command>systemd-networkd</command> will set the link up or down, respectively, when the | |
361 | interface is (re)configured. When <literal>always-up</literal> or | |
362 | <literal>always-down</literal>, <command>systemd-networkd</command> will set the link up or | |
363 | down, respectively, any time <command>systemd-networkd</command> detects a change in the | |
364 | administrative state. When <varname>BindCarrier=</varname> is also set, this is automatically | |
365 | set to <literal>bound</literal> and any other value is ignored.</para> | |
366 | ||
367 | <para>When the policy is set to <literal>down</literal> or <literal>manual</literal>, the | |
368 | default value of <varname>RequiredForOnline=</varname> is <literal>no</literal>. When the | |
369 | policy is set to <literal>always-down</literal>, the value of | |
7c644a69 DS |
370 | <varname>RequiredForOnline=</varname> forced to <literal>no</literal>.</para> |
371 | ||
61135582 | 372 | <para>The administrative state is not the same as the carrier state, so using |
add469f5 YW |
373 | <literal>always-up</literal> does not mean the link will never lose carrier. The link carrier |
374 | depends on both the administrative state as well as the network device's physical connection. | |
375 | However, to avoid reconfiguration failures, when using <literal>always-up</literal>, | |
61135582 | 376 | <varname>IgnoreCarrierLoss=</varname> is forced to true.</para> |
ec07c3c8 AK |
377 | |
378 | <xi:include href="version-info.xml" xpointer="v248"/> | |
61135582 DS |
379 | </listitem> |
380 | </varlistentry> | |
798d3a52 ZJS |
381 | </variablelist> |
382 | </refsect1> | |
383 | ||
bd29dfef | 384 | <xi:include href="systemd.link.xml" xpointer="sr-iov" /> |
518cd6b5 | 385 | |
798d3a52 ZJS |
386 | <refsect1> |
387 | <title>[Network] Section Options</title> | |
388 | ||
add469f5 YW |
389 | <para>The [Network] section accepts the following keys:</para> |
390 | ||
391 | <variablelist class='network-directives'> | |
392 | <varlistentry> | |
393 | <term><varname>Description=</varname></term> | |
394 | <listitem> | |
395 | <para>A description of the device. This is only used for presentation purposes.</para> | |
aefdc112 AK |
396 | |
397 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
398 | </listitem> |
399 | </varlistentry> | |
400 | ||
401 | <varlistentry> | |
402 | <term><varname>DHCP=</varname></term> | |
403 | <listitem> | |
404 | <para>Enables DHCPv4 and/or DHCPv6 client support. Accepts <literal>yes</literal>, | |
405 | <literal>no</literal>, <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to | |
406 | <literal>no</literal>.</para> | |
407 | ||
f217f9a8 ZJS |
408 | <para>Note that DHCPv6 will by default be triggered by Router Advertisements, if reception is |
409 | enabled, regardless of this parameter. By explicitly enabling DHCPv6 support here, the DHCPv6 | |
410 | client will be started in the mode specified by the <varname>WithoutRA=</varname> setting in the | |
411 | [DHCPv6] section, regardless of the presence of routers on the link, or what flags the routers | |
412 | pass. See <varname>IPv6AcceptRA=</varname>.</para> | |
add469f5 YW |
413 | |
414 | <para>Furthermore, note that by default the domain name specified through DHCP is not used | |
415 | for name resolution. See option <option>UseDomains=</option> below.</para> | |
416 | ||
417 | <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the | |
418 | DHCP client support.</para> | |
aefdc112 AK |
419 | |
420 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
421 | </listitem> |
422 | </varlistentry> | |
423 | ||
424 | <varlistentry> | |
425 | <term><varname>DHCPServer=</varname></term> | |
426 | <listitem> | |
427 | <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. | |
428 | Defaults to <literal>no</literal>. Further settings for the DHCP server may be set in the | |
429 | [DHCPServer] section described below.</para> | |
ec07c3c8 | 430 | |
a3ed665a YW |
431 | <para>Even if this is enabled, the DHCP server will not be started automatically and wait for the |
432 | persistent storage being ready to load/save leases in the storage, unless | |
433 | <varname>RelayTarget=</varname> or <varname>PersistLeases=no</varname> are specified in the | |
434 | [DHCPServer] section. It will be started after | |
435 | <filename>systemd-networkd-persistent-storage.service</filename> is started, which calls | |
436 | <command>networkctl persistent-storage yes</command>. See | |
5582b36c YW |
437 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
438 | for more details.</para> | |
439 | ||
440 | <xi:include href="version-info.xml" xpointer="v215"/> | |
add469f5 YW |
441 | </listitem> |
442 | </varlistentry> | |
443 | ||
444 | <varlistentry> | |
445 | <term><varname>LinkLocalAddressing=</varname></term> | |
446 | <listitem> | |
07b6924d ML |
447 | <para>Enables link-local address autoconfiguration. Accepts a boolean, <option>ipv4</option>, |
448 | and <option>ipv6</option>. An IPv6 link-local address is configured when <option>yes</option> | |
449 | or <option>ipv6</option>. An IPv4 link-local address is configured when <option>yes</option> | |
450 | or <option>ipv4</option> and when DHCPv4 autoconfiguration has been unsuccessful for some time. | |
451 | (IPv4 link-local address autoconfiguration will usually happen in parallel with repeated attempts | |
452 | to acquire a DHCPv4 lease).</para> | |
add469f5 YW |
453 | |
454 | <para>Defaults to <option>no</option> when <varname>KeepMaster=</varname> or | |
455 | <varname>Bridge=</varname> is set or when the specified | |
456 | <varname>MACVLAN=</varname>/<varname>MACVTAP=</varname> has <varname>Mode=passthru</varname>, | |
457 | or <option>ipv6</option> otherwise.</para> | |
ec07c3c8 AK |
458 | |
459 | <xi:include href="version-info.xml" xpointer="v219"/> | |
add469f5 YW |
460 | </listitem> |
461 | </varlistentry> | |
462 | ||
463 | <varlistentry> | |
464 | <term><varname>IPv6LinkLocalAddressGenerationMode=</varname></term> | |
465 | <listitem> | |
f81ac115 | 466 | <para>Specifies how IPv6 link-local address is generated. Takes one of |
add469f5 YW |
467 | <literal>eui64</literal>, <literal>none</literal>, <literal>stable-privacy</literal> and |
468 | <literal>random</literal>. When unset, <literal>stable-privacy</literal> is used if | |
469 | <varname>IPv6StableSecretAddress=</varname> is specified, and if not, | |
470 | <literal>eui64</literal> is used. Note that if <varname>LinkLocalAddressing=</varname> is | |
471 | <literal>no</literal> or <literal>ipv4</literal>, then | |
472 | <varname>IPv6LinkLocalAddressGenerationMode=</varname> will be ignored. Also, even if | |
473 | <varname>LinkLocalAddressing=</varname> is <literal>yes</literal> or <literal>ipv6</literal>, | |
474 | setting <varname>IPv6LinkLocalAddressGenerationMode=none</varname> | |
475 | disables to configure an IPv6 link-local address.</para> | |
ec07c3c8 AK |
476 | |
477 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
478 | </listitem> |
479 | </varlistentry> | |
480 | ||
481 | <varlistentry> | |
482 | <term><varname>IPv6StableSecretAddress=</varname></term> | |
483 | <listitem> | |
484 | <para>Takes an IPv6 address. The specified address will be used as a stable secret for | |
485 | generating IPv6 link-local address. If this setting is specified, and | |
486 | <varname>IPv6LinkLocalAddressGenerationMode=</varname> is unset, then | |
487 | <varname>IPv6LinkLocalAddressGenerationMode=stable-privacy</varname> is implied. | |
488 | If this setting is not specified, and <literal>stable-privacy</literal> is set to | |
489 | <varname>IPv6LinkLocalAddressGenerationMode=</varname>, | |
490 | then a stable secret address will be generated from the local machine ID and the interface | |
491 | name.</para> | |
ec07c3c8 AK |
492 | |
493 | <xi:include href="version-info.xml" xpointer="v249"/> | |
add469f5 YW |
494 | </listitem> |
495 | </varlistentry> | |
496 | ||
34b63c9e AK |
497 | <varlistentry> |
498 | <term><varname>IPv4LLStartAddress=</varname></term> | |
499 | <listitem> | |
d3efcd2d YW |
500 | <para>Specifies the first IPv4 link-local address to try. Takes an IPv4 address for example |
501 | 169.254.1.2, from the link-local address range: 169.254.0.0/16 except for 169.254.0.0/24 and | |
502 | 169.254.255.0/24. This setting may be useful if the device should always have the same address | |
503 | as long as there is no address conflict. When unset, a random address will be automatically | |
504 | selected. Defaults to unset.</para> | |
ec07c3c8 AK |
505 | |
506 | <xi:include href="version-info.xml" xpointer="v252"/> | |
34b63c9e AK |
507 | </listitem> |
508 | </varlistentry> | |
509 | ||
add469f5 YW |
510 | <varlistentry> |
511 | <term><varname>IPv4LLRoute=</varname></term> | |
512 | <listitem> | |
513 | <para>Takes a boolean. If set to true, sets up the route needed for non-IPv4LL hosts to | |
514 | communicate with IPv4LL-only hosts. Defaults to false.</para> | |
ec07c3c8 AK |
515 | |
516 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
517 | </listitem> |
518 | </varlistentry> | |
519 | ||
520 | <varlistentry> | |
521 | <term><varname>DefaultRouteOnDevice=</varname></term> | |
522 | <listitem> | |
15f330cf | 523 | <para>Takes a boolean. If set to true, sets up the IPv4 default route bound to the interface. |
add469f5 YW |
524 | Defaults to false. This is useful when creating routes on point-to-point interfaces. This is |
525 | equivalent to e.g. the following, | |
526 | <programlisting>ip route add default dev veth99</programlisting> | |
527 | or, | |
528 | <programlisting>[Route] | |
21d03e6c | 529 | Gateway=0.0.0.0</programlisting></para> |
add469f5 YW |
530 | <para>Currently, there are no way to specify e.g., the table for the route configured by this |
531 | setting. To configure the default route with such an additional property, please use the | |
532 | following instead: | |
533 | <programlisting>[Route] | |
21d03e6c | 534 | Gateway=0.0.0.0 |
15f330cf YW |
535 | Table=1234</programlisting></para> |
536 | <para>If you'd like to create an IPv6 default route bound to the interface, please use the | |
537 | following: | |
538 | <programlisting>[Route] | |
539 | Gateway=:: | |
21d03e6c | 540 | Table=1234</programlisting></para> |
ec07c3c8 AK |
541 | |
542 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
543 | </listitem> |
544 | </varlistentry> | |
c4a05aa1 | 545 | |
dd5f3175 | 546 | <varlistentry> |
add469f5 | 547 | <term><varname>LLMNR=</varname></term> |
dd5f3175 | 548 | <listitem> |
add469f5 YW |
549 | <para>Takes a boolean or <literal>resolve</literal>. When true, enables |
550 | <ulink url="https://tools.ietf.org/html/rfc4795">Link-Local Multicast Name Resolution</ulink> | |
551 | on the link. When set to <literal>resolve</literal>, only resolution is enabled, but not host | |
552 | registration and announcement. Defaults to true. This setting is read by | |
553 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
dd5f3175 | 554 | </para> |
ec07c3c8 AK |
555 | |
556 | <xi:include href="version-info.xml" xpointer="v216"/> | |
dd5f3175 SS |
557 | </listitem> |
558 | </varlistentry> | |
add469f5 | 559 | |
dd5f3175 | 560 | <varlistentry> |
add469f5 | 561 | <term><varname>MulticastDNS=</varname></term> |
dd5f3175 | 562 | <listitem> |
add469f5 YW |
563 | <para>Takes a boolean or <literal>resolve</literal>. When true, enables |
564 | <ulink url="https://tools.ietf.org/html/rfc6762">Multicast DNS</ulink> support on the link. | |
565 | When set to <literal>resolve</literal>, only resolution is enabled, but not host or service | |
566 | registration and announcement. Defaults to false. This setting is read by | |
567 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
dd5f3175 | 568 | </para> |
ec07c3c8 AK |
569 | |
570 | <xi:include href="version-info.xml" xpointer="v229"/> | |
dd5f3175 SS |
571 | </listitem> |
572 | </varlistentry> | |
add469f5 | 573 | |
dad2d78e | 574 | <varlistentry> |
add469f5 | 575 | <term><varname>DNSOverTLS=</varname></term> |
dad2d78e | 576 | <listitem> |
add469f5 YW |
577 | <para>Takes a boolean or <literal>opportunistic</literal>. When true, enables |
578 | <ulink url="https://tools.ietf.org/html/rfc7858">DNS-over-TLS</ulink> support on the link. | |
579 | When set to <literal>opportunistic</literal>, compatibility with non-DNS-over-TLS servers is | |
580 | increased, by automatically turning off DNS-over-TLS servers in this case. This option | |
581 | defines a per-interface setting for | |
582 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s | |
583 | global <varname>DNSOverTLS=</varname> option. Defaults to unset, and the global setting will | |
584 | be used. This setting is read by | |
585 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
dad2d78e | 586 | </para> |
ec07c3c8 AK |
587 | |
588 | <xi:include href="version-info.xml" xpointer="v239"/> | |
dad2d78e SS |
589 | </listitem> |
590 | </varlistentry> | |
add469f5 | 591 | |
93b4dab5 | 592 | <varlistentry> |
add469f5 | 593 | <term><varname>DNSSEC=</varname></term> |
93b4dab5 | 594 | <listitem> |
add469f5 YW |
595 | <para>Takes a boolean or <literal>allow-downgrade</literal>. When true, enables |
596 | <ulink url="https://tools.ietf.org/html/rfc4033">DNSSEC</ulink> DNS validation support on the | |
597 | link. When set to <literal>allow-downgrade</literal>, compatibility with non-DNSSEC capable | |
598 | networks is increased, by automatically turning off DNSSEC in this case. This option defines | |
599 | a per-interface setting for | |
600 | <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s | |
601 | global <varname>DNSSEC=</varname> option. Defaults to unset, and the global setting will be | |
602 | used. This setting is read by | |
603 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
604 | </para> | |
ec07c3c8 AK |
605 | |
606 | <xi:include href="version-info.xml" xpointer="v229"/> | |
add469f5 YW |
607 | </listitem> |
608 | </varlistentry> | |
61135582 | 609 | |
add469f5 YW |
610 | <varlistentry> |
611 | <term><varname>DNSSECNegativeTrustAnchors=</varname></term> | |
612 | <listitem> | |
613 | <para>A space-separated list of DNSSEC negative trust anchor domains. If specified and DNSSEC | |
614 | is enabled, look-ups done via the interface's DNS server will be subject to the list of | |
615 | negative trust anchors, and not require authentication for the specified domains, or anything | |
616 | below it. Use this to disable DNSSEC authentication for specific private domains, that cannot | |
617 | be proven valid using the Internet DNS hierarchy. Defaults to the empty list. This setting is | |
618 | read by | |
619 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
61135582 | 620 | </para> |
ec07c3c8 AK |
621 | |
622 | <xi:include href="version-info.xml" xpointer="v229"/> | |
93b4dab5 SS |
623 | </listitem> |
624 | </varlistentry> | |
add469f5 | 625 | |
c98d78d3 | 626 | <varlistentry> |
add469f5 | 627 | <term><varname>LLDP=</varname></term> |
c98d78d3 | 628 | <listitem> |
add469f5 YW |
629 | <para>Controls support for Ethernet LLDP packet reception. LLDP is a link-layer protocol |
630 | commonly implemented on professional routers and bridges which announces which physical port | |
631 | a system is connected to, as well as other related data. Accepts a boolean or the special | |
632 | value <literal>routers-only</literal>. When true, incoming LLDP packets are accepted and a | |
633 | database of all LLDP neighbors maintained. If <literal>routers-only</literal> is set only | |
634 | LLDP data of various types of routers is collected and LLDP data about other types of devices | |
635 | ignored (such as stations, telephones and others). If false, LLDP reception is disabled. | |
636 | Defaults to <literal>routers-only</literal>. Use | |
637 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
638 | to query the collected neighbor data. LLDP is only available on Ethernet links. See | |
639 | <varname>EmitLLDP=</varname> below for enabling LLDP packet emission from the local system. | |
80060352 | 640 | </para> |
ec07c3c8 AK |
641 | |
642 | <xi:include href="version-info.xml" xpointer="v219"/> | |
c98d78d3 YW |
643 | </listitem> |
644 | </varlistentry> | |
798d3a52 | 645 | |
add469f5 YW |
646 | <varlistentry> |
647 | <term><varname>EmitLLDP=</varname></term> | |
648 | <listitem> | |
649 | <para>Controls support for Ethernet LLDP packet emission. Accepts a boolean parameter or the | |
650 | special values <literal>nearest-bridge</literal>, <literal>non-tpmr-bridge</literal> and | |
651 | <literal>customer-bridge</literal>. Defaults to false, which turns off LLDP packet emission. | |
652 | If not false, a short LLDP packet with information about the local system is sent out in | |
653 | regular intervals on the link. The LLDP packet will contain information about the local | |
654 | hostname, the local machine ID (as stored in | |
655 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>) | |
656 | and the local interface name, as well as the pretty hostname of the system (as set in | |
657 | <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
658 | LLDP emission is only available on Ethernet links. Note that this setting passes data | |
659 | suitable for identification of host to the network and should thus not be enabled on | |
660 | untrusted networks, where such identification data should not be made available. Use this | |
661 | option to permit other systems to identify on which interfaces they are connected to this | |
662 | system. The three special values control propagation of the LLDP packets. The | |
663 | <literal>nearest-bridge</literal> setting permits propagation only to the nearest connected | |
664 | bridge, <literal>non-tpmr-bridge</literal> permits propagation across Two-Port MAC Relays, | |
665 | but not any other bridges, and <literal>customer-bridge</literal> permits propagation until | |
666 | a customer bridge is reached. For details about these concepts, see | |
667 | <ulink url="https://standards.ieee.org/findstds/standard/802.1AB-2016.html">IEEE 802.1AB-2016</ulink>. | |
668 | Note that configuring this setting to true is equivalent to | |
669 | <literal>nearest-bridge</literal>, the recommended and most restricted level of propagation. | |
670 | See <varname>LLDP=</varname> above for an option to enable LLDP reception.</para> | |
ec07c3c8 AK |
671 | |
672 | <xi:include href="version-info.xml" xpointer="v230"/> | |
add469f5 YW |
673 | </listitem> |
674 | </varlistentry> | |
798d3a52 | 675 | |
add469f5 YW |
676 | <varlistentry> |
677 | <term><varname>BindCarrier=</varname></term> | |
678 | <listitem> | |
679 | <para>A link name or a list of link names. When set, controls the behavior of the current | |
680 | link. When all links in the list are in an operational down state, the current link is | |
681 | brought down. When at least one link has carrier, the current interface is brought up.</para> | |
798d3a52 | 682 | |
add469f5 YW |
683 | <para>This forces <varname>ActivationPolicy=</varname> to be set to <literal>bound</literal>. |
684 | </para> | |
ec07c3c8 AK |
685 | |
686 | <xi:include href="version-info.xml" xpointer="v220"/> | |
add469f5 YW |
687 | </listitem> |
688 | </varlistentry> | |
e4a71bf3 | 689 | |
add469f5 YW |
690 | <varlistentry> |
691 | <term><varname>Address=</varname></term> | |
692 | <listitem> | |
693 | <para>A static IPv4 or IPv6 address and its prefix length, separated by a | |
694 | <literal>/</literal> character. Specify this key more than once to configure several | |
695 | addresses. The format of the address must be as described in | |
696 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
697 | This is a short-hand for an [Address] section only containing an Address key (see below). | |
698 | This option may be specified more than once.</para> | |
699 | ||
700 | <para>If the specified address is <literal>0.0.0.0</literal> (for IPv4) or | |
701 | <literal>::</literal> (for IPv6), a new address range of the requested size is automatically | |
702 | allocated from a system-wide pool of unused ranges. Note that the prefix length must be equal | |
703 | or larger than 8 for IPv4, and 64 for IPv6. The allocated range is checked against all | |
704 | current network interfaces and all known network configuration files to avoid address range | |
705 | conflicts. The default system-wide pool consists of 192.168.0.0/16, 172.16.0.0/12 and | |
706 | 10.0.0.0/8 for IPv4, and fd00::/8 for IPv6. This functionality is useful to manage a large | |
707 | number of dynamically created network interfaces with the same network configuration and | |
708 | automatic address range assignment.</para> | |
aefdc112 | 709 | |
a61738b3 YW |
710 | <para>If an empty string is specified, then the all previous assignments in both [Network] and |
711 | [Address] sections are cleared.</para> | |
712 | ||
aefdc112 | 713 | <xi:include href="version-info.xml" xpointer="v211"/> |
add469f5 YW |
714 | </listitem> |
715 | </varlistentry> | |
95b74ef6 | 716 | |
add469f5 YW |
717 | <varlistentry> |
718 | <term><varname>Gateway=</varname></term> | |
719 | <listitem> | |
720 | <para>The gateway address, which must be in the format described in | |
721 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
722 | This is a short-hand for a [Route] section only containing a <varname>Gateway=</varname> key. | |
723 | This option may be specified more than once.</para> | |
aefdc112 AK |
724 | |
725 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
726 | </listitem> |
727 | </varlistentry> | |
95b74ef6 | 728 | |
add469f5 YW |
729 | <varlistentry> |
730 | <term><varname>DNS=</varname></term> | |
731 | <listitem> | |
732 | <para>A DNS server address, which must be in the format described in | |
733 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
734 | This option may be specified more than once. Each address can optionally take a port number | |
735 | separated with <literal>:</literal>, a network interface name or index separated with | |
736 | <literal>%</literal>, and a Server Name Indication (SNI) separated with <literal>#</literal>. | |
737 | When IPv6 address is specified with a port number, then the address must be in the square | |
738 | brackets. That is, the acceptable full formats are | |
739 | <literal>111.222.333.444:9953%ifname#example.com</literal> for IPv4 and | |
740 | <literal>[1111:2222::3333]:9953%ifname#example.com</literal> for IPv6. If an empty string is | |
741 | assigned, then the all previous assignments are cleared. This setting is read by | |
742 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
743 | </para> | |
aefdc112 AK |
744 | |
745 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
746 | </listitem> |
747 | </varlistentry> | |
bce67bbe | 748 | |
418f2dc7 YW |
749 | <varlistentry> |
750 | <term><varname>UseDomains=</varname></term> | |
751 | <listitem> | |
4f529440 | 752 | <para>Specifies the protocol-independent default value for the same settings in |
418f2dc7 YW |
753 | [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below. Takes a boolean, or the special value |
754 | <option>route</option>. See also the same setting in [DHCPv4] below. Defaults to unset.</para> | |
755 | ||
756 | <xi:include href="version-info.xml" xpointer="v256"/> | |
757 | </listitem> | |
758 | </varlistentry> | |
759 | ||
add469f5 YW |
760 | <varlistentry> |
761 | <term><varname>Domains=</varname></term> | |
762 | <listitem> | |
763 | <para>A whitespace-separated list of domains which should be resolved using the DNS servers | |
764 | on this link. Each item in the list should be a domain name, optionally prefixed with a tilde | |
765 | (<literal>~</literal>). The domains with the prefix are called "routing-only domains". The | |
766 | domains without the prefix are called "search domains" and are first used as search suffixes | |
767 | for extending single-label hostnames (hostnames containing no dots) to become fully qualified | |
768 | domain names (FQDNs). If a single-label hostname is resolved on this interface, each of the | |
769 | specified search domains are appended to it in turn, converting it into a fully qualified | |
770 | domain name, until one of them may be successfully resolved.</para> | |
771 | ||
772 | <para>Both "search" and "routing-only" domains are used for routing of DNS queries: look-ups | |
773 | for hostnames ending in those domains (hence also single label names, if any "search domains" | |
774 | are listed), are routed to the DNS servers configured for this interface. The domain routing | |
775 | logic is particularly useful on multi-homed hosts with DNS servers serving particular private | |
776 | DNS zones on each interface.</para> | |
777 | ||
778 | <para>The "routing-only" domain <literal>~.</literal> (the tilde indicating definition of a | |
779 | routing domain, the dot referring to the DNS root domain which is the implied suffix of all | |
780 | valid DNS names) has special effect. It causes all DNS traffic which does not match another | |
781 | configured domain routing entry to be routed to DNS servers specified for this interface. | |
782 | This setting is useful to prefer a certain set of DNS servers if a link on which they are | |
783 | connected is available.</para> | |
784 | ||
785 | <para>This setting is read by | |
786 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
787 | "Search domains" correspond to the <varname>domain</varname> and <varname>search</varname> | |
788 | entries in | |
789 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
790 | Domain name routing has no equivalent in the traditional glibc API, which has no concept of | |
791 | domain name servers limited to a specific link.</para> | |
ec07c3c8 AK |
792 | |
793 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
794 | </listitem> |
795 | </varlistentry> | |
bce67bbe | 796 | |
add469f5 YW |
797 | <varlistentry> |
798 | <term><varname>DNSDefaultRoute=</varname></term> | |
799 | <listitem> | |
800 | <para>Takes a boolean argument. If true, this link's configured DNS servers are used for | |
801 | resolving domain names that do not match any link's configured <varname>Domains=</varname> | |
802 | setting. If false, this link's configured DNS servers are never used for such domains, and | |
803 | are exclusively used for resolving names that match at least one of the domains configured on | |
804 | this link. If not specified defaults to an automatic mode: queries not matching any link's | |
805 | configured domains will be routed to this link if it has no routing-only domains configured. | |
c953b24c | 806 | </para> |
ec07c3c8 AK |
807 | |
808 | <xi:include href="version-info.xml" xpointer="v240"/> | |
add469f5 YW |
809 | </listitem> |
810 | </varlistentry> | |
811 | ||
812 | <varlistentry> | |
813 | <term><varname>NTP=</varname></term> | |
cea79e66 | 814 | <listitem> |
add469f5 YW |
815 | <para>An NTP server address (either an IP address, or a hostname). This option may be |
816 | specified more than once. This setting is read by | |
817 | <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
818 | </para> | |
ec07c3c8 AK |
819 | |
820 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
821 | </listitem> |
822 | </varlistentry> | |
798d3a52 | 823 | |
add469f5 | 824 | <varlistentry> |
3976c430 YW |
825 | <term><varname>IPv4Forwarding=</varname></term> |
826 | <listitem> | |
827 | <para>Configures IPv4 packet forwarding for the interface. Takes a boolean value. This controls the | |
828 | <filename>net.ipv4.conf.<replaceable>INTERFACE</replaceable>.forwarding</filename> sysctl option of | |
829 | the network interface. See | |
0e685823 | 830 | <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> |
3976c430 YW |
831 | for more details about the sysctl option. Defaults to true if <varname>IPMasquerade=</varname> is |
832 | enabled for IPv4, otherwise the value specified to the same setting in | |
833 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
834 | will be used. If none of them are specified, the sysctl option will not be changed.</para> | |
835 | ||
836 | <para>To control the global setting, use the same setting in | |
837 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
838 | </para> | |
add469f5 | 839 | |
3976c430 YW |
840 | <xi:include href="version-info.xml" xpointer="v256"/> |
841 | </listitem> | |
842 | </varlistentry> | |
add469f5 | 843 | |
3976c430 YW |
844 | <varlistentry> |
845 | <term><varname>IPv6Forwarding=</varname></term> | |
846 | <listitem> | |
847 | <para>Configures IPv6 packet forwarding for the interface. Takes a boolean value. This controls the | |
848 | <filename>net.ipv6.conf.<replaceable>INTERFACE</replaceable>.forwarding</filename> sysctl option of | |
849 | the network interface. See | |
850 | <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> | |
851 | for more details about the sysctl option. Defaults to true if <varname>IPMasquerade=</varname> is | |
852 | enabled for IPv6 or <varname>IPv6SendRA=</varname> is enabled, otherwise the value specified to the | |
853 | same setting in | |
854 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
855 | will be used. If none of them are specified, the sysctl option will not be changed.</para> | |
856 | ||
857 | <para>To control the global setting, use the same setting in | |
858 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
add469f5 | 859 | </para> |
ec07c3c8 | 860 | |
3976c430 | 861 | <xi:include href="version-info.xml" xpointer="v256"/> |
add469f5 YW |
862 | </listitem> |
863 | </varlistentry> | |
caa8ca42 | 864 | |
add469f5 YW |
865 | <varlistentry> |
866 | <term><varname>IPMasquerade=</varname></term> | |
867 | <listitem> | |
868 | <para>Configures IP masquerading for the network interface. If enabled, packets forwarded | |
869 | from the network interface will be appear as coming from the local host. Takes one of | |
870 | <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>, or | |
3976c430 | 871 | <literal>no</literal>. Defaults to <literal>no</literal>.</para> |
add469f5 | 872 | <para>Note. Any positive boolean values such as <literal>yes</literal> or |
cc59d101 | 873 | <literal>true</literal> are now deprecated. Please use one of the values above.</para> |
ec07c3c8 AK |
874 | |
875 | <xi:include href="version-info.xml" xpointer="v219"/> | |
add469f5 YW |
876 | </listitem> |
877 | </varlistentry> | |
878 | ||
879 | <varlistentry> | |
880 | <term><varname>IPv6PrivacyExtensions=</varname></term> | |
881 | <listitem> | |
882 | <para>Configures use of stateless temporary addresses that change over time (see | |
883 | <ulink url="https://tools.ietf.org/html/rfc4941">RFC 4941</ulink>, | |
884 | Privacy Extensions for Stateless Address Autoconfiguration in IPv6). Takes a boolean or the | |
885 | special values <literal>prefer-public</literal> and <literal>kernel</literal>. When true, | |
886 | enables the privacy extensions and prefers temporary addresses over public addresses. When | |
887 | <literal>prefer-public</literal>, enables the privacy extensions, but prefers public | |
888 | addresses over temporary addresses. When false, the privacy extensions remain disabled. When | |
932ef6ec YW |
889 | <literal>kernel</literal>, the kernel's default setting will be left in place. When unspecified, |
890 | the value specified in the same setting in | |
891 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
892 | which defaults to <literal>no</literal>, will be used.</para> | |
ec07c3c8 AK |
893 | |
894 | <xi:include href="version-info.xml" xpointer="v222"/> | |
add469f5 YW |
895 | </listitem> |
896 | </varlistentry> | |
897 | ||
898 | <varlistentry> | |
899 | <term><varname>IPv6AcceptRA=</varname></term> | |
900 | <listitem> | |
769f9744 YW |
901 | <para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the interface. |
902 | If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may trigger the | |
903 | start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found | |
904 | on the link. Defaults to false for bridge devices, when IP forwarding is enabled, | |
905 | <varname>IPv6SendRA=</varname> or <varname>KeepMaster=</varname> is enabled. Otherwise, enabled by | |
906 | default. Cannot be enabled on devices aggregated in a bond device or when link-local addressing is | |
907 | disabled.</para> | |
add469f5 YW |
908 | |
909 | <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] | |
910 | section, see below.</para> | |
911 | ||
912 | <para>Also see | |
0e685823 | 913 | <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> |
add469f5 YW |
914 | in the kernel documentation regarding <literal>accept_ra</literal>, but note that systemd's |
915 | setting of <constant>1</constant> (i.e. true) corresponds to kernel's setting of | |
916 | <constant>2</constant>.</para> | |
917 | ||
918 | <para>Note that kernel's implementation of the IPv6 RA protocol is always disabled, | |
919 | regardless of this setting. If this option is enabled, a userspace implementation of the IPv6 | |
920 | RA protocol is used, and the kernel's own implementation remains disabled, since | |
921 | <command>systemd-networkd</command> needs to know all details supplied in the advertisements, | |
922 | and these are not available from the kernel if the kernel's own implementation is used. | |
923 | </para> | |
ec07c3c8 AK |
924 | |
925 | <xi:include href="version-info.xml" xpointer="v231"/> | |
add469f5 YW |
926 | </listitem> |
927 | </varlistentry> | |
928 | ||
929 | <varlistentry> | |
930 | <term><varname>IPv6DuplicateAddressDetection=</varname></term> | |
931 | <listitem> | |
932 | <para>Configures the amount of IPv6 Duplicate Address Detection (DAD) probes to send. When | |
933 | unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
934 | |
935 | <xi:include href="version-info.xml" xpointer="v228"/> | |
add469f5 YW |
936 | </listitem> |
937 | </varlistentry> | |
938 | ||
939 | <varlistentry> | |
940 | <term><varname>IPv6HopLimit=</varname></term> | |
941 | <listitem> | |
986e1823 YW |
942 | <para>Configures IPv6 Hop Limit. Takes an integer in the range 1…255. For each router that |
943 | forwards the packet, the hop limit is decremented by 1. When the hop limit field reaches zero, the | |
944 | packet is discarded. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
945 | |
946 | <xi:include href="version-info.xml" xpointer="v228"/> | |
add469f5 YW |
947 | </listitem> |
948 | </varlistentry> | |
949 | ||
d4c8de21 MM |
950 | <varlistentry> |
951 | <term><varname>IPv6RetransmissionTimeSec=</varname></term> | |
952 | <listitem> | |
953 | <para>Configures IPv6 Retransmission Time. The time between retransmitted Neighbor | |
954 | Solicitation messages. Used by address resolution and the Neighbor Unreachability | |
955 | Detection algorithm. A value of zero is ignored and the kernel's current value | |
956 | will be used. Defaults to unset, and the kernel's current value will be used.</para> | |
957 | ||
958 | <xi:include href="version-info.xml" xpointer="v256"/> | |
959 | </listitem> | |
960 | </varlistentry> | |
961 | ||
9c72e8f8 SS |
962 | <varlistentry> |
963 | <term><varname>IPv4ReversePathFilter=</varname></term> | |
964 | <listitem> | |
965 | <para>Configure IPv4 Reverse Path Filtering. If enabled, when an IPv4 packet is received, the machine will first check | |
966 | whether the <emphasis>source</emphasis> of the packet would be routed through the interface it came in. If there is no | |
967 | route to the source on that interface, the machine will drop the packet. Takes one of | |
968 | <literal>no</literal>, <literal>strict</literal>, or <literal>loose</literal>. When <literal>no</literal>, | |
969 | no source validation will be done. When <literal>strict</literal>, mode each incoming packet is tested against the FIB and | |
970 | if the incoming interface is not the best reverse path, the packet check will fail. By default failed packets are discarded. | |
971 | When <literal>loose</literal>, mode each incoming packet's source address is tested against the FIB. The packet is dropped | |
972 | only if the source address is not reachable via any interface on that router. | |
973 | See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 3704</ulink>. | |
974 | When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
975 | |
976 | <xi:include href="version-info.xml" xpointer="v255"/> | |
9c72e8f8 SS |
977 | </listitem> |
978 | </varlistentry> | |
979 | ||
add469f5 YW |
980 | <varlistentry> |
981 | <term><varname>IPv4AcceptLocal=</varname></term> | |
982 | <listitem> | |
983 | <para>Takes a boolean. Accept packets with local source addresses. In combination with | |
984 | suitable routing, this can be used to direct packets between two local interfaces over the | |
985 | wire and have them accepted properly. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
986 | |
987 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
988 | </listitem> |
989 | </varlistentry> | |
990 | ||
991 | <varlistentry> | |
992 | <term><varname>IPv4RouteLocalnet=</varname></term> | |
993 | <listitem> | |
994 | <para>Takes a boolean. When true, the kernel does not consider loopback addresses as martian | |
995 | source or destination while routing. This enables the use of 127.0.0.0/8 for local routing | |
996 | purposes. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
997 | |
998 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
999 | </listitem> |
1000 | </varlistentry> | |
1001 | ||
1002 | <varlistentry> | |
1003 | <term><varname>IPv4ProxyARP=</varname></term> | |
1004 | <listitem> | |
1005 | <para>Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one | |
1006 | host, usually a router, answers ARP requests intended for another machine. By "faking" its | |
1007 | identity, the router accepts responsibility for routing packets to the "real" destination. | |
1008 | See <ulink url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>. When unset, the | |
1009 | kernel's default will be used.</para> | |
ec07c3c8 AK |
1010 | |
1011 | <xi:include href="version-info.xml" xpointer="v233"/> | |
add469f5 YW |
1012 | </listitem> |
1013 | </varlistentry> | |
b4959550 RB |
1014 | |
1015 | <varlistentry> | |
1016 | <term><varname>IPv4ProxyARPPrivateVLAN=</varname></term> | |
1017 | <listitem> | |
1018 | <para>Takes a boolean. Configures proxy ARP private VLAN for IPv4, also known as VLAN aggregation, | |
1019 | private VLAN, source-port filtering, port-isolation, or MAC-forced forwarding.</para> | |
1020 | ||
1021 | <para>This variant of the ARP proxy technique will allow the ARP proxy to reply back to the same | |
1022 | interface.</para> | |
1023 | ||
1024 | <para>See <ulink url="https://tools.ietf.org/html/rfc3069">RFC 3069</ulink>. When unset, | |
1025 | the kernel's default will be used.</para> | |
1026 | <xi:include href="version-info.xml" xpointer="v256"/> | |
1027 | </listitem> | |
1028 | </varlistentry> | |
add469f5 YW |
1029 | |
1030 | <varlistentry> | |
1031 | <term><varname>IPv6ProxyNDP=</varname></term> | |
1032 | <listitem> | |
1033 | <para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery Protocol) | |
1034 | is a technique for IPv6 to allow routing of addresses to a different destination when peers | |
1035 | expect them to be present on a certain physical link. In this case a router answers Neighbour | |
1036 | Advertisement messages intended for another machine by offering its own MAC address as | |
1037 | destination. Unlike proxy ARP for IPv4, it is not enabled globally, but will only send | |
1038 | Neighbour Advertisement messages for addresses in the IPv6 neighbor proxy table, which can | |
1039 | also be shown by <command>ip -6 neighbour show proxy</command>. systemd-networkd will control | |
1040 | the per-interface `proxy_ndp` switch for each configured interface depending on this option. | |
1041 | When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
1042 | |
1043 | <xi:include href="version-info.xml" xpointer="v234"/> | |
add469f5 YW |
1044 | </listitem> |
1045 | </varlistentry> | |
1046 | ||
1047 | <varlistentry> | |
1048 | <term><varname>IPv6ProxyNDPAddress=</varname></term> | |
1049 | <listitem> | |
1050 | <para>An IPv6 address, for which Neighbour Advertisement messages will be proxied. This | |
1051 | option may be specified more than once. systemd-networkd will add the | |
1052 | <varname>IPv6ProxyNDPAddress=</varname> entries to the kernel's IPv6 neighbor proxy table. | |
1053 | This setting implies <varname>IPv6ProxyNDP=yes</varname> but has no effect if | |
1054 | <varname>IPv6ProxyNDP=</varname> has been set to false. When unset, the kernel's default will | |
1055 | be used.</para> | |
ec07c3c8 AK |
1056 | |
1057 | <xi:include href="version-info.xml" xpointer="v233"/> | |
add469f5 YW |
1058 | </listitem> |
1059 | </varlistentry> | |
1060 | ||
1061 | <varlistentry> | |
1062 | <term><varname>IPv6SendRA=</varname></term> | |
1063 | <listitem> | |
1064 | <para>Whether to enable or disable Router Advertisement sending on a link. Takes a boolean | |
1065 | value. When enabled, prefixes configured in [IPv6Prefix] sections and routes configured in | |
1066 | the [IPv6RoutePrefix] sections are distributed as defined in the [IPv6SendRA] section. If | |
1067 | <varname>DHCPPrefixDelegation=</varname> is enabled, then the delegated prefixes are also | |
51219be9 | 1068 | distributed. See <varname>DHCPPrefixDelegation=</varname> setting and the [IPv6SendRA], |
add469f5 YW |
1069 | [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration |
1070 | options.</para> | |
ec07c3c8 AK |
1071 | |
1072 | <xi:include href="version-info.xml" xpointer="v247"/> | |
add469f5 YW |
1073 | </listitem> |
1074 | </varlistentry> | |
1075 | ||
1076 | <varlistentry> | |
1077 | <term><varname>DHCPPrefixDelegation=</varname></term> | |
1078 | <listitem> | |
d68c797c ZJS |
1079 | <para>Takes a boolean value. When enabled, requests subnet prefixes on another link via the DHCPv6 |
1080 | protocol or via the 6RD option in the DHCPv4 protocol. An address within each delegated prefix will | |
1081 | be assigned, and the prefixes will be announced through IPv6 Router Advertisement if | |
1082 | <varname>IPv6SendRA=</varname> is enabled. This behaviour can be configured in the | |
1083 | [DHCPPrefixDelegation] section. Defaults to disabled.</para> | |
ec07c3c8 AK |
1084 | |
1085 | <xi:include href="version-info.xml" xpointer="v250"/> | |
add469f5 YW |
1086 | </listitem> |
1087 | </varlistentry> | |
1088 | ||
1089 | <varlistentry> | |
1090 | <term><varname>IPv6MTUBytes=</varname></term> | |
1091 | <listitem> | |
1092 | <para>Configures IPv6 maximum transmission unit (MTU). An integer greater than or equal to | |
1093 | 1280 bytes. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
1094 | |
1095 | <xi:include href="version-info.xml" xpointer="v239"/> | |
add469f5 YW |
1096 | </listitem> |
1097 | </varlistentry> | |
1098 | ||
1099 | <varlistentry> | |
1100 | <term><varname>KeepMaster=</varname></term> | |
1101 | <listitem> | |
1102 | <para>Takes a boolean value. When enabled, the current master interface index will not be | |
1103 | changed, and <varname>BatmanAdvanced=</varname>, <varname>Bond=</varname>, | |
1104 | <varname>Bridge=</varname>, and <varname>VRF=</varname> settings are ignored. This may be | |
1105 | useful when a netdev with a master interface is created by another program, e.g. | |
1106 | <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
1107 | Defaults to false.</para> | |
ec07c3c8 AK |
1108 | |
1109 | <xi:include href="version-info.xml" xpointer="v250"/> | |
add469f5 YW |
1110 | </listitem> |
1111 | </varlistentry> | |
1112 | ||
1113 | <varlistentry> | |
1114 | <term><varname>BatmanAdvanced=</varname></term> | |
1115 | <term><varname>Bond=</varname></term> | |
1116 | <term><varname>Bridge=</varname></term> | |
1117 | <term><varname>VRF=</varname></term> | |
1118 | <listitem> | |
1119 | <para>The name of the B.A.T.M.A.N. Advanced, bond, bridge, or VRF interface to add the link | |
1120 | to. See | |
1121 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
1122 | </para> | |
aefdc112 AK |
1123 | |
1124 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
1125 | </listitem> |
1126 | </varlistentry> | |
1127 | ||
1128 | <varlistentry> | |
1129 | <term><varname>IPoIB=</varname></term> | |
1130 | <term><varname>IPVLAN=</varname></term> | |
1131 | <term><varname>IPVTAP=</varname></term> | |
add469f5 YW |
1132 | <term><varname>MACsec=</varname></term> |
1133 | <term><varname>MACVLAN=</varname></term> | |
1134 | <term><varname>MACVTAP=</varname></term> | |
1135 | <term><varname>Tunnel=</varname></term> | |
1136 | <term><varname>VLAN=</varname></term> | |
1137 | <term><varname>VXLAN=</varname></term> | |
1138 | <term><varname>Xfrm=</varname></term> | |
1139 | <listitem> | |
0c91c7a2 | 1140 | <para>The name of an IPoIB, IPVLAN, IPVTAP, MACsec, MACVLAN, MACVTAP, tunnel, VLAN, |
add469f5 YW |
1141 | VXLAN, or Xfrm to be created on the link. See |
1142 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
1143 | This option may be specified more than once.</para> | |
aefdc112 AK |
1144 | |
1145 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
1146 | </listitem> |
1147 | </varlistentry> | |
1148 | ||
1149 | <varlistentry> | |
1150 | <term><varname>ActiveSlave=</varname></term> | |
1151 | <listitem> | |
1152 | <para>Takes a boolean. Specifies the new active slave. The <literal>ActiveSlave=</literal> | |
1153 | option is only valid for following modes: <literal>active-backup</literal>, | |
1154 | <literal>balance-alb</literal>, and <literal>balance-tlb</literal>. Defaults to false.</para> | |
ec07c3c8 AK |
1155 | |
1156 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1157 | </listitem> |
1158 | </varlistentry> | |
1159 | ||
1160 | <varlistentry> | |
1161 | <term><varname>PrimarySlave=</varname></term> | |
1162 | <listitem> | |
1163 | <para>Takes a boolean. Specifies which slave is the primary device. The specified device will | |
1164 | always be the active slave while it is available. Only when the primary is off-line will | |
1165 | alternate devices be used. This is useful when one slave is preferred over another, e.g. | |
1166 | when one slave has higher throughput than another. The <literal>PrimarySlave=</literal> | |
1167 | option is only valid for following modes: <literal>active-backup</literal>, | |
1168 | <literal>balance-alb</literal>, and <literal>balance-tlb</literal>. Defaults to false.</para> | |
ec07c3c8 AK |
1169 | |
1170 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1171 | </listitem> |
1172 | </varlistentry> | |
1173 | ||
1174 | <varlistentry> | |
1175 | <term><varname>ConfigureWithoutCarrier=</varname></term> | |
1176 | <listitem> | |
1177 | <para>Takes a boolean. Allows networkd to configure a specific link even if it has no | |
1178 | carrier. Defaults to false. If enabled, and the <varname>IgnoreCarrierLoss=</varname> setting | |
1179 | is not explicitly set, then it is enabled as well.</para> | |
ec07c3c8 AK |
1180 | |
1181 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1182 | </listitem> |
1183 | </varlistentry> | |
1184 | ||
1185 | <varlistentry> | |
1186 | <term><varname>IgnoreCarrierLoss=</varname></term> | |
1187 | <listitem> | |
b7326069 YW |
1188 | <para>Takes a boolean or a timespan. When true, <command>systemd-networkd</command> retains |
1189 | both the static and dynamic configuration of the interface even if its carrier is lost. When | |
1190 | false, <command>systemd-networkd</command> drops both the static and dynamic configuration of | |
1191 | the interface. When a timespan is specified, <command>systemd-networkd</command> waits for | |
1192 | the specified timespan, and ignores the carrier loss if the link regain its carrier within | |
1193 | the timespan. Setting 0 seconds is equivalent to <literal>no</literal>, and | |
1194 | <literal>infinite</literal> is equivalent to <literal>yes</literal>.</para> | |
1195 | ||
1196 | <para>Setting a finite timespan may be useful when e.g. in the following cases: | |
1197 | <itemizedlist> | |
1198 | <listitem> | |
1199 | <para>A wireless interface connecting to a network which has multiple access points with | |
1200 | the same SSID.</para> | |
1201 | </listitem> | |
1202 | <listitem> | |
1203 | <para>Enslaving a wireless interface to a bond interface, which may disconnect from the | |
1204 | connected access point and causes its carrier to be lost.</para> | |
1205 | </listitem> | |
1206 | <listitem> | |
1207 | <para>The driver of the interface resets when the MTU is changed.</para> | |
1208 | </listitem> | |
1209 | </itemizedlist> | |
add469f5 | 1210 | </para> |
b7326069 YW |
1211 | |
1212 | <para>When <varname>Bond=</varname> is specified to a wireless interface, defaults to 3 | |
1213 | seconds. When the DHCPv4 client is enabled and <varname>UseMTU=</varname> in the [DHCPv4] | |
b17a681b | 1214 | section enabled, defaults to 5 seconds. Otherwise, defaults to the value specified with |
b7326069 YW |
1215 | <varname>ConfigureWithoutCarrier=</varname>. When <varname>ActivationPolicy=</varname> is set |
1216 | to <literal>always-up</literal>, this is forced to <literal>yes</literal>, and ignored any | |
1217 | user specified values.</para> | |
ec07c3c8 AK |
1218 | |
1219 | <xi:include href="version-info.xml" xpointer="v242"/> | |
add469f5 YW |
1220 | </listitem> |
1221 | </varlistentry> | |
1222 | ||
1223 | <varlistentry> | |
1224 | <term><varname>KeepConfiguration=</varname></term> | |
1225 | <listitem> | |
1226 | <para>Takes a boolean or one of <literal>static</literal>, <literal>dhcp-on-stop</literal>, | |
1227 | <literal>dhcp</literal>. When <literal>static</literal>, <command>systemd-networkd</command> | |
1228 | will not drop static addresses and routes on starting up process. When set to | |
1229 | <literal>dhcp-on-stop</literal>, <command>systemd-networkd</command> will not drop addresses | |
1230 | and routes on stopping the daemon. When <literal>dhcp</literal>, | |
1231 | the addresses and routes provided by a DHCP server will never be dropped even if the DHCP | |
1232 | lease expires. This is contrary to the DHCP specification, but may be the best choice if, | |
1233 | e.g., the root filesystem relies on this connection. The setting <literal>dhcp</literal> | |
1234 | implies <literal>dhcp-on-stop</literal>, and <literal>yes</literal> implies | |
ea853de5 YW |
1235 | <literal>dhcp</literal> and <literal>static</literal>. Defaults to |
1236 | <literal>dhcp-on-stop</literal> when <command>systemd-networkd</command> is running in | |
1237 | initrd, <literal>yes</literal> when the root filesystem is a network filesystem, and | |
1238 | <literal>no</literal> otherwise.</para> | |
ec07c3c8 AK |
1239 | |
1240 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
1241 | </listitem> |
1242 | </varlistentry> | |
1243 | </variablelist> | |
1244 | </refsect1> | |
1245 | ||
1246 | <refsect1> | |
1247 | <title>[Address] Section Options</title> | |
1248 | ||
1249 | <para>An [Address] section accepts the following keys. Specify several [Address] sections to | |
1250 | configure several addresses.</para> | |
1251 | ||
1252 | <variablelist class='network-directives'> | |
1253 | <varlistentry> | |
1254 | <term><varname>Address=</varname></term> | |
1255 | <listitem> | |
1256 | <para>As in the [Network] section. This setting is mandatory. Each [Address] section can | |
1257 | contain one <varname>Address=</varname> setting.</para> | |
ec07c3c8 | 1258 | |
aefdc112 | 1259 | <xi:include href="version-info.xml" xpointer="v211"/> |
add469f5 YW |
1260 | </listitem> |
1261 | </varlistentry> | |
1262 | ||
1263 | <varlistentry> | |
1264 | <term><varname>Peer=</varname></term> | |
1265 | <listitem> | |
1266 | <para>The peer address in a point-to-point connection. Accepts the same format as the | |
1267 | <varname>Address=</varname> setting.</para> | |
ec07c3c8 AK |
1268 | |
1269 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
1270 | </listitem> |
1271 | </varlistentry> | |
1272 | ||
1273 | <varlistentry> | |
1274 | <term><varname>Broadcast=</varname></term> | |
1275 | <listitem> | |
1276 | <para>Takes an IPv4 address or boolean value. The address must be in the format described in | |
1277 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
1278 | If set to true, then the IPv4 broadcast address will be derived from the | |
1279 | <varname>Address=</varname> setting. If set to false, then the broadcast address will not be | |
1280 | set. Defaults to true, except for wireguard interfaces, where it default to false.</para> | |
aefdc112 AK |
1281 | |
1282 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
1283 | </listitem> |
1284 | </varlistentry> | |
1285 | ||
1286 | <varlistentry> | |
1287 | <term><varname>Label=</varname></term> | |
1288 | <listitem> | |
1289 | <para>Specifies the label for the IPv4 address. The label must be a 7-bit ASCII string with | |
1290 | a length of 1…15 characters. Defaults to unset.</para> | |
aefdc112 AK |
1291 | |
1292 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
1293 | </listitem> |
1294 | </varlistentry> | |
1295 | ||
1296 | <varlistentry> | |
1297 | <term><varname>PreferredLifetime=</varname></term> | |
1298 | <listitem> | |
1299 | <para>Allows the default "preferred lifetime" of the address to be overridden. Only three | |
1300 | settings are accepted: <literal>forever</literal>, <literal>infinity</literal>, which is the | |
1301 | default and means that the address never expires, and <literal>0</literal>, which means that | |
1302 | the address is considered immediately "expired" and will not be used, unless explicitly | |
1303 | requested. A setting of <option>PreferredLifetime=0</option> is useful for addresses which | |
1304 | are added to be used only by a specific application, which is then configured to use them | |
1305 | explicitly.</para> | |
ec07c3c8 AK |
1306 | |
1307 | <xi:include href="version-info.xml" xpointer="v230"/> | |
add469f5 YW |
1308 | </listitem> |
1309 | </varlistentry> | |
1310 | ||
1311 | <varlistentry> | |
1312 | <term><varname>Scope=</varname></term> | |
1313 | <listitem> | |
1314 | <para>The scope of the address, which can be <literal>global</literal> (valid everywhere on | |
1315 | the network, even through a gateway), <literal>link</literal> (only valid on this device, | |
1316 | will not traverse a gateway) or <literal>host</literal> (only valid within the device itself, | |
1317 | e.g. 127.0.0.1) or an integer in the range 0…255. Defaults to <literal>global</literal>. | |
ecac4878 | 1318 | IPv4 only - IPv6 scope is automatically assigned by the kernel and cannot be set manually. |
add469f5 | 1319 | </para> |
ec07c3c8 AK |
1320 | |
1321 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1322 | </listitem> |
1323 | </varlistentry> | |
1324 | ||
1325 | <varlistentry> | |
1326 | <term><varname>RouteMetric=</varname></term> | |
1327 | <listitem> | |
1328 | <para>The metric of the prefix route, which is pointing to the subnet of the configured IP | |
1329 | address, taking the configured prefix length into account. Takes an unsigned integer in the | |
1330 | range 0…4294967295. When unset or set to 0, the kernel's default value is used. This | |
1331 | setting will be ignored when <varname>AddPrefixRoute=</varname> is false.</para> | |
aefdc112 AK |
1332 | |
1333 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
1334 | </listitem> |
1335 | </varlistentry> | |
1336 | ||
1337 | <varlistentry> | |
1338 | <term><varname>HomeAddress=</varname></term> | |
1339 | <listitem> | |
1340 | <para>Takes a boolean. Designates this address the "home address" as defined in | |
1341 | <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink>. Supported only on IPv6. | |
1342 | Defaults to false.</para> | |
ec07c3c8 AK |
1343 | |
1344 | <xi:include href="version-info.xml" xpointer="v232"/> | |
add469f5 YW |
1345 | </listitem> |
1346 | </varlistentry> | |
1347 | ||
1348 | <varlistentry> | |
1349 | <term><varname>DuplicateAddressDetection=</varname></term> | |
1350 | <listitem> | |
1351 | <para>Takes one of <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>, | |
1352 | or <literal>none</literal>. When <literal>ipv4</literal>, performs IPv4 Address Conflict | |
1353 | Detection. See <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. | |
1354 | When <literal>ipv6</literal>, performs IPv6 Duplicate Address Detection. See | |
1355 | <ulink url="https://tools.ietf.org/html/rfc4862">RFC 4862</ulink>. Defaults to | |
2859932b YW |
1356 | <literal>ipv4</literal> for IPv4 link-local addresses, <literal>ipv6</literal> for IPv6 |
1357 | addresses, and <literal>none</literal> otherwise.</para> | |
ec07c3c8 AK |
1358 | |
1359 | <xi:include href="version-info.xml" xpointer="v232"/> | |
add469f5 YW |
1360 | </listitem> |
1361 | </varlistentry> | |
1362 | ||
1363 | <varlistentry> | |
1364 | <term><varname>ManageTemporaryAddress=</varname></term> | |
1365 | <listitem> | |
1366 | <para>Takes a boolean. If true the kernel manage temporary addresses created from this one as | |
1367 | template on behalf of Privacy Extensions | |
1368 | <ulink url="https://tools.ietf.org/html/rfc3041">RFC 3041</ulink>. For this to become active, | |
1369 | the use_tempaddr sysctl setting has to be set to a value greater than zero. The given address | |
1370 | needs to have a prefix length of 64. This flag allows using privacy extensions in a manually | |
1371 | configured network, just like if stateless auto-configuration was active. Defaults to false. | |
1372 | </para> | |
ec07c3c8 AK |
1373 | |
1374 | <xi:include href="version-info.xml" xpointer="v232"/> | |
add469f5 YW |
1375 | </listitem> |
1376 | </varlistentry> | |
1377 | ||
1378 | <varlistentry> | |
1379 | <term><varname>AddPrefixRoute=</varname></term> | |
1380 | <listitem> | |
1381 | <para>Takes a boolean. When true, the prefix route for the address is automatically added. | |
1382 | Defaults to true.</para> | |
ec07c3c8 AK |
1383 | |
1384 | <xi:include href="version-info.xml" xpointer="v245"/> | |
add469f5 YW |
1385 | </listitem> |
1386 | </varlistentry> | |
1387 | ||
1388 | <varlistentry> | |
1389 | <term><varname>AutoJoin=</varname></term> | |
1390 | <listitem> | |
1391 | <para>Takes a boolean. Joining multicast group on ethernet level via | |
1392 | <command>ip maddr</command> command would not work if we have an Ethernet switch that does | |
1393 | IGMP snooping since the switch would not replicate multicast packets on ports that did not | |
1394 | have IGMP reports for the multicast addresses. Linux vxlan interfaces created via | |
1395 | <command>ip link add vxlan</command> or networkd's netdev kind vxlan have the group option | |
6a1d8f11 JJ |
1396 | that enables them to do the required join. By extending <command>ip address</command> command |
1397 | with option <literal>autojoin</literal> we can get similar functionality for openvswitch (OVS) | |
1398 | vxlan interfaces as well as other tunneling mechanisms that need to receive multicast traffic. | |
add469f5 | 1399 | Defaults to <literal>no</literal>.</para> |
ec07c3c8 AK |
1400 | |
1401 | <xi:include href="version-info.xml" xpointer="v232"/> | |
add469f5 YW |
1402 | </listitem> |
1403 | </varlistentry> | |
4b3590c3 TM |
1404 | |
1405 | <varlistentry> | |
1406 | <term><varname>NetLabel=</varname><replaceable>label</replaceable></term> | |
1407 | <listitem> | |
1408 | ||
1409 | <para>This setting provides a method for integrating static and dynamic network configuration into | |
1410 | Linux <ulink url="https://docs.kernel.org/netlabel/index.html">NetLabel</ulink> subsystem rules, | |
1411 | used by <ulink url="https://en.wikipedia.org/wiki/Linux_Security_Modules">Linux Security Modules | |
1412 | (LSMs)</ulink> for network access control. The label, with suitable LSM rules, can be used to | |
1413 | control connectivity of (for example) a service with peers in the local network. At least with | |
1414 | SELinux, only the ingress can be controlled but not egress. The benefit of using this setting is | |
1415 | that it may be possible to apply interface independent part of NetLabel configuration at very early | |
1416 | stage of system boot sequence, at the time when the network interfaces are not available yet, with | |
1417 | <citerefentry | |
1418 | project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
1419 | and the per-interface configuration with <command>systemd-networkd</command> once the interfaces | |
1420 | appear later. Currently this feature is only implemented for SELinux.</para> | |
1421 | ||
1422 | <para>The option expects a single NetLabel label. The label must conform to lexical restrictions of | |
1423 | LSM labels. When an interface is configured with IP addresses, the addresses and subnetwork masks | |
1424 | will be appended to the <ulink | |
1425 | url="https://github.com/SELinuxProject/selinux-notebook/blob/main/src/network_support.md">NetLabel | |
1426 | Fallback Peer Labeling</ulink> rules. They will be removed when the interface is | |
1427 | deconfigured. Failures to manage the labels will be ignored.</para> | |
1428 | ||
617b85d1 DT |
1429 | <warning> |
1430 | <para>Once labeling is enabled for network traffic, a lot of LSM access control points in | |
1431 | Linux networking stack go from dormant to active. Care should be taken to avoid getting into a | |
1432 | situation where for example remote connectivity is broken, when the security policy hasn't been | |
1433 | updated to consider LSM per-packet access controls and no rules would allow any network | |
1434 | traffic. Also note that additional configuration with <citerefentry | |
1435 | project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
1436 | is needed.</para> | |
1437 | </warning> | |
4b3590c3 TM |
1438 | |
1439 | <para>Example: | |
1440 | <programlisting>[Address] | |
1441 | NetLabel=system_u:object_r:localnet_peer_t:s0</programlisting> | |
1442 | ||
1443 | With the example rules applying for interface <literal>eth0</literal>, when the interface is | |
1444 | configured with an IPv4 address of 10.0.0.123/8, <command>systemd-networkd</command> performs the | |
1445 | equivalent of <command>netlabelctl</command> operation | |
1446 | ||
1447 | <programlisting>netlabelctl unlbl add interface eth0 address:10.0.0.0/8 label:system_u:object_r:localnet_peer_t:s0</programlisting> | |
1448 | ||
1449 | and the reverse operation when the IPv4 address is deconfigured. The configuration can be used with | |
1450 | LSM rules; in case of SELinux to allow a SELinux domain to receive data from objects of SELinux | |
1451 | <literal>peer</literal> class. For example: | |
1452 | ||
1453 | <programlisting>type localnet_peer_t; | |
1454 | allow my_server_t localnet_peer_t:peer recv;</programlisting> | |
1455 | ||
1456 | The effect of the above configuration and rules (in absence of other rules as may be the case) is | |
1457 | to only allow <literal>my_server_t</literal> (and nothing else) to receive data from local subnet | |
1458 | 10.0.0.0/8 of interface <literal>eth0</literal>. | |
1459 | </para> | |
ec07c3c8 AK |
1460 | |
1461 | <xi:include href="version-info.xml" xpointer="v252"/> | |
4b3590c3 TM |
1462 | </listitem> |
1463 | </varlistentry> | |
fc289dd0 TM |
1464 | |
1465 | <varlistentry> | |
1466 | <term><varname>NFTSet=</varname><replaceable>source</replaceable>:<replaceable>family</replaceable>:<replaceable>table</replaceable>:<replaceable>set</replaceable></term> | |
1467 | <listitem> | |
1468 | <para>This setting provides a method for integrating network configuration into firewall rules with | |
1469 | <ulink url="https://netfilter.org/projects/nftables/index.html">NFT</ulink> sets. The benefit of | |
1470 | using the setting is that static network configuration (or dynamically obtained network addresses, | |
1471 | see similar directives in other sections) can be used in firewall rules with the indirection of NFT | |
1472 | set types. For example, access could be granted for hosts in the local subnetwork only. Firewall | |
1473 | rules using IP address of an interface are also instantly updated when the network configuration | |
1474 | changes, for example via DHCP.</para> | |
1475 | ||
1476 | <para>This option expects a whitespace separated list of NFT set definitions. Each definition | |
1477 | consists of a colon-separated tuple of source type (one of <literal>address</literal>, | |
1478 | <literal>prefix</literal> or <literal>ifindex</literal>), NFT address family (one of | |
1479 | <literal>arp</literal>, <literal>bridge</literal>, <literal>inet</literal>, <literal>ip</literal>, | |
1480 | <literal>ip6</literal>, or <literal>netdev</literal>), table name and set name. The names of tables | |
1481 | and sets must conform to lexical restrictions of NFT table names. The type of the element used in | |
1482 | the NFT filter must match the type implied by the directive (<literal>address</literal>, | |
1483 | <literal>prefix</literal> or <literal>ifindex</literal>) and address type (IPv4 or IPv6) as shown | |
1484 | in the table below.</para> | |
1485 | ||
1486 | <table> | |
1487 | <title>Defined <varname>source type</varname> values</title> | |
1488 | <tgroup cols='3'> | |
1489 | <colspec colname='source type'/> | |
1490 | <colspec colname='description'/> | |
1491 | <colspec colname='NFT type name'/> | |
1492 | <thead> | |
1493 | <row> | |
1494 | <entry>Source type</entry> | |
1495 | <entry>Description</entry> | |
1496 | <entry>Corresponding NFT type name</entry> | |
1497 | </row> | |
1498 | </thead> | |
1499 | ||
1500 | <tbody> | |
1501 | <row> | |
1502 | <entry><literal>address</literal></entry> | |
1503 | <entry>host IP address</entry> | |
1504 | <entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal></entry> | |
1505 | </row> | |
1506 | <row> | |
1507 | <entry><literal>prefix</literal></entry> | |
1508 | <entry>network prefix</entry> | |
1509 | <entry><literal>ipv4_addr</literal> or <literal>ipv6_addr</literal>, with <literal>flags interval</literal></entry> | |
1510 | </row> | |
1511 | <row> | |
1512 | <entry><literal>ifindex</literal></entry> | |
1513 | <entry>interface index</entry> | |
1514 | <entry><literal>iface_index</literal></entry> | |
1515 | </row> | |
1516 | </tbody> | |
1517 | </tgroup> | |
1518 | </table> | |
1519 | ||
1520 | <para>When an interface is configured with IP addresses, the addresses, subnetwork masks or | |
1521 | interface index will be appended to the NFT sets. The information will be removed when the | |
1522 | interface is deconfigured. <command>systemd-networkd</command> only inserts elements to (or removes | |
1523 | from) the sets, so the related NFT rules, tables and sets must be prepared elsewhere in | |
1524 | advance. Failures to manage the sets will be ignored.</para> | |
1525 | ||
1526 | <para>Example: | |
1527 | <programlisting>[Address] | |
1528 | NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> | |
1529 | Corresponding NFT rules: | |
1530 | <programlisting>table netdev filter { | |
1531 | set eth_ipv4_prefix { | |
1532 | type ipv4_addr | |
1533 | flags interval | |
1534 | } | |
1535 | chain eth_ingress { | |
1536 | type filter hook ingress device "eth0" priority filter; policy drop; | |
1537 | ip daddr != @eth_ipv4_prefix drop | |
1538 | accept | |
1539 | } | |
1540 | }</programlisting> | |
1541 | </para> | |
c97f268f YW |
1542 | |
1543 | <xi:include href="version-info.xml" xpointer="v255"/> | |
fc289dd0 TM |
1544 | </listitem> |
1545 | </varlistentry> | |
add469f5 YW |
1546 | </variablelist> |
1547 | </refsect1> | |
1548 | ||
1549 | <refsect1> | |
1550 | <title>[Neighbor] Section Options</title> | |
1551 | ||
1552 | <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, | |
1553 | static entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the | |
1554 | links matched for the network. Specify several [Neighbor] sections to configure several static | |
1555 | neighbors.</para> | |
1556 | ||
1557 | <variablelist class='network-directives'> | |
1558 | <varlistentry> | |
1559 | <term><varname>Address=</varname></term> | |
1560 | <listitem> | |
1561 | <para>The IP address of the neighbor.</para> | |
ec07c3c8 AK |
1562 | |
1563 | <xi:include href="version-info.xml" xpointer="v240"/> | |
add469f5 YW |
1564 | </listitem> |
1565 | </varlistentry> | |
1566 | ||
1567 | <varlistentry> | |
1568 | <term><varname>LinkLayerAddress=</varname></term> | |
1569 | <listitem> | |
1570 | <para>The link layer address (MAC address or IP address) of the neighbor.</para> | |
ec07c3c8 AK |
1571 | |
1572 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
1573 | </listitem> |
1574 | </varlistentry> | |
1575 | </variablelist> | |
1576 | </refsect1> | |
1577 | ||
1578 | <refsect1> | |
1579 | <title>[IPv6AddressLabel] Section Options</title> | |
1580 | ||
1581 | <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel] | |
1582 | sections to configure several address labels. IPv6 address labels are used for address selection. | |
1583 | See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by | |
1584 | userspace, and only the label itself is stored in the kernel.</para> | |
1585 | ||
1586 | <variablelist class='network-directives'> | |
1587 | <varlistentry> | |
1588 | <term><varname>Label=</varname></term> | |
1589 | <listitem> | |
1590 | <para>The label for the prefix, an unsigned integer in the range 0…4294967294. 0xffffffff is | |
1591 | reserved. This setting is mandatory.</para> | |
ec07c3c8 AK |
1592 | |
1593 | <xi:include href="version-info.xml" xpointer="v234"/> | |
add469f5 YW |
1594 | </listitem> |
1595 | </varlistentry> | |
1596 | ||
1597 | <varlistentry> | |
1598 | <term><varname>Prefix=</varname></term> | |
1599 | <listitem> | |
1600 | <para>IPv6 prefix is an address with a prefix length, separated by a slash | |
1601 | <literal>/</literal> character. This setting is mandatory. </para> | |
ec07c3c8 AK |
1602 | |
1603 | <xi:include href="version-info.xml" xpointer="v234"/> | |
add469f5 YW |
1604 | </listitem> |
1605 | </varlistentry> | |
1606 | </variablelist> | |
1607 | </refsect1> | |
1608 | ||
1609 | <refsect1> | |
1610 | <title>[RoutingPolicyRule] Section Options</title> | |
1611 | ||
1612 | <para>An [RoutingPolicyRule] section accepts the following settings. Specify several | |
1613 | [RoutingPolicyRule] sections to configure several rules.</para> | |
1614 | ||
1615 | <variablelist class='network-directives'> | |
1616 | <varlistentry> | |
1617 | <term><varname>TypeOfService=</varname></term> | |
1618 | <listitem> | |
cd18d983 BF |
1619 | <para> |
1620 | This specifies the Type of Service (ToS) field of packets to match; | |
1621 | it takes an unsigned integer in the range 0…255. | |
1622 | The field can be used to specify precedence (the first 3 bits) and ToS (the next 3 bits). | |
1623 | The field can be also used to specify Differentiated Services Code Point (DSCP) (the first 6 bits) and | |
1624 | Explicit Congestion Notification (ECN) (the last 2 bits). | |
1625 | See <ulink url="https://en.wikipedia.org/wiki/Type_of_service">Type of Service</ulink> | |
1626 | and <ulink url="https://en.wikipedia.org/wiki/Differentiated_services">Differentiated services</ulink> | |
1627 | for more details. | |
1628 | </para> | |
ec07c3c8 AK |
1629 | |
1630 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1631 | </listitem> |
1632 | </varlistentry> | |
1633 | ||
1634 | <varlistentry> | |
1635 | <term><varname>From=</varname></term> | |
1636 | <listitem> | |
1637 | <para>Specifies the source address prefix to match. Possibly followed by a slash and the | |
1638 | prefix length.</para> | |
ec07c3c8 AK |
1639 | |
1640 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1641 | </listitem> |
1642 | </varlistentry> | |
1643 | ||
1644 | <varlistentry> | |
1645 | <term><varname>To=</varname></term> | |
1646 | <listitem> | |
1647 | <para>Specifies the destination address prefix to match. Possibly followed by a slash and the | |
1648 | prefix length.</para> | |
ec07c3c8 AK |
1649 | |
1650 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1651 | </listitem> |
1652 | </varlistentry> | |
1653 | ||
1654 | <varlistentry> | |
1655 | <term><varname>FirewallMark=</varname></term> | |
1656 | <listitem> | |
1657 | <para>Specifies the iptables firewall mark value to match (a number in the range | |
1658 | 1…4294967295). Optionally, the firewall mask (also a number between 1…4294967295) can be | |
1659 | suffixed with a slash (<literal>/</literal>), e.g., <literal>7/255</literal>.</para> | |
ec07c3c8 AK |
1660 | |
1661 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1662 | </listitem> |
1663 | </varlistentry> | |
1664 | ||
1665 | <varlistentry> | |
1666 | <term><varname>Table=</varname></term> | |
1667 | <listitem> | |
195427cd | 1668 | <para>Specifies the routing table identifier to look up if the rule selector matches. Takes |
add469f5 YW |
1669 | one of predefined names <literal>default</literal>, <literal>main</literal>, and |
1670 | <literal>local</literal>, and names defined in <varname>RouteTable=</varname> in | |
1671 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1672 | or a number between 1 and 4294967295. Defaults to <literal>main</literal>.</para> | |
ec07c3c8 AK |
1673 | |
1674 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1675 | </listitem> |
1676 | </varlistentry> | |
1677 | ||
1678 | <varlistentry> | |
1679 | <term><varname>Priority=</varname></term> | |
1680 | <listitem> | |
1681 | <para>Specifies the priority of this rule. <varname>Priority=</varname> is an integer in the | |
1682 | range 0…4294967295. Higher number means lower priority, and rules get processed in order of | |
1683 | increasing number. Defaults to unset, and the kernel will pick a value dynamically.</para> | |
ec07c3c8 AK |
1684 | |
1685 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
1686 | </listitem> |
1687 | </varlistentry> | |
1688 | ||
1689 | <varlistentry> | |
1690 | <term><varname>IncomingInterface=</varname></term> | |
1691 | <listitem> | |
1692 | <para>Specifies incoming device to match. If the interface is loopback, the rule only matches | |
1693 | packets originating from this host.</para> | |
ec07c3c8 AK |
1694 | |
1695 | <xi:include href="version-info.xml" xpointer="v236"/> | |
add469f5 YW |
1696 | </listitem> |
1697 | </varlistentry> | |
1698 | ||
1699 | <varlistentry> | |
1700 | <term><varname>OutgoingInterface=</varname></term> | |
1701 | <listitem> | |
1702 | <para>Specifies the outgoing device to match. The outgoing interface is only available for | |
1703 | packets originating from local sockets that are bound to a device.</para> | |
ec07c3c8 AK |
1704 | |
1705 | <xi:include href="version-info.xml" xpointer="v236"/> | |
add469f5 YW |
1706 | </listitem> |
1707 | </varlistentry> | |
1708 | ||
4be1fc84 NC |
1709 | <varlistentry> |
1710 | <term><varname>L3MasterDevice=</varname></term> | |
1711 | <listitem> | |
1712 | <para>A boolean. Specifies whether the rule is to direct lookups to the tables associated with | |
1713 | level 3 master devices (also known as Virtual Routing and Forwarding or VRF devices). | |
1714 | For further details see <ulink url="https://docs.kernel.org/networking/vrf.html"> | |
1715 | Virtual Routing and Forwarding (VRF)</ulink>. Defaults to false.</para> | |
1716 | ||
1717 | <xi:include href="version-info.xml" xpointer="v256"/> | |
1718 | </listitem> | |
1719 | </varlistentry> | |
1720 | ||
add469f5 YW |
1721 | <varlistentry> |
1722 | <term><varname>SourcePort=</varname></term> | |
1723 | <listitem> | |
1724 | <para>Specifies the source IP port or IP port range match in forwarding information base | |
1725 | (FIB) rules. A port range is specified by the lower and upper port separated by a dash. | |
1726 | Defaults to unset.</para> | |
ec07c3c8 AK |
1727 | |
1728 | <xi:include href="version-info.xml" xpointer="v240"/> | |
add469f5 YW |
1729 | </listitem> |
1730 | </varlistentry> | |
1731 | ||
1732 | <varlistentry> | |
1733 | <term><varname>DestinationPort=</varname></term> | |
1734 | <listitem> | |
1735 | <para>Specifies the destination IP port or IP port range match in forwarding information base | |
1736 | (FIB) rules. A port range is specified by the lower and upper port separated by a dash. | |
1737 | Defaults to unset.</para> | |
ec07c3c8 AK |
1738 | |
1739 | <xi:include href="version-info.xml" xpointer="v240"/> | |
add469f5 YW |
1740 | </listitem> |
1741 | </varlistentry> | |
1742 | ||
1743 | <varlistentry> | |
1744 | <term><varname>IPProtocol=</varname></term> | |
1745 | <listitem> | |
1746 | <para>Specifies the IP protocol to match in forwarding information base (FIB) rules. Takes IP | |
1747 | protocol name such as <literal>tcp</literal>, <literal>udp</literal> or | |
1748 | <literal>sctp</literal>, or IP protocol number such as <literal>6</literal> for | |
1749 | <literal>tcp</literal> or <literal>17</literal> for <literal>udp</literal>. Defaults to unset. | |
1750 | </para> | |
ec07c3c8 AK |
1751 | |
1752 | <xi:include href="version-info.xml" xpointer="v240"/> | |
add469f5 YW |
1753 | </listitem> |
1754 | </varlistentry> | |
1755 | ||
1756 | <varlistentry> | |
1757 | <term><varname>InvertRule=</varname></term> | |
1758 | <listitem> | |
1759 | <para>A boolean. Specifies whether the rule is to be inverted. Defaults to false.</para> | |
ec07c3c8 AK |
1760 | |
1761 | <xi:include href="version-info.xml" xpointer="v240"/> | |
add469f5 YW |
1762 | </listitem> |
1763 | </varlistentry> | |
1764 | ||
1765 | <varlistentry> | |
1766 | <term><varname>Family=</varname></term> | |
1767 | <listitem> | |
1768 | <para>Takes a special value <literal>ipv4</literal>, <literal>ipv6</literal>, or | |
1769 | <literal>both</literal>. By default, the address family is determined by the address | |
1770 | specified in <varname>To=</varname> or <varname>From=</varname>. If neither | |
1771 | <varname>To=</varname> nor <varname>From=</varname> are specified, then defaults to | |
1772 | <literal>ipv4</literal>.</para> | |
ec07c3c8 AK |
1773 | |
1774 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
1775 | </listitem> |
1776 | </varlistentry> | |
1777 | ||
1778 | <varlistentry> | |
1779 | <term><varname>User=</varname></term> | |
1780 | <listitem> | |
1781 | <para>Takes a username, a user ID, or a range of user IDs separated by a dash. Defaults to | |
1782 | unset.</para> | |
ec07c3c8 AK |
1783 | |
1784 | <xi:include href="version-info.xml" xpointer="v245"/> | |
add469f5 YW |
1785 | </listitem> |
1786 | </varlistentry> | |
1787 | ||
1788 | <varlistentry> | |
1789 | <term><varname>SuppressPrefixLength=</varname></term> | |
1790 | <listitem> | |
1791 | <para>Takes a number <replaceable>N</replaceable> in the range 0…128 and rejects routing | |
1792 | decisions that have a prefix length of <replaceable>N</replaceable> or less. Defaults to | |
1793 | unset.</para> | |
ec07c3c8 AK |
1794 | |
1795 | <xi:include href="version-info.xml" xpointer="v245"/> | |
add469f5 YW |
1796 | </listitem> |
1797 | </varlistentry> | |
1798 | ||
1799 | <varlistentry> | |
1800 | <term><varname>SuppressInterfaceGroup=</varname></term> | |
1801 | <listitem> | |
1802 | <para>Takes an integer in the range 0…2147483647 and rejects routing decisions that have | |
1803 | an interface with the same group id. It has the same meaning as | |
1804 | <option>suppress_ifgroup</option> in <command>ip rule</command>. Defaults to unset.</para> | |
ec07c3c8 AK |
1805 | |
1806 | <xi:include href="version-info.xml" xpointer="v250"/> | |
add469f5 YW |
1807 | </listitem> |
1808 | </varlistentry> | |
1809 | ||
1810 | <varlistentry> | |
1811 | <term><varname>Type=</varname></term> | |
1812 | <listitem> | |
1813 | <para>Specifies Routing Policy Database (RPDB) rule type. Takes one of | |
1814 | <literal>blackhole</literal>, <literal>unreachable</literal> or <literal>prohibit</literal>. | |
1815 | </para> | |
ec07c3c8 AK |
1816 | |
1817 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
1818 | </listitem> |
1819 | </varlistentry> | |
1820 | </variablelist> | |
1821 | </refsect1> | |
1822 | ||
1823 | <refsect1> | |
1824 | <title>[NextHop] Section Options</title> | |
1825 | ||
1826 | <para>The [NextHop] section is used to manipulate entries in the kernel's "nexthop" tables. The | |
1827 | [NextHop] section accepts the following settings. Specify several [NextHop] sections to configure | |
1828 | several hops.</para> | |
1829 | ||
1830 | <variablelist class='network-directives'> | |
1831 | <varlistentry> | |
1832 | <term><varname>Id=</varname></term> | |
1833 | <listitem> | |
bbc05bec YW |
1834 | <para>The id of the next hop. Takes an integer in the range 1…4294967295. |
1835 | This is mandatory if <varname>ManageForeignNextHops=no</varname> is specified in | |
1836 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
1837 | Otherwise, if unspecified, an unused ID will be automatically picked.</para> | |
ec07c3c8 AK |
1838 | |
1839 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
1840 | </listitem> |
1841 | </varlistentry> | |
1842 | ||
1843 | <varlistentry> | |
1844 | <term><varname>Gateway=</varname></term> | |
1845 | <listitem> | |
1846 | <para>As in the [Network] section.</para> | |
ec07c3c8 AK |
1847 | |
1848 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
1849 | </listitem> |
1850 | </varlistentry> | |
1851 | ||
1852 | <varlistentry> | |
1853 | <term><varname>Family=</varname></term> | |
1854 | <listitem> | |
1855 | <para>Takes one of the special values <literal>ipv4</literal> or <literal>ipv6</literal>. | |
1856 | By default, the family is determined by the address specified in | |
1857 | <varname>Gateway=</varname>. If <varname>Gateway=</varname> is not specified, then defaults | |
1858 | to <literal>ipv4</literal>.</para> | |
ec07c3c8 AK |
1859 | |
1860 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
1861 | </listitem> |
1862 | </varlistentry> | |
1863 | ||
1864 | <varlistentry> | |
1865 | <term><varname>OnLink=</varname></term> | |
1866 | <listitem> | |
1867 | <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is | |
1868 | reachable directly by the current machine (i.e., attached to the local network), so that we | |
1869 | can insert the nexthop in the kernel table without it being complained about. Defaults to | |
1870 | <literal>no</literal>.</para> | |
ec07c3c8 AK |
1871 | |
1872 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
1873 | </listitem> |
1874 | </varlistentry> | |
1875 | ||
1876 | <varlistentry> | |
1877 | <term><varname>Blackhole=</varname></term> | |
1878 | <listitem> | |
1879 | <para>Takes a boolean. If enabled, packets to the corresponding routes are discarded | |
1880 | silently, and <varname>Gateway=</varname> cannot be specified. Defaults to | |
1881 | <literal>no</literal>.</para> | |
ec07c3c8 AK |
1882 | |
1883 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
1884 | </listitem> |
1885 | </varlistentry> | |
1886 | ||
1887 | <varlistentry> | |
1888 | <term><varname>Group=</varname></term> | |
1889 | <listitem> | |
1890 | <para>Takes a whitespace separated list of nexthop IDs. Each ID must be in the range | |
1891 | 1…4294967295. Optionally, each nexthop ID can take a weight after a colon | |
1892 | (<literal><replaceable>id</replaceable><optional>:<replaceable>weight</replaceable></optional></literal>). | |
1893 | The weight must be in the range 1…255. If the weight is not specified, then it is assumed | |
1894 | that the weight is 1. This setting cannot be specified with <varname>Gateway=</varname>, | |
1895 | <varname>Family=</varname>, <varname>Blackhole=</varname>. This setting can be specified | |
1896 | multiple times. If an empty string is assigned, then the all previous assignments are | |
1897 | cleared. Defaults to unset.</para> | |
ec07c3c8 AK |
1898 | |
1899 | <xi:include href="version-info.xml" xpointer="v249"/> | |
add469f5 YW |
1900 | </listitem> |
1901 | </varlistentry> | |
1902 | </variablelist> | |
1903 | </refsect1> | |
1904 | ||
1905 | <refsect1> | |
1906 | <title>[Route] Section Options</title> | |
1907 | ||
1908 | <para>The [Route] section accepts the following settings. Specify several [Route] sections to | |
1909 | configure several routes.</para> | |
1910 | ||
1911 | <variablelist class='network-directives'> | |
1912 | <varlistentry> | |
1913 | <term><varname>Gateway=</varname></term> | |
1914 | <listitem> | |
1915 | <para>Takes the gateway address or the special values <literal>_dhcp4</literal> and | |
1916 | <literal>_ipv6ra</literal>. If <literal>_dhcp4</literal> or <literal>_ipv6ra</literal> is | |
1917 | set, then the gateway address provided by DHCPv4 or IPv6 RA is used.</para> | |
ec07c3c8 | 1918 | |
aefdc112 | 1919 | <xi:include href="version-info.xml" xpointer="v211"/> |
add469f5 YW |
1920 | </listitem> |
1921 | </varlistentry> | |
1922 | ||
1923 | <varlistentry> | |
1924 | <term><varname>GatewayOnLink=</varname></term> | |
1925 | <listitem> | |
1926 | <para>Takes a boolean. If set to true, the kernel does not have to check if the gateway is | |
1927 | reachable directly by the current machine (i.e., attached to the local network), so that we | |
1928 | can insert the route in the kernel table without it being complained about. Defaults to | |
1929 | <literal>no</literal>.</para> | |
ec07c3c8 | 1930 | |
aefdc112 | 1931 | <xi:include href="version-info.xml" xpointer="v234"/> |
add469f5 YW |
1932 | </listitem> |
1933 | </varlistentry> | |
1934 | ||
1935 | <varlistentry> | |
1936 | <term><varname>Destination=</varname></term> | |
1937 | <listitem> | |
1938 | <para>The destination prefix of the route. Possibly followed by a slash and the prefix | |
1939 | length. If omitted, a full-length host route is assumed.</para> | |
aefdc112 AK |
1940 | |
1941 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
1942 | </listitem> |
1943 | </varlistentry> | |
1944 | ||
1945 | <varlistentry> | |
1946 | <term><varname>Source=</varname></term> | |
1947 | <listitem> | |
1948 | <para>The source prefix of the route. Possibly followed by a slash and the prefix length. If | |
1949 | omitted, a full-length host route is assumed.</para> | |
ec07c3c8 AK |
1950 | |
1951 | <xi:include href="version-info.xml" xpointer="v218"/> | |
add469f5 YW |
1952 | </listitem> |
1953 | </varlistentry> | |
1954 | ||
1955 | <varlistentry> | |
1956 | <term><varname>Metric=</varname></term> | |
1957 | <listitem> | |
1958 | <para>The metric of the route. Takes an unsigned integer in the range 0…4294967295. Defaults | |
1959 | to unset, and the kernel's default will be used.</para> | |
ec07c3c8 AK |
1960 | |
1961 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
1962 | </listitem> |
1963 | </varlistentry> | |
1964 | ||
1965 | <varlistentry> | |
1966 | <term><varname>IPv6Preference=</varname></term> | |
1967 | <listitem> | |
1968 | <para>Specifies the route preference as defined in | |
1969 | <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for Router Discovery | |
1970 | messages. Which can be one of <literal>low</literal> the route has a lowest priority, | |
1971 | <literal>medium</literal> the route has a default priority or <literal>high</literal> the | |
1972 | route has a highest priority.</para> | |
ec07c3c8 AK |
1973 | |
1974 | <xi:include href="version-info.xml" xpointer="v234"/> | |
add469f5 YW |
1975 | </listitem> |
1976 | </varlistentry> | |
1977 | ||
1978 | <varlistentry> | |
1979 | <term><varname>Scope=</varname></term> | |
1980 | <listitem> | |
1981 | <para>The scope of the IPv4 route, which can be <literal>global</literal>, | |
1982 | <literal>site</literal>, <literal>link</literal>, <literal>host</literal>, or | |
1983 | <literal>nowhere</literal>:</para> | |
1984 | <itemizedlist> | |
1985 | <listitem> | |
1986 | <para><literal>global</literal> means the route can reach hosts more than one hop away. | |
1987 | </para> | |
1988 | </listitem> | |
1989 | ||
1990 | <listitem> | |
1991 | <para><literal>site</literal> means an interior route in the local autonomous system. | |
1992 | </para> | |
1993 | </listitem> | |
1994 | ||
1995 | <listitem> | |
1996 | <para><literal>link</literal> means the route can only reach hosts on the local network | |
1997 | (one hop away).</para> | |
1998 | </listitem> | |
1999 | ||
2000 | <listitem> | |
2001 | <para><literal>host</literal> means the route will not leave the local machine (used for | |
2002 | internal addresses like 127.0.0.1).</para> | |
2003 | </listitem> | |
2004 | ||
2005 | <listitem> | |
2006 | <para><literal>nowhere</literal> means the destination doesn't exist.</para> | |
2007 | </listitem> | |
2008 | </itemizedlist> | |
2009 | ||
2010 | <para>For IPv4 route, defaults to <literal>host</literal> if <varname>Type=</varname> is | |
2011 | <literal>local</literal> or <literal>nat</literal>, and <literal>link</literal> if | |
902bbdc4 | 2012 | <varname>Type=</varname> is <literal>broadcast</literal>, <literal>multicast</literal>, |
6a1d8f11 | 2013 | <literal>anycast</literal>, or <literal>unicast</literal>. In other cases, |
902bbdc4 | 2014 | defaults to <literal>global</literal>. The value is not used for IPv6.</para> |
ec07c3c8 AK |
2015 | |
2016 | <xi:include href="version-info.xml" xpointer="v219"/> | |
add469f5 YW |
2017 | </listitem> |
2018 | </varlistentry> | |
2019 | ||
2020 | <varlistentry> | |
2021 | <term><varname>PreferredSource=</varname></term> | |
2022 | <listitem> | |
2023 | <para>The preferred source address of the route. The address must be in the format described | |
2024 | in | |
2025 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
2026 | </para> | |
ec07c3c8 AK |
2027 | |
2028 | <xi:include href="version-info.xml" xpointer="v227"/> | |
add469f5 YW |
2029 | </listitem> |
2030 | </varlistentry> | |
2031 | ||
2032 | <varlistentry> | |
2033 | <term><varname>Table=</varname></term> | |
2034 | <listitem> | |
2035 | <para>The table identifier for the route. Takes one of predefined names | |
2036 | <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names | |
2037 | defined in <varname>RouteTable=</varname> in | |
2038 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
2039 | or a number between 1 and 4294967295. The table can be retrieved using | |
2040 | <command>ip route show table <replaceable>num</replaceable></command>. If unset and | |
2041 | <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>, | |
2042 | <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used. | |
4be1fc84 | 2043 | In other cases, defaults to <literal>main</literal>. Ignored if <varname>L3MasterDevice=</varname> is true.</para> |
ec07c3c8 | 2044 | |
aefdc112 | 2045 | <xi:include href="version-info.xml" xpointer="v230"/> |
add469f5 YW |
2046 | </listitem> |
2047 | </varlistentry> | |
2048 | ||
88c06423 SS |
2049 | <varlistentry> |
2050 | <term><varname>HopLimit=</varname></term> | |
2051 | <listitem> | |
08801318 YW |
2052 | <para>Configures per route hop limit. Takes an integer in the range 1…255. See also |
2053 | <varname>IPv6HopLimit=</varname>.</para> | |
ec07c3c8 AK |
2054 | |
2055 | <xi:include href="version-info.xml" xpointer="v255"/> | |
88c06423 SS |
2056 | </listitem> |
2057 | </varlistentry> | |
2058 | ||
add469f5 YW |
2059 | <varlistentry> |
2060 | <term><varname>Protocol=</varname></term> | |
2061 | <listitem> | |
2062 | <para>The protocol identifier for the route. Takes a number between 0 and 255 or the special | |
2063 | values <literal>kernel</literal>, <literal>boot</literal>, <literal>static</literal>, | |
2064 | <literal>ra</literal> and <literal>dhcp</literal>. Defaults to <literal>static</literal>. | |
2065 | </para> | |
ec07c3c8 AK |
2066 | |
2067 | <xi:include href="version-info.xml" xpointer="v234"/> | |
add469f5 YW |
2068 | </listitem> |
2069 | </varlistentry> | |
2070 | ||
2071 | <varlistentry> | |
2072 | <term><varname>Type=</varname></term> | |
2073 | <listitem> | |
2074 | <para>Specifies the type for the route. Takes one of <literal>unicast</literal>, | |
2075 | <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>, | |
2076 | <literal>multicast</literal>, <literal>blackhole</literal>, <literal>unreachable</literal>, | |
2077 | <literal>prohibit</literal>, <literal>throw</literal>, <literal>nat</literal>, and | |
2078 | <literal>xresolve</literal>. If <literal>unicast</literal>, a regular route is defined, i.e. | |
2079 | a route indicating the path to take to a destination network address. If | |
2080 | <literal>blackhole</literal>, packets to the defined route are discarded silently. If | |
2081 | <literal>unreachable</literal>, packets to the defined route are discarded and the ICMP | |
2082 | message "Host Unreachable" is generated. If <literal>prohibit</literal>, packets to the | |
2083 | defined route are discarded and the ICMP message "Communication Administratively Prohibited" | |
2084 | is generated. If <literal>throw</literal>, route lookup in the current routing table will | |
2085 | fail and the route selection process will return to Routing Policy Database (RPDB). Defaults | |
2086 | to <literal>unicast</literal>.</para> | |
aefdc112 AK |
2087 | |
2088 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
2089 | </listitem> |
2090 | </varlistentry> | |
2091 | ||
2092 | <varlistentry> | |
2093 | <term><varname>InitialCongestionWindow=</varname></term> | |
2094 | <listitem> | |
2095 | <para>The TCP initial congestion window is used during the start of a TCP connection. | |
2096 | During the start of a TCP session, when a client requests a resource, the server's initial | |
2097 | congestion window determines how many packets will be sent during the initial burst of data | |
2098 | without waiting for acknowledgement. Takes a number between 1 and 1023. Note that 100 is | |
2099 | considered an extremely large value for this option. When unset, the kernel's default | |
2100 | (typically 10) will be used.</para> | |
ec07c3c8 AK |
2101 | |
2102 | <xi:include href="version-info.xml" xpointer="v237"/> | |
add469f5 YW |
2103 | </listitem> |
2104 | </varlistentry> | |
2105 | ||
2106 | <varlistentry> | |
2107 | <term><varname>InitialAdvertisedReceiveWindow=</varname></term> | |
2108 | <listitem> | |
2109 | <para>The TCP initial advertised receive window is the amount of receive data (in bytes) | |
2110 | that can initially be buffered at one time on a connection. The sending host can send only | |
2111 | that amount of data before waiting for an acknowledgment and window update from the | |
2112 | receiving host. Takes a number between 1 and 1023. Note that 100 is considered an extremely | |
2113 | large value for this option. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
2114 | |
2115 | <xi:include href="version-info.xml" xpointer="v237"/> | |
add469f5 YW |
2116 | </listitem> |
2117 | </varlistentry> | |
2118 | ||
2119 | <varlistentry> | |
2120 | <term><varname>QuickAck=</varname></term> | |
2121 | <listitem> | |
f95fb199 YW |
2122 | <para>Takes a boolean. When true, the TCP quick ACK mode for the route is enabled. When unset, |
2123 | the kernel's default will be used.</para> | |
ec07c3c8 AK |
2124 | |
2125 | <xi:include href="version-info.xml" xpointer="v237"/> | |
add469f5 YW |
2126 | </listitem> |
2127 | </varlistentry> | |
2128 | ||
2129 | <varlistentry> | |
2130 | <term><varname>FastOpenNoCookie=</varname></term> | |
2131 | <listitem> | |
2132 | <para>Takes a boolean. When true enables TCP fastopen without a cookie on a per-route basis. | |
2133 | When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
2134 | |
2135 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
2136 | </listitem> |
2137 | </varlistentry> | |
2138 | ||
2139 | <varlistentry> | |
add469f5 YW |
2140 | <term><varname>MTUBytes=</varname></term> |
2141 | <listitem> | |
2142 | <para>The maximum transmission unit in bytes to set for the route. The usual suffixes K, M, | |
2143 | G, are supported and are understood to the base of 1024.</para> | |
ec07c3c8 AK |
2144 | |
2145 | <xi:include href="version-info.xml" xpointer="v239"/> | |
add469f5 YW |
2146 | </listitem> |
2147 | </varlistentry> | |
2148 | ||
2149 | <varlistentry> | |
2150 | <term><varname>TCPAdvertisedMaximumSegmentSize=</varname></term> | |
2151 | <listitem> | |
2152 | <para>Specifies the Path MSS (in bytes) hints given on TCP layer. The usual suffixes K, M, G, | |
2153 | are supported and are understood to the base of 1024. An unsigned integer in the range | |
2154 | 1…4294967294. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
2155 | |
2156 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
2157 | </listitem> |
2158 | </varlistentry> | |
2159 | ||
dc7c21f0 YW |
2160 | <varlistentry> |
2161 | <term><varname>TCPCongestionControlAlgorithm=</varname></term> | |
2162 | <listitem> | |
2163 | <para>Specifies the TCP congestion control algorithm for the route. Takes a name of the algorithm, | |
2164 | e.g. <literal>bbr</literal>, <literal>dctcp</literal>, or <literal>vegas</literal>. When unset, | |
2165 | the kernel's default will be used.</para> | |
ec07c3c8 AK |
2166 | |
2167 | <xi:include href="version-info.xml" xpointer="v252"/> | |
dc7c21f0 YW |
2168 | </listitem> |
2169 | </varlistentry> | |
2170 | ||
1412d4a4 | 2171 | <varlistentry> |
9475e23c | 2172 | <term><varname>TCPRetransmissionTimeoutSec=</varname></term> |
1412d4a4 | 2173 | <listitem> |
9475e23c YW |
2174 | <para>Specifies the TCP Retransmission Timeout (RTO) for the route. Takes time values in seconds. |
2175 | This value specifies the timeout of an alive TCP connection, when retransmissions remain | |
2176 | unacknowledged. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
2177 | |
2178 | <xi:include href="version-info.xml" xpointer="v255"/> | |
1412d4a4 SS |
2179 | </listitem> |
2180 | </varlistentry> | |
2181 | ||
add469f5 YW |
2182 | <varlistentry> |
2183 | <term><varname>MultiPathRoute=<replaceable>address</replaceable>[@<replaceable>name</replaceable>] [<replaceable>weight</replaceable>]</varname></term> | |
2184 | <listitem> | |
2185 | <para>Configures multipath route. Multipath routing is the technique of using multiple | |
2186 | alternative paths through a network. Takes gateway address. Optionally, takes a network | |
2187 | interface name or index separated with <literal>@</literal>, and a weight in 1..256 for this | |
2188 | multipath route separated with whitespace. This setting can be specified multiple times. If | |
2189 | an empty string is assigned, then the all previous assignments are cleared.</para> | |
ec07c3c8 AK |
2190 | |
2191 | <xi:include href="version-info.xml" xpointer="v245"/> | |
add469f5 YW |
2192 | </listitem> |
2193 | </varlistentry> | |
2194 | ||
2195 | <varlistentry> | |
2196 | <term><varname>NextHop=</varname></term> | |
2197 | <listitem> | |
2198 | <para>Specifies the nexthop id. Takes an unsigned integer in the range 1…4294967295. If set, | |
2199 | the corresponding [NextHop] section must be configured. Defaults to unset.</para> | |
ec07c3c8 AK |
2200 | |
2201 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
2202 | </listitem> |
2203 | </varlistentry> | |
2204 | </variablelist> | |
2205 | </refsect1> | |
2206 | ||
2207 | <refsect1> | |
2208 | <title>[DHCPv4] Section Options</title> | |
2209 | ||
2210 | <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the | |
2211 | <varname>DHCP=</varname> setting described above:</para> | |
2212 | ||
2213 | <variablelist class='network-directives'> | |
2214 | ||
2215 | <!-- DHCP packet contents --> | |
2216 | ||
b93bf1bf YW |
2217 | <varlistentry> |
2218 | <term><varname>RequestAddress=</varname></term> | |
2219 | <listitem> | |
2220 | <para>Takes an IPv4 address. When specified, the Requested IP Address option (option code 50) is | |
2221 | added with it to the initial DHCPDISCOVER message sent by the DHCP client. Defaults to unset, and | |
2222 | an already assigned dynamic address to the interface is automatically picked.</para> | |
2223 | ||
2224 | <xi:include href="version-info.xml" xpointer="v255"/> | |
2225 | </listitem> | |
2226 | </varlistentry> | |
2227 | ||
add469f5 YW |
2228 | <varlistentry> |
2229 | <term><varname>SendHostname=</varname></term> | |
2230 | <listitem> | |
2231 | <para>When true (the default), the machine's hostname (or the value specified with | |
2232 | <varname>Hostname=</varname>, described below) will be sent to the DHCP server. Note that the | |
2233 | hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be | |
2234 | formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option | |
2235 | is true.</para> | |
aefdc112 AK |
2236 | |
2237 | <xi:include href="version-info.xml" xpointer="v215"/> | |
add469f5 YW |
2238 | </listitem> |
2239 | </varlistentry> | |
2240 | ||
2241 | <varlistentry> | |
2242 | <term><varname>Hostname=</varname></term> | |
2243 | <listitem> | |
2244 | <para>Use this value for the hostname which is sent to the DHCP server, instead of machine's | |
2245 | hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case | |
2246 | characters and no spaces or dots, and be formatted as a valid DNS domain name.</para> | |
aefdc112 AK |
2247 | |
2248 | <xi:include href="version-info.xml" xpointer="v223"/> | |
add469f5 YW |
2249 | </listitem> |
2250 | </varlistentry> | |
2251 | ||
2252 | <varlistentry> | |
2253 | <term><varname>MUDURL=</varname></term> | |
2254 | <listitem> | |
2255 | <para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent | |
2256 | to the DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification | |
2257 | that the string is a valid URL will be performed. DHCPv4 clients are intended to have at most | |
2258 | one MUD URL associated with them. See | |
2259 | <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para> | |
2260 | ||
2261 | <para>MUD is an embedded software standard defined by the IETF that allows IoT device makers | |
2262 | to advertise device specifications, including the intended communication patterns for their | |
2263 | device when it connects to the network. The network can then use this to author a | |
2264 | context-specific access policy, so the device functions only within those parameters.</para> | |
ec07c3c8 AK |
2265 | |
2266 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2267 | </listitem> |
2268 | </varlistentry> | |
2269 | ||
2270 | <varlistentry> | |
2271 | <term><varname>ClientIdentifier=</varname></term> | |
2272 | <listitem> | |
d8f19e03 YW |
2273 | <para>The DHCPv4 client identifier to use. Takes one of <option>mac</option> or |
2274 | <option>duid</option>. If set to <option>mac</option>, the MAC address of the link is used. If set | |
2275 | to <option>duid</option>, an RFC4361-compliant Client ID, which is the combination of IAID and | |
2276 | DUID, is used. IAID can be configured by <varname>IAID=</varname>. DUID can be configured by | |
2277 | <varname>DUIDType=</varname> and <varname>DUIDRawData=</varname>. Defaults to | |
2278 | <option>duid</option>.</para> | |
aefdc112 AK |
2279 | |
2280 | <xi:include href="version-info.xml" xpointer="v220"/> | |
add469f5 YW |
2281 | </listitem> |
2282 | </varlistentry> | |
2283 | ||
2284 | <varlistentry> | |
2285 | <term><varname>VendorClassIdentifier=</varname></term> | |
2286 | <listitem> | |
2287 | <para>The vendor class identifier used to identify vendor type and configuration.</para> | |
aefdc112 AK |
2288 | |
2289 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
2290 | </listitem> |
2291 | </varlistentry> | |
2292 | ||
2293 | <varlistentry> | |
2294 | <term><varname>UserClass=</varname></term> | |
2295 | <listitem> | |
2296 | <para>A DHCPv4 client can use UserClass option to identify the type or category of user or | |
2297 | applications it represents. The information contained in this option is a string that | |
2298 | represents the user class of which the client is a member. Each class sets an identifying | |
2299 | string of information to be used by the DHCP service to classify clients. Takes a | |
2300 | whitespace-separated list of strings.</para> | |
aefdc112 AK |
2301 | |
2302 | <xi:include href="version-info.xml" xpointer="v239"/> | |
add469f5 YW |
2303 | </listitem> |
2304 | </varlistentry> | |
2305 | ||
2306 | <varlistentry> | |
2307 | <term><varname>DUIDType=</varname></term> | |
2308 | <listitem> | |
2309 | <para>Override the global <varname>DUIDType=</varname> setting for this network. See | |
2310 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
2311 | for a description of possible values.</para> | |
aefdc112 AK |
2312 | |
2313 | <xi:include href="version-info.xml" xpointer="v230"/> | |
add469f5 YW |
2314 | </listitem> |
2315 | </varlistentry> | |
2316 | ||
2317 | <varlistentry> | |
2318 | <term><varname>DUIDRawData=</varname></term> | |
2319 | <listitem> | |
2320 | <para>Override the global <varname>DUIDRawData=</varname> setting for this network. See | |
2321 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
2322 | for a description of possible values.</para> | |
aefdc112 AK |
2323 | |
2324 | <xi:include href="version-info.xml" xpointer="v230"/> | |
add469f5 YW |
2325 | </listitem> |
2326 | </varlistentry> | |
2327 | ||
2328 | <varlistentry> | |
2329 | <term><varname>IAID=</varname></term> | |
2330 | <listitem> | |
2331 | <para>The DHCP Identity Association Identifier (IAID) for the interface, a 32-bit unsigned | |
2332 | integer.</para> | |
aefdc112 AK |
2333 | |
2334 | <xi:include href="version-info.xml" xpointer="v230"/> | |
add469f5 YW |
2335 | </listitem> |
2336 | </varlistentry> | |
2337 | ||
808b65a0 RP |
2338 | <varlistentry> |
2339 | <term><varname>RapidCommit=</varname></term> | |
2340 | <listitem> | |
2341 | <para>Takes a boolean. The DHCPv4 client can obtain configuration parameters from a DHCPv4 server | |
2342 | through a rapid two-message exchange (discover and ack). When the rapid commit option is set by | |
2343 | both the DHCPv4 client and the DHCPv4 server, the two-message exchange is used. Otherwise, the | |
2344 | four-message exchange (discover, offer, request, and ack) is used. The two-message exchange | |
2345 | provides faster client configuration. See | |
2346 | <ulink url="https://tools.ietf.org/html/rfc4039">RFC 4039</ulink> for details. | |
cf289b14 YW |
2347 | Defaults to true when <varname>Anonymize=no</varname> and neither <varname>AllowList=</varname> |
2348 | nor <varname>DenyList=</varname> is specified, and false otherwise.</para> | |
808b65a0 RP |
2349 | |
2350 | <xi:include href="version-info.xml" xpointer="v255"/> | |
2351 | </listitem> | |
2352 | </varlistentry> | |
2353 | ||
add469f5 YW |
2354 | <varlistentry> |
2355 | <term><varname>Anonymize=</varname></term> | |
2356 | <listitem> | |
2357 | <para>Takes a boolean. When true, the options sent to the DHCP server will follow the | |
2358 | <ulink url="https://tools.ietf.org/html/rfc7844">RFC 7844</ulink> (Anonymity Profiles for | |
2359 | DHCP Clients) to minimize disclosure of identifying information. Defaults to false.</para> | |
2360 | ||
2361 | <para>This option should only be set to true when <varname>MACAddressPolicy=</varname> is set | |
2362 | to <option>random</option> (see | |
2363 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
2364 | </para> | |
2365 | ||
fcf17d69 YW |
2366 | <para>When true, |
2367 | <varname>ClientIdentifier=mac</varname>, | |
24bb67ed | 2368 | <varname>RapidCommit=no</varname>, |
fcf17d69 YW |
2369 | <varname>SendHostname=no</varname>, |
2370 | <varname>Use6RD=no</varname>, | |
2371 | <varname>UseCaptivePortal=no</varname>, | |
2372 | <varname>UseMTU=no</varname>, | |
2373 | <varname>UseNTP=no</varname>, | |
2374 | <varname>UseSIP=no</varname>, and | |
2375 | <varname>UseTimezone=no</varname> | |
2376 | are implied and these settings in the .network file are silently ignored. Also, | |
2377 | <varname>Hostname=</varname>, | |
2378 | <varname>MUDURL=</varname>, | |
6a321088 | 2379 | <varname>RequestAddress=</varname>, |
fcf17d69 YW |
2380 | <varname>RequestOptions=</varname>, |
2381 | <varname>SendOption=</varname>, | |
2382 | <varname>SendVendorOption=</varname>, | |
2383 | <varname>UserClass=</varname>, and | |
2384 | <varname>VendorClassIdentifier=</varname> | |
2385 | are silently ignored.</para> | |
add469f5 YW |
2386 | |
2387 | <para>With this option enabled DHCP requests will mimic those generated by Microsoft | |
2388 | Windows, in order to reduce the ability to fingerprint and recognize installations. This | |
2389 | means DHCP request sizes will grow and lease data will be more comprehensive than normally, | |
2390 | though most of the requested data is not actually used.</para> | |
aefdc112 AK |
2391 | |
2392 | <xi:include href="version-info.xml" xpointer="v235"/> | |
add469f5 YW |
2393 | </listitem> |
2394 | </varlistentry> | |
2395 | ||
2396 | <varlistentry> | |
2397 | <term><varname>RequestOptions=</varname></term> | |
2398 | <listitem> | |
2399 | <para>Sets request options to be sent to the server in the DHCPv4 request options list. A | |
2400 | whitespace-separated list of integers in the range 1…254. Defaults to unset.</para> | |
ec07c3c8 AK |
2401 | |
2402 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
2403 | </listitem> |
2404 | </varlistentry> | |
2405 | ||
2406 | <varlistentry> | |
2407 | <term><varname>SendOption=</varname></term> | |
2408 | <listitem> | |
2409 | <para>Send an arbitrary raw option in the DHCPv4 request. Takes a DHCP option number, data | |
2410 | type and data separated with a colon | |
2411 | (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). | |
2412 | The option number must be an integer in the range 1…254. The type takes one of | |
2413 | <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>, | |
2414 | <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data | |
2415 | string may be escaped using | |
2416 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style | |
2417 | escapes</ulink>. This setting can be specified multiple times. If an empty string is | |
2418 | specified, then all options specified earlier are cleared. Defaults to unset.</para> | |
ec07c3c8 AK |
2419 | |
2420 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
2421 | </listitem> |
2422 | </varlistentry> | |
2423 | ||
2424 | <varlistentry> | |
2425 | <term><varname>SendVendorOption=</varname></term> | |
2426 | <listitem> | |
2427 | <para>Send an arbitrary vendor option in the DHCPv4 request. Takes a DHCP option number, data | |
2428 | type and data separated with a colon | |
2429 | (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). | |
2430 | The option number must be an integer in the range 1…254. The type takes one of | |
2431 | <literal>uint8</literal>, <literal>uint16</literal>, <literal>uint32</literal>, | |
2432 | <literal>ipv4address</literal>, or <literal>string</literal>. Special characters in the data | |
2433 | string may be escaped using | |
2434 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style | |
2435 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, | |
2436 | then all options specified earlier are cleared. Defaults to unset.</para> | |
ec07c3c8 AK |
2437 | |
2438 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2439 | </listitem> |
2440 | </varlistentry> | |
2441 | ||
2442 | <varlistentry> | |
2443 | <term><varname>IPServiceType=</varname></term> | |
2444 | <listitem> | |
2445 | <para>Takes one of the special values <literal>none</literal>, <literal>CS6</literal>, or | |
2446 | <literal>CS4</literal>. When <literal>none</literal> no IP service type is set to the packet | |
2447 | sent from the DHCPv4 client. When <literal>CS6</literal> (network control) or | |
2448 | <literal>CS4</literal> (realtime), the corresponding service type will be set. Defaults to | |
2449 | <literal>CS6</literal>.</para> | |
aefdc112 AK |
2450 | |
2451 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
2452 | </listitem> |
2453 | </varlistentry> | |
ea577968 | 2454 | |
2455 | <varlistentry> | |
2456 | <term><varname>SocketPriority=</varname></term> | |
2457 | <listitem> | |
2458 | <para>The Linux socket option <constant>SO_PRIORITY</constant> applied to the raw IP socket used for | |
2459 | initial DHCPv4 messages. Unset by default. Usual values range from 0 to 6. | |
2460 | More details about <constant>SO_PRIORITY</constant> socket option in | |
2461 | <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>. | |
2462 | Can be used in conjunction with [VLAN] section <varname>EgressQOSMaps=</varname> setting of .netdev | |
2463 | file to set the 802.1Q VLAN ethernet tagged header priority, see | |
2464 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
2465 | </para> | |
ec07c3c8 AK |
2466 | |
2467 | <xi:include href="version-info.xml" xpointer="v253"/> | |
ea577968 | 2468 | </listitem> |
2469 | </varlistentry> | |
add469f5 YW |
2470 | |
2471 | <!-- How to use the DHCP lease --> | |
2472 | ||
2473 | <varlistentry> | |
2474 | <term><varname>Label=</varname></term> | |
2475 | <listitem> | |
2476 | <para>Specifies the label for the IPv4 address received from the DHCP server. The label must | |
2477 | be a 7-bit ASCII string with a length of 1…15 characters. Defaults to unset.</para> | |
ec07c3c8 AK |
2478 | |
2479 | <xi:include href="version-info.xml" xpointer="v250"/> | |
add469f5 YW |
2480 | </listitem> |
2481 | </varlistentry> | |
2482 | ||
2483 | <varlistentry> | |
2484 | <term><varname>UseDNS=</varname></term> | |
2485 | <listitem> | |
2486 | <para>When true (the default), the DNS servers received from the DHCP server will be used. | |
2487 | </para> | |
2488 | ||
2489 | <para>This corresponds to the <option>nameserver</option> option in | |
2490 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
2491 | </para> | |
aefdc112 AK |
2492 | |
2493 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
2494 | </listitem> |
2495 | </varlistentry> | |
2496 | ||
2497 | <varlistentry> | |
2498 | <term><varname>RoutesToDNS=</varname></term> | |
2499 | <listitem> | |
2500 | <para>When true, the routes to the DNS servers received from the DHCP server will be | |
2501 | configured. When <varname>UseDNS=</varname> is disabled, this setting is ignored. Defaults to | |
2502 | true.</para> | |
ec07c3c8 AK |
2503 | |
2504 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
2505 | </listitem> |
2506 | </varlistentry> | |
2507 | ||
2508 | <varlistentry> | |
2509 | <term><varname>UseNTP=</varname></term> | |
2510 | <listitem> | |
2511 | <para>When true (the default), the NTP servers received from the DHCP server will be used by | |
2512 | <filename>systemd-timesyncd.service</filename>.</para> | |
aefdc112 AK |
2513 | |
2514 | <xi:include href="version-info.xml" xpointer="v220"/> | |
add469f5 YW |
2515 | </listitem> |
2516 | </varlistentry> | |
2517 | ||
2518 | <varlistentry> | |
2519 | <term><varname>RoutesToNTP=</varname></term> | |
2520 | <listitem> | |
2521 | <para>When true, the routes to the NTP servers received from the DHCP server will be | |
2522 | configured. When <varname>UseNTP=</varname> is disabled, this setting is ignored. Defaults to | |
2523 | true.</para> | |
ec07c3c8 AK |
2524 | |
2525 | <xi:include href="version-info.xml" xpointer="v249"/> | |
add469f5 YW |
2526 | </listitem> |
2527 | </varlistentry> | |
2528 | ||
2529 | <varlistentry> | |
2530 | <term><varname>UseSIP=</varname></term> | |
2531 | <listitem> | |
2532 | <para>When true (the default), the SIP servers received from the DHCP server will be collected | |
2533 | and made available to client programs.</para> | |
ec07c3c8 AK |
2534 | |
2535 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
2536 | </listitem> |
2537 | </varlistentry> | |
2538 | ||
edb88a72 RP |
2539 | <varlistentry> |
2540 | <term><varname>UseCaptivePortal=</varname></term> | |
2541 | <listitem> | |
2542 | <para>When true (the default), the captive portal advertised by the DHCP server will be recorded | |
bf63dadb ZJS |
2543 | and made available to client programs and displayed in the |
2544 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
2545 | status output per-link.</para> | |
ec07c3c8 AK |
2546 | |
2547 | <xi:include href="version-info.xml" xpointer="v254"/> | |
edb88a72 RP |
2548 | </listitem> |
2549 | </varlistentry> | |
2550 | ||
add469f5 YW |
2551 | <varlistentry> |
2552 | <term><varname>UseMTU=</varname></term> | |
2553 | <listitem> | |
2554 | <para>When true, the interface maximum transmission unit from the DHCP server will be used on | |
2555 | the current link. If <varname>MTUBytes=</varname> is set, then this setting is ignored. | |
2556 | Defaults to false.</para> | |
2557 | ||
2558 | <para>Note, some drivers will reset the interfaces if the MTU is changed. For such | |
2559 | interfaces, please try to use <varname>IgnoreCarrierLoss=</varname> with a short timespan, | |
2560 | e.g. <literal>3 seconds</literal>.</para> | |
aefdc112 AK |
2561 | |
2562 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
2563 | </listitem> |
2564 | </varlistentry> | |
2565 | ||
2566 | <varlistentry> | |
2567 | <term><varname>UseHostname=</varname></term> | |
2568 | <listitem> | |
2569 | <para>When true (the default), the hostname received from the DHCP server will be set as the | |
2570 | transient hostname of the system.</para> | |
aefdc112 AK |
2571 | |
2572 | <xi:include href="version-info.xml" xpointer="v211"/> | |
add469f5 YW |
2573 | </listitem> |
2574 | </varlistentry> | |
2575 | ||
2576 | <varlistentry> | |
2577 | <term><varname>UseDomains=</varname></term> | |
2578 | <listitem> | |
15102ced ZJS |
2579 | <para>Takes a boolean, or the special value <option>route</option>. When true, the domain name |
2580 | received from the DHCP server will be used as DNS search domain over this link, similarly to the | |
2581 | effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain name | |
2582 | received from the DHCP server will be used for routing DNS queries only, but not for searching, | |
2583 | similarly to the effect of the <option>Domains=</option> setting when the argument is prefixed with | |
418f2dc7 YW |
2584 | <literal>~</literal>.</para> |
2585 | ||
2586 | <para>When unspecified, the value specified in the same setting in the [Network] section will be | |
2587 | used. When it is unspecified, the value specified in the same setting in the [DHCPv4] section in | |
2588 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
2589 | will be used. When it is unspecified, the value specified in the same setting in the [Network] | |
2590 | section in | |
2591 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
2592 | will be used. When none of them are specified, defaults to <literal>no</literal>.</para> | |
add469f5 YW |
2593 | |
2594 | <para>It is recommended to enable this option only on trusted networks, as setting this | |
2595 | affects resolution of all hostnames, in particular of single-label names. It is generally | |
2596 | safer to use the supplied domain only as routing domain, rather than as search domain, in | |
2597 | order to not have it affect local resolution of single-label names.</para> | |
2598 | ||
2599 | <para>When set to true, this setting corresponds to the <option>domain</option> option in | |
2600 | <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
2601 | </para> | |
aefdc112 AK |
2602 | |
2603 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
2604 | </listitem> |
2605 | </varlistentry> | |
2606 | ||
2607 | <varlistentry> | |
2608 | <term><varname>UseRoutes=</varname></term> | |
2609 | <listitem> | |
2610 | <para>When true (the default), the static routes will be requested from the DHCP server and | |
2611 | added to the routing table with a metric of 1024, and a scope of <option>global</option>, | |
2612 | <option>link</option> or <option>host</option>, depending on the route's destination and | |
2613 | gateway. If the destination is on the local host, e.g., 127.x.x.x, or the same as the link's | |
2614 | own address, the scope will be set to <option>host</option>. Otherwise if the gateway is null | |
2615 | (a direct route), a <option>link</option> scope will be used. For anything else, scope | |
2616 | defaults to <option>global</option>.</para> | |
aefdc112 AK |
2617 | |
2618 | <xi:include href="version-info.xml" xpointer="v215"/> | |
add469f5 YW |
2619 | </listitem> |
2620 | </varlistentry> | |
2621 | ||
2622 | <varlistentry> | |
2623 | <term><varname>RouteMetric=</varname></term> | |
2624 | <listitem> | |
2625 | <para>Set the routing metric for routes specified by the DHCP server (including the prefix | |
2626 | route added for the specified prefix). Takes an unsigned integer in the range 0…4294967295. | |
2627 | Defaults to 1024.</para> | |
aefdc112 AK |
2628 | |
2629 | <xi:include href="version-info.xml" xpointer="v217"/> | |
add469f5 YW |
2630 | </listitem> |
2631 | </varlistentry> | |
2632 | ||
2633 | <varlistentry> | |
2634 | <term><varname>RouteTable=<replaceable>num</replaceable></varname></term> | |
2635 | <listitem> | |
7db98bc9 YW |
2636 | <para>The table identifier for DHCP routes. Takes one of predefined names |
2637 | <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, and names | |
2638 | defined in <varname>RouteTable=</varname> in | |
2639 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
2640 | or a number between 1…4294967295.</para> | |
add469f5 YW |
2641 | |
2642 | <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is | |
2643 | used when this parameter is not specified.</para> | |
aefdc112 AK |
2644 | |
2645 | <xi:include href="version-info.xml" xpointer="v232"/> | |
add469f5 YW |
2646 | </listitem> |
2647 | </varlistentry> | |
2648 | ||
2649 | <varlistentry> | |
2650 | <term><varname>RouteMTUBytes=</varname></term> | |
2651 | <listitem> | |
2652 | <para>Specifies the MTU for the DHCP routes. Please see the [Route] section for further | |
2653 | details.</para> | |
ec07c3c8 AK |
2654 | |
2655 | <xi:include href="version-info.xml" xpointer="v245"/> | |
add469f5 YW |
2656 | </listitem> |
2657 | </varlistentry> | |
2658 | ||
f95fb199 YW |
2659 | <varlistentry> |
2660 | <term><varname>QuickAck=</varname></term> | |
2661 | <listitem> | |
2662 | <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by | |
2663 | the acquired DHCPv4 lease. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
2664 | |
2665 | <xi:include href="version-info.xml" xpointer="v253"/> | |
f95fb199 YW |
2666 | </listitem> |
2667 | </varlistentry> | |
2668 | ||
cb35a0d4 SS |
2669 | <varlistentry> |
2670 | <term><varname>InitialCongestionWindow=</varname></term> | |
2671 | <listitem> | |
2672 | <para>As in the [Route] section.</para> | |
ec07c3c8 AK |
2673 | |
2674 | <xi:include href="version-info.xml" xpointer="v255"/> | |
cb35a0d4 SS |
2675 | </listitem> |
2676 | </varlistentry> | |
2677 | ||
2678 | <varlistentry> | |
2679 | <term><varname>InitialAdvertisedReceiveWindow=</varname></term> | |
2680 | <listitem> | |
2681 | <para>As in the [Route] section.</para> | |
ec07c3c8 AK |
2682 | |
2683 | <xi:include href="version-info.xml" xpointer="v255"/> | |
cb35a0d4 SS |
2684 | </listitem> |
2685 | </varlistentry> | |
2686 | ||
add469f5 YW |
2687 | <varlistentry> |
2688 | <term><varname>UseGateway=</varname></term> | |
2689 | <listitem> | |
45a7ef45 YW |
2690 | <para>When true, and the DHCP server provides a Router option, the default gateway based on the |
2691 | router address will be configured. Defaults to unset, and the value specified with | |
2692 | <varname>UseRoutes=</varname> will be used.</para> | |
2693 | ||
2694 | <para>Note, when the server provides both the Router and Classless Static Routes option, and | |
2695 | <varname>UseRoutes=</varname> is enabled, the Router option is always ignored regardless of this | |
2696 | setting. See <ulink url="https://datatracker.ietf.org/doc/html/rfc3442">RFC 3442</ulink>.</para> | |
ec07c3c8 AK |
2697 | |
2698 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2699 | </listitem> |
2700 | </varlistentry> | |
2701 | ||
2702 | <varlistentry> | |
2703 | <term><varname>UseTimezone=</varname></term> | |
2704 | <listitem><para>When true, the timezone received from the DHCP server will be set as timezone | |
aefdc112 AK |
2705 | of the local system. Defaults to false.</para> |
2706 | ||
2707 | <xi:include href="version-info.xml" xpointer="v226"/></listitem> | |
add469f5 YW |
2708 | </varlistentry> |
2709 | ||
2710 | <varlistentry> | |
2711 | <term><varname>Use6RD=</varname></term> | |
2712 | <listitem> | |
2713 | <para>When true, subnets of the received IPv6 prefix are assigned to downstream interfaces | |
2714 | which enables <varname>DHCPPrefixDelegation=</varname>. See also | |
2715 | <varname>DHCPPrefixDelegation=</varname> in the [Network] section, the [DHCPPrefixDelegation] | |
2716 | section, and <ulink url="https://tools.ietf.org/html/rfc5969">RFC 5969</ulink>. Defaults to | |
2717 | false.</para> | |
ec07c3c8 AK |
2718 | |
2719 | <xi:include href="version-info.xml" xpointer="v250"/> | |
add469f5 YW |
2720 | </listitem> |
2721 | </varlistentry> | |
2722 | ||
fc35a9f8 YW |
2723 | <varlistentry> |
2724 | <term><varname>IPv6OnlyMode=</varname></term> | |
2725 | <listitem> | |
2726 | <para>When true, the DHCPv4 configuration will be delayed by the timespan provided by the DHCP | |
2727 | server and skip to configure dynamic IPv4 network connectivity if IPv6 connectivity is provided | |
2728 | within the timespan. See <ulink url="https://tools.ietf.org/html/rfc8925">RFC 8925</ulink>. | |
7dc43183 | 2729 | Defaults to false.</para> |
fc35a9f8 YW |
2730 | |
2731 | <xi:include href="version-info.xml" xpointer="v255"/> | |
2732 | </listitem> | |
2733 | </varlistentry> | |
2734 | ||
add469f5 YW |
2735 | <varlistentry> |
2736 | <term><varname>FallbackLeaseLifetimeSec=</varname></term> | |
2737 | <listitem> | |
6eed65d4 | 2738 | <para>Allows one to set DHCPv4 lease lifetime when DHCPv4 server does not send the lease |
add469f5 YW |
2739 | lifetime. Takes one of <literal>forever</literal> or <literal>infinity</literal>. If |
2740 | specified, the acquired address never expires. Defaults to unset.</para> | |
ec07c3c8 AK |
2741 | |
2742 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2743 | </listitem> |
2744 | </varlistentry> | |
2745 | ||
2746 | <!-- How to communicate with the server --> | |
2747 | ||
2748 | <varlistentry> | |
2749 | <term><varname>RequestBroadcast=</varname></term> | |
2750 | <listitem> | |
2751 | <para>Request the server to use broadcast messages before the IP address has been configured. | |
2752 | This is necessary for devices that cannot receive RAW packets, or that cannot receive packets | |
2753 | at all before an IP address has been configured. On the other hand, this must not be enabled | |
2754 | on networks where broadcasts are filtered out.</para> | |
aefdc112 AK |
2755 | |
2756 | <xi:include href="version-info.xml" xpointer="v216"/> | |
add469f5 YW |
2757 | </listitem> |
2758 | </varlistentry> | |
2759 | ||
2760 | <varlistentry> | |
2761 | <term><varname>MaxAttempts=</varname></term> | |
2762 | <listitem> | |
2763 | <para>Specifies how many times the DHCPv4 client configuration should be attempted. Takes a | |
2764 | number or <literal>infinity</literal>. Defaults to <literal>infinity</literal>. Note that the | |
2765 | time between retries is increased exponentially, up to approximately one per minute, so the | |
2766 | network will not be overloaded even if this number is high. The default is suitable in most | |
2767 | circumstances.</para> | |
ec07c3c8 AK |
2768 | |
2769 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
2770 | </listitem> |
2771 | </varlistentry> | |
2772 | ||
2773 | <varlistentry> | |
2774 | <term><varname>ListenPort=</varname></term> | |
2775 | <listitem> | |
2776 | <para>Set the port from which the DHCP client packets originate.</para> | |
aefdc112 AK |
2777 | |
2778 | <xi:include href="version-info.xml" xpointer="v233"/> | |
add469f5 YW |
2779 | </listitem> |
2780 | </varlistentry> | |
2781 | ||
ea932bd3 MI |
2782 | <varlistentry> |
2783 | <term><varname>ServerPort=</varname></term> | |
2784 | <listitem> | |
2785 | <para>Set the port on which the DHCP server is listening.</para> | |
2786 | ||
2787 | <xi:include href="version-info.xml" xpointer="v256"/> | |
2788 | </listitem> | |
2789 | </varlistentry> | |
2790 | ||
add469f5 YW |
2791 | <varlistentry> |
2792 | <term><varname>DenyList=</varname></term> | |
2793 | <listitem> | |
2794 | <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a | |
2795 | prefix length after <literal>/</literal>. DHCP offers from servers in the list are rejected. | |
2796 | Note that if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is | |
2797 | ignored.</para> | |
cf289b14 YW |
2798 | <para>Note that this filters only DHCP offers, so the filtering may not work when |
2799 | <varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> in the above. | |
2800 | </para> | |
ec07c3c8 AK |
2801 | |
2802 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2803 | </listitem> |
2804 | </varlistentry> | |
2805 | ||
2806 | <varlistentry> | |
2807 | <term><varname>AllowList=</varname></term> | |
2808 | <listitem> | |
2809 | <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a | |
2810 | prefix length after <literal>/</literal>. DHCP offers from servers in the list are accepted. | |
2811 | </para> | |
cf289b14 YW |
2812 | <para>Note that this filters only DHCP offers, so the filtering may not work when |
2813 | <varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> in the above. | |
2814 | </para> | |
ec07c3c8 AK |
2815 | |
2816 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2817 | </listitem> |
2818 | </varlistentry> | |
2819 | ||
2820 | <varlistentry> | |
2821 | <term><varname>SendRelease=</varname></term> | |
2822 | <listitem> | |
2823 | <para>When true, the DHCPv4 client sends a DHCP release packet when it stops. Defaults to | |
2824 | true.</para> | |
ec07c3c8 AK |
2825 | |
2826 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
2827 | </listitem> |
2828 | </varlistentry> | |
2829 | ||
2830 | <varlistentry> | |
2831 | <term><varname>SendDecline=</varname></term> | |
2832 | <listitem> | |
2833 | <para>A boolean. When true, <command>systemd-networkd</command> performs IPv4 Duplicate | |
2834 | Address Detection to the acquired address by the DHCPv4 client. If duplicate is detected, | |
2835 | the DHCPv4 client rejects the address by sending a <constant>DHCPDECLINE</constant> packet to | |
2836 | the DHCP server, and tries to obtain an IP address again. See | |
2837 | <ulink url="https://tools.ietf.org/html/rfc5227">RFC 5227</ulink>. Defaults to false.</para> | |
ec07c3c8 AK |
2838 | |
2839 | <xi:include href="version-info.xml" xpointer="v245"/> | |
add469f5 YW |
2840 | </listitem> |
2841 | </varlistentry> | |
4b3590c3 TM |
2842 | |
2843 | <varlistentry> | |
2844 | <term><varname>NetLabel=</varname></term> | |
2845 | <listitem> | |
2846 | <para>This applies the NetLabel for the addresses received with DHCP, like | |
2847 | <varname>NetLabel=</varname> in [Address] section applies it to statically configured | |
2848 | addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para> | |
ec07c3c8 AK |
2849 | |
2850 | <xi:include href="version-info.xml" xpointer="v252"/> | |
4b3590c3 TM |
2851 | </listitem> |
2852 | </varlistentry> | |
fc289dd0 TM |
2853 | |
2854 | <varlistentry> | |
2855 | <term><varname>NFTSet=</varname></term> | |
2856 | <listitem> | |
2857 | <para>This applies the NFT set for the network configuration received with DHCP, like | |
2858 | <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See | |
2859 | <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or | |
2860 | <literal>prefix</literal> source types, the type of the element used in the NFT filter must be | |
2861 | <literal>ipv4_addr</literal>.</para> | |
c97f268f YW |
2862 | |
2863 | <xi:include href="version-info.xml" xpointer="v255"/> | |
fc289dd0 TM |
2864 | </listitem> |
2865 | </varlistentry> | |
add469f5 YW |
2866 | </variablelist> |
2867 | </refsect1> | |
2868 | ||
2869 | <refsect1> | |
2870 | <title>[DHCPv6] Section Options</title> | |
2871 | ||
2872 | <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the | |
2873 | <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement: | |
2874 | </para> | |
2875 | ||
2876 | <variablelist class='network-directives'> | |
2877 | ||
2878 | <!-- DHCP packet contents --> | |
2879 | ||
2880 | <varlistentry> | |
2881 | <term><varname>MUDURL=</varname></term> | |
2882 | <term><varname>IAID=</varname></term> | |
2883 | <term><varname>DUIDType=</varname></term> | |
2884 | <term><varname>DUIDRawData=</varname></term> | |
2885 | <term><varname>RequestOptions=</varname></term> | |
2886 | <listitem> | |
2887 | <para>As in the [DHCPv4] section.</para> | |
aefdc112 AK |
2888 | |
2889 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2890 | </listitem> |
2891 | </varlistentry> | |
2892 | ||
2893 | <varlistentry> | |
2894 | <term><varname>SendOption=</varname></term> | |
2895 | <listitem> | |
2896 | <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option | |
2897 | numbers, the option number is an integer in the range 1…65536.</para> | |
ec07c3c8 AK |
2898 | |
2899 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2900 | </listitem> |
2901 | </varlistentry> | |
2902 | ||
2903 | <varlistentry> | |
2904 | <term><varname>SendVendorOption=</varname></term> | |
2905 | <listitem> | |
2906 | <para>Send an arbitrary vendor option in the DHCPv6 request. Takes an enterprise identifier, | |
2907 | DHCP option number, data type, and data separated with a colon | |
2908 | (<literal><replaceable>enterprise identifier</replaceable>:<replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). | |
2909 | Enterprise identifier is an unsigned integer in the range 1…4294967294. The option number | |
2910 | must be an integer in the range 1…254. Data type takes one of <literal>uint8</literal>, | |
2911 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, | |
2912 | <literal>ipv6address</literal>, or <literal>string</literal>. Special characters in the data | |
2913 | string may be escaped using | |
2914 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style | |
2915 | escapes</ulink>. This setting can be specified multiple times. If an empty string is | |
2916 | specified, then all options specified earlier are cleared. Defaults to unset.</para> | |
ec07c3c8 AK |
2917 | |
2918 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2919 | </listitem> |
2920 | </varlistentry> | |
2921 | ||
2922 | <varlistentry> | |
2923 | <term><varname>UserClass=</varname></term> | |
2924 | <listitem> | |
2925 | <para>A DHCPv6 client can use User Class option to identify the type or category of user or | |
2926 | applications it represents. The information contained in this option is a string that | |
2927 | represents the user class of which the client is a member. Each class sets an identifying | |
2928 | string of information to be used by the DHCP service to classify clients. Special characters | |
2929 | in the data string may be escaped using | |
2930 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style | |
2931 | escapes</ulink>. This setting can be specified multiple times. If an empty string is | |
2932 | specified, then all options specified earlier are cleared. Takes a whitespace-separated list | |
2933 | of strings. Note that currently <constant>NUL</constant> bytes are not allowed.</para> | |
ec07c3c8 AK |
2934 | |
2935 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2936 | </listitem> |
2937 | </varlistentry> | |
2938 | ||
2939 | <varlistentry> | |
2940 | <term><varname>VendorClass=</varname></term> | |
2941 | <listitem> | |
2942 | <para>A DHCPv6 client can use VendorClass option to identify the vendor that manufactured the | |
2943 | hardware on which the client is running. The information contained in the data area of this | |
2944 | option is contained in one or more opaque fields that identify details of the hardware | |
2945 | configuration. Takes a whitespace-separated list of strings.</para> | |
ec07c3c8 AK |
2946 | |
2947 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
2948 | </listitem> |
2949 | </varlistentry> | |
2950 | ||
2951 | <varlistentry> | |
2952 | <term><varname>PrefixDelegationHint=</varname></term> | |
2953 | <listitem> | |
2954 | <para>Takes an IPv6 address with prefix length in the same format as the | |
2955 | <varname>Address=</varname> in the [Network] section. The DHCPv6 client will include a prefix | |
2956 | hint in the DHCPv6 solicitation sent to the server. The prefix length must be in the range | |
2957 | 1…128. Defaults to unset.</para> | |
ec07c3c8 AK |
2958 | |
2959 | <xi:include href="version-info.xml" xpointer="v244"/> | |
add469f5 YW |
2960 | </listitem> |
2961 | </varlistentry> | |
2962 | ||
50ee1fec YW |
2963 | <varlistentry> |
2964 | <term><varname>RapidCommit=</varname></term> | |
2965 | <listitem> | |
2966 | <para>Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server | |
2967 | through a rapid two-message exchange (solicit and reply). When the rapid commit option is set by | |
2968 | both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used. Otherwise, the | |
2969 | four-message exchange (solicit, advertise, request, and reply) is used. The two-message exchange | |
2970 | provides faster client configuration. See | |
2971 | <ulink url="https://tools.ietf.org/html/rfc3315#section-17.2.1">RFC 3315</ulink> for details. | |
2972 | Defaults to true, and the two-message exchange will be used if the server support it.</para> | |
ec07c3c8 AK |
2973 | |
2974 | <xi:include href="version-info.xml" xpointer="v252"/> | |
50ee1fec YW |
2975 | </listitem> |
2976 | </varlistentry> | |
2977 | ||
b90480c8 RP |
2978 | <varlistentry> |
2979 | <term><varname>SendHostname=</varname></term> | |
2980 | <listitem> | |
2981 | <para>When true (the default), the machine's hostname (or the value specified with | |
2982 | <varname>Hostname=</varname>, described below) will be sent to the DHCPv6 server. Note that the | |
2983 | hostname must consist only of 7-bit ASCII lower-case characters and no spaces or dots, and be | |
2984 | formatted as a valid DNS domain name. Otherwise, the hostname is not sent even if this option | |
2985 | is true.</para> | |
2986 | ||
2987 | <xi:include href="version-info.xml" xpointer="v255"/> | |
2988 | </listitem> | |
2989 | </varlistentry> | |
2990 | ||
2991 | <varlistentry> | |
2992 | <term><varname>Hostname=</varname></term> | |
2993 | <listitem> | |
2994 | <para>Use this value for the hostname which is sent to the DHCPv6 server, instead of machine's | |
2995 | hostname. Note that the specified hostname must consist only of 7-bit ASCII lower-case | |
2996 | characters and no spaces or dots, and be formatted as a valid DNS domain name.</para> | |
2997 | ||
2998 | <xi:include href="version-info.xml" xpointer="v255"/> | |
2999 | </listitem> | |
3000 | </varlistentry> | |
3001 | ||
add469f5 YW |
3002 | <!-- How to use the DHCP lease --> |
3003 | ||
3004 | <varlistentry> | |
3005 | <term><varname>UseAddress=</varname></term> | |
3006 | <listitem> | |
3007 | <para>When true (the default), the IP addresses provided by the DHCPv6 server will be | |
3008 | assigned.</para> | |
ec07c3c8 AK |
3009 | |
3010 | <xi:include href="version-info.xml" xpointer="v248"/> | |
add469f5 YW |
3011 | </listitem> |
3012 | </varlistentry> | |
3013 | ||
a75feb55 RP |
3014 | <varlistentry> |
3015 | <term><varname>UseCaptivePortal=</varname></term> | |
3016 | <listitem> | |
3017 | <para>When true (the default), the captive portal advertised by the DHCPv6 server will be recorded | |
bf63dadb ZJS |
3018 | and made available to client programs and displayed in the |
3019 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
3020 | status output per-link.</para> | |
ec07c3c8 AK |
3021 | |
3022 | <xi:include href="version-info.xml" xpointer="v254"/> | |
a75feb55 RP |
3023 | </listitem> |
3024 | </varlistentry> | |
3025 | ||
add469f5 YW |
3026 | <varlistentry> |
3027 | <term><varname>UseDelegatedPrefix=</varname></term> | |
3028 | <listitem> | |
3029 | <para>When true (the default), the client will request the DHCPv6 server to delegate | |
3030 | prefixes. If the server provides prefixes to be delegated, then subnets of the prefixes are | |
625d71b9 | 3031 | assigned to the interfaces that have <varname>DHCPPrefixDelegation=yes</varname>. |
add469f5 YW |
3032 | See also the <varname>DHCPPrefixDelegation=</varname> setting in the [Network] section, |
3033 | settings in the [DHCPPrefixDelegation] section, and | |
3034 | <ulink url="https://www.rfc-editor.org/rfc/rfc8415.html#section-6.3">RFC 8415</ulink>. | |
3035 | </para> | |
ec07c3c8 AK |
3036 | |
3037 | <xi:include href="version-info.xml" xpointer="v250"/> | |
add469f5 YW |
3038 | </listitem> |
3039 | </varlistentry> | |
3040 | ||
3041 | <varlistentry> | |
3042 | <term><varname>UseDNS=</varname></term> | |
3043 | <term><varname>UseNTP=</varname></term> | |
3044 | <term><varname>UseHostname=</varname></term> | |
3045 | <term><varname>UseDomains=</varname></term> | |
4b3590c3 | 3046 | <term><varname>NetLabel=</varname></term> |
b895aa5f | 3047 | <term><varname>SendRelease=</varname></term> |
add469f5 YW |
3048 | <listitem> |
3049 | <para>As in the [DHCPv4] section.</para> | |
aefdc112 AK |
3050 | |
3051 | <xi:include href="version-info.xml" xpointer="v243"/> | |
add469f5 YW |
3052 | </listitem> |
3053 | </varlistentry> | |
3054 | ||
fc289dd0 TM |
3055 | <varlistentry> |
3056 | <term><varname>NFTSet=</varname></term> | |
3057 | <listitem> | |
3058 | <para>This applies the NFT set for the network configuration received with DHCP, like | |
3059 | <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See | |
3060 | <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> | |
3061 | or <literal>prefix</literal> source types, the type of the element used in the NFT filter must be | |
3062 | <literal>ipv6_addr</literal>.</para> | |
c97f268f YW |
3063 | |
3064 | <xi:include href="version-info.xml" xpointer="v255"/> | |
fc289dd0 TM |
3065 | </listitem> |
3066 | </varlistentry> | |
3067 | ||
add469f5 YW |
3068 | <!-- How to communicate with the server --> |
3069 | ||
3070 | <varlistentry> | |
3071 | <term><varname>WithoutRA=</varname></term> | |
3072 | <listitem> | |
0bcc6557 AH |
3073 | <para>Allows DHCPv6 client to start without router advertisements's |
3074 | <literal>managed</literal> or <literal>other configuration</literal> flag. Takes one of | |
3075 | <literal>no</literal>, <literal>solicit</literal>, or | |
3076 | <literal>information-request</literal>. If this is not specified, | |
add469f5 YW |
3077 | <literal>solicit</literal> is used when <varname>DHCPPrefixDelegation=</varname> is enabled |
3078 | and <varname>UplinkInterface=:self</varname> is specified in the [DHCPPrefixDelegation] | |
3079 | section. Otherwise, defaults to <literal>no</literal>, and the DHCPv6 client will be started | |
3080 | when an RA is received. See also the <varname>DHCPv6Client=</varname> setting in the | |
3081 | [IPv6AcceptRA] section.</para> | |
ec07c3c8 AK |
3082 | |
3083 | <xi:include href="version-info.xml" xpointer="v246"/> | |
add469f5 YW |
3084 | </listitem> |
3085 | </varlistentry> | |
3086 | </variablelist> | |
caa8ca42 | 3087 | </refsect1> |
99e015e2 YW |
3088 | |
3089 | <refsect1> | |
a27588d4 | 3090 | <title>[DHCPPrefixDelegation] Section Options</title> |
31fc1366 | 3091 | <para>The [DHCPPrefixDelegation] section configures subnet prefixes of the delegated prefixes |
8b9f0921 | 3092 | acquired by a DHCPv6 client or by a DHCPv4 client through the 6RD option on another interface. |
31fc1366 YW |
3093 | The settings in this section are used only when the <varname>DHCPPrefixDelegation=</varname> |
3094 | setting in the [Network] section is enabled.</para> | |
99e015e2 YW |
3095 | |
3096 | <variablelist class='network-directives'> | |
dc5cae6c YW |
3097 | <varlistentry> |
3098 | <term><varname>UplinkInterface=</varname></term> | |
3099 | <listitem> | |
3100 | <para>Specifies the name or the index of the uplink interface, or one of the special values | |
3101 | <literal>:self</literal> and <literal>:auto</literal>. When <literal>:self</literal>, the | |
149cda85 YW |
3102 | interface itself is considered the uplink interface, and |
3103 | <varname>WithoutRA=solicit</varname> is implied if the setting is not explicitly specified. | |
3104 | When <literal>:auto</literal>, the first link which acquired prefixes to be delegated from | |
31fc1366 | 3105 | the DHCPv6 or DHCPv4 server is selected. Defaults to <literal>:auto</literal>.</para> |
ec07c3c8 AK |
3106 | |
3107 | <xi:include href="version-info.xml" xpointer="v250"/> | |
dc5cae6c YW |
3108 | </listitem> |
3109 | </varlistentry> | |
3110 | ||
99e015e2 YW |
3111 | <varlistentry> |
3112 | <term><varname>SubnetId=</varname></term> | |
3113 | <listitem> | |
3114 | <para>Configure a specific subnet ID on the interface from a (previously) received prefix | |
3115 | delegation. You can either set "auto" (the default) or a specific subnet ID (as defined in | |
3116 | <ulink url="https://tools.ietf.org/html/rfc4291#section-2.5.4">RFC 4291</ulink>, section | |
3117 | 2.5.4), in which case the allowed value is hexadecimal, from 0 to 0x7fffffffffffffff | |
e5ff2245 | 3118 | inclusive.</para> |
aefdc112 AK |
3119 | |
3120 | <xi:include href="version-info.xml" xpointer="v246"/> | |
e5ff2245 YW |
3121 | </listitem> |
3122 | </varlistentry> | |
3123 | ||
3124 | <varlistentry> | |
3125 | <term><varname>Announce=</varname></term> | |
3126 | <listitem> | |
3127 | <para>Takes a boolean. When enabled, and <varname>IPv6SendRA=</varname> in [Network] section | |
3128 | is enabled, the delegated prefixes are distributed through the IPv6 Router Advertisement. | |
31fc1366 YW |
3129 | This setting will be ignored when the <varname>DHCPPrefixDelegation=</varname> setting is |
3130 | enabled on the upstream interface. Defaults to yes.</para> | |
aefdc112 AK |
3131 | |
3132 | <xi:include href="version-info.xml" xpointer="v247"/> | |
99e015e2 YW |
3133 | </listitem> |
3134 | </varlistentry> | |
3135 | ||
3136 | <varlistentry> | |
3137 | <term><varname>Assign=</varname></term> | |
3138 | <listitem> | |
3139 | <para>Takes a boolean. Specifies whether to add an address from the delegated prefixes which | |
e5ff2245 | 3140 | are received from the WAN interface by the DHCPv6 Prefix Delegation. When true (on LAN |
6c2d70ce | 3141 | interface), the EUI-64 algorithm will be used by default to form an interface identifier from |
e5ff2245 YW |
3142 | the delegated prefixes. See also <varname>Token=</varname> setting below. Defaults to yes. |
3143 | </para> | |
aefdc112 AK |
3144 | |
3145 | <xi:include href="version-info.xml" xpointer="v246"/> | |
99e015e2 YW |
3146 | </listitem> |
3147 | </varlistentry> | |
3148 | ||
3149 | <varlistentry> | |
3150 | <term><varname>Token=</varname></term> | |
3151 | <listitem> | |
e5ff2245 | 3152 | <para>Specifies an optional address generation mode for assigning an address in each |
f5960e0a YW |
3153 | delegated prefix. This accepts the same syntax as <varname>Token=</varname> in the |
3154 | [IPv6AcceptRA] section. If <varname>Assign=</varname> is set to false, then this setting will | |
3155 | be ignored. Defaults to unset, which means the EUI-64 algorithm will be used.</para> | |
aefdc112 AK |
3156 | |
3157 | <xi:include href="version-info.xml" xpointer="v246"/> | |
99e015e2 YW |
3158 | </listitem> |
3159 | </varlistentry> | |
fec1b650 YW |
3160 | |
3161 | <varlistentry> | |
3162 | <term><varname>ManageTemporaryAddress=</varname></term> | |
3163 | <listitem> | |
3164 | <para>As in the [Address] section, but defaults to true.</para> | |
aefdc112 AK |
3165 | |
3166 | <xi:include href="version-info.xml" xpointer="v248"/> | |
fec1b650 YW |
3167 | </listitem> |
3168 | </varlistentry> | |
9fe0b7b4 YW |
3169 | |
3170 | <varlistentry> | |
3171 | <term><varname>RouteMetric=</varname></term> | |
3172 | <listitem> | |
3173 | <para>The metric of the route to the delegated prefix subnet. Takes an unsigned integer in | |
d0619f2c YW |
3174 | the range 0…4294967295. When set to 0, the kernel's default value is used. Defaults to 256. |
3175 | </para> | |
aefdc112 AK |
3176 | |
3177 | <xi:include href="version-info.xml" xpointer="v249"/> | |
9fe0b7b4 YW |
3178 | </listitem> |
3179 | </varlistentry> | |
4b3590c3 TM |
3180 | |
3181 | <varlistentry> | |
3182 | <term><varname>NetLabel=</varname></term> | |
3183 | <listitem> | |
3184 | <para>This applies the NetLabel for the addresses received with DHCP, like | |
3185 | <varname>NetLabel=</varname> in [Address] section applies it to statically configured | |
3186 | addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para> | |
ec07c3c8 AK |
3187 | |
3188 | <xi:include href="version-info.xml" xpointer="v252"/> | |
4b3590c3 TM |
3189 | </listitem> |
3190 | </varlistentry> | |
fc289dd0 TM |
3191 | |
3192 | <varlistentry> | |
3193 | <term><varname>NFTSet=</varname></term> | |
3194 | <listitem> | |
3195 | <para>This applies the NFT set for the network configuration received with DHCP, like | |
3196 | <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See | |
3197 | <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or | |
3198 | <literal>prefix</literal> source types, the type of the element used in the NFT filter must be | |
3199 | <literal>ipv6_addr</literal>.</para> | |
c97f268f YW |
3200 | |
3201 | <xi:include href="version-info.xml" xpointer="v255"/> | |
fc289dd0 TM |
3202 | </listitem> |
3203 | </varlistentry> | |
99e015e2 YW |
3204 | </variablelist> |
3205 | </refsect1> | |
413708d1 | 3206 | |
1e7a0e21 | 3207 | <refsect1> |
f921f573 | 3208 | <title>[IPv6AcceptRA] Section Options</title> |
c463ae74 YW |
3209 | <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled |
3210 | with the <varname>IPv6AcceptRA=</varname> setting described above:</para> | |
1e7a0e21 | 3211 | |
c463ae74 | 3212 | <variablelist class='network-directives'> |
6df00594 YW |
3213 | <varlistentry> |
3214 | <term><varname>UseRedirect=</varname></term> | |
3215 | <listitem> | |
3216 | <para>When true (the default), Redirect message sent by the current first-hop router will be | |
3217 | accepted, and configures routes to redirected nodes will be configured.</para> | |
3218 | ||
3219 | <xi:include href="version-info.xml" xpointer="v256"/> | |
3220 | </listitem> | |
3221 | </varlistentry> | |
3222 | ||
c463ae74 YW |
3223 | <varlistentry> |
3224 | <term><varname>Token=</varname></term> | |
3225 | <listitem> | |
3226 | <para>Specifies an optional address generation mode for the Stateless Address | |
3227 | Autoconfiguration (SLAAC). The following values are supported:</para> | |
3228 | ||
3229 | <variablelist> | |
3230 | <varlistentry> | |
3231 | <term><option>eui64</option></term> | |
3232 | <listitem> | |
3233 | <para> | |
ab106a60 YW |
3234 | The EUI-64 algorithm will be used to generate an address for that prefix. Only |
3235 | supported by Ethernet or InfiniBand interfaces. | |
c463ae74 | 3236 | </para> |
ec07c3c8 AK |
3237 | |
3238 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3239 | </listitem> |
3240 | </varlistentry> | |
3241 | <varlistentry> | |
3242 | <term><option>static:<replaceable>ADDRESS</replaceable></option></term> | |
3243 | <listitem> | |
3244 | <para> | |
3245 | An IPv6 address must be specified after a colon (<literal>:</literal>), and the | |
3246 | lower bits of the supplied address are combined with the upper bits of a prefix | |
3247 | received in a Router Advertisement (RA) message to form a complete address. Note | |
3248 | that if multiple prefixes are received in an RA message, or in multiple RA messages, | |
3249 | addresses will be formed from each of them using the supplied address. This mode | |
3250 | implements SLAAC but uses a static interface identifier instead of an identifier | |
3251 | generated by using the EUI-64 algorithm. Because the interface identifier is static, | |
3252 | if Duplicate Address Detection detects that the computed address is a duplicate | |
3253 | (in use by another node on the link), then this mode will fail to provide an address | |
3254 | for that prefix. If an IPv6 address without mode is specified, then | |
3255 | <literal>static</literal> mode is assumed. | |
3256 | </para> | |
ec07c3c8 AK |
3257 | |
3258 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3259 | </listitem> |
3260 | </varlistentry> | |
3261 | <varlistentry> | |
f2a3a133 | 3262 | <term><option>prefixstable[:<replaceable>ADDRESS</replaceable>][,<replaceable>UUID</replaceable>]</option></term> |
c463ae74 YW |
3263 | <listitem> |
3264 | <para> | |
3265 | The algorithm specified in | |
3266 | <ulink url="https://tools.ietf.org/html/rfc7217">RFC 7217</ulink> will be used to | |
3267 | generate interface identifiers. This mode can optionally take an IPv6 address | |
3268 | separated with a colon (<literal>:</literal>). If an IPv6 address is specified, | |
3269 | then an interface identifier is generated only when a prefix received in an RA | |
3270 | message matches the supplied address. | |
3271 | </para> | |
f2a3a133 YW |
3272 | <para> |
3273 | This mode can also optionally take a non-null UUID in the format which | |
3274 | <function>sd_id128_from_string()</function> accepts, e.g. | |
3275 | <literal>86b123b969ba4b7eb8b3d8605123525a</literal> or | |
3276 | <literal>86b123b9-69ba-4b7e-b8b3-d8605123525a</literal>. If a UUID is specified, the | |
3277 | value is used as the secret key to generate interface identifiers. If not specified, | |
3278 | then an application specific ID generated with the system's machine-ID will be used | |
3279 | as the secret key. See | |
3280 | <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
3281 | <citerefentry><refentrytitle>sd_id128_from_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
3282 | and | |
fe003f02 | 3283 | <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>. |
f2a3a133 | 3284 | </para> |
c463ae74 YW |
3285 | <para> |
3286 | Note that the <literal>prefixstable</literal> algorithm uses both the interface | |
3287 | name and MAC address as input to the hash to compute the interface identifier, so | |
3288 | if either of those are changed the resulting interface identifier (and address) | |
3289 | will be changed, even if the prefix received in the RA message has not been | |
3290 | changed. | |
3291 | </para> | |
ec07c3c8 AK |
3292 | |
3293 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3294 | </listitem> |
3295 | </varlistentry> | |
3296 | </variablelist> | |
3297 | ||
3298 | <para>If no address generation mode is specified (which is the default), or a received | |
3299 | prefix does not match any of the addresses provided in <literal>prefixstable</literal> | |
ab106a60 YW |
3300 | mode, then the EUI-64 algorithm will be used for Ethernet or InfiniBand interfaces, |
3301 | otherwise <literal>prefixstable</literal> will be used to form an interface identifier for | |
3302 | that prefix.</para> | |
c463ae74 YW |
3303 | |
3304 | <para>This setting can be specified multiple times. If an empty string is assigned, then | |
3305 | the all previous assignments are cleared.</para> | |
3306 | ||
3307 | <para>Examples: | |
3308 | <programlisting>Token=eui64 | |
140bf8da | 3309 | Token=::1a:2b:3c:4d |
a73628e6 YW |
3310 | Token=static:::1a:2b:3c:4d |
3311 | Token=prefixstable | |
3312 | Token=prefixstable:2002:da8:1::</programlisting></para> | |
ec07c3c8 AK |
3313 | |
3314 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3315 | </listitem> |
3316 | </varlistentry> | |
1e7a0e21 | 3317 | |
c463ae74 YW |
3318 | <varlistentry> |
3319 | <term><varname>UseDNS=</varname></term> | |
3320 | <listitem> | |
3321 | <para>When true (the default), the DNS servers received in the Router Advertisement will be used.</para> | |
1e7a0e21 | 3322 | |
c463ae74 YW |
3323 | <para>This corresponds to the <option>nameserver</option> option in <citerefentry |
3324 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
aefdc112 AK |
3325 | |
3326 | <xi:include href="version-info.xml" xpointer="v231"/> | |
c463ae74 YW |
3327 | </listitem> |
3328 | </varlistentry> | |
1e7a0e21 | 3329 | |
c463ae74 YW |
3330 | <varlistentry> |
3331 | <term><varname>UseDomains=</varname></term> | |
3332 | <listitem> | |
3333 | <para>Takes a boolean, or the special value <literal>route</literal>. When true, the domain name | |
15102ced ZJS |
3334 | received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, |
3335 | similarly to the effect of the <option>Domains=</option> setting. If set to | |
3336 | <literal>route</literal>, the domain name received via IPv6 RA will be used for routing DNS queries | |
3337 | only, but not for searching, similarly to the effect of the <option>Domains=</option> setting when | |
3338 | the argument is prefixed with <literal>~</literal>. Defaults to false.</para> | |
c463ae74 YW |
3339 | |
3340 | <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution | |
3341 | of all hostnames, in particular of single-label names. It is generally safer to use the supplied domain | |
3342 | only as routing domain, rather than as search domain, in order to not have it affect local resolution of | |
3343 | single-label names.</para> | |
3344 | ||
3345 | <para>When set to true, this setting corresponds to the <option>domain</option> option in <citerefentry | |
3346 | project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
aefdc112 AK |
3347 | |
3348 | <xi:include href="version-info.xml" xpointer="v231"/> | |
c463ae74 YW |
3349 | </listitem> |
3350 | </varlistentry> | |
2ba31d29 | 3351 | |
c463ae74 YW |
3352 | <varlistentry> |
3353 | <term><varname>RouteTable=<replaceable>num</replaceable></varname></term> | |
3354 | <listitem> | |
7db98bc9 YW |
3355 | <para>The table identifier for the routes received in the Router Advertisement. Takes one of |
3356 | predefined names <literal>default</literal>, <literal>main</literal>, and <literal>local</literal>, | |
3357 | and names defined in <varname>RouteTable=</varname> in | |
3358 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
3359 | or a number between 1…4294967295.</para> | |
3360 | ||
3361 | <para>When used in combination with <varname>VRF=</varname>, the VRF's routing table is | |
3362 | used when this parameter is not specified.</para> | |
ec07c3c8 AK |
3363 | |
3364 | <xi:include href="version-info.xml" xpointer="v232"/> | |
c463ae74 YW |
3365 | </listitem> |
3366 | </varlistentry> | |
062c2eea | 3367 | |
c463ae74 YW |
3368 | <varlistentry> |
3369 | <term><varname>RouteMetric=</varname></term> | |
3370 | <listitem> | |
6f812d28 YW |
3371 | <para>Set the routing metric for the routes received in the Router Advertisement. Takes an unsigned |
3372 | integer in the range 0…4294967295, or three unsigned integer separated with <literal>:</literal>, | |
3373 | in that case the first one is used when the router preference is high, the second is for medium | |
3374 | preference, and the last is for low preference | |
3375 | (<literal><replaceable>high</replaceable>:<replaceable>medium</replaceable>:<replaceable>low</replaceable></literal>). | |
3376 | Defaults to <literal>512:1024:2048</literal>.</para> | |
ec07c3c8 AK |
3377 | |
3378 | <xi:include href="version-info.xml" xpointer="v249"/> | |
c463ae74 YW |
3379 | </listitem> |
3380 | </varlistentry> | |
8ebafba9 | 3381 | |
f95fb199 YW |
3382 | <varlistentry> |
3383 | <term><varname>QuickAck=</varname></term> | |
3384 | <listitem> | |
3385 | <para>Takes a boolean. When true, the TCP quick ACK mode is enabled for the routes configured by | |
3386 | the received RAs. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
3387 | |
3388 | <xi:include href="version-info.xml" xpointer="v253"/> | |
f95fb199 YW |
3389 | </listitem> |
3390 | </varlistentry> | |
3391 | ||
c463ae74 YW |
3392 | <varlistentry> |
3393 | <term><varname>UseMTU=</varname></term> | |
3394 | <listitem> | |
3395 | <para>Takes a boolean. When true, the MTU received in the Router Advertisement will be | |
3396 | used. Defaults to true.</para> | |
ec07c3c8 AK |
3397 | |
3398 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3399 | </listitem> |
3400 | </varlistentry> | |
7d93b92f | 3401 | |
f141b2c0 SS |
3402 | <varlistentry> |
3403 | <term><varname>UseHopLimit=</varname></term> | |
3404 | <listitem> | |
3405 | <para>Takes a boolean. When true, the hop limit received in the Router Advertisement will be set to routes | |
3406 | configured based on the advertisement. See also <varname>IPv6HopLimit=</varname>. Defaults to true.</para> | |
ec07c3c8 AK |
3407 | |
3408 | <xi:include href="version-info.xml" xpointer="v255"/> | |
f141b2c0 SS |
3409 | </listitem> |
3410 | </varlistentry> | |
3411 | ||
1452d497 YW |
3412 | <varlistentry> |
3413 | <term><varname>UseReachableTime=</varname></term> | |
3414 | <listitem> | |
3415 | <para>Takes a boolean. When true, the reachable time received in the Router Advertisement will be | |
3416 | set on the interface receiving the advertisement. It is used as the base timespan of the validity | |
3417 | of a neighbor entry. Defaults to true.</para> | |
3418 | ||
3419 | <xi:include href="version-info.xml" xpointer="v256"/> | |
3420 | </listitem> | |
3421 | </varlistentry> | |
3422 | ||
d4c8de21 MM |
3423 | <varlistentry> |
3424 | <term><varname>UseRetransmissionTime=</varname></term> | |
3425 | <listitem> | |
3426 | <para>Takes a boolean. When true, the retransmission time received in the Router Advertisement will be set | |
3427 | on the interface receiving the advertisement. It is used as the time between retransmissions of Neighbor | |
3428 | Solicitation messages to a neighbor when resolving the address or when probing the reachability of a neighbor. | |
3429 | Defaults to true.</para> | |
3430 | ||
3431 | <xi:include href="version-info.xml" xpointer="v256"/> | |
3432 | </listitem> | |
3433 | </varlistentry> | |
3434 | ||
c463ae74 YW |
3435 | <varlistentry> |
3436 | <term><varname>UseGateway=</varname></term> | |
3437 | <listitem> | |
3438 | <para>When true (the default), the router address will be configured as the default gateway. | |
3439 | </para> | |
ec07c3c8 AK |
3440 | |
3441 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3442 | </listitem> |
3443 | </varlistentry> | |
610c0db1 | 3444 | |
c463ae74 YW |
3445 | <varlistentry> |
3446 | <term><varname>UseRoutePrefix=</varname></term> | |
3447 | <listitem> | |
3448 | <para>When true (the default), the routes corresponding to the route prefixes received in | |
3449 | the Router Advertisement will be configured.</para> | |
ec07c3c8 AK |
3450 | |
3451 | <xi:include href="version-info.xml" xpointer="v250"/> | |
c463ae74 YW |
3452 | </listitem> |
3453 | </varlistentry> | |
610c0db1 | 3454 | |
d74c4ce1 RP |
3455 | <varlistentry> |
3456 | <term><varname>UseCaptivePortal=</varname></term> | |
3457 | <listitem> | |
3458 | <para>When true (the default), the captive portal received in the Router Advertisement will be recorded | |
bf63dadb ZJS |
3459 | and made available to client programs and displayed in the |
3460 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
3461 | status output per-link.</para> | |
ec07c3c8 AK |
3462 | |
3463 | <xi:include href="version-info.xml" xpointer="v254"/> | |
d74c4ce1 RP |
3464 | </listitem> |
3465 | </varlistentry> | |
3466 | ||
6e8f5e4c SS |
3467 | <varlistentry> |
3468 | <term><varname>UsePREF64=</varname></term> | |
3469 | <listitem> | |
bf63dadb ZJS |
3470 | <para>When true, the IPv6 PREF64 (or NAT64) prefixes received in the Router Advertisement will be |
3471 | recorded and made available to client programs and displayed in the | |
3472 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
3473 | status output per-link. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink>. | |
3474 | Defaults to false.</para> | |
6e8f5e4c SS |
3475 | |
3476 | <xi:include href="version-info.xml" xpointer="v255"/> | |
3477 | </listitem> | |
3478 | </varlistentry> | |
3479 | ||
c463ae74 YW |
3480 | <varlistentry> |
3481 | <term><varname>UseAutonomousPrefix=</varname></term> | |
3482 | <listitem> | |
3483 | <para>When true (the default), the autonomous prefix received in the Router Advertisement will be used and take | |
3484 | precedence over any statically configured ones.</para> | |
ec07c3c8 AK |
3485 | |
3486 | <xi:include href="version-info.xml" xpointer="v242"/> | |
c463ae74 YW |
3487 | </listitem> |
3488 | </varlistentry> | |
062c2eea | 3489 | |
c463ae74 YW |
3490 | <varlistentry> |
3491 | <term><varname>UseOnLinkPrefix=</varname></term> | |
3492 | <listitem> | |
3493 | <para>When true (the default), the onlink prefix received in the Router Advertisement will be | |
3494 | used and takes precedence over any statically configured ones.</para> | |
ec07c3c8 AK |
3495 | |
3496 | <xi:include href="version-info.xml" xpointer="v242"/> | |
c463ae74 YW |
3497 | </listitem> |
3498 | </varlistentry> | |
062c2eea | 3499 | |
c463ae74 YW |
3500 | <varlistentry> |
3501 | <term><varname>RouterDenyList=</varname></term> | |
3502 | <listitem> | |
3503 | <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally | |
3504 | take a prefix length after <literal>/</literal>. Any information advertised by the listed | |
3505 | router is ignored.</para> | |
ec07c3c8 AK |
3506 | |
3507 | <xi:include href="version-info.xml" xpointer="v248"/> | |
c463ae74 YW |
3508 | </listitem> |
3509 | </varlistentry> | |
75d26411 | 3510 | |
c463ae74 YW |
3511 | <varlistentry> |
3512 | <term><varname>RouterAllowList=</varname></term> | |
3513 | <listitem> | |
3514 | <para>A whitespace-separated list of IPv6 router addresses. Each address can optionally | |
3515 | take a prefix length after <literal>/</literal>. Only information advertised by the listed | |
3516 | router is accepted. Note that if <varname>RouterAllowList=</varname> is configured then | |
3517 | <varname>RouterDenyList=</varname> is ignored.</para> | |
ec07c3c8 AK |
3518 | |
3519 | <xi:include href="version-info.xml" xpointer="v248"/> | |
c463ae74 YW |
3520 | </listitem> |
3521 | </varlistentry> | |
75d26411 | 3522 | |
c463ae74 YW |
3523 | <varlistentry> |
3524 | <term><varname>PrefixDenyList=</varname></term> | |
3525 | <listitem> | |
3526 | <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its | |
3527 | prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements | |
3528 | in the list are ignored.</para> | |
ec07c3c8 AK |
3529 | |
3530 | <xi:include href="version-info.xml" xpointer="v248"/> | |
c463ae74 YW |
3531 | </listitem> |
3532 | </varlistentry> | |
16c89e64 | 3533 | |
c463ae74 YW |
3534 | <varlistentry> |
3535 | <term><varname>PrefixAllowList=</varname></term> | |
3536 | <listitem> | |
3537 | <para>A whitespace-separated list of IPv6 prefixes. Each prefix can optionally take its | |
3538 | prefix length after <literal>/</literal>. IPv6 prefixes supplied via router advertisements | |
3539 | in the list are allowed. Note that if <varname>PrefixAllowList=</varname> is configured | |
3540 | then <varname>PrefixDenyList=</varname> is ignored.</para> | |
ec07c3c8 AK |
3541 | |
3542 | <xi:include href="version-info.xml" xpointer="v248"/> | |
c463ae74 YW |
3543 | </listitem> |
3544 | </varlistentry> | |
de6b6ff8 | 3545 | |
c463ae74 YW |
3546 | <varlistentry> |
3547 | <term><varname>RouteDenyList=</varname></term> | |
3548 | <listitem> | |
3549 | <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take | |
3550 | its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router | |
3551 | advertisements in the list are ignored.</para> | |
ec07c3c8 AK |
3552 | |
3553 | <xi:include href="version-info.xml" xpointer="v248"/> | |
c463ae74 YW |
3554 | </listitem> |
3555 | </varlistentry> | |
e520ce64 | 3556 | |
c463ae74 YW |
3557 | <varlistentry> |
3558 | <term><varname>RouteAllowList=</varname></term> | |
3559 | <listitem> | |
3560 | <para>A whitespace-separated list of IPv6 route prefixes. Each prefix can optionally take | |
3561 | its prefix length after <literal>/</literal>. IPv6 route prefixes supplied via router | |
3562 | advertisements in the list are allowed. Note that if <varname>RouteAllowList=</varname> is | |
3563 | configured then <varname>RouteDenyList=</varname> is ignored.</para> | |
ec07c3c8 AK |
3564 | |
3565 | <xi:include href="version-info.xml" xpointer="v248"/> | |
c463ae74 YW |
3566 | </listitem> |
3567 | </varlistentry> | |
de6b6ff8 | 3568 | |
c463ae74 YW |
3569 | <varlistentry> |
3570 | <term><varname>DHCPv6Client=</varname></term> | |
3571 | <listitem> | |
3572 | <para>Takes a boolean, or the special value <literal>always</literal>. When true, the | |
0bcc6557 AH |
3573 | DHCPv6 client will be started in <literal>solicit</literal> mode if the RA has the |
3574 | <literal>managed</literal> flag or <literal>information-request</literal> mode if the RA | |
3575 | lacks the <literal>managed</literal> flag but has the | |
3576 | <literal>other configuration</literal> flag. If set to <literal>always</literal>, the | |
3577 | DHCPv6 client will be started in <literal>solicit</literal> mode when an RA is received, | |
3578 | even if neither the <literal>managed</literal> nor the | |
3579 | <literal>other configuration</literal> flag is set in the RA. This will be ignored when | |
3580 | <varname>WithoutRA=</varname> in the [DHCPv6] section is enabled, or | |
a27588d4 | 3581 | <varname>UplinkInterface=:self</varname> in the [DHCPPrefixDelegation] section is |
c463ae74 | 3582 | specified. Defaults to true.</para> |
ec07c3c8 AK |
3583 | |
3584 | <xi:include href="version-info.xml" xpointer="v246"/> | |
c463ae74 YW |
3585 | </listitem> |
3586 | </varlistentry> | |
4b3590c3 TM |
3587 | |
3588 | <varlistentry> | |
3589 | <term><varname>NetLabel=</varname></term> | |
3590 | <listitem> | |
3591 | <para>This applies the NetLabel for the addresses received with RA, like | |
3592 | <varname>NetLabel=</varname> in [Address] section applies it to statically configured | |
3593 | addresses. See <varname>NetLabel=</varname> in [Address] section for more details.</para> | |
ec07c3c8 AK |
3594 | |
3595 | <xi:include href="version-info.xml" xpointer="v252"/> | |
4b3590c3 TM |
3596 | </listitem> |
3597 | </varlistentry> | |
fc289dd0 TM |
3598 | |
3599 | <varlistentry> | |
3600 | <term><varname>NFTSet=</varname></term> | |
3601 | <listitem> | |
3602 | <para>This applies the NFT set for the network configuration received with RA, like | |
3603 | <varname>NFTSet=</varname> in [Address] section applies it to static configuration. See | |
3604 | <varname>NFTSet=</varname> in [Address] section for more details. For <literal>address</literal> or | |
3605 | <literal>prefix</literal> source types, the type of the element used in the NFT filter must be | |
3606 | <literal>ipv6_addr</literal>.</para> | |
c97f268f YW |
3607 | |
3608 | <xi:include href="version-info.xml" xpointer="v255"/> | |
fc289dd0 TM |
3609 | </listitem> |
3610 | </varlistentry> | |
c463ae74 | 3611 | </variablelist> |
1e7a0e21 LP |
3612 | </refsect1> |
3613 | ||
ad943783 LP |
3614 | <refsect1> |
3615 | <title>[DHCPServer] Section Options</title> | |
bdac5608 | 3616 | <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the |
ad943783 LP |
3617 | <varname>DHCPServer=</varname> option described above:</para> |
3618 | ||
3619 | <variablelist class='network-directives'> | |
3620 | ||
0017ba31 YW |
3621 | <varlistentry> |
3622 | <term><varname>ServerAddress=</varname></term> | |
e443a88a YW |
3623 | <listitem> |
3624 | <para>Specifies the server address for the DHCP server. Takes an IPv4 address with prefix length | |
3625 | separated with a slash, e.g. <literal>192.168.0.1/24</literal>. Defaults to unset, and one of | |
3626 | static IPv4 addresses configured in [Network] or [Address] section will be automatically selected. | |
3627 | This setting may be useful when the interface on which the DHCP server is running has multiple | |
3628 | static IPv4 addresses.</para> | |
3629 | <para>This implies <varname>Address=</varname> in [Network] or [Address] section with the same | |
3630 | address and prefix length. That is, | |
3631 | <programlisting>[Network] | |
3632 | DHCPServer=yes | |
3633 | Address=192.168.0.1/24 | |
3634 | Address=192.168.0.2/24 | |
3635 | [DHCPServer] | |
3636 | ServerAddress=192.168.0.1/24</programlisting> | |
3637 | or | |
3638 | <programlisting>[Network] | |
3639 | DHCPServer=yes | |
3640 | [Address] | |
3641 | Address=192.168.0.1/24 | |
3642 | [Address] | |
3643 | Address=192.168.0.2/24 | |
3644 | [DHCPServer] | |
3645 | ServerAddress=192.168.0.1/24</programlisting> | |
cc59d101 | 3646 | are equivalent to the following: |
e443a88a YW |
3647 | <programlisting>[Network] |
3648 | DHCPServer=yes | |
3649 | Address=192.168.0.2/24 | |
3650 | [DHCPServer] | |
3651 | ServerAddress=192.168.0.1/24</programlisting> | |
3652 | </para> | |
3653 | <para>Since version 255, like the <varname>Address=</varname> setting in [Network] or [Address] | |
3654 | section, this also supports a null address, e.g. <literal>0.0.0.0/24</literal>, and an unused | |
3655 | address will be automatically selected. For more details about the automatic address selection, | |
3656 | see <varname>Address=</varname> setting in [Network] section in the above.</para> | |
ec07c3c8 | 3657 | |
e443a88a YW |
3658 | <xi:include href="version-info.xml" xpointer="v249"/> |
3659 | </listitem> | |
0017ba31 YW |
3660 | </varlistentry> |
3661 | ||
9b3a67c5 TG |
3662 | <varlistentry> |
3663 | <term><varname>PoolOffset=</varname></term> | |
3664 | <term><varname>PoolSize=</varname></term> | |
3665 | ||
3666 | <listitem><para>Configures the pool of addresses to hand out. The pool | |
3667 | is a contiguous sequence of IP addresses in the subnet configured for | |
3668 | the server address, which does not include the subnet nor the broadcast | |
3669 | address. <varname>PoolOffset=</varname> takes the offset of the pool | |
3670 | from the start of subnet, or zero to use the default value. | |
3671 | <varname>PoolSize=</varname> takes the number of IP addresses in the | |
b938cb90 | 3672 | pool or zero to use the default value. By default, the pool starts at |
9b3a67c5 TG |
3673 | the first address after the subnet address and takes up the rest of |
3674 | the subnet, excluding the broadcast address. If the pool includes | |
3675 | the server address (the default), this is reserved and not handed | |
ec07c3c8 AK |
3676 | out to clients.</para> |
3677 | ||
3678 | <xi:include href="version-info.xml" xpointer="v226"/></listitem> | |
9b3a67c5 TG |
3679 | </varlistentry> |
3680 | ||
ad943783 LP |
3681 | <varlistentry> |
3682 | <term><varname>DefaultLeaseTimeSec=</varname></term> | |
3683 | <term><varname>MaxLeaseTimeSec=</varname></term> | |
3684 | ||
3685 | <listitem><para>Control the default and maximum DHCP lease | |
3686 | time to pass to clients. These settings take time values in seconds or | |
3687 | another common time unit, depending on the suffix. The default | |
3688 | lease time is used for clients that did not ask for a specific | |
3689 | lease time. If a client asks for a lease time longer than the | |
b938cb90 | 3690 | maximum lease time, it is automatically shortened to the |
ad943783 LP |
3691 | specified time. The default lease time defaults to 1h, the |
3692 | maximum lease time to 12h. Shorter lease times are beneficial | |
3693 | if the configuration data in DHCP leases changes frequently | |
3694 | and clients shall learn the new settings with shorter | |
3695 | latencies. Longer lease times reduce the generated DHCP | |
ec07c3c8 AK |
3696 | network traffic.</para> |
3697 | ||
3698 | <xi:include href="version-info.xml" xpointer="v226"/></listitem> | |
ad943783 LP |
3699 | </varlistentry> |
3700 | ||
165d7c5c YW |
3701 | <varlistentry> |
3702 | <term><varname>UplinkInterface=</varname></term> | |
2b242926 YW |
3703 | <listitem><para>Specifies the name or the index of the uplink interface, or one of the special |
3704 | values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS, NTP, or SIP | |
3705 | servers is enabled but no servers are specified, the servers configured in the uplink interface | |
3706 | will be emitted. When <literal>:auto</literal>, the link which has a default gateway with the | |
3707 | highest priority will be automatically selected. When <literal>:none</literal>, no uplink | |
ec07c3c8 AK |
3708 | interface will be selected. Defaults to <literal>:auto</literal>.</para> |
3709 | ||
3710 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
165d7c5c YW |
3711 | </varlistentry> |
3712 | ||
ad943783 LP |
3713 | <varlistentry> |
3714 | <term><varname>EmitDNS=</varname></term> | |
3715 | <term><varname>DNS=</varname></term> | |
3716 | ||
2a71d57f | 3717 | <listitem><para><varname>EmitDNS=</varname> takes a boolean. Configures whether the DHCP leases |
5f468b9f YW |
3718 | handed out to clients shall contain DNS server information. Defaults to <literal>yes</literal>. |
3719 | The DNS servers to pass to clients may be configured with the <varname>DNS=</varname> option, | |
3720 | which takes a list of IPv4 addresses, or special value <literal>_server_address</literal> which | |
faa1b3c6 YW |
3721 | will be converted to the address used by the DHCP server.</para> |
3722 | ||
3723 | <para>If the <varname>EmitDNS=</varname> option is enabled but no servers configured, the | |
3724 | servers are automatically propagated from an "uplink" interface that has appropriate servers | |
3725 | set. The "uplink" interface is determined by the default route of the system with the highest | |
3726 | priority. Note that this information is acquired at the time the lease is handed out, and does | |
3727 | not take uplink interfaces into account that acquire DNS server information at a later point. | |
3728 | If no suitable uplink interface is found the DNS server data from | |
3729 | <filename>/etc/resolv.conf</filename> is used. Also, note that the leases are not refreshed if | |
3730 | the uplink network configuration changes. To ensure clients regularly acquire the most current | |
3731 | uplink DNS server information, it is thus advisable to shorten the DHCP lease time via | |
3732 | <varname>MaxLeaseTimeSec=</varname> described above.</para> | |
3733 | ||
3734 | <para>This setting can be specified multiple times. If an empty string is specified, then all | |
ec07c3c8 AK |
3735 | DNS servers specified earlier are cleared.</para> |
3736 | ||
3737 | <xi:include href="version-info.xml" xpointer="v226"/></listitem> | |
ad943783 LP |
3738 | </varlistentry> |
3739 | ||
3740 | <varlistentry> | |
3741 | <term><varname>EmitNTP=</varname></term> | |
3742 | <term><varname>NTP=</varname></term> | |
299d578f SS |
3743 | <term><varname>EmitSIP=</varname></term> |
3744 | <term><varname>SIP=</varname></term> | |
2a71d57f LP |
3745 | <term><varname>EmitPOP3=</varname></term> |
3746 | <term><varname>POP3=</varname></term> | |
3747 | <term><varname>EmitSMTP=</varname></term> | |
3748 | <term><varname>SMTP=</varname></term> | |
3749 | <term><varname>EmitLPR=</varname></term> | |
3750 | <term><varname>LPR=</varname></term> | |
3751 | ||
3752 | <listitem><para>Similar to the <varname>EmitDNS=</varname> and <varname>DNS=</varname> settings | |
3753 | described above, these settings configure whether and what server information for the indicate | |
3754 | protocol shall be emitted as part of the DHCP lease. The same syntax, propagation semantics and | |
aefdc112 AK |
3755 | defaults apply as for <varname>EmitDNS=</varname> and <varname>DNS=</varname>.</para> |
3756 | ||
3757 | <xi:include href="version-info.xml" xpointer="v226"/></listitem> | |
284e8fd0 SS |
3758 | </varlistentry> |
3759 | ||
77ff6022 CG |
3760 | <varlistentry> |
3761 | <term><varname>EmitRouter=</varname></term> | |
59aa6220 YW |
3762 | <term><varname>Router=</varname></term> |
3763 | ||
3764 | <listitem><para>The <varname>EmitRouter=</varname> setting takes a boolean value, and configures | |
3765 | whether the DHCP lease should contain the router option. The <varname>Router=</varname> setting | |
3766 | takes an IPv4 address, and configures the router address to be emitted. When the | |
3767 | <varname>Router=</varname> setting is not specified, then the server address will be used for | |
3768 | the router option. When the <varname>EmitRouter=</varname> setting is disabled, the | |
3769 | <varname>Router=</varname> setting will be ignored. The <varname>EmitRouter=</varname> setting | |
3770 | defaults to true, and the <varname>Router=</varname> setting defaults to unset. | |
aefdc112 AK |
3771 | </para> |
3772 | ||
3773 | <xi:include href="version-info.xml" xpointer="v230"/></listitem> | |
77ff6022 CG |
3774 | </varlistentry> |
3775 | ||
ad943783 LP |
3776 | <varlistentry> |
3777 | <term><varname>EmitTimezone=</varname></term> | |
3778 | <term><varname>Timezone=</varname></term> | |
3779 | ||
9b6ffef3 YW |
3780 | <listitem><para>Takes a boolean. Configures whether the DHCP leases handed out |
3781 | to clients shall contain timezone information. Defaults to <literal>yes</literal>. The | |
ad943783 LP |
3782 | <varname>Timezone=</varname> setting takes a timezone string |
3783 | (such as <literal>Europe/Berlin</literal> or | |
3784 | <literal>UTC</literal>) to pass to clients. If no explicit | |
b938cb90 | 3785 | timezone is set, the system timezone of the local host is |
ad943783 | 3786 | propagated, as determined by the |
ec07c3c8 AK |
3787 | <filename>/etc/localtime</filename> symlink.</para> |
3788 | ||
3789 | <xi:include href="version-info.xml" xpointer="v226"/></listitem> | |
ad943783 LP |
3790 | </varlistentry> |
3791 | ||
369ac192 | 3792 | <varlistentry> |
6278e428 | 3793 | <term><varname>BootServerAddress=</varname></term> |
369ac192 YW |
3794 | |
3795 | <listitem> | |
94f7ee97 ZJS |
3796 | <para>Takes an IPv4 address of the boot server used by e.g. PXE boot systems. When specified, this |
3797 | address is sent in the <option>siaddr</option> field of the DHCP message header. See <ulink | |
3798 | url="https://www.rfc-editor.org/rfc/rfc2131.html">RFC 2131</ulink> for more details. Defaults to | |
3799 | unset.</para> | |
ec07c3c8 AK |
3800 | |
3801 | <xi:include href="version-info.xml" xpointer="v251"/> | |
369ac192 YW |
3802 | </listitem> |
3803 | </varlistentry> | |
3804 | ||
3805 | <varlistentry> | |
6278e428 | 3806 | <term><varname>BootServerName=</varname></term> |
369ac192 YW |
3807 | |
3808 | <listitem> | |
94f7ee97 ZJS |
3809 | <para>Takes a name of the boot server used by e.g. PXE boot systems. When specified, this name is |
3810 | sent in the DHCP option 66 ("TFTP server name"). See <ulink | |
3811 | url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to | |
3812 | unset.</para> | |
3813 | ||
3814 | <para>Note that typically setting one of <varname>BootServerName=</varname> or | |
3815 | <varname>BootServerAddress=</varname> is sufficient, but both can be set too, if desired.</para> | |
ec07c3c8 AK |
3816 | |
3817 | <xi:include href="version-info.xml" xpointer="v251"/> | |
6278e428 YW |
3818 | </listitem> |
3819 | </varlistentry> | |
3820 | ||
3821 | <varlistentry> | |
3822 | <term><varname>BootFilename=</varname></term> | |
3823 | ||
3824 | <listitem> | |
94f7ee97 ZJS |
3825 | <para>Takes a path or URL to a file loaded by e.g. a PXE boot loader. When specified, this path is |
3826 | sent in the DHCP option 67 ("Bootfile name"). See <ulink | |
3827 | url="https://www.rfc-editor.org/rfc/rfc2132.html">RFC 2132</ulink> for more details. Defaults to | |
3828 | unset.</para> | |
ec07c3c8 AK |
3829 | |
3830 | <xi:include href="version-info.xml" xpointer="v251"/> | |
369ac192 YW |
3831 | </listitem> |
3832 | </varlistentry> | |
3833 | ||
34bea0a1 SS |
3834 | <varlistentry> |
3835 | <term><varname>IPv6OnlyPreferredSec=</varname></term> | |
3836 | ||
3837 | <listitem> | |
3838 | <para>Takes a timespan. Controls the | |
3839 | <ulink url="https://tools.ietf.org/html/rfc8925">RFC 8925</ulink> IPv6-Only Preferred option. | |
3840 | Specifies the DHCPv4 option to indicate that a host supports an IPv6-only mode and is willing to | |
3841 | forgo obtaining an IPv4 address if the network provides IPv6 connectivity. Defaults to unset, and | |
3842 | not send the option. The minimum allowed value is 300 seconds.</para> | |
3843 | ||
3844 | <xi:include href="version-info.xml" xpointer="v255"/> | |
3845 | </listitem> | |
3846 | </varlistentry> | |
3847 | ||
564ca984 | 3848 | <varlistentry> |
d8b736bd YW |
3849 | <term><varname>SendOption=</varname></term> |
3850 | <listitem> | |
3851 | <para>Send a raw option with value via DHCPv4 server. Takes a DHCP option number, data type | |
3852 | and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). | |
1d3a473b | 3853 | The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>, |
e7d5fe17 | 3854 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, <literal>ipv6address</literal>, or |
7354900d DW |
3855 | <literal>string</literal>. Special characters in the data string may be escaped using |
3856 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style | |
3857 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, | |
3858 | then all options specified earlier are cleared. Defaults to unset.</para> | |
ec07c3c8 AK |
3859 | |
3860 | <xi:include href="version-info.xml" xpointer="v244"/> | |
7354900d DW |
3861 | </listitem> |
3862 | </varlistentry> | |
3863 | ||
3864 | <varlistentry> | |
3865 | <term><varname>SendVendorOption=</varname></term> | |
3866 | <listitem> | |
3867 | <para>Send a vendor option with value via DHCPv4 server. Takes a DHCP option number, data type | |
3868 | and data (<literal><replaceable>option</replaceable>:<replaceable>type</replaceable>:<replaceable>value</replaceable></literal>). | |
1d3a473b | 3869 | The option number is an integer in the range 1…254. The type takes one of <literal>uint8</literal>, |
d8b736bd YW |
3870 | <literal>uint16</literal>, <literal>uint32</literal>, <literal>ipv4address</literal>, or |
3871 | <literal>string</literal>. Special characters in the data string may be escaped using | |
3872 | <ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C-style | |
3873 | escapes</ulink>. This setting can be specified multiple times. If an empty string is specified, | |
3874 | then all options specified earlier are cleared. Defaults to unset.</para> | |
ec07c3c8 AK |
3875 | |
3876 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d8b736bd | 3877 | </listitem> |
564ca984 | 3878 | </varlistentry> |
21b6b87e YA |
3879 | <varlistentry> |
3880 | <term><varname>BindToInterface=</varname></term> | |
11c38d3e YA |
3881 | <listitem> |
3882 | <para>Takes a boolean value. When <literal>yes</literal>, DHCP server socket will be bound | |
3883 | to its network interface and all socket communication will be restricted to this interface. | |
3884 | Defaults to <literal>yes</literal>, except if <varname>RelayTarget=</varname> is used (see below), | |
84b10e53 | 3885 | in which case it defaults to <literal>no</literal>.</para> |
ec07c3c8 AK |
3886 | |
3887 | <xi:include href="version-info.xml" xpointer="v249"/> | |
11c38d3e YA |
3888 | </listitem> |
3889 | </varlistentry> | |
3890 | <varlistentry> | |
3891 | <term><varname>RelayTarget=</varname></term> | |
3892 | <listitem> | |
3893 | <para>Takes an IPv4 address, which must be in the format described in | |
3894 | <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
3895 | Turns this DHCP server into a DHCP relay agent. See <ulink url="https://tools.ietf.org/html/rfc1542">RFC 1542</ulink>. | |
3896 | The address is the address of DHCP server or another relay agent to forward DHCP messages to and from.</para> | |
ec07c3c8 AK |
3897 | |
3898 | <xi:include href="version-info.xml" xpointer="v249"/> | |
11c38d3e YA |
3899 | </listitem> |
3900 | </varlistentry> | |
3901 | <varlistentry> | |
3902 | <term><varname>RelayAgentCircuitId=</varname></term> | |
3903 | <listitem> | |
3904 | <para>Specifies value for Agent Circuit ID suboption of Relay Agent Information option. | |
3905 | Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>, | |
3906 | where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption. | |
3907 | Defaults to unset (means no Agent Circuit ID suboption is generated). | |
3908 | Ignored if <varname>RelayTarget=</varname> is not specified.</para> | |
ec07c3c8 AK |
3909 | |
3910 | <xi:include href="version-info.xml" xpointer="v249"/> | |
11c38d3e YA |
3911 | </listitem> |
3912 | </varlistentry> | |
3913 | <varlistentry> | |
3914 | <term><varname>RelayAgentRemoteId=</varname></term> | |
3915 | <listitem> | |
3916 | <para>Specifies value for Agent Remote ID suboption of Relay Agent Information option. | |
3917 | Takes a string, which must be in the format <literal>string:<replaceable>value</replaceable></literal>, | |
3918 | where <literal><replaceable>value</replaceable></literal> should be replaced with the value of the suboption. | |
3919 | Defaults to unset (means no Agent Remote ID suboption is generated). | |
3920 | Ignored if <varname>RelayTarget=</varname> is not specified.</para> | |
ec07c3c8 AK |
3921 | |
3922 | <xi:include href="version-info.xml" xpointer="v249"/> | |
21b6b87e YA |
3923 | </listitem> |
3924 | </varlistentry> | |
564ca984 | 3925 | |
1fa0a4ef YW |
3926 | <varlistentry> |
3927 | <term><varname>RapidCommit=</varname></term> | |
3928 | <listitem> | |
3929 | <para>Takes a boolean. When true, the server supports | |
3930 | <ulink url="https://datatracker.ietf.org/doc/html/rfc4039">RFC 4039</ulink>. When a client sends | |
3931 | a DHCPDISCOVER message with the Rapid Commit option to the server, then the server will reply with | |
3932 | a DHCPACK message to the client, instead of DHCPOFFER. Defaults to true.</para> | |
3933 | ||
3934 | <xi:include href="version-info.xml" xpointer="v255"/> | |
3935 | </listitem> | |
3936 | </varlistentry> | |
3937 | ||
a3ed665a YW |
3938 | <varlistentry> |
3939 | <term><varname>PersistLeases=</varname></term> | |
3940 | <listitem> | |
3941 | <para>Takes a boolean. When true, the DHCP server will load and save leases in the persistent | |
3942 | storage. When false, the DHCP server will neither load nor save leases in the persistent storage. | |
3943 | Hence, bound leases will be lost when the interface is reconfigured e.g. by | |
3944 | <command>networkctl reconfigure</command>, or <filename>systemd-networkd.service</filename> | |
3945 | is restarted. That may cause address conflict on the network. So, please take an extra care when | |
3946 | disable this setting. When unspecified, the value specified in the same setting in | |
3947 | <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
3948 | which defaults to <literal>yes</literal>, will be used.</para> | |
3949 | ||
3950 | <xi:include href="version-info.xml" xpointer="v256"/> | |
3951 | </listitem> | |
3952 | </varlistentry> | |
3953 | ||
ad943783 LP |
3954 | </variablelist> |
3955 | </refsect1> | |
3956 | ||
c517a49b | 3957 | <refsect1> |
3958 | <title>[DHCPServerStaticLease] Section Options</title> | |
be0d27ee ZJS |
3959 | <para>The <literal>[DHCPServerStaticLease]</literal> section configures a static DHCP lease to assign a |
3960 | fixed IPv4 address to a specific device based on its MAC address. This section can be specified multiple | |
3961 | times.</para> | |
c517a49b | 3962 | |
3963 | <variablelist class='network-directives'> | |
3964 | <varlistentry> | |
3965 | <term><varname>MACAddress=</varname></term> | |
3966 | ||
aefdc112 AK |
3967 | <listitem><para>The hardware address of a device to match. This key is mandatory.</para> |
3968 | ||
3969 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
c517a49b | 3970 | </varlistentry> |
3971 | ||
3972 | <varlistentry> | |
3973 | <term><varname>Address=</varname></term> | |
3974 | ||
be0d27ee | 3975 | <listitem><para>The IPv4 address that should be assigned to the device that was matched with |
ec07c3c8 AK |
3976 | <varname>MACAddress=</varname>. This key is mandatory.</para> |
3977 | ||
3978 | <xi:include href="version-info.xml" xpointer="v249"/></listitem> | |
c517a49b | 3979 | </varlistentry> |
3980 | </variablelist> | |
3981 | </refsect1> | |
3982 | ||
798d3a52 | 3983 | <refsect1> |
e5ff2245 YW |
3984 | <title>[IPv6SendRA] Section Options</title> |
3985 | <para>The [IPv6SendRA] section contains settings for sending IPv6 Router Advertisements and whether | |
3986 | to act as a router, if enabled via the <varname>IPv6SendRA=</varname> option described above. IPv6 | |
3987 | network prefixes or routes are defined with one or more [IPv6Prefix] or [IPv6RoutePrefix] sections. | |
3988 | </para> | |
3f9e0236 PF |
3989 | |
3990 | <variablelist class='network-directives'> | |
3991 | ||
3992 | <varlistentry> | |
3993 | <term><varname>Managed=</varname></term> | |
3994 | <term><varname>OtherInformation=</varname></term> | |
3995 | ||
9b6ffef3 YW |
3996 | <listitem><para>Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6 |
3997 | addresses on the network link when <varname>Managed=</varname> | |
3f9e0236 PF |
3998 | is set to <literal>true</literal> or if only additional network |
3999 | information can be obtained via DHCPv6 for the network link when | |
9b6ffef3 | 4000 | <varname>OtherInformation=</varname> is set to |
3f9e0236 PF |
4001 | <literal>true</literal>. Both settings default to |
4002 | <literal>false</literal>, which means that a DHCPv6 server is not being | |
aefdc112 AK |
4003 | used.</para> |
4004 | ||
4005 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
3f9e0236 PF |
4006 | </varlistentry> |
4007 | ||
4008 | <varlistentry> | |
4009 | <term><varname>RouterLifetimeSec=</varname></term> | |
4010 | ||
17cd1f62 ZJS |
4011 | <listitem><para>Takes a timespan. Configures the IPv6 router lifetime in seconds. The value must be 0 |
4012 | seconds, or between 4 seconds and 9000 seconds. When set to 0, the host is not acting as a router. | |
4013 | Defaults to 1800 seconds (30 minutes).</para> | |
aefdc112 AK |
4014 | |
4015 | <xi:include href="version-info.xml" xpointer="v235"/> | |
3f9e0236 PF |
4016 | </listitem> |
4017 | </varlistentry> | |
4018 | ||
59d475ba YW |
4019 | <varlistentry> |
4020 | <term><varname>ReachableTimeSec=</varname></term> | |
4021 | ||
4022 | <listitem> | |
4023 | <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which | |
4024 | clients can assume a neighbor is reachable after having received a reachability confirmation. Takes | |
4025 | a time span in the range 0…4294967295 ms. When 0, clients will handle it as if the value wasn't | |
4026 | specified. Defaults to 0.</para> | |
4027 | ||
4028 | <xi:include href="version-info.xml" xpointer="v256"/> | |
4029 | </listitem> | |
4030 | </varlistentry> | |
4031 | ||
fdc4c67c SS |
4032 | <varlistentry> |
4033 | <term><varname>RetransmitSec=</varname></term> | |
4034 | ||
5d8b72e1 YW |
4035 | <listitem> |
4036 | <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which | |
4037 | clients can use as retransmit time on address resolution and the Neighbor Unreachability Detection | |
4038 | algorithm. Takes a time span in the range 0…4294967295 ms. When 0, clients will handle it as if | |
4039 | the value wasn't specified. Defaults to 0.</para> | |
ec07c3c8 | 4040 | |
5d8b72e1 | 4041 | <xi:include href="version-info.xml" xpointer="v255"/> |
fdc4c67c SS |
4042 | </listitem> |
4043 | </varlistentry> | |
4044 | ||
3f9e0236 PF |
4045 | <varlistentry> |
4046 | <term><varname>RouterPreference=</varname></term> | |
4047 | ||
4048 | <listitem><para>Configures IPv6 router preference if | |
4049 | <varname>RouterLifetimeSec=</varname> is non-zero. Valid values are | |
4050 | <literal>high</literal>, <literal>medium</literal> and | |
4051 | <literal>low</literal>, with <literal>normal</literal> and | |
4052 | <literal>default</literal> added as synonyms for | |
4053 | <literal>medium</literal> just to make configuration easier. See | |
4054 | <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> | |
aefdc112 AK |
4055 | for details. Defaults to <literal>medium</literal>.</para> |
4056 | ||
4057 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
3f9e0236 PF |
4058 | </varlistentry> |
4059 | ||
b26c3452 SS |
4060 | <varlistentry> |
4061 | <term><varname>HopLimit=</varname></term> | |
4062 | <listitem> | |
4063 | <para>Configures hop limit. Takes an integer in the range 0…255. See also | |
4064 | <varname>IPv6HopLimit=</varname>.</para> | |
ec07c3c8 AK |
4065 | |
4066 | <xi:include href="version-info.xml" xpointer="v255"/> | |
b26c3452 SS |
4067 | </listitem> |
4068 | </varlistentry> | |
4069 | ||
63295b42 YW |
4070 | <varlistentry> |
4071 | <term><varname>UplinkInterface=</varname></term> | |
4072 | <listitem><para>Specifies the name or the index of the uplink interface, or one of the special | |
4073 | values <literal>:none</literal> and <literal>:auto</literal>. When emitting DNS servers or | |
4074 | search domains is enabled but no servers are specified, the servers configured in the uplink | |
f6032ff3 | 4075 | interface will be emitted. When <literal>:auto</literal>, the value specified to the same |
a27588d4 YW |
4076 | setting in the [DHCPPrefixDelegation] section will be used if |
4077 | <varname>DHCPPrefixDelegation=</varname> is enabled, otherwise the link which has a default | |
f6032ff3 | 4078 | gateway with the highest priority will be automatically selected. When <literal>:none</literal>, |
ec07c3c8 AK |
4079 | no uplink interface will be selected. Defaults to <literal>:auto</literal>.</para> |
4080 | ||
4081 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
63295b42 YW |
4082 | </varlistentry> |
4083 | ||
3f9e0236 | 4084 | <varlistentry> |
4cb8478c | 4085 | <term><varname>EmitDNS=</varname></term> |
3f9e0236 PF |
4086 | <term><varname>DNS=</varname></term> |
4087 | ||
63295b42 YW |
4088 | <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses |
4089 | that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is true. | |
4090 | <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case | |
f81ac115 | 4091 | the IPv6 link-local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are |
63295b42 YW |
4092 | read from the [Network] section. If the [Network] section does not contain any DNS servers |
4093 | either, DNS servers from the uplink interface specified in <varname>UplinkInterface=</varname> | |
4094 | will be used. When <varname>EmitDNS=</varname> is false, no DNS server information is sent in | |
aefdc112 AK |
4095 | Router Advertisement messages. <varname>EmitDNS=</varname> defaults to true.</para> |
4096 | ||
4097 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
3f9e0236 PF |
4098 | </varlistentry> |
4099 | ||
760021c0 | 4100 | <varlistentry> |
4cb8478c | 4101 | <term><varname>EmitDomains=</varname></term> |
760021c0 PF |
4102 | <term><varname>Domains=</varname></term> |
4103 | ||
bdac5608 | 4104 | <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when |
63295b42 YW |
4105 | <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search |
4106 | domains are read from the [Network] section. If the [Network] section does not contain any DNS | |
4107 | search domains either, DNS search domains from the uplink interface specified in | |
4108 | <varname>UplinkInterface=</varname> will be used. When <varname>EmitDomains=</varname> is false, | |
4109 | no DNS search domain information is sent in Router Advertisement messages. | |
aefdc112 AK |
4110 | <varname>EmitDomains=</varname> defaults to true.</para> |
4111 | ||
4112 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
760021c0 PF |
4113 | </varlistentry> |
4114 | ||
3f9e0236 PF |
4115 | <varlistentry> |
4116 | <term><varname>DNSLifetimeSec=</varname></term> | |
4117 | ||
9fa25e07 YW |
4118 | <listitem><para>Lifetime in seconds for the DNS server addresses listed in |
4119 | <varname>DNS=</varname> and search domains listed in <varname>Domains=</varname>. Defaults to | |
aefdc112 AK |
4120 | 3600 seconds (one hour).</para> |
4121 | ||
4122 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
3f9e0236 PF |
4123 | </varlistentry> |
4124 | ||
6a6d27bc SS |
4125 | <varlistentry> |
4126 | <term><varname>HomeAgent=</varname></term> | |
4127 | ||
cc59d101 | 4128 | <listitem><para>Takes a boolean. Specifies that IPv6 router advertisements which indicate to hosts that |
4129 | the router acts as a Home Agent and includes a Home Agent option. Defaults to false. See | |
6a6d27bc SS |
4130 | <ulink url="https://tools.ietf.org/html/rfc6275">RFC 6275</ulink> for further details.</para> |
4131 | ||
4132 | <xi:include href="version-info.xml" xpointer="v255"/> | |
4133 | </listitem> | |
4134 | </varlistentry> | |
4135 | ||
4136 | <varlistentry> | |
4137 | <term><varname>HomeAgentLifetimeSec=</varname></term> | |
4138 | ||
cc59d101 | 4139 | <listitem><para>Takes a timespan. Specifies the lifetime of the Home Agent. An integer, the default unit is seconds, |
6a6d27bc SS |
4140 | in the range 1…65535. Defaults to the value set to <varname>RouterLifetimeSec=</varname>.</para> |
4141 | ||
4142 | <xi:include href="version-info.xml" xpointer="v255"/> | |
4143 | </listitem> | |
4144 | </varlistentry> | |
4145 | ||
4146 | <varlistentry> | |
4147 | <term><varname>HomeAgentPreference=</varname></term> | |
4148 | ||
4149 | <listitem><para>Configures IPv6 Home Agent preference. Takes an integer in the range 0…65535. | |
4150 | Defaults to 0.</para> | |
4151 | ||
4152 | <xi:include href="version-info.xml" xpointer="v255"/> | |
4153 | </listitem> | |
4154 | </varlistentry> | |
4155 | ||
3f9e0236 | 4156 | </variablelist> |
b9e6e925 | 4157 | </refsect1> |
3f9e0236 | 4158 | |
b9e6e925 | 4159 | <refsect1> |
3f9e0236 | 4160 | <title>[IPv6Prefix] Section Options</title> |
e9dd6984 ZJS |
4161 | <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router |
4162 | Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further | |
4163 | details.</para> | |
3f9e0236 PF |
4164 | |
4165 | <variablelist class='network-directives'> | |
4166 | ||
4167 | <varlistentry> | |
4168 | <term><varname>AddressAutoconfiguration=</varname></term> | |
4169 | <term><varname>OnLink=</varname></term> | |
4170 | ||
9b6ffef3 | 4171 | <listitem><para>Takes a boolean to specify whether IPv6 addresses can be |
3f9e0236 PF |
4172 | autoconfigured with this prefix and whether the prefix can be used for |
4173 | onlink determination. Both settings default to <literal>true</literal> | |
4174 | in order to ease configuration. | |
ec07c3c8 AK |
4175 | </para> |
4176 | ||
4177 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
3f9e0236 PF |
4178 | </varlistentry> |
4179 | ||
4180 | <varlistentry> | |
4181 | <term><varname>Prefix=</varname></term> | |
4182 | ||
15102ced | 4183 | <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static |
bdac5608 ZJS |
4184 | IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a |
4185 | <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6 | |
4186 | prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one | |
ec07c3c8 AK |
4187 | prefix to another.</para> |
4188 | ||
4189 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
3f9e0236 PF |
4190 | </varlistentry> |
4191 | ||
4192 | <varlistentry> | |
4193 | <term><varname>PreferredLifetimeSec=</varname></term> | |
4194 | <term><varname>ValidLifetimeSec=</varname></term> | |
4195 | ||
c9e2c2da YW |
4196 | <listitem><para>Preferred and valid lifetimes for the prefix measured in seconds. |
4197 | <varname>PreferredLifetimeSec=</varname> defaults to 1800 seconds (30 minutes) and | |
ec07c3c8 AK |
4198 | <varname>ValidLifetimeSec=</varname> defaults to 3600 seconds (one hour).</para> |
4199 | ||
4200 | <xi:include href="version-info.xml" xpointer="v235"/></listitem> | |
203d4df5 SS |
4201 | </varlistentry> |
4202 | ||
bd6379ec SS |
4203 | <varlistentry> |
4204 | <term><varname>Assign=</varname></term> | |
4205 | <listitem><para>Takes a boolean. When true, adds an address from the prefix. Default to false. | |
ec07c3c8 AK |
4206 | </para> |
4207 | ||
4208 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
bd6379ec | 4209 | </varlistentry> |
0e1fb1d0 | 4210 | |
e609cd06 YW |
4211 | <varlistentry> |
4212 | <term><varname>Token=</varname></term> | |
4213 | <listitem> | |
4214 | <para>Specifies an optional address generation mode for assigning an address in each | |
4215 | prefix. This accepts the same syntax as <varname>Token=</varname> in the [IPv6AcceptRA] | |
4216 | section. If <varname>Assign=</varname> is set to false, then this setting will be ignored. | |
4217 | Defaults to unset, which means the EUI-64 algorithm will be used.</para> | |
ec07c3c8 AK |
4218 | |
4219 | <xi:include href="version-info.xml" xpointer="v250"/> | |
e609cd06 YW |
4220 | </listitem> |
4221 | </varlistentry> | |
4222 | ||
0e1fb1d0 YW |
4223 | <varlistentry> |
4224 | <term><varname>RouteMetric=</varname></term> | |
4225 | <listitem> | |
4226 | <para>The metric of the prefix route. Takes an unsigned integer in the range 0…4294967295. | |
4227 | When unset or set to 0, the kernel's default value is used. This setting is ignored when | |
4228 | <varname>Assign=</varname> is false.</para> | |
ec07c3c8 AK |
4229 | |
4230 | <xi:include href="version-info.xml" xpointer="v249"/> | |
0e1fb1d0 YW |
4231 | </listitem> |
4232 | </varlistentry> | |
203d4df5 | 4233 | </variablelist> |
b9e6e925 | 4234 | </refsect1> |
203d4df5 | 4235 | |
b9e6e925 | 4236 | <refsect1> |
203d4df5 | 4237 | <title>[IPv6RoutePrefix] Section Options</title> |
bdac5608 | 4238 | <para>One or more [IPv6RoutePrefix] sections contain the IPv6 |
203d4df5 SS |
4239 | prefix routes that are announced via Router Advertisements. See |
4240 | <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> | |
4241 | for further details.</para> | |
4242 | ||
4243 | <variablelist class='network-directives'> | |
4244 | ||
4245 | <varlistentry> | |
4246 | <term><varname>Route=</varname></term> | |
4247 | ||
15102ced | 4248 | <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static |
bdac5608 | 4249 | IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length, |
69a7d108 | 4250 | separated by a <literal>/</literal> character. Use multiple [IPv6RoutePrefix] sections to configure |
ec07c3c8 AK |
4251 | multiple IPv6 prefix routes.</para> |
4252 | ||
4253 | <xi:include href="version-info.xml" xpointer="v244"/></listitem> | |
203d4df5 SS |
4254 | </varlistentry> |
4255 | ||
4256 | <varlistentry> | |
4257 | <term><varname>LifetimeSec=</varname></term> | |
4258 | ||
c9e2c2da | 4259 | <listitem><para>Lifetime for the route prefix measured in seconds. |
ec07c3c8 AK |
4260 | <varname>LifetimeSec=</varname> defaults to 3600 seconds (one hour).</para> |
4261 | ||
4262 | <xi:include href="version-info.xml" xpointer="v244"/></listitem> | |
3f9e0236 PF |
4263 | </varlistentry> |
4264 | ||
4265 | </variablelist> | |
b9e6e925 | 4266 | </refsect1> |
3f9e0236 | 4267 | |
b9e6e925 | 4268 | <refsect1> |
1925f829 SS |
4269 | <title>[IPv6PREF64Prefix] Section Options</title> |
4270 | <para>One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router | |
4271 | Advertisements. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink> for further | |
4272 | details.</para> | |
4273 | ||
4274 | <variablelist class='network-directives'> | |
4275 | ||
4276 | <varlistentry> | |
4277 | <term><varname>Prefix=</varname></term> | |
4278 | ||
4279 | <listitem><para>The IPv6 PREF64 (or NAT64) prefix that is to be distributed to hosts. The setting holds | |
4280 | an IPv6 prefix that should be set up for NAT64 translation (PLAT) to allow 464XLAT on the network segment. | |
4281 | Use multiple [IPv6PREF64Prefix] sections to configure multiple IPv6 prefixes since prefix lifetime may differ | |
4282 | from one prefix to another. The prefix is an address with a prefix length, separated by a slash | |
ec07c3c8 AK |
4283 | <literal>/</literal> character. Valid NAT64 prefix length are 96, 64, 56, 48, 40, and 32 bits.</para> |
4284 | ||
4285 | <xi:include href="version-info.xml" xpointer="v255"/></listitem></varlistentry> | |
1925f829 SS |
4286 | |
4287 | <varlistentry> | |
4288 | <term><varname>LifetimeSec=</varname></term> | |
4289 | <listitem><para>Lifetime for the prefix measured in seconds. Should be greater than or equal to <varname>RouterLifetimeSec=</varname>. | |
ec07c3c8 AK |
4290 | <varname>LifetimeSec=</varname> defaults to 1800 seconds.</para> |
4291 | ||
4292 | <xi:include href="version-info.xml" xpointer="v255"/></listitem> | |
1925f829 SS |
4293 | </varlistentry> |
4294 | </variablelist> | |
b9e6e925 | 4295 | </refsect1> |
1925f829 | 4296 | |
b9e6e925 | 4297 | <refsect1> |
798d3a52 | 4298 | <title>[Bridge] Section Options</title> |
b9e6e925 YW |
4299 | <para>The [Bridge] section accepts the following keys:</para> |
4300 | ||
4301 | <variablelist class='network-directives'> | |
4302 | <varlistentry> | |
4303 | <term><varname>UnicastFlood=</varname></term> | |
4304 | <listitem> | |
4305 | <para>Takes a boolean. Controls whether the bridge should flood | |
4306 | traffic for which an FDB entry is missing and the destination | |
4307 | is unknown through this port. When unset, the kernel's default will be used. | |
4308 | </para> | |
4309 | ||
4310 | <xi:include href="version-info.xml" xpointer="v223"/> | |
4311 | </listitem> | |
4312 | </varlistentry> | |
4313 | <varlistentry> | |
4314 | <term><varname>MulticastFlood=</varname></term> | |
4315 | <listitem> | |
4316 | <para>Takes a boolean. Controls whether the bridge should flood | |
4317 | traffic for which an MDB entry is missing and the destination | |
4318 | is unknown through this port. When unset, the kernel's default will be used. | |
4319 | </para> | |
4320 | ||
4321 | <xi:include href="version-info.xml" xpointer="v242"/> | |
4322 | </listitem> | |
4323 | </varlistentry> | |
4324 | <varlistentry> | |
4325 | <term><varname>MulticastToUnicast=</varname></term> | |
4326 | <listitem> | |
4327 | <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of | |
4328 | the bridge. Which means unicast copies are only delivered to hosts which are interested in it. | |
4329 | When unset, the kernel's default will be used. | |
4330 | </para> | |
4331 | ||
4332 | <xi:include href="version-info.xml" xpointer="v240"/> | |
4333 | </listitem> | |
4334 | </varlistentry> | |
4335 | <varlistentry> | |
4336 | <term><varname>NeighborSuppression=</varname></term> | |
4337 | <listitem> | |
4338 | <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for | |
4339 | this port. When unset, the kernel's default will be used. | |
4340 | </para> | |
4341 | ||
4342 | <xi:include href="version-info.xml" xpointer="v242"/> | |
4343 | </listitem> | |
4344 | </varlistentry> | |
4345 | <varlistentry> | |
4346 | <term><varname>Learning=</varname></term> | |
4347 | <listitem> | |
4348 | <para>Takes a boolean. Configures whether MAC address learning is enabled for | |
4349 | this port. When unset, the kernel's default will be used. | |
4350 | </para> | |
4351 | ||
4352 | <xi:include href="version-info.xml" xpointer="v242"/> | |
4353 | </listitem> | |
4354 | </varlistentry> | |
4355 | <varlistentry> | |
4356 | <term><varname>HairPin=</varname></term> | |
4357 | <listitem> | |
4358 | <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it | |
4359 | was received. When this flag is false, then the bridge will not forward traffic back out of the | |
4360 | receiving port. When unset, the kernel's default will be used.</para> | |
4361 | ||
4362 | <xi:include href="version-info.xml" xpointer="v223"/> | |
4363 | </listitem> | |
4364 | </varlistentry> | |
4365 | <varlistentry> | |
4366 | <term><varname>Isolated=</varname></term> | |
4367 | <listitem> | |
4368 | <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge, | |
4369 | isolated ports can only communicate with non-isolated ports. When set to true, this port can only | |
4370 | communicate with other ports whose Isolated setting is false. When set to false, this port | |
4371 | can communicate with any other ports. When unset, the kernel's default will be used.</para> | |
4372 | ||
4373 | <xi:include href="version-info.xml" xpointer="v251"/> | |
4374 | </listitem> | |
4375 | </varlistentry> | |
4376 | <varlistentry> | |
4377 | <term><varname>UseBPDU=</varname></term> | |
4378 | <listitem> | |
4379 | <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be | |
4380 | processed by the bridge port. When unset, the kernel's default will be used.</para> | |
4381 | ||
4382 | <xi:include href="version-info.xml" xpointer="v223"/> | |
4383 | </listitem> | |
4384 | </varlistentry> | |
4385 | <varlistentry> | |
4386 | <term><varname>FastLeave=</varname></term> | |
4387 | <listitem> | |
4388 | <para>Takes a boolean. This flag allows the bridge to immediately stop multicast | |
4389 | traffic on a port that receives an IGMP Leave message. It is only used with | |
4390 | IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para> | |
4391 | ||
4392 | <xi:include href="version-info.xml" xpointer="v223"/> | |
4393 | </listitem> | |
4394 | </varlistentry> | |
4395 | <varlistentry> | |
4396 | <term><varname>AllowPortToBeRoot=</varname></term> | |
4397 | <listitem> | |
4398 | <para>Takes a boolean. Configures whether a given port is allowed to | |
4399 | become a root port. Only used when STP is enabled on the bridge. | |
4400 | When unset, the kernel's default will be used.</para> | |
4401 | ||
4402 | <xi:include href="version-info.xml" xpointer="v223"/> | |
4403 | </listitem> | |
4404 | </varlistentry> | |
4405 | <varlistentry> | |
4406 | <term><varname>ProxyARP=</varname></term> | |
4407 | <listitem> | |
4408 | <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port. | |
4409 | When unset, the kernel's default will be used.</para> | |
4410 | ||
4411 | <xi:include href="version-info.xml" xpointer="v243"/> | |
4412 | </listitem> | |
4413 | </varlistentry> | |
4414 | <varlistentry> | |
4415 | <term><varname>ProxyARPWiFi=</varname></term> | |
4416 | <listitem> | |
4417 | <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port | |
4418 | which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications. | |
4419 | When unset, the kernel's default will be used.</para> | |
4420 | ||
4421 | <xi:include href="version-info.xml" xpointer="v243"/> | |
4422 | </listitem> | |
4423 | </varlistentry> | |
4424 | <varlistentry> | |
4425 | <term><varname>MulticastRouter=</varname></term> | |
4426 | <listitem> | |
4427 | <para>Configures this port for having multicast routers attached. A port with a multicast | |
4428 | router will receive all multicast traffic. Takes one of <literal>no</literal> | |
4429 | to disable multicast routers on this port, <literal>query</literal> to let the system detect | |
4430 | the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic | |
4431 | forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily | |
4432 | on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para> | |
4433 | ||
4434 | <xi:include href="version-info.xml" xpointer="v243"/> | |
4435 | </listitem> | |
4436 | </varlistentry> | |
4437 | <varlistentry> | |
4438 | <term><varname>Cost=</varname></term> | |
4439 | <listitem> | |
4440 | <para>Sets the "cost" of sending packets of this interface. | |
4441 | Each port in a bridge may have a different speed and the cost | |
4442 | is used to decide which link to use. Faster interfaces | |
4443 | should have lower costs. It is an integer value between 1 and | |
4444 | 65535.</para> | |
4445 | ||
4446 | <xi:include href="version-info.xml" xpointer="v218"/> | |
4447 | </listitem> | |
4448 | </varlistentry> | |
4449 | <varlistentry> | |
4450 | <term><varname>Priority=</varname></term> | |
4451 | <listitem> | |
4452 | <para>Sets the "priority" of sending packets on this interface. | |
4453 | Each port in a bridge may have a different priority which is used | |
4454 | to decide which link to use. Lower value means higher priority. | |
4455 | It is an integer value between 0 to 63. Networkd does not set any | |
4456 | default, meaning the kernel default value of 32 is used.</para> | |
4457 | ||
4458 | <xi:include href="version-info.xml" xpointer="v234"/> | |
4459 | </listitem> | |
4460 | </varlistentry> | |
4461 | </variablelist> | |
798d3a52 | 4462 | </refsect1> |
b9e6e925 | 4463 | |
798d3a52 ZJS |
4464 | <refsect1> |
4465 | <title>[BridgeFDB] Section Options</title> | |
798d3a52 | 4466 | |
b9e6e925 YW |
4467 | <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following |
4468 | keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para> | |
4469 | ||
4470 | <variablelist class='network-directives'> | |
4471 | <varlistentry> | |
4472 | <term><varname>MACAddress=</varname></term> | |
4473 | <listitem> | |
4474 | <para>As in the [Network] section. This key is mandatory.</para> | |
4475 | ||
4476 | <xi:include href="version-info.xml" xpointer="v219"/> | |
4477 | </listitem> | |
4478 | </varlistentry> | |
4479 | <varlistentry> | |
4480 | <term><varname>Destination=</varname></term> | |
4481 | <listitem> | |
4482 | <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para> | |
4483 | ||
4484 | <xi:include href="version-info.xml" xpointer="v243"/> | |
4485 | </listitem> | |
4486 | </varlistentry> | |
4487 | <varlistentry> | |
4488 | <term><varname>VLANId=</varname></term> | |
4489 | <listitem> | |
4490 | <para>The VLAN ID for the new static MAC table entry. If | |
4491 | omitted, no VLAN ID information is appended to the new static MAC | |
4492 | table entry.</para> | |
aefdc112 AK |
4493 | |
4494 | <xi:include href="version-info.xml" xpointer="v219"/> | |
b9e6e925 YW |
4495 | </listitem> |
4496 | </varlistentry> | |
4497 | <varlistentry> | |
4498 | <term><varname>VNI=</varname></term> | |
4499 | <listitem> | |
4500 | <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to | |
4501 | the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215. | |
4502 | Defaults to unset.</para> | |
ec07c3c8 AK |
4503 | |
4504 | <xi:include href="version-info.xml" xpointer="v243"/> | |
b9e6e925 YW |
4505 | </listitem> |
4506 | </varlistentry> | |
4507 | <varlistentry> | |
4508 | <term><varname>AssociatedWith=</varname></term> | |
4509 | <listitem> | |
4510 | <para>Specifies where the address is associated with. Takes one of <literal>use</literal>, | |
4511 | <literal>self</literal>, <literal>master</literal> or <literal>router</literal>. | |
4512 | <literal>use</literal> means the address is in use. User space can use this option to | |
4513 | indicate to the kernel that the fdb entry is in use. <literal>self</literal> means | |
4514 | the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal> | |
4515 | means the address is associated with master devices fdb. <literal>router</literal> means | |
4516 | the destination address is associated with a router. Note that it's valid if the referenced | |
4517 | device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para> | |
ec07c3c8 AK |
4518 | |
4519 | <xi:include href="version-info.xml" xpointer="v243"/> | |
b9e6e925 YW |
4520 | </listitem> |
4521 | </varlistentry> | |
4522 | <varlistentry> | |
4523 | <term><varname>OutgoingInterface=</varname></term> | |
4524 | <listitem> | |
4525 | <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to | |
4526 | reach the remote VXLAN tunnel endpoint. Defaults to unset.</para> | |
4527 | ||
4528 | <xi:include href="version-info.xml" xpointer="v249"/> | |
4529 | </listitem> | |
4530 | </varlistentry> | |
4531 | </variablelist> | |
798d3a52 | 4532 | </refsect1> |
b9e6e925 | 4533 | |
a1717e9a DM |
4534 | <refsect1> |
4535 | <title>[BridgeMDB] Section Options</title> | |
b9e6e925 YW |
4536 | <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following |
4537 | keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para> | |
a1717e9a | 4538 | |
b9e6e925 YW |
4539 | <variablelist class='network-directives'> |
4540 | <varlistentry> | |
4541 | <term><varname>MulticastGroupAddress=</varname></term> | |
4542 | <listitem> | |
4543 | <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para> | |
ec07c3c8 AK |
4544 | |
4545 | <xi:include href="version-info.xml" xpointer="v247"/> | |
b9e6e925 YW |
4546 | </listitem> |
4547 | </varlistentry> | |
4548 | <varlistentry> | |
4549 | <term><varname>VLANId=</varname></term> | |
4550 | <listitem> | |
4551 | <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para> | |
aefdc112 AK |
4552 | |
4553 | <xi:include href="version-info.xml" xpointer="v247"/> | |
b9e6e925 YW |
4554 | </listitem> |
4555 | </varlistentry> | |
4556 | </variablelist> | |
a1717e9a | 4557 | </refsect1> |
06828bb6 | 4558 | |
e9a8c550 SS |
4559 | <refsect1> |
4560 | <title>[LLDP] Section Options</title> | |
b9e6e925 YW |
4561 | <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following |
4562 | keys:</para> | |
4563 | ||
4564 | <variablelist class='network-directives'> | |
4565 | <varlistentry> | |
4566 | <term><varname>MUDURL=</varname></term> | |
4567 | <listitem> | |
4568 | <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in | |
4569 | LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the | |
4570 | [DHCPv4] section described above.</para> | |
4571 | ||
4572 | <para>The MUD URLs received via LLDP packets are saved and can be read using the | |
4573 | <function>sd_lldp_neighbor_get_mud_url()</function> function.</para> | |
4574 | ||
4575 | <xi:include href="version-info.xml" xpointer="v246"/> | |
4576 | </listitem> | |
4577 | </varlistentry> | |
4578 | </variablelist> | |
e9a8c550 SS |
4579 | </refsect1> |
4580 | ||
06828bb6 HP |
4581 | <refsect1> |
4582 | <title>[CAN] Section Options</title> | |
b9e6e925 YW |
4583 | <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the |
4584 | following keys:</para> | |
4585 | <variablelist class='network-directives'> | |
4586 | <varlistentry> | |
4587 | <term><varname>BitRate=</varname></term> | |
4588 | <listitem> | |
4589 | <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can | |
4590 | be used here. Takes a number in the range 1…4294967295.</para> | |
4591 | ||
4592 | <xi:include href="version-info.xml" xpointer="v239"/> | |
4593 | </listitem> | |
4594 | </varlistentry> | |
4595 | <varlistentry> | |
4596 | <term><varname>SamplePoint=</varname></term> | |
4597 | <listitem> | |
4598 | <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>, | |
4599 | <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when | |
4600 | <varname>BitRate=</varname> is unspecified.</para> | |
ec07c3c8 AK |
4601 | |
4602 | <xi:include href="version-info.xml" xpointer="v239"/> | |
b9e6e925 YW |
4603 | </listitem> |
4604 | </varlistentry> | |
4605 | <varlistentry> | |
4606 | <term><varname>TimeQuantaNSec=</varname></term> | |
4607 | <term><varname>PropagationSegment=</varname></term> | |
4608 | <term><varname>PhaseBufferSegment1=</varname></term> | |
4609 | <term><varname>PhaseBufferSegment2=</varname></term> | |
4610 | <term><varname>SyncJumpWidth=</varname></term> | |
4611 | <listitem> | |
4612 | <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the | |
4613 | synchronization jump width, which allow one to define the CAN bit-timing in a hardware | |
4614 | independent format as proposed by the Bosch CAN 2.0 Specification. | |
4615 | <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds. | |
4616 | <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>, | |
4617 | <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number | |
4618 | of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned | |
4619 | integer in the range 0…4294967295. These settings except for | |
4620 | <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is | |
4621 | specified.</para> | |
4622 | ||
4623 | <xi:include href="version-info.xml" xpointer="v250"/> | |
4624 | </listitem> | |
4625 | </varlistentry> | |
4626 | <varlistentry> | |
4627 | <term><varname>DataBitRate=</varname></term> | |
4628 | <term><varname>DataSamplePoint=</varname></term> | |
4629 | <listitem> | |
4630 | <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are | |
4631 | analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para> | |
ec07c3c8 AK |
4632 | |
4633 | <xi:include href="version-info.xml" xpointer="v246"/> | |
b9e6e925 YW |
4634 | </listitem> |
4635 | </varlistentry> | |
4636 | <varlistentry> | |
4637 | <term><varname>DataTimeQuantaNSec=</varname></term> | |
4638 | <term><varname>DataPropagationSegment=</varname></term> | |
4639 | <term><varname>DataPhaseBufferSegment1=</varname></term> | |
4640 | <term><varname>DataPhaseBufferSegment2=</varname></term> | |
4641 | <term><varname>DataSyncJumpWidth=</varname></term> | |
4642 | <listitem> | |
4643 | <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the | |
4644 | synchronization jump width for the data phase, if CAN-FD is used. These settings are | |
4645 | analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para> | |
4646 | ||
4647 | <xi:include href="version-info.xml" xpointer="v250"/> | |
4648 | </listitem> | |
4649 | </varlistentry> | |
4650 | <varlistentry> | |
4651 | <term><varname>FDMode=</varname></term> | |
4652 | <listitem> | |
4653 | <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface. | |
4654 | Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using | |
4655 | the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or | |
4656 | <varname>DataTimeQuanta=</varname> and related settings.</para> | |
ec07c3c8 AK |
4657 | |
4658 | <xi:include href="version-info.xml" xpointer="v246"/> | |
b9e6e925 YW |
4659 | </listitem> |
4660 | </varlistentry> | |
4661 | <varlistentry> | |
4662 | <term><varname>FDNonISO=</varname></term> | |
4663 | <listitem> | |
4664 | <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the | |
4665 | interface. When unset, the kernel's default will be used.</para> | |
4666 | ||
4667 | <xi:include href="version-info.xml" xpointer="v246"/> | |
4668 | </listitem> | |
4669 | </varlistentry> | |
4670 | <varlistentry> | |
4671 | <term><varname>RestartSec=</varname></term> | |
4672 | <listitem> | |
4673 | <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be | |
4674 | triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can | |
4675 | be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or | |
4676 | <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the | |
4677 | automatic restart off. By default automatic restart is disabled.</para> | |
4678 | ||
4679 | <xi:include href="version-info.xml" xpointer="v239"/> | |
4680 | </listitem> | |
4681 | </varlistentry> | |
4682 | <varlistentry> | |
4683 | <term><varname>Termination=</varname></term> | |
4684 | <listitem> | |
4685 | <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When | |
4686 | <literal>yes</literal>, the termination resistor is set to 120 ohm. When | |
4687 | <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled. | |
4688 | When unset, the kernel's default will be used.</para> | |
4689 | ||
4690 | <xi:include href="version-info.xml" xpointer="v246"/> | |
4691 | </listitem> | |
4692 | </varlistentry> | |
4693 | <varlistentry> | |
4694 | <term><varname>TripleSampling=</varname></term> | |
4695 | <listitem> | |
4696 | <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine | |
4697 | the value of a received bit by majority rule. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
4698 | |
4699 | <xi:include href="version-info.xml" xpointer="v242"/> | |
b9e6e925 YW |
4700 | </listitem> |
4701 | </varlistentry> | |
4702 | <varlistentry> | |
4703 | <term><varname>BusErrorReporting=</varname></term> | |
4704 | <listitem> | |
4705 | <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated | |
4706 | (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit, | |
4707 | unable to send recessive bit, bus overload, active error announcement, error occurred on | |
4708 | transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a | |
4709 | single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para> | |
ec07c3c8 AK |
4710 | |
4711 | <xi:include href="version-info.xml" xpointer="v248"/> | |
b9e6e925 YW |
4712 | </listitem> |
4713 | </varlistentry> | |
4714 | <varlistentry> | |
4715 | <term><varname>ListenOnly=</varname></term> | |
4716 | <listitem> | |
4717 | <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the | |
4718 | interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK | |
4719 | bit. Listen-only mode is important to debug CAN networks without interfering with the | |
4720 | communication or acknowledge the CAN frame. When unset, the kernel's default will be used. | |
4721 | </para> | |
ec07c3c8 AK |
4722 | |
4723 | <xi:include href="version-info.xml" xpointer="v246"/> | |
b9e6e925 YW |
4724 | </listitem> |
4725 | </varlistentry> | |
4726 | <varlistentry> | |
4727 | <term><varname>Loopback=</varname></term> | |
4728 | <listitem> | |
4729 | <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the | |
4730 | loopback mode is enabled, the interface treats messages transmitted by itself as received | |
4731 | messages. The loopback mode is important to debug CAN networks. When unset, the kernel's | |
4732 | default will be used.</para> | |
ec07c3c8 AK |
4733 | |
4734 | <xi:include href="version-info.xml" xpointer="v250"/> | |
b9e6e925 YW |
4735 | </listitem> |
4736 | </varlistentry> | |
4737 | <varlistentry> | |
4738 | <term><varname>OneShot=</varname></term> | |
4739 | <listitem> | |
4740 | <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset, | |
4741 | the kernel's default will be used.</para> | |
ec07c3c8 AK |
4742 | |
4743 | <xi:include href="version-info.xml" xpointer="v250"/> | |
b9e6e925 YW |
4744 | </listitem> |
4745 | </varlistentry> | |
4746 | <varlistentry> | |
4747 | <term><varname>PresumeAck=</varname></term> | |
4748 | <listitem> | |
4749 | <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN | |
4750 | ACKs. When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
4751 | |
4752 | <xi:include href="version-info.xml" xpointer="v250"/> | |
b9e6e925 YW |
4753 | </listitem> |
4754 | </varlistentry> | |
4755 | <varlistentry> | |
4756 | <term><varname>ClassicDataLengthCode=</varname></term> | |
4757 | <listitem> | |
4758 | <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data | |
4759 | length code (DLC). When unset, the kernel's default will be used.</para> | |
ec07c3c8 AK |
4760 | |
4761 | <xi:include href="version-info.xml" xpointer="v250"/> | |
b9e6e925 YW |
4762 | </listitem> |
4763 | </varlistentry> | |
4764 | </variablelist> | |
72e65e6f YW |
4765 | </refsect1> |
4766 | ||
4767 | <refsect1> | |
4768 | <title>[IPoIB] Section Options</title> | |
b9e6e925 YW |
4769 | <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para> |
4770 | ||
4771 | <variablelist class='network-directives'> | |
4772 | <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" /> | |
4773 | <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" /> | |
4774 | </variablelist> | |
06828bb6 HP |
4775 | </refsect1> |
4776 | ||
2ed5f6d5 YW |
4777 | <refsect1> |
4778 | <title>[QDisc] Section Options</title> | |
bdac5608 | 4779 | <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para> |
2ed5f6d5 YW |
4780 | |
4781 | <variablelist class='network-directives'> | |
4782 | <varlistentry> | |
4783 | <term><varname>Parent=</varname></term> | |
4784 | <listitem> | |
4785 | <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal> | |
4786 | or <literal>ingress</literal>. This is mandatory.</para> | |
aefdc112 | 4787 | |
b9e6e925 | 4788 | <xi:include href="version-info.xml" xpointer="v244"/> |
2ed5f6d5 YW |
4789 | </listitem> |
4790 | </varlistentry> | |
d8b2396d | 4791 | |
f344a492 | 4792 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> |
2ed5f6d5 YW |
4793 | </variablelist> |
4794 | </refsect1> | |
4795 | ||
0f5bd7fe | 4796 | <refsect1> |
18de0969 | 4797 | <title>[NetworkEmulator] Section Options</title> |
bdac5608 ZJS |
4798 | <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It |
4799 | can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP | |
4800 | applications, or limit the bandwidth usage of a particular service to simulate internet connections. | |
4801 | </para> | |
0f5bd7fe SS |
4802 | |
4803 | <variablelist class='network-directives'> | |
f344a492 YW |
4804 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
4805 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 4806 | |
0f5bd7fe | 4807 | <varlistentry> |
18de0969 | 4808 | <term><varname>DelaySec=</varname></term> |
0f5bd7fe SS |
4809 | <listitem> |
4810 | <para>Specifies the fixed amount of delay to be added to all packets going out of the | |
4811 | interface. Defaults to unset.</para> | |
ec07c3c8 AK |
4812 | |
4813 | <xi:include href="version-info.xml" xpointer="v245"/> | |
0f5bd7fe SS |
4814 | </listitem> |
4815 | </varlistentry> | |
4816 | ||
4817 | <varlistentry> | |
18de0969 | 4818 | <term><varname>DelayJitterSec=</varname></term> |
0f5bd7fe SS |
4819 | <listitem> |
4820 | <para>Specifies the chosen delay to be added to the packets outgoing to the network | |
4821 | interface. Defaults to unset.</para> | |
ec07c3c8 AK |
4822 | |
4823 | <xi:include href="version-info.xml" xpointer="v245"/> | |
0f5bd7fe SS |
4824 | </listitem> |
4825 | </varlistentry> | |
4826 | ||
4827 | <varlistentry> | |
18de0969 | 4828 | <term><varname>PacketLimit=</varname></term> |
0f5bd7fe SS |
4829 | <listitem> |
4830 | <para>Specifies the maximum number of packets the qdisc may hold queued at a time. | |
69978eb9 | 4831 | An unsigned integer in the range 0…4294967294. Defaults to 1000.</para> |
ec07c3c8 AK |
4832 | |
4833 | <xi:include href="version-info.xml" xpointer="v245"/> | |
0f5bd7fe SS |
4834 | </listitem> |
4835 | </varlistentry> | |
4836 | ||
4837 | <varlistentry> | |
18de0969 | 4838 | <term><varname>LossRate=</varname></term> |
0f5bd7fe SS |
4839 | <listitem> |
4840 | <para>Specifies an independent loss probability to be added to the packets outgoing from the | |
4841 | network interface. Takes a percentage value, suffixed with "%". Defaults to unset.</para> | |
ec07c3c8 AK |
4842 | |
4843 | <xi:include href="version-info.xml" xpointer="v245"/> | |
0f5bd7fe SS |
4844 | </listitem> |
4845 | </varlistentry> | |
4846 | ||
b9c5aa3c | 4847 | <varlistentry> |
18de0969 | 4848 | <term><varname>DuplicateRate=</varname></term> |
b9c5aa3c SS |
4849 | <listitem> |
4850 | <para>Specifies that the chosen percent of packets is duplicated before queuing them. | |
4851 | Takes a percentage value, suffixed with "%". Defaults to unset.</para> | |
ec07c3c8 AK |
4852 | |
4853 | <xi:include href="version-info.xml" xpointer="v245"/> | |
b9c5aa3c SS |
4854 | </listitem> |
4855 | </varlistentry> | |
18de0969 YW |
4856 | </variablelist> |
4857 | </refsect1> | |
b9c5aa3c | 4858 | |
18de0969 | 4859 | <refsect1> |
60ed2dcf | 4860 | <title>[TokenBucketFilter] Section Options</title> |
e9dd6984 ZJS |
4861 | <para>The [TokenBucketFilter] section manages the queueing discipline (qdisc) of token bucket filter |
4862 | (tbf).</para> | |
18de0969 YW |
4863 | |
4864 | <variablelist class='network-directives'> | |
f344a492 YW |
4865 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
4866 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 4867 | |
18de0969 YW |
4868 | <varlistentry> |
4869 | <term><varname>LatencySec=</varname></term> | |
ba5841b5 SS |
4870 | <listitem> |
4871 | <para>Specifies the latency parameter, which specifies the maximum amount of time a | |
60ed2dcf | 4872 | packet can sit in the Token Bucket Filter (TBF). Defaults to unset.</para> |
ec07c3c8 AK |
4873 | |
4874 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ba5841b5 SS |
4875 | </listitem> |
4876 | </varlistentry> | |
4877 | ||
dcfc23ae | 4878 | <varlistentry> |
c03ef420 | 4879 | <term><varname>LimitBytes=</varname></term> |
dcfc23ae YW |
4880 | <listitem> |
4881 | <para>Takes the number of bytes that can be queued waiting for tokens to become available. | |
4882 | When the size is suffixed with K, M, or G, it is parsed as Kilobytes, Megabytes, or Gigabytes, | |
c03ef420 | 4883 | respectively, to the base of 1024. Defaults to unset.</para> |
ec07c3c8 AK |
4884 | |
4885 | <xi:include href="version-info.xml" xpointer="v246"/> | |
dcfc23ae YW |
4886 | </listitem> |
4887 | </varlistentry> | |
4888 | ||
ba5841b5 | 4889 | <varlistentry> |
c03ef420 | 4890 | <term><varname>BurstBytes=</varname></term> |
ba5841b5 SS |
4891 | <listitem> |
4892 | <para>Specifies the size of the bucket. This is the maximum amount of bytes that tokens | |
4893 | can be available for instantaneous transfer. When the size is suffixed with K, M, or G, it is | |
c03ef420 | 4894 | parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to |
ba5841b5 | 4895 | unset.</para> |
ec07c3c8 AK |
4896 | |
4897 | <xi:include href="version-info.xml" xpointer="v246"/> | |
ba5841b5 SS |
4898 | </listitem> |
4899 | </varlistentry> | |
4900 | ||
4901 | <varlistentry> | |
18de0969 | 4902 | <term><varname>Rate=</varname></term> |
ba5841b5 SS |
4903 | <listitem> |
4904 | <para>Specifies the device specific bandwidth. When suffixed with K, M, or G, the specified | |
6b8fe4c3 | 4905 | bandwidth is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. |
ba5841b5 | 4906 | Defaults to unset.</para> |
ec07c3c8 AK |
4907 | |
4908 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ba5841b5 SS |
4909 | </listitem> |
4910 | </varlistentry> | |
4911 | ||
dcfc23ae | 4912 | <varlistentry> |
18de0969 | 4913 | <term><varname>MPUBytes=</varname></term> |
dcfc23ae YW |
4914 | <listitem> |
4915 | <para>The Minimum Packet Unit (MPU) determines the minimal token usage (specified in bytes) | |
4916 | for a packet. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, | |
c03ef420 | 4917 | Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to zero.</para> |
ec07c3c8 AK |
4918 | |
4919 | <xi:include href="version-info.xml" xpointer="v245"/> | |
dcfc23ae YW |
4920 | </listitem> |
4921 | </varlistentry> | |
4922 | ||
4923 | <varlistentry> | |
18de0969 | 4924 | <term><varname>PeakRate=</varname></term> |
dcfc23ae YW |
4925 | <listitem> |
4926 | <para>Takes the maximum depletion rate of the bucket. When suffixed with K, M, or G, the | |
6b8fe4c3 | 4927 | specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of |
dcfc23ae | 4928 | 1000. Defaults to unset.</para> |
ec07c3c8 AK |
4929 | |
4930 | <xi:include href="version-info.xml" xpointer="v245"/> | |
dcfc23ae YW |
4931 | </listitem> |
4932 | </varlistentry> | |
4933 | ||
4934 | <varlistentry> | |
18de0969 | 4935 | <term><varname>MTUBytes=</varname></term> |
dcfc23ae YW |
4936 | <listitem> |
4937 | <para>Specifies the size of the peakrate bucket. When suffixed with K, M, or G, the specified | |
c03ef420 | 4938 | size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. |
dcfc23ae | 4939 | Defaults to unset.</para> |
ec07c3c8 AK |
4940 | |
4941 | <xi:include href="version-info.xml" xpointer="v245"/> | |
dcfc23ae YW |
4942 | </listitem> |
4943 | </varlistentry> | |
18de0969 YW |
4944 | </variablelist> |
4945 | </refsect1> | |
4946 | ||
bde4ae88 SS |
4947 | <refsect1> |
4948 | <title>[PIE] Section Options</title> | |
bdac5608 ZJS |
4949 | <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral |
4950 | controller-Enhanced (PIE).</para> | |
bde4ae88 SS |
4951 | |
4952 | <variablelist class='network-directives'> | |
f344a492 YW |
4953 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
4954 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
bde4ae88 SS |
4955 | |
4956 | <varlistentry> | |
4957 | <term><varname>PacketLimit=</varname></term> | |
4958 | <listitem> | |
1d3a473b ZJS |
4959 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, |
4960 | incoming packets are dropped. An unsigned integer in the range 1…4294967294. Defaults to unset and | |
4961 | kernel's default is used.</para> | |
ec07c3c8 AK |
4962 | |
4963 | <xi:include href="version-info.xml" xpointer="v246"/> | |
8f6b6d70 SS |
4964 | </listitem> |
4965 | </varlistentry> | |
4966 | </variablelist> | |
4967 | </refsect1> | |
4968 | ||
4969 | <refsect1> | |
4970 | <title>[FlowQueuePIE] Section Options</title> | |
4971 | <para>The <literal>[FlowQueuePIE]</literal> section manages the queueing discipline | |
4972 | (qdisc) of Flow Queue Proportional Integral controller-Enhanced (fq_pie).</para> | |
4973 | ||
4974 | <variablelist class='network-directives'> | |
4975 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> | |
4976 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
4977 | ||
4978 | <varlistentry> | |
4979 | <term><varname>PacketLimit=</varname></term> | |
4980 | <listitem> | |
75909cc7 ZJS |
4981 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, |
4982 | incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and | |
4983 | kernel's default is used.</para> | |
ec07c3c8 AK |
4984 | |
4985 | <xi:include href="version-info.xml" xpointer="v247"/> | |
bde4ae88 SS |
4986 | </listitem> |
4987 | </varlistentry> | |
4988 | </variablelist> | |
4989 | </refsect1> | |
4990 | ||
982998b0 SS |
4991 | <refsect1> |
4992 | <title>[StochasticFairBlue] Section Options</title> | |
bdac5608 ZJS |
4993 | <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue |
4994 | (sfb).</para> | |
982998b0 SS |
4995 | |
4996 | <variablelist class='network-directives'> | |
f344a492 YW |
4997 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
4998 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
982998b0 SS |
4999 | |
5000 | <varlistentry> | |
5001 | <term><varname>PacketLimit=</varname></term> | |
5002 | <listitem> | |
e9dd6984 | 5003 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, |
69978eb9 | 5004 | incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and |
e9dd6984 | 5005 | kernel's default is used.</para> |
ec07c3c8 AK |
5006 | |
5007 | <xi:include href="version-info.xml" xpointer="v246"/> | |
982998b0 SS |
5008 | </listitem> |
5009 | </varlistentry> | |
5010 | </variablelist> | |
5011 | </refsect1> | |
5012 | ||
18de0969 YW |
5013 | <refsect1> |
5014 | <title>[StochasticFairnessQueueing] Section Options</title> | |
bdac5608 ZJS |
5015 | <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic |
5016 | fairness queueing (sfq).</para> | |
18de0969 YW |
5017 | |
5018 | <variablelist class='network-directives'> | |
f344a492 YW |
5019 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5020 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 5021 | |
9942b710 | 5022 | <varlistentry> |
18de0969 | 5023 | <term><varname>PerturbPeriodSec=</varname></term> |
9942b710 SS |
5024 | <listitem> |
5025 | <para>Specifies the interval in seconds for queue algorithm perturbation. Defaults to unset.</para> | |
ec07c3c8 AK |
5026 | |
5027 | <xi:include href="version-info.xml" xpointer="v245"/> | |
9942b710 SS |
5028 | </listitem> |
5029 | </varlistentry> | |
18de0969 YW |
5030 | </variablelist> |
5031 | </refsect1> | |
5032 | ||
c853f594 SS |
5033 | <refsect1> |
5034 | <title>[BFIFO] Section Options</title> | |
bdac5608 ZJS |
5035 | <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First |
5036 | Out (bfifo).</para> | |
c853f594 SS |
5037 | |
5038 | <variablelist class='network-directives'> | |
f344a492 YW |
5039 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5040 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
c853f594 SS |
5041 | |
5042 | <varlistentry> | |
c03ef420 | 5043 | <term><varname>LimitBytes=</varname></term> |
c853f594 | 5044 | <listitem> |
885a4e6c ZJS |
5045 | <para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow |
5046 | in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is | |
5047 | reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed | |
5048 | as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and | |
5049 | kernel default is used.</para> | |
ec07c3c8 AK |
5050 | |
5051 | <xi:include href="version-info.xml" xpointer="v246"/> | |
c853f594 SS |
5052 | </listitem> |
5053 | </varlistentry> | |
5054 | </variablelist> | |
5055 | </refsect1> | |
5056 | ||
a7476065 SS |
5057 | <refsect1> |
5058 | <title>[PFIFO] Section Options</title> | |
bdac5608 ZJS |
5059 | <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out |
5060 | (pfifo).</para> | |
a7476065 SS |
5061 | |
5062 | <variablelist class='network-directives'> | |
f344a492 YW |
5063 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5064 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
a7476065 SS |
5065 | |
5066 | <varlistentry> | |
5067 | <term><varname>PacketLimit=</varname></term> | |
5068 | <listitem> | |
75909cc7 ZJS |
5069 | <para>Specifies the hard limit on the number of packets in the FIFO queue. The size limit prevents |
5070 | overflow in case the kernel is unable to dequeue packets as quickly as it receives them. When this | |
5071 | limit is reached, incoming packets are dropped. An unsigned integer in the range | |
69978eb9 | 5072 | 0…4294967294. Defaults to unset and kernel's default is used.</para> |
ec07c3c8 AK |
5073 | |
5074 | <xi:include href="version-info.xml" xpointer="v246"/> | |
a7476065 SS |
5075 | </listitem> |
5076 | </varlistentry> | |
ad8352f4 SS |
5077 | </variablelist> |
5078 | </refsect1> | |
5079 | ||
053a2ddb SS |
5080 | <refsect1> |
5081 | <title>[PFIFOHeadDrop] Section Options</title> | |
bdac5608 ZJS |
5082 | <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out |
5083 | Head Drop (pfifo_head_drop).</para> | |
053a2ddb SS |
5084 | |
5085 | <variablelist class='network-directives'> | |
f344a492 YW |
5086 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5087 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
053a2ddb SS |
5088 | |
5089 | <varlistentry> | |
5090 | <term><varname>PacketLimit=</varname></term> | |
5091 | <listitem> | |
ec07c3c8 AK |
5092 | <para>As in [PFIFO] section.</para> |
5093 | ||
5094 | <xi:include href="version-info.xml" xpointer="v246"/></listitem> | |
053a2ddb SS |
5095 | </varlistentry> |
5096 | </variablelist> | |
5097 | </refsect1> | |
5098 | ||
1a95964b SS |
5099 | <refsect1> |
5100 | <title>[PFIFOFast] Section Options</title> | |
bdac5608 ZJS |
5101 | <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast |
5102 | (pfifo_fast).</para> | |
1a95964b SS |
5103 | |
5104 | <variablelist class='network-directives'> | |
f344a492 YW |
5105 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5106 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
1a95964b SS |
5107 | </variablelist> |
5108 | </refsect1> | |
5109 | ||
ad8352f4 SS |
5110 | <refsect1> |
5111 | <title>[CAKE] Section Options</title> | |
bdac5608 ZJS |
5112 | <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced |
5113 | (CAKE).</para> | |
ad8352f4 SS |
5114 | |
5115 | <variablelist class='network-directives'> | |
f344a492 YW |
5116 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5117 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
a7476065 | 5118 | |
ad8352f4 | 5119 | <varlistentry> |
ca2c3e92 | 5120 | <term><varname>Bandwidth=</varname></term> |
ad8352f4 | 5121 | <listitem> |
ca2c3e92 YW |
5122 | <para>Specifies the shaper bandwidth. When suffixed with K, M, or G, the specified size is |
5123 | parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of 1000. Defaults to | |
5124 | unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5125 | |
5126 | <xi:include href="version-info.xml" xpointer="v246"/> | |
ad8352f4 | 5127 | </listitem> |
f344a492 | 5128 | </varlistentry> |
ad8352f4 | 5129 | |
025cd94e YW |
5130 | <varlistentry> |
5131 | <term><varname>AutoRateIngress=</varname></term> | |
5132 | <listitem> | |
5133 | <para>Takes a boolean value. Enables automatic capacity estimation based on traffic arriving | |
5134 | at this qdisc. This is most likely to be useful with cellular links, which tend to change | |
5135 | quality randomly. If this setting is enabled, the <varname>Bandwidth=</varname> setting is | |
5136 | used as an initial estimate. Defaults to unset, and the kernel's default is used.</para> | |
ec07c3c8 AK |
5137 | |
5138 | <xi:include href="version-info.xml" xpointer="v250"/> | |
025cd94e YW |
5139 | </listitem> |
5140 | </varlistentry> | |
5141 | ||
ad8352f4 | 5142 | <varlistentry> |
c03ef420 | 5143 | <term><varname>OverheadBytes=</varname></term> |
ad8352f4 | 5144 | <listitem> |
69978eb9 YW |
5145 | <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative. |
5146 | Takes an integer in the range -64…256. Defaults to unset and kernel's default is used. | |
5147 | </para> | |
ec07c3c8 AK |
5148 | |
5149 | <xi:include href="version-info.xml" xpointer="v246"/> | |
ad8352f4 | 5150 | </listitem> |
f344a492 | 5151 | </varlistentry> |
ad8352f4 SS |
5152 | |
5153 | <varlistentry> | |
863542e1 | 5154 | <term><varname>MPUBytes=</varname></term> |
ad8352f4 | 5155 | <listitem> |
863542e1 YW |
5156 | <para>Rounds each packet (including overhead) up to the specified bytes. Takes an integer in |
5157 | the range 1…256. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5158 | |
5159 | <xi:include href="version-info.xml" xpointer="v250"/> | |
863542e1 YW |
5160 | </listitem> |
5161 | </varlistentry> | |
5162 | ||
b6eccfda YW |
5163 | <varlistentry> |
5164 | <term><varname>CompensationMode=</varname></term> | |
5165 | <listitem> | |
5166 | <para>Takes one of <literal>none</literal>, <literal>atm</literal>, or <literal>ptm</literal>. | |
5167 | Specifies the compensation mode for overhead calculation. When <literal>none</literal>, no | |
5168 | compensation is taken into account. When <literal>atm</literal>, enables the compensation for | |
5169 | ATM cell framing, which is normally found on ADSL links. When <literal>ptm</literal>, enables | |
5170 | the compensation for PTM encoding, which is normally found on VDSL2 links and uses a 64b/65b | |
5171 | encoding scheme. Defaults to unset and the kernel's default is used.</para> | |
ec07c3c8 AK |
5172 | |
5173 | <xi:include href="version-info.xml" xpointer="v250"/> | |
b6eccfda YW |
5174 | </listitem> |
5175 | </varlistentry> | |
5176 | ||
1c7a81e6 YW |
5177 | <varlistentry> |
5178 | <term><varname>UseRawPacketSize=</varname></term> | |
5179 | <listitem> | |
5180 | <para>Takes a boolean value. When true, the packet size reported by the Linux kernel will be | |
5181 | used, instead of the underlying IP packet size. Defaults to unset, and the kernel's default | |
5182 | is used.</para> | |
ec07c3c8 AK |
5183 | |
5184 | <xi:include href="version-info.xml" xpointer="v250"/> | |
1c7a81e6 YW |
5185 | </listitem> |
5186 | </varlistentry> | |
5187 | ||
a049cf16 YW |
5188 | <varlistentry> |
5189 | <term><varname>FlowIsolationMode=</varname></term> | |
5190 | <listitem> | |
5191 | <para>CAKE places packets from different flows into different queues, then packets from each | |
5192 | queue are delivered fairly. This specifies whether the fairness is based on source address, | |
5193 | destination address, individual flows, or any combination of those. The available values are: | |
5194 | </para> | |
5195 | ||
5196 | <variablelist> | |
5197 | <varlistentry> | |
5198 | <term><option>none</option></term> | |
5199 | <listitem><para> | |
5200 | The flow isolation is disabled, and all traffic passes through a single queue. | |
ec07c3c8 AK |
5201 | </para> |
5202 | ||
5203 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5204 | </varlistentry> |
5205 | <varlistentry> | |
5206 | <term><option>src-host</option></term> | |
5207 | <listitem><para> | |
2f7a0648 | 5208 | Flows are defined only by source address. Equivalent to the <literal>srchost</literal> |
a049cf16 YW |
5209 | option for <command>tc qdisc</command> command. See also |
5210 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
ec07c3c8 AK |
5211 | </para> |
5212 | ||
5213 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5214 | </varlistentry> |
5215 | <varlistentry> | |
5216 | <term><option>dst-host</option></term> | |
5217 | <listitem><para> | |
2f7a0648 | 5218 | Flows are defined only by destination address. Equivalent to the |
d68c797c | 5219 | <literal>dsthost</literal> option for <command>tc qdisc</command> command. See also |
a049cf16 | 5220 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. |
ec07c3c8 AK |
5221 | </para> |
5222 | ||
5223 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5224 | </varlistentry> |
5225 | <varlistentry> | |
5226 | <term><option>hosts</option></term> | |
5227 | <listitem><para> | |
5228 | Flows are defined by source-destination host pairs. Equivalent to the same option for | |
5229 | <command>tc qdisc</command> command. See also | |
5230 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
ec07c3c8 AK |
5231 | </para> |
5232 | ||
5233 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5234 | </varlistentry> |
5235 | <varlistentry> | |
5236 | <term><option>flows</option></term> | |
5237 | <listitem><para> | |
5238 | Flows are defined by the entire 5-tuple of source address, destination address, | |
5239 | transport protocol, source port and destination port. Equivalent to the same option for | |
5240 | <command>tc qdisc</command> command. See also | |
5241 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
ec07c3c8 AK |
5242 | </para> |
5243 | ||
5244 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5245 | </varlistentry> |
5246 | <varlistentry> | |
5247 | <term><option>dual-src-host</option></term> | |
5248 | <listitem><para> | |
5249 | Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and | |
2f7a0648 | 5250 | fairness is applied first over source addresses, then over individual flows. Equivalent |
a049cf16 YW |
5251 | to the <literal>dual-srchost</literal> option for <command>tc qdisc</command> command. |
5252 | See also | |
5253 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
ec07c3c8 AK |
5254 | </para> |
5255 | ||
5256 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5257 | </varlistentry> |
5258 | <varlistentry> | |
5259 | <term><option>dual-dst-host</option></term> | |
5260 | <listitem><para> | |
5261 | Flows are defined by the 5-tuple (see <literal>flows</literal> in the above), and | |
5262 | fairness is applied first over destination addresses, then over individual flows. | |
2f7a0648 | 5263 | Equivalent to the <literal>dual-dsthost</literal> option for |
a049cf16 YW |
5264 | <command>tc qdisc</command> command. See also |
5265 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
ec07c3c8 AK |
5266 | </para> |
5267 | ||
5268 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5269 | </varlistentry> |
5270 | <varlistentry> | |
5271 | <term><option>triple</option></term> | |
5272 | <listitem><para> | |
5273 | Flows are defined by the 5-tuple (see <literal>flows</literal>), and fairness is | |
5274 | applied over source and destination addresses, and also over individual flows. | |
2f7a0648 | 5275 | Equivalent to the <literal>triple-isolate</literal> option for |
a049cf16 YW |
5276 | <command>tc qdisc</command> command. See also |
5277 | <citerefentry project='man-pages'><refentrytitle>tc-cake</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
ec07c3c8 AK |
5278 | </para> |
5279 | ||
5280 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
a049cf16 YW |
5281 | </varlistentry> |
5282 | </variablelist> | |
5283 | ||
5284 | <para>Defaults to unset and the kernel's default is used.</para> | |
ec07c3c8 AK |
5285 | |
5286 | <xi:include href="version-info.xml" xpointer="v250"/> | |
a049cf16 YW |
5287 | </listitem> |
5288 | </varlistentry> | |
5289 | ||
4bff8086 YW |
5290 | <varlistentry> |
5291 | <term><varname>NAT=</varname></term> | |
5292 | <listitem> | |
5293 | <para>Takes a boolean value. When true, CAKE performs a NAT lookup before applying | |
5294 | flow-isolation rules, to determine the true addresses and port numbers of the packet, to | |
5295 | improve fairness between hosts inside the NAT. This has no practical effect when | |
5296 | <varname>FlowIsolationMode=</varname> is <literal>none</literal> or <literal>flows</literal>, | |
5297 | or if NAT is performed on a different host. Defaults to unset, and the kernel's default is | |
5298 | used.</para> | |
ec07c3c8 AK |
5299 | |
5300 | <xi:include href="version-info.xml" xpointer="v250"/> | |
4bff8086 YW |
5301 | </listitem> |
5302 | </varlistentry> | |
5303 | ||
fe8e156e YW |
5304 | <varlistentry> |
5305 | <term><varname>PriorityQueueingPreset=</varname></term> | |
5306 | <listitem> | |
5307 | <para>CAKE divides traffic into <literal>tins</literal>, and each tin has its own independent | |
5308 | set of flow-isolation queues, bandwidth threshold, and priority. This specifies the preset of | |
5309 | tin profiles. The available values are:</para> | |
5310 | ||
5311 | <variablelist> | |
5312 | <varlistentry> | |
5313 | <term><option>besteffort</option></term> | |
5314 | <listitem><para> | |
5315 | Disables priority queueing by placing all traffic in one tin. | |
ec07c3c8 AK |
5316 | </para> |
5317 | ||
5318 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
fe8e156e YW |
5319 | </varlistentry> |
5320 | <varlistentry> | |
5321 | <term><option>precedence</option></term> | |
5322 | <listitem><para> | |
5323 | Enables priority queueing based on the legacy interpretation of TOS | |
5324 | <literal>Precedence</literal> field. Use of this preset on the modern Internet is | |
5325 | firmly discouraged. | |
ec07c3c8 AK |
5326 | </para> |
5327 | ||
5328 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
fe8e156e YW |
5329 | </varlistentry> |
5330 | <varlistentry> | |
5331 | <term><option>diffserv8</option></term> | |
5332 | <listitem><para> | |
5333 | Enables priority queueing based on the Differentiated Service | |
5334 | (<literal>DiffServ</literal>) field with eight tins: Background Traffic, High | |
5335 | Throughput, Best Effort, Video Streaming, Low Latency Transactions, Interactive Shell, | |
5336 | Minimum Latency, and Network Control. | |
ec07c3c8 AK |
5337 | </para> |
5338 | ||
5339 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
fe8e156e YW |
5340 | </varlistentry> |
5341 | <varlistentry> | |
5342 | <term><option>diffserv4</option></term> | |
5343 | <listitem><para> | |
5344 | Enables priority queueing based on the Differentiated Service | |
5345 | (<literal>DiffServ</literal>) field with four tins: Background Traffic, Best Effort, | |
5346 | Streaming Media, and Latency Sensitive. | |
ec07c3c8 AK |
5347 | </para> |
5348 | ||
5349 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
fe8e156e YW |
5350 | </varlistentry> |
5351 | <varlistentry> | |
5352 | <term><option>diffserv3</option></term> | |
5353 | <listitem><para> | |
5354 | Enables priority queueing based on the Differentiated Service | |
5355 | (<literal>DiffServ</literal>) field with three tins: Background Traffic, Best Effort, | |
5356 | and Latency Sensitive. | |
ec07c3c8 AK |
5357 | </para> |
5358 | ||
5359 | <xi:include href="version-info.xml" xpointer="v250"/></listitem> | |
fe8e156e YW |
5360 | </varlistentry> |
5361 | </variablelist> | |
5362 | ||
5363 | <para>Defaults to unset, and the kernel's default is used.</para> | |
ec07c3c8 AK |
5364 | |
5365 | <xi:include href="version-info.xml" xpointer="v250"/> | |
ad8352f4 SS |
5366 | </listitem> |
5367 | </varlistentry> | |
fe8e156e | 5368 | |
049b66cc YW |
5369 | <varlistentry> |
5370 | <term><varname>FirewallMark=</varname></term> | |
5371 | <listitem> | |
5372 | <para>Takes an integer in the range 1…4294967295. When specified, firewall-mark-based | |
5373 | overriding of CAKE's tin selection is enabled. Defaults to unset, and the kernel's default is | |
5374 | used.</para> | |
ec07c3c8 AK |
5375 | |
5376 | <xi:include href="version-info.xml" xpointer="v250"/> | |
049b66cc YW |
5377 | </listitem> |
5378 | </varlistentry> | |
5379 | ||
d05dce95 YW |
5380 | <varlistentry> |
5381 | <term><varname>Wash=</varname></term> | |
5382 | <listitem> | |
5383 | <para>Takes a boolean value. When true, CAKE clears the DSCP fields, except for ECN bits, of | |
5384 | any packet passing through CAKE. Defaults to unset, and the kernel's default is used.</para> | |
ec07c3c8 AK |
5385 | |
5386 | <xi:include href="version-info.xml" xpointer="v250"/> | |
d05dce95 YW |
5387 | </listitem> |
5388 | </varlistentry> | |
5389 | ||
35896db4 YW |
5390 | <varlistentry> |
5391 | <term><varname>SplitGSO=</varname></term> | |
5392 | <listitem> | |
5393 | <para>Takes a boolean value. When true, CAKE will split General Segmentation Offload (GSO) | |
5394 | super-packets into their on-the-wire components and dequeue them individually. Defaults to | |
5395 | unset, and the kernel's default is used.</para> | |
ec07c3c8 AK |
5396 | |
5397 | <xi:include href="version-info.xml" xpointer="v250"/> | |
35896db4 YW |
5398 | </listitem> |
5399 | </varlistentry> | |
5400 | ||
3af9cd0b YW |
5401 | <varlistentry> |
5402 | <term><varname>RTTSec=</varname></term> | |
5403 | <listitem> | |
5404 | <para>Specifies the RTT for the filter. Takes a timespan. Typical values are e.g. 100us for | |
5405 | extremely high-performance 10GigE+ networks like datacentre, 1ms for non-WiFi LAN connections, | |
5406 | 100ms for typical internet connections. Defaults to unset, and the kernel's default will be used. | |
5407 | </para> | |
ec07c3c8 AK |
5408 | |
5409 | <xi:include href="version-info.xml" xpointer="v253"/> | |
3af9cd0b YW |
5410 | </listitem> |
5411 | </varlistentry> | |
5412 | ||
8c920636 YW |
5413 | <varlistentry> |
5414 | <term><varname>AckFilter=</varname></term> | |
5415 | <listitem> | |
5416 | <para>Takes a boolean value, or special value <literal>aggressive</literal>. If enabled, ACKs in | |
5417 | each flow are queued and redundant ACKs to the upstream are dropped. If yes, the filter will always | |
5418 | keep at least two redundant ACKs in the queue, while in <literal>aggressive</literal> mode, it will | |
5419 | filter down to a single ACK. This may improve download throughput on links with very asymmetrical | |
5420 | rate limits. Defaults to unset, and the kernel's default will be used.</para> | |
ec07c3c8 AK |
5421 | |
5422 | <xi:include href="version-info.xml" xpointer="v253"/> | |
8c920636 YW |
5423 | </listitem> |
5424 | </varlistentry> | |
5425 | ||
a7476065 SS |
5426 | </variablelist> |
5427 | </refsect1> | |
5428 | ||
18de0969 YW |
5429 | <refsect1> |
5430 | <title>[ControlledDelay] Section Options</title> | |
bdac5608 | 5431 | <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of |
18de0969 | 5432 | controlled delay (CoDel).</para> |
9942b710 | 5433 | |
18de0969 | 5434 | <variablelist class='network-directives'> |
f344a492 YW |
5435 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5436 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 5437 | |
18de0969 YW |
5438 | <varlistentry> |
5439 | <term><varname>PacketLimit=</varname></term> | |
a9a5d632 | 5440 | <listitem> |
e9dd6984 | 5441 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, |
69978eb9 | 5442 | incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and |
e9dd6984 | 5443 | kernel's default is used.</para> |
ec07c3c8 AK |
5444 | |
5445 | <xi:include href="version-info.xml" xpointer="v245"/> | |
a9a5d632 SS |
5446 | </listitem> |
5447 | </varlistentry> | |
5448 | ||
b078e528 | 5449 | <varlistentry> |
18de0969 | 5450 | <term><varname>TargetSec=</varname></term> |
b078e528 YW |
5451 | <listitem> |
5452 | <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay. | |
5453 | Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5454 | |
5455 | <xi:include href="version-info.xml" xpointer="v245"/> | |
b078e528 YW |
5456 | </listitem> |
5457 | </varlistentry> | |
5458 | ||
5459 | <varlistentry> | |
18de0969 | 5460 | <term><varname>IntervalSec=</varname></term> |
b078e528 YW |
5461 | <listitem> |
5462 | <para>Takes a timespan. This is used to ensure that the measured minimum delay does not | |
5463 | become too stale. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5464 | |
5465 | <xi:include href="version-info.xml" xpointer="v245"/> | |
b078e528 YW |
5466 | </listitem> |
5467 | </varlistentry> | |
5468 | ||
5469 | <varlistentry> | |
18de0969 | 5470 | <term><varname>ECN=</varname></term> |
b078e528 YW |
5471 | <listitem> |
5472 | <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to | |
5473 | unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5474 | |
5475 | <xi:include href="version-info.xml" xpointer="v245"/> | |
b078e528 YW |
5476 | </listitem> |
5477 | </varlistentry> | |
5478 | ||
5479 | <varlistentry> | |
18de0969 | 5480 | <term><varname>CEThresholdSec=</varname></term> |
b078e528 YW |
5481 | <listitem> |
5482 | <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN | |
5483 | Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5484 | |
5485 | <xi:include href="version-info.xml" xpointer="v245"/> | |
b078e528 YW |
5486 | </listitem> |
5487 | </varlistentry> | |
18de0969 YW |
5488 | </variablelist> |
5489 | </refsect1> | |
b078e528 | 5490 | |
f5fc0441 SS |
5491 | <refsect1> |
5492 | <title>[DeficitRoundRobinScheduler] Section Options</title> | |
bdac5608 ZJS |
5493 | <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round |
5494 | Robin Scheduler (DRR).</para> | |
f5fc0441 SS |
5495 | |
5496 | <variablelist class='network-directives'> | |
f344a492 YW |
5497 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5498 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
f5fc0441 SS |
5499 | </variablelist> |
5500 | </refsect1> | |
5501 | ||
ad365c5d YW |
5502 | <refsect1> |
5503 | <title>[DeficitRoundRobinSchedulerClass] Section Options</title> | |
bdac5608 ZJS |
5504 | <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round |
5505 | Robin Scheduler (DRR).</para> | |
ad365c5d YW |
5506 | |
5507 | <variablelist class='network-directives'> | |
f344a492 YW |
5508 | <xi:include href="tc.xml" xpointer="tclass-parent" /> |
5509 | <xi:include href="tc.xml" xpointer="tclass-classid" /> | |
ad365c5d YW |
5510 | |
5511 | <varlistentry> | |
c03ef420 | 5512 | <term><varname>QuantumBytes=</varname></term> |
ad365c5d | 5513 | <listitem> |
c03ef420 YW |
5514 | <para>Specifies the amount of bytes a flow is allowed to dequeue before the scheduler moves |
5515 | to the next class. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, | |
5516 | Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to the MTU of the | |
5517 | interface.</para> | |
ec07c3c8 AK |
5518 | |
5519 | <xi:include href="version-info.xml" xpointer="v246"/> | |
ad365c5d YW |
5520 | </listitem> |
5521 | </varlistentry> | |
5522 | ||
5523 | </variablelist> | |
5524 | </refsect1> | |
5525 | ||
d474aa51 YW |
5526 | <refsect1> |
5527 | <title>[EnhancedTransmissionSelection] Section Options</title> | |
bdac5608 ZJS |
5528 | <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced |
5529 | Transmission Selection (ETS).</para> | |
d474aa51 YW |
5530 | |
5531 | <variablelist class='network-directives'> | |
5532 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> | |
5533 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
5534 | ||
5535 | <varlistentry> | |
5536 | <term><varname>Bands=</varname></term> | |
5537 | <listitem> | |
69978eb9 | 5538 | <para>Specifies the number of bands. An unsigned integer in the range 1…16. This value has to be at |
e9dd6984 ZJS |
5539 | least large enough to cover the strict bands specified through the <varname>StrictBands=</varname> |
5540 | and bandwidth-sharing bands specified in <varname>QuantumBytes=</varname>.</para> | |
ec07c3c8 AK |
5541 | |
5542 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d474aa51 YW |
5543 | </listitem> |
5544 | </varlistentry> | |
5545 | ||
5546 | <varlistentry> | |
5547 | <term><varname>StrictBands=</varname></term> | |
5548 | <listitem> | |
e9dd6984 | 5549 | <para>Specifies the number of bands that should be created in strict mode. An unsigned integer in |
69978eb9 | 5550 | the range 1…16.</para> |
ec07c3c8 AK |
5551 | |
5552 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d474aa51 YW |
5553 | </listitem> |
5554 | </varlistentry> | |
5555 | ||
5556 | <varlistentry> | |
5557 | <term><varname>QuantumBytes=</varname></term> | |
5558 | <listitem> | |
5559 | <para>Specifies the white-space separated list of quantum used in band-sharing bands. When | |
5560 | suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, | |
5561 | respectively, to the base of 1024. This setting can be specified multiple times. If an empty | |
5562 | string is assigned, then the all previous assignments are cleared.</para> | |
ec07c3c8 AK |
5563 | |
5564 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d474aa51 YW |
5565 | </listitem> |
5566 | </varlistentry> | |
5567 | ||
5568 | <varlistentry> | |
5569 | <term><varname>PriorityMap=</varname></term> | |
5570 | <listitem> | |
885a4e6c ZJS |
5571 | <para>The priority map maps the priority of a packet to a band. The argument is a whitespace |
5572 | separated list of numbers. The first number indicates which band the packets with priority 0 should | |
5573 | be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If | |
5574 | there are fewer, the default band that traffic with one of the unmentioned priorities goes to is | |
1d3a473b | 5575 | the last one. Each band number must be in the range 0…255. This setting can be specified multiple |
885a4e6c | 5576 | times. If an empty string is assigned, then the all previous assignments are cleared.</para> |
ec07c3c8 AK |
5577 | |
5578 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d474aa51 YW |
5579 | </listitem> |
5580 | </varlistentry> | |
5581 | </variablelist> | |
5582 | </refsect1> | |
5583 | ||
609e8340 SS |
5584 | <refsect1> |
5585 | <title>[GenericRandomEarlyDetection] Section Options</title> | |
bdac5608 ZJS |
5586 | <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random |
5587 | Early Detection (GRED).</para> | |
609e8340 SS |
5588 | |
5589 | <variablelist class='network-directives'> | |
f344a492 YW |
5590 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5591 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
609e8340 SS |
5592 | |
5593 | <varlistentry> | |
5594 | <term><varname>VirtualQueues=</varname></term> | |
5595 | <listitem> | |
387f6955 | 5596 | <para>Specifies the number of virtual queues. Takes an integer in the range 1…16. Defaults to unset |
1d3a473b | 5597 | and kernel's default is used.</para> |
ec07c3c8 AK |
5598 | |
5599 | <xi:include href="version-info.xml" xpointer="v246"/> | |
609e8340 SS |
5600 | </listitem> |
5601 | </varlistentry> | |
5602 | ||
5603 | <varlistentry> | |
5604 | <term><varname>DefaultVirtualQueue=</varname></term> | |
5605 | <listitem> | |
5606 | <para>Specifies the number of default virtual queue. This must be less than <varname>VirtualQueue=</varname>. | |
5607 | Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5608 | |
5609 | <xi:include href="version-info.xml" xpointer="v246"/> | |
609e8340 SS |
5610 | </listitem> |
5611 | </varlistentry> | |
5612 | ||
5613 | <varlistentry> | |
5614 | <term><varname>GenericRIO=</varname></term> | |
5615 | <listitem> | |
5616 | <para>Takes a boolean. It turns on the RIO-like buffering scheme. Defaults to | |
5617 | unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5618 | |
5619 | <xi:include href="version-info.xml" xpointer="v246"/> | |
609e8340 SS |
5620 | </listitem> |
5621 | </varlistentry> | |
5622 | </variablelist> | |
5623 | </refsect1> | |
5624 | ||
18de0969 YW |
5625 | <refsect1> |
5626 | <title>[FairQueueingControlledDelay] Section Options</title> | |
bdac5608 ZJS |
5627 | <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing |
5628 | controlled delay (FQ-CoDel).</para> | |
18de0969 YW |
5629 | |
5630 | <variablelist class='network-directives'> | |
f344a492 YW |
5631 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5632 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 5633 | |
18de0969 YW |
5634 | <varlistentry> |
5635 | <term><varname>PacketLimit=</varname></term> | |
4e5ef149 SS |
5636 | <listitem> |
5637 | <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are | |
5638 | dropped. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5639 | |
5640 | <xi:include href="version-info.xml" xpointer="v245"/> | |
4e5ef149 SS |
5641 | </listitem> |
5642 | </varlistentry> | |
5643 | ||
ac810b75 | 5644 | <varlistentry> |
c03ef420 | 5645 | <term><varname>MemoryLimitBytes=</varname></term> |
ac810b75 YW |
5646 | <listitem> |
5647 | <para>Specifies the limit on the total number of bytes that can be queued in this FQ-CoDel instance. | |
5648 | When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, | |
5649 | respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5650 | |
5651 | <xi:include href="version-info.xml" xpointer="v246"/> | |
ac810b75 YW |
5652 | </listitem> |
5653 | </varlistentry> | |
5654 | ||
5655 | <varlistentry> | |
18de0969 | 5656 | <term><varname>Flows=</varname></term> |
ac810b75 YW |
5657 | <listitem> |
5658 | <para>Specifies the number of flows into which the incoming packets are classified. | |
5659 | Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5660 | |
5661 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ac810b75 YW |
5662 | </listitem> |
5663 | </varlistentry> | |
5664 | ||
5665 | <varlistentry> | |
18de0969 | 5666 | <term><varname>TargetSec=</varname></term> |
ac810b75 YW |
5667 | <listitem> |
5668 | <para>Takes a timespan. Specifies the acceptable minimum standing/persistent queue delay. | |
5669 | Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5670 | |
5671 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ac810b75 YW |
5672 | </listitem> |
5673 | </varlistentry> | |
5674 | ||
5675 | <varlistentry> | |
18de0969 | 5676 | <term><varname>IntervalSec=</varname></term> |
ac810b75 YW |
5677 | <listitem> |
5678 | <para>Takes a timespan. This is used to ensure that the measured minimum delay does not | |
5679 | become too stale. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5680 | |
5681 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ac810b75 YW |
5682 | </listitem> |
5683 | </varlistentry> | |
5684 | ||
5685 | <varlistentry> | |
c03ef420 | 5686 | <term><varname>QuantumBytes=</varname></term> |
ac810b75 | 5687 | <listitem> |
e9dd6984 | 5688 | <para>Specifies the number of bytes used as the "deficit" in the fair queuing algorithm timespan. |
ac810b75 YW |
5689 | When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, |
5690 | respectively, to the base of 1024. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5691 | |
5692 | <xi:include href="version-info.xml" xpointer="v246"/> | |
ac810b75 YW |
5693 | </listitem> |
5694 | </varlistentry> | |
5695 | ||
5696 | <varlistentry> | |
18de0969 | 5697 | <term><varname>ECN=</varname></term> |
ac810b75 YW |
5698 | <listitem> |
5699 | <para>Takes a boolean. This can be used to mark packets instead of dropping them. Defaults to | |
5700 | unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5701 | |
5702 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ac810b75 YW |
5703 | </listitem> |
5704 | </varlistentry> | |
5705 | ||
5706 | <varlistentry> | |
18de0969 | 5707 | <term><varname>CEThresholdSec=</varname></term> |
ac810b75 YW |
5708 | <listitem> |
5709 | <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN | |
5710 | Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5711 | |
5712 | <xi:include href="version-info.xml" xpointer="v245"/> | |
ac810b75 YW |
5713 | </listitem> |
5714 | </varlistentry> | |
18de0969 YW |
5715 | </variablelist> |
5716 | </refsect1> | |
5717 | ||
5718 | <refsect1> | |
ca58d00c | 5719 | <title>[FairQueueing] Section Options</title> |
bdac5608 ZJS |
5720 | <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing |
5721 | (FQ).</para> | |
18de0969 YW |
5722 | |
5723 | <variablelist class='network-directives'> | |
f344a492 YW |
5724 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5725 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 5726 | |
7234b915 | 5727 | <varlistentry> |
18de0969 | 5728 | <term><varname>PacketLimit=</varname></term> |
7234b915 SS |
5729 | <listitem> |
5730 | <para>Specifies the hard limit on the real queue size. When this limit is reached, incoming packets are | |
5731 | dropped. Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5732 | |
5733 | <xi:include href="version-info.xml" xpointer="v245"/> | |
7234b915 SS |
5734 | </listitem> |
5735 | </varlistentry> | |
5736 | ||
e83562e5 | 5737 | <varlistentry> |
18de0969 | 5738 | <term><varname>FlowLimit=</varname></term> |
e83562e5 YW |
5739 | <listitem> |
5740 | <para>Specifies the hard limit on the maximum number of packets queued per flow. Defaults to | |
5741 | unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5742 | |
5743 | <xi:include href="version-info.xml" xpointer="v245"/> | |
e83562e5 YW |
5744 | </listitem> |
5745 | </varlistentry> | |
5746 | ||
5747 | <varlistentry> | |
c03ef420 | 5748 | <term><varname>QuantumBytes=</varname></term> |
e83562e5 YW |
5749 | <listitem> |
5750 | <para>Specifies the credit per dequeue RR round, i.e. the amount of bytes a flow is allowed | |
5751 | to dequeue at once. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, | |
5752 | Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and kernel's | |
5753 | default is used.</para> | |
ec07c3c8 AK |
5754 | |
5755 | <xi:include href="version-info.xml" xpointer="v246"/> | |
e83562e5 YW |
5756 | </listitem> |
5757 | </varlistentry> | |
5758 | ||
5759 | <varlistentry> | |
c03ef420 | 5760 | <term><varname>InitialQuantumBytes=</varname></term> |
e83562e5 YW |
5761 | <listitem> |
5762 | <para>Specifies the initial sending rate credit, i.e. the amount of bytes a new flow is | |
5763 | allowed to dequeue initially. When suffixed with K, M, or G, the specified size is parsed as | |
5764 | Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and | |
5765 | kernel's default is used.</para> | |
ec07c3c8 | 5766 | |
aefdc112 | 5767 | <xi:include href="version-info.xml" xpointer="v245"/> |
e83562e5 YW |
5768 | </listitem> |
5769 | </varlistentry> | |
5770 | ||
5771 | <varlistentry> | |
18de0969 | 5772 | <term><varname>MaximumRate=</varname></term> |
e83562e5 YW |
5773 | <listitem> |
5774 | <para>Specifies the maximum sending rate of a flow. When suffixed with K, M, or G, the | |
6b8fe4c3 | 5775 | specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, to the base of |
e83562e5 | 5776 | 1000. Defaults to unset and kernel's default is used.</para> |
ec07c3c8 AK |
5777 | |
5778 | <xi:include href="version-info.xml" xpointer="v245"/> | |
e83562e5 YW |
5779 | </listitem> |
5780 | </varlistentry> | |
5781 | ||
5782 | <varlistentry> | |
18de0969 | 5783 | <term><varname>Buckets=</varname></term> |
e83562e5 YW |
5784 | <listitem> |
5785 | <para>Specifies the size of the hash table used for flow lookups. Defaults to unset and | |
5786 | kernel's default is used.</para> | |
ec07c3c8 AK |
5787 | |
5788 | <xi:include href="version-info.xml" xpointer="v245"/> | |
e83562e5 YW |
5789 | </listitem> |
5790 | </varlistentry> | |
5791 | ||
5792 | <varlistentry> | |
18de0969 | 5793 | <term><varname>OrphanMask=</varname></term> |
e83562e5 YW |
5794 | <listitem> |
5795 | <para>Takes an unsigned integer. For packets not owned by a socket, fq is able to mask a part | |
5796 | of hash and reduce number of buckets associated with the traffic. Defaults to unset and | |
5797 | kernel's default is used.</para> | |
ec07c3c8 AK |
5798 | |
5799 | <xi:include href="version-info.xml" xpointer="v245"/> | |
e83562e5 YW |
5800 | </listitem> |
5801 | </varlistentry> | |
5802 | ||
5803 | <varlistentry> | |
18de0969 | 5804 | <term><varname>Pacing=</varname></term> |
e83562e5 YW |
5805 | <listitem> |
5806 | <para>Takes a boolean, and enables or disables flow pacing. Defaults to unset and kernel's | |
5807 | default is used.</para> | |
ec07c3c8 AK |
5808 | |
5809 | <xi:include href="version-info.xml" xpointer="v245"/> | |
e83562e5 YW |
5810 | </listitem> |
5811 | </varlistentry> | |
5812 | ||
5813 | <varlistentry> | |
18de0969 | 5814 | <term><varname>CEThresholdSec=</varname></term> |
e83562e5 YW |
5815 | <listitem> |
5816 | <para>Takes a timespan. This sets a threshold above which all packets are marked with ECN | |
5817 | Congestion Experienced (CE). Defaults to unset and kernel's default is used.</para> | |
ec07c3c8 AK |
5818 | |
5819 | <xi:include href="version-info.xml" xpointer="v245"/> | |
e83562e5 YW |
5820 | </listitem> |
5821 | </varlistentry> | |
0f5bd7fe SS |
5822 | </variablelist> |
5823 | </refsect1> | |
5824 | ||
9b749c11 YW |
5825 | <refsect1> |
5826 | <title>[TrivialLinkEqualizer] Section Options</title> | |
bdac5608 ZJS |
5827 | <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link |
5828 | equalizer (teql).</para> | |
9b749c11 YW |
5829 | |
5830 | <variablelist class='network-directives'> | |
f344a492 YW |
5831 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5832 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
d8b2396d | 5833 | |
9b749c11 YW |
5834 | <varlistentry> |
5835 | <term><varname>Id=</varname></term> | |
5836 | <listitem> | |
5837 | <para>Specifies the interface ID <literal>N</literal> of teql. Defaults to <literal>0</literal>. | |
5838 | Note that when teql is used, currently, the module <constant>sch_teql</constant> with | |
5839 | <constant>max_equalizers=N+1</constant> option must be loaded before | |
5840 | <command>systemd-networkd</command> is started.</para> | |
ec07c3c8 AK |
5841 | |
5842 | <xi:include href="version-info.xml" xpointer="v245"/> | |
9b749c11 YW |
5843 | </listitem> |
5844 | </varlistentry> | |
5845 | </variablelist> | |
5846 | </refsect1> | |
5847 | ||
b934ac3d YW |
5848 | <refsect1> |
5849 | <title>[HierarchyTokenBucket] Section Options</title> | |
bdac5608 ZJS |
5850 | <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token |
5851 | bucket (htb).</para> | |
b934ac3d YW |
5852 | |
5853 | <variablelist class='network-directives'> | |
f344a492 YW |
5854 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5855 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
b934ac3d YW |
5856 | |
5857 | <varlistentry> | |
5858 | <term><varname>DefaultClass=</varname></term> | |
5859 | <listitem> | |
5860 | <para>Takes the minor id in hexadecimal of the default class. Unclassified traffic gets sent | |
5861 | to the class. Defaults to unset.</para> | |
ec07c3c8 AK |
5862 | |
5863 | <xi:include href="version-info.xml" xpointer="v246"/> | |
b934ac3d YW |
5864 | </listitem> |
5865 | </varlistentry> | |
d9eacc1c YW |
5866 | |
5867 | <varlistentry> | |
5868 | <term><varname>RateToQuantum=</varname></term> | |
5869 | <listitem> | |
5870 | <para>Takes an unsigned integer. The DRR quantums are calculated by dividing the value | |
5871 | configured in <varname>Rate=</varname> by <varname>RateToQuantum=</varname>.</para> | |
ec07c3c8 AK |
5872 | |
5873 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d9eacc1c YW |
5874 | </listitem> |
5875 | </varlistentry> | |
b934ac3d YW |
5876 | </variablelist> |
5877 | </refsect1> | |
5878 | ||
19f86a63 YW |
5879 | <refsect1> |
5880 | <title>[HierarchyTokenBucketClass] Section Options</title> | |
bdac5608 ZJS |
5881 | <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket |
5882 | (htb).</para> | |
19f86a63 YW |
5883 | |
5884 | <variablelist class='network-directives'> | |
f344a492 YW |
5885 | <xi:include href="tc.xml" xpointer="tclass-parent" /> |
5886 | <xi:include href="tc.xml" xpointer="tclass-classid" /> | |
19f86a63 YW |
5887 | |
5888 | <varlistentry> | |
5889 | <term><varname>Priority=</varname></term> | |
5890 | <listitem> | |
5891 | <para>Specifies the priority of the class. In the round-robin process, classes with the lowest | |
d9eacc1c | 5892 | priority field are tried for packets first.</para> |
ec07c3c8 AK |
5893 | |
5894 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d9eacc1c YW |
5895 | </listitem> |
5896 | </varlistentry> | |
5897 | ||
5898 | <varlistentry> | |
5899 | <term><varname>QuantumBytes=</varname></term> | |
5900 | <listitem> | |
5901 | <para>Specifies how many bytes to serve from leaf at once. When suffixed with K, M, or G, the | |
5902 | specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of | |
5903 | 1024.</para> | |
ec07c3c8 AK |
5904 | |
5905 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d9eacc1c YW |
5906 | </listitem> |
5907 | </varlistentry> | |
5908 | ||
5909 | <varlistentry> | |
5910 | <term><varname>MTUBytes=</varname></term> | |
5911 | <listitem> | |
5912 | <para>Specifies the maximum packet size we create. When suffixed with K, M, or G, the specified | |
5913 | size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024.</para> | |
ec07c3c8 AK |
5914 | |
5915 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d9eacc1c YW |
5916 | </listitem> |
5917 | </varlistentry> | |
5918 | ||
5919 | <varlistentry> | |
5920 | <term><varname>OverheadBytes=</varname></term> | |
5921 | <listitem> | |
5922 | <para>Takes an unsigned integer which specifies per-packet size overhead used in rate | |
5923 | computations. When suffixed with K, M, or G, the specified size is parsed as Kilobytes, | |
5924 | Megabytes, or Gigabytes, respectively, to the base of 1024.</para> | |
ec07c3c8 AK |
5925 | |
5926 | <xi:include href="version-info.xml" xpointer="v246"/> | |
19f86a63 YW |
5927 | </listitem> |
5928 | </varlistentry> | |
5929 | ||
5930 | <varlistentry> | |
5931 | <term><varname>Rate=</varname></term> | |
5932 | <listitem> | |
5933 | <para>Specifies the maximum rate this class and all its children are guaranteed. When suffixed | |
5934 | with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, respectively, | |
5935 | to the base of 1000. This setting is mandatory.</para> | |
ec07c3c8 AK |
5936 | |
5937 | <xi:include href="version-info.xml" xpointer="v246"/> | |
19f86a63 YW |
5938 | </listitem> |
5939 | </varlistentry> | |
5940 | ||
5941 | <varlistentry> | |
5942 | <term><varname>CeilRate=</varname></term> | |
5943 | <listitem> | |
5944 | <para>Specifies the maximum rate at which a class can send, if its parent has bandwidth to spare. | |
5945 | When suffixed with K, M, or G, the specified size is parsed as Kilobits, Megabits, or Gigabits, | |
5946 | respectively, to the base of 1000. When unset, the value specified with <varname>Rate=</varname> | |
5947 | is used.</para> | |
ec07c3c8 AK |
5948 | |
5949 | <xi:include href="version-info.xml" xpointer="v246"/> | |
19f86a63 YW |
5950 | </listitem> |
5951 | </varlistentry> | |
d9eacc1c YW |
5952 | |
5953 | <varlistentry> | |
5954 | <term><varname>BufferBytes=</varname></term> | |
5955 | <listitem> | |
5956 | <para>Specifies the maximum bytes burst which can be accumulated during idle period. When suffixed | |
5957 | with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, | |
5958 | to the base of 1024.</para> | |
ec07c3c8 AK |
5959 | |
5960 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d9eacc1c YW |
5961 | </listitem> |
5962 | </varlistentry> | |
5963 | ||
5964 | <varlistentry> | |
5965 | <term><varname>CeilBufferBytes=</varname></term> | |
5966 | <listitem> | |
5967 | <para>Specifies the maximum bytes burst for ceil which can be accumulated during idle period. | |
5968 | When suffixed with K, M, or G, the specified size is parsed as Kilobytes, Megabytes, or Gigabytes, | |
5969 | respectively, to the base of 1024.</para> | |
ec07c3c8 AK |
5970 | |
5971 | <xi:include href="version-info.xml" xpointer="v246"/> | |
d9eacc1c YW |
5972 | </listitem> |
5973 | </varlistentry> | |
7f224020 SS |
5974 | </variablelist> |
5975 | </refsect1> | |
5976 | ||
5977 | <refsect1> | |
5978 | <title>[HeavyHitterFilter] Section Options</title> | |
bdac5608 ZJS |
5979 | <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter |
5980 | (hhf).</para> | |
7f224020 SS |
5981 | |
5982 | <variablelist class='network-directives'> | |
f344a492 YW |
5983 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> |
5984 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
19f86a63 | 5985 | |
7f224020 SS |
5986 | <varlistentry> |
5987 | <term><varname>PacketLimit=</varname></term> | |
5988 | <listitem> | |
e9dd6984 | 5989 | <para>Specifies the hard limit on the queue size in number of packets. When this limit is reached, |
69978eb9 | 5990 | incoming packets are dropped. An unsigned integer in the range 0…4294967294. Defaults to unset and |
e9dd6984 | 5991 | kernel's default is used.</para> |
ec07c3c8 AK |
5992 | |
5993 | <xi:include href="version-info.xml" xpointer="v246"/> | |
7f224020 SS |
5994 | </listitem> |
5995 | </varlistentry> | |
19f86a63 YW |
5996 | </variablelist> |
5997 | </refsect1> | |
5998 | ||
b12aaee5 SS |
5999 | <refsect1> |
6000 | <title>[QuickFairQueueing] Section Options</title> | |
bdac5608 ZJS |
6001 | <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing |
6002 | (QFQ).</para> | |
b12aaee5 SS |
6003 | |
6004 | <variablelist class='network-directives'> | |
6005 | <xi:include href="tc.xml" xpointer="qdisc-parent" /> | |
6006 | <xi:include href="tc.xml" xpointer="qdisc-handle" /> | |
6007 | </variablelist> | |
6008 | </refsect1> | |
6009 | ||
4d7ddaf9 YW |
6010 | <refsect1> |
6011 | <title>[QuickFairQueueingClass] Section Options</title> | |
bdac5608 ZJS |
6012 | <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing |
6013 | (qfq).</para> | |
4d7ddaf9 YW |
6014 | |
6015 | <variablelist class='network-directives'> | |
6016 | <xi:include href="tc.xml" xpointer="tclass-parent" /> | |
6017 | <xi:include href="tc.xml" xpointer="tclass-classid" /> | |
6018 | ||
6019 | <varlistentry> | |
6020 | <term><varname>Weight=</varname></term> | |
6021 | <listitem> | |
1d3a473b | 6022 | <para>Specifies the weight of the class. Takes an integer in the range 1…1023. Defaults to |
4d7ddaf9 | 6023 | unset in which case the kernel default is used.</para> |
ec07c3c8 AK |
6024 | |
6025 | <xi:include href="version-info.xml" xpointer="v246"/> | |
4d7ddaf9 YW |
6026 | </listitem> |
6027 | </varlistentry> | |
6028 | ||
6029 | <varlistentry> | |
c03ef420 | 6030 | <term><varname>MaxPacketBytes=</varname></term> |
4d7ddaf9 | 6031 | <listitem> |
75909cc7 ZJS |
6032 | <para>Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the |
6033 | specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of | |
6034 | 1024. When unset, the kernel default is used.</para> | |
ec07c3c8 AK |
6035 | |
6036 | <xi:include href="version-info.xml" xpointer="v246"/> | |
4d7ddaf9 YW |
6037 | </listitem> |
6038 | </varlistentry> | |
6039 | </variablelist> | |
6040 | </refsect1> | |
6041 | ||
13b498f9 TJ |
6042 | <refsect1> |
6043 | <title>[BridgeVLAN] Section Options</title> | |
03a46b5e YW |
6044 | <para> |
6045 | The [BridgeVLAN] section manages the VLAN ID configurations of a bridge master or port, and accepts the | |
6046 | following keys. To make the settings in this section take an effect, | |
6047 | <varname>VLANFiltering=</varname> option has to be enabled on the bridge master, see the [Bridge] | |
6048 | section in | |
6049 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
6050 | If at least one valid settings specified in this section in a .network file for an interface, all | |
6051 | assigned VLAN IDs on the interface that are not configured in the .network file will be removed. If | |
6052 | VLAN IDs on an interface need to be managed by other tools, then the settings in this section cannot | |
6053 | be used in the matching .network file. | |
6054 | </para> | |
b9e6e925 YW |
6055 | |
6056 | <variablelist class='network-directives'> | |
6057 | <varlistentry> | |
6058 | <term><varname>VLAN=</varname></term> | |
6059 | <listitem> | |
6060 | <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes an | |
6061 | integer in the range 1…4094. This setting can be specified multiple times. If an empty string is | |
6062 | assigned, then the all previous assignments are cleared.</para> | |
6063 | ||
6064 | <xi:include href="version-info.xml" xpointer="v231"/> | |
6065 | </listitem> | |
6066 | </varlistentry> | |
6067 | <varlistentry> | |
6068 | <term><varname>EgressUntagged=</varname></term> | |
6069 | <listitem> | |
6070 | <para>The VLAN ID specified here will be used to untag frames on egress. Configuring | |
6071 | <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will | |
6072 | enable the VLAN ID for ingress as well. This can be either a single ID or a range M-N. This | |
6073 | setting can be specified multiple times. If an empty string is assigned, then the all previous | |
6074 | assignments are cleared.</para> | |
6075 | ||
6076 | <xi:include href="version-info.xml" xpointer="v231"/> | |
6077 | </listitem> | |
6078 | </varlistentry> | |
6079 | <varlistentry> | |
6080 | <term><varname>PVID=</varname></term> | |
6081 | <listitem> | |
6082 | <para>The port VLAN ID specified here is assigned to all untagged frames at ingress. Takes an | |
6083 | VLAN ID or negative boolean value (e.g. <literal>no</literal>). When false, the currently | |
6084 | assigned port VLAN ID will be dropped. Configuring <varname>PVID=</varname> implicates the use of | |
6085 | <varname>VLAN=</varname> setting in the above and will enable the VLAN ID for ingress as well. | |
6086 | Defaults to unset, and will keep the assigned port VLAN ID if exists.</para> | |
6087 | ||
6088 | <xi:include href="version-info.xml" xpointer="v231"/> | |
6089 | </listitem> | |
6090 | </varlistentry> | |
6091 | </variablelist> | |
13b498f9 | 6092 | </refsect1> |
798d3a52 ZJS |
6093 | |
6094 | <refsect1> | |
9e35b3de | 6095 | <title>Examples</title> |
798d3a52 | 6096 | <example> |
9e35b3de | 6097 | <title>Static network configuration</title> |
798d3a52 | 6098 | |
9e35b3de ZJS |
6099 | <programlisting># /etc/systemd/network/50-static.network |
6100 | [Match] | |
eac684ef TG |
6101 | Name=enp2s0 |
6102 | ||
6103 | [Network] | |
6104 | Address=192.168.0.15/24 | |
6105 | Gateway=192.168.0.1</programlisting> | |
9e35b3de ZJS |
6106 | |
6107 | <para>This brings interface <literal>enp2s0</literal> up with a static address. The | |
6108 | specified gateway will be used for a default route.</para> | |
798d3a52 | 6109 | </example> |
eac684ef | 6110 | |
798d3a52 | 6111 | <example> |
9e35b3de | 6112 | <title>DHCP on ethernet links</title> |
eac684ef | 6113 | |
9e35b3de ZJS |
6114 | <programlisting># /etc/systemd/network/80-dhcp.network |
6115 | [Match] | |
eac684ef TG |
6116 | Name=en* |
6117 | ||
6118 | [Network] | |
9c8ca3f7 | 6119 | DHCP=yes</programlisting> |
9e35b3de ZJS |
6120 | |
6121 | <para>This will enable DHCPv4 and DHCPv6 on all interfaces with names starting with | |
6122 | <literal>en</literal> (i.e. ethernet interfaces).</para> | |
798d3a52 | 6123 | </example> |
eac684ef | 6124 | |
4c94a4c2 | 6125 | <example> |
d4579825 | 6126 | <title>IPv6 Prefix Delegation (DHCPv6 PD)</title> |
4c94a4c2 | 6127 | |
d4579825 | 6128 | <programlisting># /etc/systemd/network/55-dhcpv6-pd-upstream.network |
4c94a4c2 | 6129 | [Match] |
6130 | Name=enp1s0 | |
6131 | ||
6132 | [Network] | |
d4579825 | 6133 | DHCP=ipv6 |
4c94a4c2 | 6134 | |
d4579825 YW |
6135 | # The below setting is optional, to also assign an address in the delegated prefix |
6136 | # to the upstream interface. If not necessary, then comment out the line below and | |
6137 | # the [DHCPPrefixDelegation] section. | |
6138 | DHCPPrefixDelegation=yes | |
6139 | ||
6140 | # If the upstream network provides Router Advertisement with Managed bit set, | |
6141 | # then comment out the line below and WithoutRA= setting in the [DHCPv6] section. | |
6142 | IPv6AcceptRA=no | |
6143 | ||
6144 | [DHCPv6] | |
6145 | WithoutRA=solicit | |
6146 | ||
6147 | [DHCPPrefixDelegation] | |
6148 | UplinkInterface=:self | |
6149 | SubnetId=0 | |
6150 | Announce=no</programlisting> | |
6151 | ||
6152 | <programlisting># /etc/systemd/network/55-dhcpv6-pd-downstream.network | |
4c94a4c2 | 6153 | [Match] |
6154 | Name=enp2s0 | |
6155 | ||
6156 | [Network] | |
d4579825 | 6157 | DHCPPrefixDelegation=yes |
e5ff2245 | 6158 | IPv6SendRA=yes |
d4579825 YW |
6159 | |
6160 | # It is expected that the host is acting as a router. So, usually it is not | |
6161 | # necessary to receive Router Advertisement from other hosts in the downstream network. | |
6162 | IPv6AcceptRA=no | |
6163 | ||
6164 | [DHCPPrefixDelegation] | |
6165 | UplinkInterface=enp1s0 | |
6166 | SubnetId=1 | |
6167 | Announce=yes</programlisting> | |
4c94a4c2 | 6168 | |
e5ff2245 YW |
6169 | <para>This will enable DHCPv6-PD on the interface enp1s0 as an upstream interface where the |
6170 | DHCPv6 client is running and enp2s0 as a downstream interface where the prefix is delegated to. | |
6171 | The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network. | |
6172 | </para> | |
4c94a4c2 | 6173 | </example> |
6174 | ||
d4579825 YW |
6175 | <example> |
6176 | <title>IPv6 Prefix Delegation (DHCPv4 6RD)</title> | |
6177 | ||
6178 | <programlisting># /etc/systemd/network/55-dhcpv4-6rd-upstream.network | |
6179 | [Match] | |
6180 | Name=enp1s0 | |
6181 | ||
6182 | [Network] | |
6183 | DHCP=ipv4 | |
6184 | ||
6185 | # When DHCPv4-6RD is used, the upstream network does not support IPv6. | |
6186 | # Hence, it is not necessary to wait for Router Advertisement, which is enabled by default. | |
6187 | IPv6AcceptRA=no | |
6188 | ||
6189 | [DHCPv4] | |
6190 | Use6RD=yes</programlisting> | |
6191 | ||
6192 | <programlisting># /etc/systemd/network/55-dhcpv4-6rd-downstream.network | |
6193 | [Match] | |
6194 | Name=enp2s0 | |
6195 | ||
6196 | [Network] | |
6197 | DHCPPrefixDelegation=yes | |
6198 | IPv6SendRA=yes | |
6199 | ||
6200 | # It is expected that the host is acting as a router. So, usually it is not | |
6201 | # necessary to receive Router Advertisement from other hosts in the downstream network. | |
6202 | IPv6AcceptRA=no | |
6203 | ||
6204 | [DHCPPrefixDelegation] | |
6205 | UplinkInterface=enp1s0 | |
6206 | SubnetId=1 | |
6207 | Announce=yes</programlisting> | |
6208 | ||
6209 | <para>This will enable DHCPv4-6RD on the interface enp1s0 as an upstream interface where the | |
6210 | DHCPv4 client is running and enp2s0 as a downstream interface where the prefix is delegated to. | |
6211 | The delegated prefixes are distributed by IPv6 Router Advertisement on the downstream network. | |
6212 | </para> | |
6213 | </example> | |
6214 | ||
798d3a52 | 6215 | <example> |
9e35b3de | 6216 | <title>A bridge with two enslaved links</title> |
f47c5c47 | 6217 | |
bc33789a JB |
6218 | <programlisting># /etc/systemd/network/25-bridge-static.netdev |
6219 | [NetDev] | |
6220 | Name=bridge0 | |
6221 | Kind=bridge</programlisting> | |
6222 | ||
9e35b3de ZJS |
6223 | <programlisting># /etc/systemd/network/25-bridge-static.network |
6224 | [Match] | |
f47c5c47 | 6225 | Name=bridge0 |
6226 | ||
6227 | [Network] | |
6228 | Address=192.168.0.15/24 | |
6229 | Gateway=192.168.0.1 | |
6230 | DNS=192.168.0.1</programlisting> | |
f47c5c47 | 6231 | |
9e35b3de ZJS |
6232 | <programlisting># /etc/systemd/network/25-bridge-slave-interface-1.network |
6233 | [Match] | |
f47c5c47 | 6234 | Name=enp2s0 |
6235 | ||
6236 | [Network] | |
6237 | Bridge=bridge0</programlisting> | |
9e35b3de ZJS |
6238 | |
6239 | <programlisting># /etc/systemd/network/25-bridge-slave-interface-2.network | |
6240 | [Match] | |
6241 | Name=wlp3s0 | |
6242 | ||
6243 | [Network] | |
6244 | Bridge=bridge0</programlisting> | |
6245 | ||
6246 | <para>This creates a bridge and attaches devices <literal>enp2s0</literal> and | |
6247 | <literal>wlp3s0</literal> to it. The bridge will have the specified static address | |
6248 | and network assigned, and a default route via the specified gateway will be | |
6249 | added. The specified DNS server will be added to the global list of DNS resolvers. | |
6250 | </para> | |
13b498f9 | 6251 | </example> |
9e35b3de | 6252 | |
13b498f9 | 6253 | <example> |
55ac274e | 6254 | <title>Bridge port with VLAN forwarding</title> |
13b498f9 | 6255 | |
9e35b3de | 6256 | <programlisting> |
55ac274e | 6257 | # /etc/systemd/network/25-bridge-slave-interface-1.network |
9e35b3de | 6258 | [Match] |
13b498f9 TJ |
6259 | Name=enp2s0 |
6260 | ||
6261 | [Network] | |
6262 | Bridge=bridge0 | |
6263 | ||
6264 | [BridgeVLAN] | |
6265 | VLAN=1-32 | |
6266 | PVID=42 | |
6267 | EgressUntagged=42 | |
6268 | ||
6269 | [BridgeVLAN] | |
6270 | VLAN=100-200 | |
6271 | ||
6272 | [BridgeVLAN] | |
6273 | EgressUntagged=300-400</programlisting> | |
0a8a0fad | 6274 | |
9e35b3de ZJS |
6275 | <para>This overrides the configuration specified in the previous example for the |
6276 | interface <literal>enp2s0</literal>, and enables VLAN on that bridge port. VLAN IDs | |
6277 | 1-32, 42, 100-400 will be allowed. Packets tagged with VLAN IDs 42, 300-400 will be | |
6278 | untagged when they leave on this interface. Untagged packets which arrive on this | |
6279 | interface will be assigned VLAN ID 42.</para> | |
798d3a52 | 6280 | </example> |
0a8a0fad | 6281 | |
798d3a52 | 6282 | <example> |
9e35b3de | 6283 | <title>Various tunnels</title> |
0a8a0fad | 6284 | |
9e35b3de ZJS |
6285 | <programlisting>/etc/systemd/network/25-tunnels.network |
6286 | [Match] | |
6287 | Name=ens1 | |
0a8a0fad TG |
6288 | |
6289 | [Network] | |
9e35b3de ZJS |
6290 | Tunnel=ipip-tun |
6291 | Tunnel=sit-tun | |
6292 | Tunnel=gre-tun | |
6293 | Tunnel=vti-tun | |
6294 | </programlisting> | |
6295 | ||
6296 | <programlisting>/etc/systemd/network/25-tunnel-ipip.netdev | |
6297 | [NetDev] | |
6298 | Name=ipip-tun | |
6299 | Kind=ipip | |
6300 | </programlisting> | |
6301 | ||
6302 | <programlisting>/etc/systemd/network/25-tunnel-sit.netdev | |
6303 | [NetDev] | |
6304 | Name=sit-tun | |
6305 | Kind=sit | |
6306 | </programlisting> | |
6307 | ||
6308 | <programlisting>/etc/systemd/network/25-tunnel-gre.netdev | |
6309 | [NetDev] | |
6310 | Name=gre-tun | |
6311 | Kind=gre | |
6312 | </programlisting> | |
6313 | ||
6314 | <programlisting>/etc/systemd/network/25-tunnel-vti.netdev | |
6315 | [NetDev] | |
6316 | Name=vti-tun | |
6317 | Kind=vti | |
6318 | </programlisting> | |
6319 | ||
6320 | <para>This will bring interface <literal>ens1</literal> up and create an IPIP tunnel, | |
6321 | a SIT tunnel, a GRE tunnel, and a VTI tunnel using it.</para> | |
798d3a52 | 6322 | </example> |
0a8a0fad | 6323 | |
798d3a52 | 6324 | <example> |
9e35b3de | 6325 | <title>A bond device</title> |
0a8a0fad | 6326 | |
9e35b3de ZJS |
6327 | <programlisting># /etc/systemd/network/30-bond1.network |
6328 | [Match] | |
6329 | Name=bond1 | |
0a8a0fad TG |
6330 | |
6331 | [Network] | |
9e35b3de ZJS |
6332 | DHCP=ipv6 |
6333 | </programlisting> | |
0a8a0fad | 6334 | |
9e35b3de ZJS |
6335 | <programlisting># /etc/systemd/network/30-bond1.netdev |
6336 | [NetDev] | |
6337 | Name=bond1 | |
6338 | Kind=bond | |
6339 | </programlisting> | |
0a8a0fad | 6340 | |
301a21a8 | 6341 | <programlisting># /etc/systemd/network/30-bond1-dev1.network |
9e35b3de ZJS |
6342 | [Match] |
6343 | MACAddress=52:54:00:e9:64:41 | |
0a8a0fad TG |
6344 | |
6345 | [Network] | |
9e35b3de ZJS |
6346 | Bond=bond1 |
6347 | </programlisting> | |
d94facdc | 6348 | |
301a21a8 | 6349 | <programlisting># /etc/systemd/network/30-bond1-dev2.network |
9e35b3de ZJS |
6350 | [Match] |
6351 | MACAddress=52:54:00:e9:64:42 | |
d94facdc MH |
6352 | |
6353 | [Network] | |
9e35b3de | 6354 | Bond=bond1 |
6cb955c6 | 6355 | </programlisting> |
9e35b3de ZJS |
6356 | |
6357 | <para>This will create a bond device <literal>bond1</literal> and enslave the two | |
6358 | devices with MAC addresses 52:54:00:e9:64:41 and 52:54:00:e9:64:42 to it. IPv6 DHCP | |
6359 | will be used to acquire an address.</para> | |
6cb955c6 AR |
6360 | </example> |
6361 | ||
6362 | <example> | |
9e35b3de ZJS |
6363 | <title>Virtual Routing and Forwarding (VRF)</title> |
6364 | <para>Add the <literal>bond1</literal> interface to the VRF master interface | |
6365 | <literal>vrf1</literal>. This will redirect routes generated on this interface to be | |
11d38b90 AR |
6366 | within the routing table defined during VRF creation. For kernels before 4.8 traffic |
6367 | won't be redirected towards the VRFs routing table unless specific ip-rules are added. | |
6368 | </para> | |
9e35b3de ZJS |
6369 | <programlisting># /etc/systemd/network/25-vrf.network |
6370 | [Match] | |
6cb955c6 AR |
6371 | Name=bond1 |
6372 | ||
6373 | [Network] | |
9e35b3de | 6374 | VRF=vrf1 |
d94facdc MH |
6375 | </programlisting> |
6376 | </example> | |
6377 | ||
42125eda SS |
6378 | <example> |
6379 | <title>MacVTap</title> | |
6380 | <para>This brings up a network interface <literal>macvtap-test</literal> | |
6381 | and attaches it to <literal>enp0s25</literal>.</para> | |
83ddf5d3 | 6382 | <programlisting># /usr/lib/systemd/network/25-macvtap.network |
42125eda SS |
6383 | [Match] |
6384 | Name=enp0s25 | |
6385 | ||
6386 | [Network] | |
6387 | MACVTAP=macvtap-test | |
6388 | </programlisting> | |
6389 | </example> | |
98d20a17 | 6390 | |
6391 | <example> | |
6392 | <title>A Xfrm interface with physical underlying device.</title> | |
6393 | ||
6394 | <programlisting># /etc/systemd/network/27-xfrm.netdev | |
6395 | [NetDev] | |
6396 | Name=xfrm0 | |
0d03e672 | 6397 | Kind=xfrm |
98d20a17 | 6398 | |
6399 | [Xfrm] | |
6400 | InterfaceId=7</programlisting> | |
6401 | ||
6402 | <programlisting># /etc/systemd/network/27-eth0.network | |
6403 | [Match] | |
6404 | Name=eth0 | |
6405 | ||
6406 | [Network] | |
6407 | Xfrm=xfrm0</programlisting> | |
6408 | ||
6409 | <para>This creates a <literal>xfrm0</literal> interface and binds it to the <literal>eth0</literal> device. | |
6410 | This allows hardware based ipsec offloading to the <literal>eth0</literal> nic. | |
6411 | If offloading is not needed, xfrm interfaces can be assigned to the <literal>lo</literal> device. | |
6412 | </para> | |
6413 | </example> | |
798d3a52 ZJS |
6414 | </refsect1> |
6415 | ||
6416 | <refsect1> | |
6417 | <title>See Also</title> | |
13a69c12 DT |
6418 | <para><simplelist type="inline"> |
6419 | <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
6420 | <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
6421 | <member><citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> | |
6422 | <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> | |
6423 | <member><citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
6424 | <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
6425 | </simplelist></para> | |
798d3a52 | 6426 | </refsect1> |
eac684ef TG |
6427 | |
6428 | </refentry> |