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