]>
Commit | Line | Data |
---|---|---|
eac684ef TG |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
eac684ef TG |
4 | |
5 | <!-- | |
572eb058 ZJS |
6 | SPDX-License-Identifier: LGPL-2.1+ |
7 | ||
eac684ef TG |
8 | This file is part of systemd. |
9 | ||
10 | Copyright 2013 Tom Gundersen | |
11 | ||
12 | systemd is free software; you can redistribute it and/or modify it | |
13 | under the terms of the GNU Lesser General Public License as published by | |
14 | the Free Software Foundation; either version 2.1 of the License, or | |
15 | (at your option) any later version. | |
16 | ||
17 | systemd is distributed in the hope that it will be useful, but | |
18 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 | Lesser General Public License for more details. | |
21 | ||
22 | You should have received a copy of the GNU Lesser General Public License | |
23 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
24 | --> | |
25 | ||
26 | <refentry id="systemd.netdev" conditional='ENABLE_NETWORKD'> | |
27 | ||
798d3a52 ZJS |
28 | <refentryinfo> |
29 | <title>systemd.network</title> | |
30 | <productname>systemd</productname> | |
31 | ||
32 | <authorgroup> | |
33 | <author> | |
34 | <contrib>Developer</contrib> | |
35 | <firstname>Tom</firstname> | |
36 | <surname>Gundersen</surname> | |
37 | <email>teg@jklm.no</email> | |
38 | </author> | |
39 | </authorgroup> | |
40 | </refentryinfo> | |
41 | ||
42 | <refmeta> | |
43 | <refentrytitle>systemd.netdev</refentrytitle> | |
44 | <manvolnum>5</manvolnum> | |
45 | </refmeta> | |
46 | ||
47 | <refnamediv> | |
48 | <refname>systemd.netdev</refname> | |
49 | <refpurpose>Virtual Network Device configuration</refpurpose> | |
50 | </refnamediv> | |
51 | ||
52 | <refsynopsisdiv> | |
53 | <para><filename><replaceable>netdev</replaceable>.netdev</filename></para> | |
54 | </refsynopsisdiv> | |
55 | ||
56 | <refsect1> | |
57 | <title>Description</title> | |
58 | ||
59 | <para>Network setup is performed by | |
60 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
61 | </para> | |
62 | ||
bac150e9 ZJS |
63 | <para>The main Virtual Network Device file must have the extension <filename>.netdev</filename>; |
64 | other extensions are ignored. Virtual network devices are created as soon as networkd is | |
65 | started. If a netdev with the specified name already exists, networkd will use that as-is rather | |
66 | than create its own. Note that the settings of the pre-existing netdev will not be changed by | |
798d3a52 ZJS |
67 | networkd.</para> |
68 | ||
bac150e9 ZJS |
69 | <para>The <filename>.netdev</filename> files are read from the files located in the system |
70 | network directory <filename>/usr/lib/systemd/network</filename>, the volatile runtime network | |
71 | directory <filename>/run/systemd/network</filename> and the local administration network | |
72 | directory <filename>/etc/systemd/network</filename>. All configuration files are collectively | |
73 | sorted and processed in lexical order, regardless of the directories in which they live. | |
74 | However, files with identical filenames replace each other. Files in <filename>/etc</filename> | |
75 | have the highest priority, files in <filename>/run</filename> take precedence over files with | |
76 | the same name in <filename>/usr/lib</filename>. This can be used to override a system-supplied | |
77 | configuration file with a local file if needed. As a special case, an empty file (file size 0) | |
78 | or symlink with the same name pointing to <filename>/dev/null</filename> disables the | |
79 | configuration file entirely (it is "masked").</para> | |
80 | ||
81 | <para>Along with the netdev file <filename>foo.netdev</filename>, a "drop-in" directory | |
82 | <filename>foo.netdev.d/</filename> may exist. All files with the suffix <literal>.conf</literal> | |
83 | from this directory will be parsed after the file itself is parsed. This is useful to alter or | |
84 | add configuration settings, without having to modify the main configuration file. Each drop-in | |
85 | file must have appropriate section headers.</para> | |
86 | ||
87 | <para>In addition to <filename>/etc/systemd/network</filename>, drop-in <literal>.d</literal> | |
88 | directories can be placed in <filename>/usr/lib/systemd/network</filename> or | |
89 | <filename>/run/systemd/network</filename> directories. Drop-in files in | |
90 | <filename>/etc</filename> take precedence over those in <filename>/run</filename> which in turn | |
91 | take precedence over those in <filename>/usr/lib</filename>. Drop-in files under any of these | |
92 | directories take precedence over the main netdev file wherever located. (Of course, since | |
93 | <filename>/run</filename> is temporary and <filename>/usr/lib</filename> is for vendors, it is | |
94 | unlikely drop-ins should be used in either of those places.)</para> | |
798d3a52 ZJS |
95 | </refsect1> |
96 | ||
97 | <refsect1> | |
98 | <title>Supported netdev kinds</title> | |
99 | ||
100 | <para>The following kinds of virtual network devices may be | |
101 | configured in <filename>.netdev</filename> files:</para> | |
102 | ||
103 | <table> | |
104 | <title>Supported kinds of virtual network devices</title> | |
105 | ||
106 | <tgroup cols='2'> | |
107 | <colspec colname='kind' /> | |
108 | <colspec colname='explanation' /> | |
109 | <thead><row> | |
110 | <entry>Kind</entry> | |
111 | <entry>Description</entry> | |
112 | </row></thead> | |
113 | <tbody> | |
114 | <row><entry><varname>bond</varname></entry> | |
115 | <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO</ulink> for details.Local configuration</entry></row> | |
116 | ||
117 | <row><entry><varname>bridge</varname></entry> | |
a8eaaee7 | 118 | <entry>A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch.</entry></row> |
798d3a52 ZJS |
119 | |
120 | <row><entry><varname>dummy</varname></entry> | |
121 | <entry>A dummy device drops all packets sent to it.</entry></row> | |
122 | ||
123 | <row><entry><varname>gre</varname></entry> | |
124 | <entry>A Level 3 GRE tunnel over IPv4. See <ulink url="https://tools.ietf.org/html/rfc2784">RFC 2784</ulink> for details.</entry></row> | |
125 | ||
126 | <row><entry><varname>gretap</varname></entry> | |
127 | <entry>A Level 2 GRE tunnel over IPv4.</entry></row> | |
128 | ||
129 | <row><entry><varname>ip6gre</varname></entry> | |
130 | <entry>A Level 3 GRE tunnel over IPv6.</entry></row> | |
131 | ||
132 | <row><entry><varname>ip6tnl</varname></entry> | |
133 | <entry>An IPv4 or IPv6 tunnel over IPv6</entry></row> | |
134 | ||
135 | <row><entry><varname>ip6gretap</varname></entry> | |
037a3ded | 136 | <entry>A Level 2 GRE tunnel over IPv6.</entry></row> |
798d3a52 ZJS |
137 | |
138 | <row><entry><varname>ipip</varname></entry> | |
139 | <entry>An IPv4 over IPv4 tunnel.</entry></row> | |
140 | ||
141 | <row><entry><varname>ipvlan</varname></entry> | |
142 | <entry>An ipvlan device is a stacked device which receives packets from its underlying device based on IP address filtering.</entry></row> | |
143 | ||
144 | <row><entry><varname>macvlan</varname></entry> | |
145 | <entry>A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row> | |
146 | ||
0371f2df SS |
147 | <row><entry><varname>macvtap</varname></entry> |
148 | <entry>A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering.</entry></row> | |
149 | ||
798d3a52 ZJS |
150 | <row><entry><varname>sit</varname></entry> |
151 | <entry>An IPv6 over IPv4 tunnel.</entry></row> | |
152 | ||
153 | <row><entry><varname>tap</varname></entry> | |
154 | <entry>A persistent Level 2 tunnel between a network device and a device node.</entry></row> | |
155 | ||
156 | <row><entry><varname>tun</varname></entry> | |
157 | <entry>A persistent Level 3 tunnel between a network device and a device node.</entry></row> | |
158 | ||
159 | <row><entry><varname>veth</varname></entry> | |
a8eaaee7 | 160 | <entry>An Ethernet tunnel between a pair of network devices.</entry></row> |
798d3a52 ZJS |
161 | |
162 | <row><entry><varname>vlan</varname></entry> | |
163 | <entry>A VLAN is a stacked device which receives packets from its underlying device based on VLAN tagging. See <ulink url="http://www.ieee802.org/1/pages/802.1Q.html">IEEE 802.1Q</ulink> for details.</entry></row> | |
164 | ||
165 | <row><entry><varname>vti</varname></entry> | |
166 | <entry>An IPv4 over IPSec tunnel.</entry></row> | |
167 | ||
5cc0748e SS |
168 | <row><entry><varname>vti6</varname></entry> |
169 | <entry>An IPv6 over IPSec tunnel.</entry></row> | |
170 | ||
798d3a52 ZJS |
171 | <row><entry><varname>vxlan</varname></entry> |
172 | <entry>A virtual extensible LAN (vxlan), for connecting Cloud computing deployments.</entry></row> | |
20897a0d | 173 | |
6598e046 SS |
174 | <row><entry><varname>geneve</varname></entry> |
175 | <entry>A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver.</entry></row> | |
176 | ||
20897a0d | 177 | <row><entry><varname>vrf</varname></entry> |
92c918b0 SS |
178 | <entry>A Virtual Routing and Forwarding (<ulink url="https://www.kernel.org/doc/Documentation/networking/vrf.txt">VRF</ulink>) interface to create separate routing and forwarding domains.</entry></row> |
179 | ||
180 | <row><entry><varname>vcan</varname></entry> | |
ba9fa3bc | 181 | <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.</entry></row> |
20897a0d | 182 | |
d6df583c SS |
183 | <row><entry><varname>vxcan</varname></entry> |
184 | <entry>The virtual CAN tunnel driver (vxcan). Similar to the virtual ethernet driver veth, vxcan implements a local CAN traffic tunnel between two virtual CAN network devices. When creating a vxcan, two vxcan devices are created as pair. When one end receives the packet it appears on its pair and vice versa. The vxcan can be used for cross namespace communication. | |
185 | </entry></row> | |
186 | ||
e5719363 JT |
187 | <row><entry><varname>wireguard</varname></entry> |
188 | <entry>WireGuard Secure Network Tunnel.</entry></row> | |
189 | ||
798d3a52 ZJS |
190 | </tbody> |
191 | </tgroup> | |
192 | </table> | |
193 | ||
194 | </refsect1> | |
195 | ||
196 | <refsect1> | |
197 | <title>[Match] Section Options</title> | |
198 | ||
199 | <para>A virtual network device is only created if the | |
200 | <literal>[Match]</literal> section matches the current | |
201 | environment, or if the section is empty. The following keys are | |
202 | accepted:</para> | |
203 | ||
204 | <variablelist class='network-directives'> | |
205 | <varlistentry> | |
206 | <term><varname>Host=</varname></term> | |
207 | <listitem> | |
208 | <para>Matches against the hostname or machine ID of the | |
209 | host. See <literal>ConditionHost=</literal> in | |
210 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
211 | for details. | |
212 | </para> | |
213 | </listitem> | |
214 | </varlistentry> | |
215 | <varlistentry> | |
216 | <term><varname>Virtualization=</varname></term> | |
217 | <listitem> | |
218 | <para>Checks whether the system is executed in a virtualized | |
219 | environment and optionally test whether it is a specific | |
220 | implementation. See | |
221 | <literal>ConditionVirtualization=</literal> in | |
222 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
223 | for details. | |
224 | </para> | |
225 | </listitem> | |
226 | </varlistentry> | |
227 | <varlistentry> | |
228 | <term><varname>KernelCommandLine=</varname></term> | |
229 | <listitem> | |
230 | <para>Checks whether a specific kernel command line option | |
231 | is set (or if prefixed with the exclamation mark unset). See | |
232 | <literal>ConditionKernelCommandLine=</literal> in | |
233 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
234 | for details. | |
235 | </para> | |
236 | </listitem> | |
237 | </varlistentry> | |
5022f08a LP |
238 | <varlistentry> |
239 | <term><varname>KernelVersion=</varname></term> | |
240 | <listitem> | |
241 | <para>Checks whether the kernel version (as reported by <command>uname -r</command>) matches a certain | |
242 | expression (or if prefixed with the exclamation mark does not match it). See | |
243 | <literal>ConditionKernelVersion=</literal> in | |
244 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details. | |
245 | </para> | |
246 | </listitem> | |
247 | </varlistentry> | |
798d3a52 ZJS |
248 | <varlistentry> |
249 | <term><varname>Architecture=</varname></term> | |
250 | <listitem> | |
251 | <para>Checks whether the system is running on a specific | |
252 | architecture. See <literal>ConditionArchitecture=</literal> in | |
253 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
254 | for details. | |
255 | </para> | |
256 | </listitem> | |
257 | </varlistentry> | |
258 | </variablelist> | |
259 | ||
260 | </refsect1> | |
261 | ||
262 | <refsect1> | |
263 | <title>[NetDev] Section Options</title> | |
264 | ||
265 | <para>The <literal>[NetDev]</literal> section accepts the | |
266 | following keys:</para> | |
267 | ||
268 | <variablelist class='network-directives'> | |
269 | <varlistentry> | |
270 | <term><varname>Description=</varname></term> | |
271 | <listitem> | |
272 | <para>A free-form description of the netdev.</para> | |
273 | </listitem> | |
274 | </varlistentry> | |
275 | <varlistentry> | |
276 | <term><varname>Name=</varname></term> | |
277 | <listitem> | |
278 | <para>The interface name used when creating the netdev. | |
279 | This option is compulsory.</para> | |
280 | </listitem> | |
281 | </varlistentry> | |
282 | <varlistentry> | |
283 | <term><varname>Kind=</varname></term> | |
284 | <listitem> | |
285 | <para>The netdev kind. This option is compulsory. See the | |
286 | <literal>Supported netdev kinds</literal> section for the | |
287 | valid keys.</para> | |
288 | </listitem> | |
289 | </varlistentry> | |
290 | <varlistentry> | |
291 | <term><varname>MTUBytes=</varname></term> | |
292 | <listitem> | |
293 | <para>The maximum transmission unit in bytes to set for | |
294 | the device. The usual suffixes K, M, G, are supported and | |
295 | are understood to the base of 1024. This key is not | |
ff9b60f3 | 296 | currently supported for <literal>tun</literal> or |
798d3a52 ZJS |
297 | <literal>tap</literal> devices. |
298 | </para> | |
299 | </listitem> | |
300 | </varlistentry> | |
301 | <varlistentry> | |
302 | <term><varname>MACAddress=</varname></term> | |
303 | <listitem> | |
304 | <para>The MAC address to use for the device. If none is | |
305 | given, one is generated based on the interface name and | |
306 | the | |
307 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
ff9b60f3 | 308 | This key is not currently supported for |
798d3a52 ZJS |
309 | <literal>tun</literal> or <literal>tap</literal> devices. |
310 | </para> | |
311 | </listitem> | |
312 | </varlistentry> | |
313 | </variablelist> | |
314 | </refsect1> | |
315 | ||
3428fe07 SS |
316 | <refsect1> |
317 | <title>[Bridge] Section Options</title> | |
318 | ||
319 | <para>The <literal>[Bridge]</literal> section only applies for | |
320 | netdevs of kind <literal>bridge</literal>, and accepts the | |
a8eaaee7 | 321 | following keys:</para> |
3428fe07 SS |
322 | |
323 | <variablelist class='network-directives'> | |
324 | <varlistentry> | |
325 | <term><varname>HelloTimeSec=</varname></term> | |
326 | <listitem> | |
a8eaaee7 | 327 | <para>HelloTimeSec specifies the number of seconds between two hello packets |
3428fe07 SS |
328 | sent out by the root bridge and the designated bridges. Hello packets are |
329 | used to communicate information about the topology throughout the entire | |
330 | bridged local area network.</para> | |
331 | </listitem> | |
332 | </varlistentry> | |
333 | <varlistentry> | |
334 | <term><varname>MaxAgeSec=</varname></term> | |
335 | <listitem> | |
336 | <para>MaxAgeSec specifies the number of seconds of maximum message age. | |
337 | If the last seen (received) hello packet is more than this number of | |
338 | seconds old, the bridge in question will start the takeover procedure | |
339 | in attempt to become the Root Bridge itself.</para> | |
340 | </listitem> | |
341 | </varlistentry> | |
342 | <varlistentry> | |
343 | <term><varname>ForwardDelaySec=</varname></term> | |
344 | <listitem> | |
345 | <para>ForwardDelaySec specifies the number of seconds spent in each | |
346 | of the Listening and Learning states before the Forwarding state is entered.</para> | |
347 | </listitem> | |
348 | </varlistentry> | |
c7440e74 TJ |
349 | <varlistentry> |
350 | <term><varname>AgeingTimeSec=</varname></term> | |
351 | <listitem> | |
352 | <para>This specifies the number of seconds a MAC Address will be kept in | |
d23a0044 | 353 | the forwarding database after having a packet received from this MAC Address.</para> |
c7440e74 TJ |
354 | </listitem> |
355 | </varlistentry> | |
356 | <varlistentry> | |
357 | <term><varname>Priority=</varname></term> | |
358 | <listitem> | |
359 | <para>The priority of the bridge. An integer between 0 and 65535. A lower value | |
360 | means higher priority. The bridge having the lowest priority will be elected as root bridge.</para> | |
361 | </listitem> | |
362 | </varlistentry> | |
c4819961 JC |
363 | <varlistentry> |
364 | <term><varname>GroupForwardMask=</varname></term> | |
365 | <listitem> | |
366 | <para>A 16-bit bitmask represented as an integer which allows forwarding of link | |
367 | local frames with 802.1D reserved addresses (01:80:C2:00:00:0X). A logical AND | |
368 | is performed between the specified bitmask and the exponentiation of 2^X, the | |
369 | lower nibble of the last octet of the MAC address. For example, a value of 8 | |
370 | would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802.1X PAE).</para> | |
371 | </listitem> | |
372 | </varlistentry> | |
c7440e74 TJ |
373 | <varlistentry> |
374 | <term><varname>DefaultPVID=</varname></term> | |
375 | <listitem> | |
0d6c68eb TJ |
376 | <para>This specifies the default port VLAN ID of a newly attached bridge port. |
377 | Set this to an integer in the range 1–4094 or <literal>none</literal> to disable the PVID.</para> | |
c7440e74 TJ |
378 | </listitem> |
379 | </varlistentry> | |
3fef7a3f SS |
380 | <varlistentry> |
381 | <term><varname>MulticastQuerier=</varname></term> | |
382 | <listitem> | |
383 | <para>A boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel. | |
384 | If enabled, the kernel will send general ICMP queries from a zero source address. | |
385 | This feature should allow faster convergence on startup, but it causes some | |
386 | multicast-aware switches to misbehave and disrupt forwarding of multicast packets. | |
387 | When unset, the kernel's default setting applies. | |
388 | </para> | |
389 | </listitem> | |
390 | </varlistentry> | |
6df6d898 SS |
391 | <varlistentry> |
392 | <term><varname>MulticastSnooping=</varname></term> | |
393 | <listitem> | |
394 | <para>A boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel. | |
395 | If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic | |
396 | between hosts and multicast routers. When unset, the kernel's default setting applies. | |
397 | </para> | |
398 | </listitem> | |
399 | </varlistentry> | |
c6f8d17d TJ |
400 | <varlistentry> |
401 | <term><varname>VLANFiltering=</varname></term> | |
402 | <listitem> | |
403 | <para>A boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel. | |
404 | If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's | |
405 | default setting applies. | |
406 | </para> | |
407 | </listitem> | |
408 | </varlistentry> | |
b760a9af SS |
409 | <varlistentry> |
410 | <term><varname>STP=</varname></term> | |
411 | <listitem> | |
412 | <para>A boolean. This enables the bridge's Spanning Tree Protocol (STP). When unset, | |
413 | the kernel's default setting applies. | |
414 | </para> | |
415 | </listitem> | |
416 | </varlistentry> | |
3428fe07 | 417 | </variablelist> |
3428fe07 SS |
418 | </refsect1> |
419 | ||
798d3a52 ZJS |
420 | <refsect1> |
421 | <title>[VLAN] Section Options</title> | |
422 | ||
423 | <para>The <literal>[VLAN]</literal> section only applies for | |
424 | netdevs of kind <literal>vlan</literal>, and accepts the | |
425 | following key:</para> | |
426 | ||
427 | <variablelist class='network-directives'> | |
428 | <varlistentry> | |
429 | <term><varname>Id=</varname></term> | |
430 | <listitem> | |
431 | <para>The VLAN ID to use. An integer in the range 0–4094. | |
432 | This option is compulsory.</para> | |
433 | </listitem> | |
434 | </varlistentry> | |
c8b21184 SS |
435 | <varlistentry> |
436 | <term><varname>GVRP=</varname></term> | |
437 | <listitem> | |
438 | <para>The Generic VLAN Registration Protocol (GVRP) is a protocol that | |
439 | allows automatic learning of VLANs on a network. A boolean. When unset, | |
440 | the kernel's default setting applies.</para> | |
441 | </listitem> | |
442 | </varlistentry> | |
6c1ff21b SS |
443 | <varlistentry> |
444 | <term><varname>MVRP=</varname></term> | |
445 | <listitem> | |
446 | <para>Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN | |
447 | Registration Protocol (GVRP) is a standards-based Layer 2 network protocol, | |
448 | for automatic configuration of VLAN information on switches. It was defined | |
449 | in the 802.1ak amendment to 802.1Q-2005. A boolean. When unset, the kernel's | |
450 | default setting applies.</para> | |
451 | </listitem> | |
452 | </varlistentry> | |
453 | <varlistentry> | |
454 | <term><varname>LooseBinding=</varname></term> | |
455 | <listitem> | |
456 | <para>The VLAN loose binding mode, in which only the operational state is passed | |
457 | from the parent to the associated VLANs, but the VLAN device state is not changed. | |
458 | A boolean. When unset, the kernel's default setting applies.</para> | |
459 | </listitem> | |
460 | </varlistentry> | |
461 | <varlistentry> | |
462 | <term><varname>ReorderHeader=</varname></term> | |
463 | <listitem> | |
464 | <para>The VLAN reorder header is set VLAN interfaces behave like physical interfaces. | |
465 | A boolean. When unset, the kernel's default setting applies.</para> | |
466 | </listitem> | |
467 | </varlistentry> | |
798d3a52 | 468 | </variablelist> |
798d3a52 ZJS |
469 | </refsect1> |
470 | ||
471 | <refsect1> | |
472 | <title>[MACVLAN] Section Options</title> | |
473 | ||
474 | <para>The <literal>[MACVLAN]</literal> section only applies for | |
475 | netdevs of kind <literal>macvlan</literal>, and accepts the | |
476 | following key:</para> | |
477 | ||
478 | <variablelist class='network-directives'> | |
479 | <varlistentry> | |
480 | <term><varname>Mode=</varname></term> | |
481 | <listitem> | |
482 | <para>The MACVLAN mode to use. The supported options are | |
483 | <literal>private</literal>, | |
484 | <literal>vepa</literal>, | |
485 | <literal>bridge</literal>, and | |
486 | <literal>passthru</literal>. | |
487 | </para> | |
488 | </listitem> | |
489 | </varlistentry> | |
490 | </variablelist> | |
491 | ||
492 | </refsect1> | |
493 | ||
0371f2df SS |
494 | <refsect1> |
495 | <title>[MACVTAP] Section Options</title> | |
496 | ||
497 | <para>The <literal>[MACVTAP]</literal> section applies for | |
498 | netdevs of kind <literal>macvtap</literal> and accepts the | |
96d49011 | 499 | same key as <literal>[MACVLAN]</literal>.</para> |
0371f2df SS |
500 | |
501 | </refsect1> | |
502 | ||
798d3a52 ZJS |
503 | <refsect1> |
504 | <title>[IPVLAN] Section Options</title> | |
505 | ||
506 | <para>The <literal>[IPVLAN]</literal> section only applies for | |
507 | netdevs of kind <literal>ipvlan</literal>, and accepts the | |
508 | following key:</para> | |
509 | ||
510 | <variablelist class='network-directives'> | |
511 | <varlistentry> | |
512 | <term><varname>Mode=</varname></term> | |
513 | <listitem> | |
514 | <para>The IPVLAN mode to use. The supported options are | |
d384826f SS |
515 | <literal>L2</literal>,<literal>L3</literal> and <literal>L3S</literal>. |
516 | </para> | |
517 | </listitem> | |
518 | </varlistentry> | |
519 | <varlistentry> | |
520 | <term><varname>Flags=</varname></term> | |
521 | <listitem> | |
522 | <para>The IPVLAN flags to use. The supported options are | |
523 | <literal>bridge</literal>,<literal>private</literal> and <literal>vepa</literal>. | |
798d3a52 ZJS |
524 | </para> |
525 | </listitem> | |
526 | </varlistentry> | |
527 | </variablelist> | |
528 | ||
529 | </refsect1> | |
530 | ||
531 | <refsect1> | |
532 | <title>[VXLAN] Section Options</title> | |
533 | <para>The <literal>[VXLAN]</literal> section only applies for | |
534 | netdevs of kind <literal>vxlan</literal>, and accepts the | |
535 | following keys:</para> | |
536 | ||
537 | <variablelist class='network-directives'> | |
538 | <varlistentry> | |
539 | <term><varname>Id=</varname></term> | |
540 | <listitem> | |
541 | <para>The VXLAN ID to use.</para> | |
542 | </listitem> | |
543 | </varlistentry> | |
544 | <varlistentry> | |
d35e5d37 | 545 | <term><varname>Remote=</varname></term> |
798d3a52 | 546 | <listitem> |
d35e5d37 | 547 | <para>Configures destination multicast group IP address.</para> |
798d3a52 ZJS |
548 | </listitem> |
549 | </varlistentry> | |
550 | <varlistentry> | |
d35e5d37 SS |
551 | <term><varname>Local=</varname></term> |
552 | <listitem> | |
553 | <para>Configures local IP address.</para> | |
554 | </listitem> | |
555 | </varlistentry> | |
556 | <varlistentry> | |
798d3a52 ZJS |
557 | <term><varname>TOS=</varname></term> |
558 | <listitem> | |
559 | <para>The Type Of Service byte value for a vxlan interface.</para> | |
560 | </listitem> | |
561 | </varlistentry> | |
562 | <varlistentry> | |
563 | <term><varname>TTL=</varname></term> | |
564 | <listitem> | |
565 | <para>A fixed Time To Live N on Virtual eXtensible Local | |
b938cb90 | 566 | Area Network packets. N is a number in the range 1–255. 0 |
798d3a52 ZJS |
567 | is a special value meaning that packets inherit the TTL |
568 | value.</para> | |
569 | </listitem> | |
570 | </varlistentry> | |
571 | <varlistentry> | |
572 | <term><varname>MacLearning=</varname></term> | |
573 | <listitem> | |
574 | <para>A boolean. When true, enables dynamic MAC learning | |
575 | to discover remote MAC addresses.</para> | |
576 | </listitem> | |
577 | </varlistentry> | |
578 | <varlistentry> | |
579 | <term><varname>FDBAgeingSec=</varname></term> | |
580 | <listitem> | |
581 | <para>The lifetime of Forwarding Database entry learnt by | |
b938cb90 | 582 | the kernel, in seconds.</para> |
798d3a52 ZJS |
583 | </listitem> |
584 | </varlistentry> | |
585 | <varlistentry> | |
3d276dd2 SS |
586 | <term><varname>MaximumFDBEntries=</varname></term> |
587 | <listitem> | |
588 | <para>Configures maximum number of FDB entries.</para> | |
589 | </listitem> | |
590 | </varlistentry> | |
798d3a52 | 591 | <varlistentry> |
7dd6974c | 592 | <term><varname>ReduceARPProxy=</varname></term> |
798d3a52 | 593 | <listitem> |
7dd6974c SS |
594 | <para>A boolean. When true, bridge-connected VXLAN tunnel |
595 | endpoint answers ARP requests from the local bridge on behalf | |
596 | of remote Distributed Overlay Virtual Ethernet | |
597 | <ulink url="https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet"> | |
598 | (DVOE)</ulink> clients. Defaults to false.</para> | |
798d3a52 ZJS |
599 | </listitem> |
600 | </varlistentry> | |
601 | <varlistentry> | |
602 | <term><varname>L2MissNotification=</varname></term> | |
603 | <listitem> | |
604 | <para>A boolean. When true, enables netlink LLADDR miss | |
605 | notifications.</para> | |
606 | </listitem> | |
607 | </varlistentry> | |
608 | <varlistentry> | |
609 | <term><varname>L3MissNotification=</varname></term> | |
610 | <listitem> | |
a8eaaee7 | 611 | <para>A boolean. When true, enables netlink IP address miss |
798d3a52 ZJS |
612 | notifications.</para> |
613 | </listitem> | |
614 | </varlistentry> | |
615 | <varlistentry> | |
616 | <term><varname>RouteShortCircuit=</varname></term> | |
617 | <listitem> | |
a8eaaee7 | 618 | <para>A boolean. When true, route short circuiting is turned |
798d3a52 ZJS |
619 | on.</para> |
620 | </listitem> | |
621 | </varlistentry> | |
cffacc74 | 622 | <varlistentry> |
53c06862 | 623 | <term><varname>UDPChecksum=</varname></term> |
cffacc74 | 624 | <listitem> |
b938cb90 | 625 | <para>A boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on.</para> |
cffacc74 SS |
626 | </listitem> |
627 | </varlistentry> | |
628 | <varlistentry> | |
629 | <term><varname>UDP6ZeroChecksumTx=</varname></term> | |
630 | <listitem> | |
b938cb90 | 631 | <para>A boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on.</para> |
cffacc74 SS |
632 | </listitem> |
633 | </varlistentry> | |
634 | <varlistentry> | |
53c06862 | 635 | <term><varname>UDP6ZeroChecksumRx=</varname></term> |
cffacc74 | 636 | <listitem> |
b938cb90 | 637 | <para>A boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on.</para> |
16441027 SS |
638 | </listitem> |
639 | </varlistentry> | |
640 | <varlistentry> | |
53c06862 | 641 | <term><varname>RemoteChecksumTx=</varname></term> |
16441027 SS |
642 | <listitem> |
643 | <para>A boolean. When true, remote transmit checksum offload of VXLAN is turned on.</para> | |
644 | </listitem> | |
645 | </varlistentry> | |
646 | <varlistentry> | |
53c06862 | 647 | <term><varname>RemoteChecksumRx=</varname></term> |
16441027 SS |
648 | <listitem> |
649 | <para>A boolean. When true, remote receive checksum offload in VXLAN is turned on.</para> | |
cffacc74 SS |
650 | </listitem> |
651 | </varlistentry> | |
8b414e52 SS |
652 | <varlistentry> |
653 | <term><varname>GroupPolicyExtension=</varname></term> | |
654 | <listitem> | |
b938cb90 JE |
655 | <para>A boolean. When true, it enables Group Policy VXLAN extension security label mechanism |
656 | across network peers based on VXLAN. For details about the Group Policy VXLAN, see the | |
8b414e52 SS |
657 | <ulink url="https://tools.ietf.org/html/draft-smith-vxlan-group-policy"> |
658 | VXLAN Group Policy </ulink> document. Defaults to false.</para> | |
659 | </listitem> | |
660 | </varlistentry> | |
ea0288d1 SS |
661 | <varlistentry> |
662 | <term><varname>DestinationPort=</varname></term> | |
663 | <listitem> | |
664 | <para>Configures the default destination UDP port on a per-device basis. | |
665 | If destination port is not specified then Linux kernel default will be used. | |
98616735 SS |
666 | Set destination port 4789 to get the IANA assigned value. If not set or if the |
667 | destination port is assigned the empty string the default port of 4789 is used.</para> | |
ea0288d1 SS |
668 | </listitem> |
669 | </varlistentry> | |
670 | <varlistentry> | |
671 | <term><varname>PortRange=</varname></term> | |
672 | <listitem> | |
673 | <para>Configures VXLAN port range. VXLAN bases source | |
674 | UDP port based on flow to help the receiver to be able | |
675 | to load balance based on outer header flow. It | |
676 | restricts the port range to the normal UDP local | |
677 | ports, and allows overriding via configuration.</para> | |
678 | </listitem> | |
679 | </varlistentry> | |
d8653945 SS |
680 | <varlistentry> |
681 | <term><varname>FlowLabel=</varname></term> | |
682 | <listitem> | |
683 | <para>Specifies the flow label to use in outgoing packets. | |
684 | The valid range is 0-1048575. | |
685 | </para> | |
686 | </listitem> | |
687 | </varlistentry> | |
798d3a52 ZJS |
688 | </variablelist> |
689 | </refsect1> | |
6598e046 SS |
690 | <refsect1> |
691 | <title>[GENEVE] Section Options</title> | |
692 | <para>The <literal>[GENEVE]</literal> section only applies for | |
693 | netdevs of kind <literal>geneve</literal>, and accepts the | |
694 | following keys:</para> | |
695 | ||
696 | <variablelist class='network-directives'> | |
697 | <varlistentry> | |
698 | <term><varname>Id=</varname></term> | |
699 | <listitem> | |
785889e5 | 700 | <para>Specifies the Virtual Network Identifier (VNI) to use. Ranges [0-16777215].</para> |
6598e046 SS |
701 | </listitem> |
702 | </varlistentry> | |
703 | <varlistentry> | |
704 | <term><varname>Remote=</varname></term> | |
705 | <listitem> | |
706 | <para>Specifies the unicast destination IP address to use in outgoing packets.</para> | |
707 | </listitem> | |
708 | </varlistentry> | |
709 | <varlistentry> | |
710 | <term><varname>TOS=</varname></term> | |
711 | <listitem> | |
98616735 | 712 | <para>Specifies the TOS value to use in outgoing packets. Ranges [1-255].</para> |
6598e046 SS |
713 | </listitem> |
714 | </varlistentry> | |
715 | <varlistentry> | |
716 | <term><varname>TTL=</varname></term> | |
717 | <listitem> | |
98616735 | 718 | <para>Specifies the TTL value to use in outgoing packets. Ranges [1-255].</para> |
6598e046 SS |
719 | </listitem> |
720 | </varlistentry> | |
721 | <varlistentry> | |
722 | <term><varname>UDPChecksum=</varname></term> | |
723 | <listitem> | |
724 | <para>A boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4.</para> | |
725 | </listitem> | |
726 | </varlistentry> | |
727 | <varlistentry> | |
728 | <term><varname>UDP6ZeroChecksumTx=</varname></term> | |
729 | <listitem> | |
730 | <para>A boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para> | |
731 | </listitem> | |
732 | </varlistentry> | |
733 | <varlistentry> | |
734 | <term><varname>UDP6ZeroChecksumRx=</varname></term> | |
735 | <listitem> | |
736 | <para>A boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para> | |
737 | </listitem> | |
738 | </varlistentry> | |
739 | <varlistentry> | |
740 | <term><varname>DestinationPort=</varname></term> | |
741 | <listitem> | |
98616735 SS |
742 | <para>Specifies destination port. Defaults to 6081. If not set or assigned the empty string, the default |
743 | port of 6081 is used.</para> | |
6598e046 SS |
744 | </listitem> |
745 | </varlistentry> | |
746 | <varlistentry> | |
747 | <term><varname>FlowLabel=</varname></term> | |
748 | <listitem> | |
749 | <para>Specifies the flow label to use in outgoing packets.</para> | |
750 | </listitem> | |
751 | </varlistentry> | |
752 | </variablelist> | |
753 | </refsect1> | |
798d3a52 ZJS |
754 | <refsect1> |
755 | <title>[Tunnel] Section Options</title> | |
756 | ||
757 | <para>The <literal>[Tunnel]</literal> section only applies for | |
758 | netdevs of kind | |
759 | <literal>ipip</literal>, | |
760 | <literal>sit</literal>, | |
761 | <literal>gre</literal>, | |
762 | <literal>gretap</literal>, | |
763 | <literal>ip6gre</literal>, | |
764 | <literal>ip6gretap</literal>, | |
5cc0748e SS |
765 | <literal>vti</literal>, |
766 | <literal>vti6</literal>, and | |
798d3a52 ZJS |
767 | <literal>ip6tnl</literal> and accepts |
768 | the following keys:</para> | |
769 | ||
770 | <variablelist class='network-directives'> | |
771 | <varlistentry> | |
772 | <term><varname>Local=</varname></term> | |
773 | <listitem> | |
774 | <para>A static local address for tunneled packets. It must | |
775 | be an address on another interface of this host.</para> | |
776 | </listitem> | |
777 | </varlistentry> | |
778 | <varlistentry> | |
779 | <term><varname>Remote=</varname></term> | |
780 | <listitem> | |
781 | <para>The remote endpoint of the tunnel.</para> | |
782 | </listitem> | |
783 | </varlistentry> | |
784 | <varlistentry> | |
785 | <term><varname>TOS=</varname></term> | |
786 | <listitem> | |
787 | <para>The Type Of Service byte value for a tunnel interface. | |
b938cb90 | 788 | For details about the TOS, see the |
798d3a52 ZJS |
789 | <ulink url="http://tools.ietf.org/html/rfc1349"> Type of |
790 | Service in the Internet Protocol Suite </ulink> document. | |
791 | </para> | |
792 | </listitem> | |
793 | </varlistentry> | |
794 | <varlistentry> | |
795 | <term><varname>TTL=</varname></term> | |
796 | <listitem> | |
797 | <para>A fixed Time To Live N on tunneled packets. N is a | |
b938cb90 | 798 | number in the range 1–255. 0 is a special value meaning that |
798d3a52 | 799 | packets inherit the TTL value. The default value for IPv4 |
b938cb90 | 800 | tunnels is: inherit. The default value for IPv6 tunnels is |
798d3a52 ZJS |
801 | 64.</para> |
802 | </listitem> | |
803 | </varlistentry> | |
804 | <varlistentry> | |
805 | <term><varname>DiscoverPathMTU=</varname></term> | |
806 | <listitem> | |
807 | <para>A boolean. When true, enables Path MTU Discovery on | |
808 | the tunnel.</para> | |
809 | </listitem> | |
810 | </varlistentry> | |
276de526 SS |
811 | <varlistentry> |
812 | <term><varname>IPv6FlowLabel=</varname></term> | |
813 | <listitem> | |
a8eaaee7 | 814 | <para>Configures the 20-bit flow label (see <ulink url="https://tools.ietf.org/html/rfc6437"> |
276de526 | 815 | RFC 6437</ulink>) field in the IPv6 header (see <ulink url="https://tools.ietf.org/html/rfc2460"> |
a8eaaee7 JE |
816 | RFC 2460</ulink>), which is used by a node to label packets of a flow. |
817 | It is only used for IPv6 tunnels. | |
818 | A flow label of zero is used to indicate packets that have | |
819 | not been labeled. | |
820 | It can be configured to a value in the range 0–0xFFFFF, or be | |
821 | set to <literal>inherit</literal>, in which case the original flowlabel is used.</para> | |
276de526 SS |
822 | </listitem> |
823 | </varlistentry> | |
9b0ca30a | 824 | <varlistentry> |
a9b70f9d | 825 | <term><varname>CopyDSCP=</varname></term> |
9b0ca30a | 826 | <listitem> |
3cf4bcab ZJS |
827 | <para>A boolean. When true, the Differentiated Service Code |
828 | Point (DSCP) field will be copied to the inner header from | |
a9b70f9d | 829 | outer header during the decapsulation of an IPv6 tunnel |
3cf4bcab ZJS |
830 | packet. DSCP is a field in an IP packet that enables different |
831 | levels of service to be assigned to network traffic. | |
832 | Defaults to <literal>no</literal>. | |
9b0ca30a SS |
833 | </para> |
834 | </listitem> | |
835 | </varlistentry> | |
dae398a8 SS |
836 | <varlistentry> |
837 | <term><varname>EncapsulationLimit=</varname></term> | |
838 | <listitem> | |
839 | <para>The Tunnel Encapsulation Limit option specifies how many additional | |
840 | levels of encapsulation are permitted to be prepended to the packet. | |
841 | For example, a Tunnel Encapsulation Limit option containing a limit | |
842 | value of zero means that a packet carrying that option may not enter | |
843 | another tunnel before exiting the current tunnel. | |
844 | (see <ulink url="https://tools.ietf.org/html/rfc2473#section-4.1.1"> RFC 2473</ulink>). | |
b938cb90 | 845 | The valid range is 0–255 and <literal>none</literal>. Defaults to 4. |
dae398a8 SS |
846 | </para> |
847 | </listitem> | |
848 | </varlistentry> | |
1d710029 SS |
849 | <varlistentry> |
850 | <term><varname>Key=</varname></term> | |
851 | <listitem> | |
852 | <para>The <varname>Key=</varname> parameter specifies the same key to use in | |
853 | both directions (<varname>InputKey=</varname> and <varname>OutputKey=</varname>). | |
854 | The <varname>Key=</varname> is either a number or an IPv4 address-like dotted quad. | |
855 | It is used as mark-configured SAD/SPD entry as part of the lookup key (both in data | |
856 | and control path) in ip xfrm (framework used to implement IPsec protocol). | |
857 | See <ulink url="http://man7.org/linux/man-pages/man8/ip-xfrm.8.html"> | |
e306f2df | 858 | ip-xfrm — transform configuration</ulink> for details. It is only used for VTI/VTI6 |
1d710029 SS |
859 | tunnels.</para> |
860 | </listitem> | |
861 | </varlistentry> | |
862 | <varlistentry> | |
863 | <term><varname>InputKey=</varname></term> | |
864 | <listitem> | |
865 | <para>The <varname>InputKey=</varname> parameter specifies the key to use for input. | |
866 | The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6 tunnels.</para> | |
867 | </listitem> | |
868 | </varlistentry> | |
869 | <varlistentry> | |
870 | <term><varname>OutputKey=</varname></term> | |
871 | <listitem> | |
872 | <para>The <varname>OutputKey=</varname> parameter specifies the key to use for output. | |
873 | The format is same as <varname>Key=</varname>. It is only used for VTI/VTI6 tunnels.</para> | |
874 | </listitem> | |
875 | </varlistentry> | |
798d3a52 ZJS |
876 | <varlistentry> |
877 | <term><varname>Mode=</varname></term> | |
878 | <listitem> | |
a8eaaee7 | 879 | <para>An <literal>ip6tnl</literal> tunnel can be in one of three |
798d3a52 ZJS |
880 | modes |
881 | <literal>ip6ip6</literal> for IPv6 over IPv6, | |
882 | <literal>ipip6</literal> for IPv4 over IPv6 or | |
883 | <literal>any</literal> for either. | |
884 | </para> | |
885 | </listitem> | |
886 | </varlistentry> | |
4d7fa6de SS |
887 | <varlistentry> |
888 | <term><varname>Independent=</varname></term> | |
889 | <listitem> | |
890 | <para>A boolean. When true tunnel does not require .network file. Created as "tunnel@NONE". | |
891 | Defaults to <literal>false</literal>. | |
892 | </para> | |
893 | </listitem> | |
894 | </varlistentry> | |
3a4f3e42 SS |
895 | <varlistentry> |
896 | <term><varname>AllowLocalRemote=</varname></term> | |
897 | <listitem> | |
898 | <para>A boolean. When true allows tunnel traffic on <varname>ip6tnl</varname> devices where the remote endpoint is a local host address. | |
899 | Defaults to unset. | |
900 | </para> | |
901 | </listitem> | |
902 | </varlistentry> | |
798d3a52 ZJS |
903 | </variablelist> |
904 | </refsect1> | |
905 | <refsect1> | |
906 | <title>[Peer] Section Options</title> | |
907 | ||
908 | <para>The <literal>[Peer]</literal> section only applies for | |
909 | netdevs of kind <literal>veth</literal> and accepts the | |
a8eaaee7 | 910 | following keys:</para> |
798d3a52 ZJS |
911 | |
912 | <variablelist class='network-directives'> | |
913 | <varlistentry> | |
914 | <term><varname>Name=</varname></term> | |
915 | <listitem> | |
916 | <para>The interface name used when creating the netdev. | |
917 | This option is compulsory.</para> | |
918 | </listitem> | |
919 | </varlistentry> | |
920 | <varlistentry> | |
921 | <term><varname>MACAddress=</varname></term> | |
922 | <listitem> | |
b938cb90 | 923 | <para>The peer MACAddress, if not set, it is generated in |
798d3a52 ZJS |
924 | the same way as the MAC address of the main |
925 | interface.</para> | |
926 | </listitem> | |
927 | </varlistentry> | |
928 | </variablelist> | |
929 | </refsect1> | |
d6df583c SS |
930 | <refsect1> |
931 | <title>[VXCAN] Section Options</title> | |
932 | <para>The <literal>[VXCAN]</literal> section only applies for | |
933 | netdevs of kind <literal>vxcan</literal> and accepts the | |
934 | following key:</para> | |
935 | ||
936 | <variablelist class='network-directives'> | |
937 | <varlistentry> | |
938 | <term><varname>Peer=</varname></term> | |
939 | <listitem> | |
940 | <para>The peer interface name used when creating the netdev. | |
941 | This option is compulsory.</para> | |
942 | </listitem> | |
943 | </varlistentry> | |
944 | </variablelist> | |
945 | </refsect1> | |
798d3a52 ZJS |
946 | <refsect1> |
947 | <title>[Tun] Section Options</title> | |
948 | ||
949 | <para>The <literal>[Tun]</literal> section only applies for | |
950 | netdevs of kind <literal>tun</literal>, and accepts the following | |
951 | keys:</para> | |
952 | ||
953 | <variablelist class='network-directives'> | |
954 | <varlistentry> | |
955 | <term><varname>OneQueue=</varname></term> | |
956 | <listitem><para>Takes a boolean argument. Configures whether | |
957 | all packets are queued at the device (enabled), or a fixed | |
958 | number of packets are queued at the device and the rest at the | |
959 | <literal>qdisc</literal>. Defaults to | |
960 | <literal>no</literal>.</para> | |
961 | </listitem> | |
962 | </varlistentry> | |
963 | <varlistentry> | |
964 | <term><varname>MultiQueue=</varname></term> | |
965 | <listitem><para>Takes a boolean argument. Configures whether | |
966 | to use multiple file descriptors (queues) to parallelize | |
967 | packets sending and receiving. Defaults to | |
968 | <literal>no</literal>.</para> | |
969 | </listitem> | |
970 | </varlistentry> | |
971 | <varlistentry> | |
972 | <term><varname>PacketInfo=</varname></term> | |
973 | <listitem><para>Takes a boolean argument. Configures whether | |
ff9b60f3 | 974 | packets should be prepended with four extra bytes (two flag |
b938cb90 | 975 | bytes and two protocol bytes). If disabled, it indicates that |
798d3a52 ZJS |
976 | the packets will be pure IP packets. Defaults to |
977 | <literal>no</literal>.</para> | |
978 | </listitem> | |
979 | </varlistentry> | |
43f78da4 | 980 | <varlistentry> |
2aba142e | 981 | <term><varname>VNetHeader=</varname></term> |
43f78da4 SS |
982 | <listitem><para>Takes a boolean argument. Configures |
983 | IFF_VNET_HDR flag for a tap device. It allows sending | |
984 | and receiving larger Generic Segmentation Offload (GSO) | |
985 | packets. This may increase throughput significantly. | |
986 | Defaults to | |
987 | <literal>no</literal>.</para> | |
988 | </listitem> | |
989 | </varlistentry> | |
798d3a52 ZJS |
990 | <varlistentry> |
991 | <term><varname>User=</varname></term> | |
992 | <listitem><para>User to grant access to the | |
993 | <filename>/dev/net/tun</filename> device.</para> | |
994 | </listitem> | |
995 | </varlistentry> | |
996 | <varlistentry> | |
997 | <term><varname>Group=</varname></term> | |
998 | <listitem><para>Group to grant access to the | |
999 | <filename>/dev/net/tun</filename> device.</para> | |
1000 | </listitem> | |
1001 | </varlistentry> | |
1002 | ||
1003 | </variablelist> | |
1004 | ||
1005 | </refsect1> | |
1006 | ||
1007 | <refsect1> | |
1008 | <title>[Tap] Section Options</title> | |
1009 | ||
1010 | <para>The <literal>[Tap]</literal> section only applies for | |
1011 | netdevs of kind <literal>tap</literal>, and accepts the same keys | |
1012 | as the <literal>[Tun]</literal> section.</para> | |
1013 | </refsect1> | |
1014 | ||
e5719363 JT |
1015 | <refsect1> |
1016 | <title>[WireGuard] Section Options</title> | |
1017 | ||
1018 | <para>The <literal>[WireGuard]</literal> section accepts the following | |
1019 | keys:</para> | |
1020 | ||
1021 | <variablelist class='network-directives'> | |
1022 | <varlistentry> | |
1023 | <term><varname>PrivateKey=</varname></term> | |
1024 | <listitem> | |
1025 | <para>The Base64 encoded private key for the interface. It can be | |
1026 | generated using the <command>wg genkey</command> command | |
1027 | (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>). | |
1028 | This option is mandatory to use wireguard.</para> | |
1029 | </listitem> | |
1030 | </varlistentry> | |
1031 | <varlistentry> | |
1032 | <term><varname>ListenPort=</varname></term> | |
1033 | <listitem> | |
1034 | <para>Sets UDP port for listening. Takes either value between 1 and 65535 | |
1035 | or <literal>auto</literal>. If <literal>auto</literal> is specified, | |
1036 | the port is automatically generated based on interface name. | |
1037 | Defaults to <literal>auto</literal>.</para> | |
1038 | </listitem> | |
1039 | </varlistentry> | |
1040 | <varlistentry> | |
1041 | <term><varname>FwMark=</varname></term> | |
1042 | <listitem> | |
1043 | <para>Sets a firewall mark on outgoing wireguard packets from this interface.</para> | |
1044 | </listitem> | |
1045 | </varlistentry> | |
1046 | </variablelist> | |
1047 | </refsect1> | |
1048 | ||
1049 | <refsect1> | |
1050 | <title>[WireGuardPeer] Section Options</title> | |
1051 | ||
1052 | <para>The <literal>[WireGuardPeer]</literal> section accepts the following | |
1053 | keys:</para> | |
1054 | ||
1055 | <variablelist class='network-directives'> | |
1056 | <varlistentry> | |
1057 | <term><varname>PublicKey=</varname></term> | |
1058 | <listitem> | |
1059 | <para>Sets a Base64 encoded public key calculated by <command>wg pubkey</command> | |
1060 | (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>) | |
1061 | from a private key, and usually transmitted out of band to the | |
1062 | author of the configuration file. This option is mandatory for this | |
1063 | section.</para> | |
1064 | </listitem> | |
1065 | </varlistentry> | |
1066 | <varlistentry> | |
1067 | <term><varname>PresharedKey=</varname></term> | |
1068 | <listitem> | |
1069 | <para>Optional preshared key for the interface. It can be generated | |
1070 | by the <command>wg genpsk</command> command. This option adds an | |
1071 | additional layer of symmetric-key cryptography to be mixed into the | |
1072 | already existing public-key cryptography, for post-quantum | |
1073 | resistance.</para> | |
1074 | </listitem> | |
1075 | </varlistentry> | |
1076 | <varlistentry> | |
1077 | <term><varname>AllowedIPs=</varname></term> | |
1078 | <listitem> | |
1079 | <para>Sets a comma-separated list of IP (v4 or v6) addresses with CIDR masks | |
1080 | from which this peer is allowed to send incoming traffic and to | |
1081 | which outgoing traffic for this peer is directed. The catch-all | |
1082 | 0.0.0.0/0 may be specified for matching all IPv4 addresses, and | |
1083 | ::/0 may be specified for matching all IPv6 addresses. </para> | |
1084 | </listitem> | |
1085 | </varlistentry> | |
1086 | <varlistentry> | |
1087 | <term><varname>Endpoint=</varname></term> | |
1088 | <listitem> | |
1089 | <para>Sets an endpoint IP address or hostname, followed by a colon, and then | |
1090 | a port number. This endpoint will be updated automatically once to | |
1091 | the most recent source IP address and port of correctly | |
1092 | authenticated packets from the peer at configuration time.</para> | |
1093 | </listitem> | |
1094 | </varlistentry> | |
1095 | <varlistentry> | |
1096 | <term><varname>PersistentKeepalive=</varname></term> | |
1097 | <listitem> | |
1098 | <para>Sets a seconds interval, between 1 and 65535 inclusive, of how often | |
1099 | to send an authenticated empty packet to the peer for the purpose | |
1100 | of keeping a stateful firewall or NAT mapping valid persistently. | |
1101 | For example, if the interface very rarely sends traffic, but it | |
1102 | might at anytime receive traffic from a peer, and it is behind NAT, | |
1103 | the interface might benefit from having a persistent keepalive | |
1104 | interval of 25 seconds. If set to 0 or "off", this option is | |
1105 | disabled. By default or when unspecified, this option is off. | |
1106 | Most users will not need this.</para> | |
1107 | </listitem> | |
1108 | </varlistentry> | |
1109 | </variablelist> | |
1110 | </refsect1> | |
1111 | ||
798d3a52 ZJS |
1112 | <refsect1> |
1113 | <title>[Bond] Section Options</title> | |
1114 | ||
1115 | <para>The <literal>[Bond]</literal> section accepts the following | |
1116 | key:</para> | |
1117 | ||
1118 | <variablelist class='network-directives'> | |
1119 | <varlistentry> | |
1120 | <term><varname>Mode=</varname></term> | |
1121 | <listitem> | |
1122 | <para>Specifies one of the bonding policies. The default is | |
1123 | <literal>balance-rr</literal> (round robin). Possible values are | |
1124 | <literal>balance-rr</literal>, | |
1125 | <literal>active-backup</literal>, | |
1126 | <literal>balance-xor</literal>, | |
1127 | <literal>broadcast</literal>, | |
1128 | <literal>802.3ad</literal>, | |
1129 | <literal>balance-tlb</literal>, and | |
1130 | <literal>balance-alb</literal>. | |
1131 | </para> | |
1132 | </listitem> | |
1133 | </varlistentry> | |
1134 | ||
1135 | <varlistentry> | |
1136 | <term><varname>TransmitHashPolicy=</varname></term> | |
1137 | <listitem> | |
1138 | <para>Selects the transmit hash policy to use for slave | |
1139 | selection in balance-xor, 802.3ad, and tlb modes. Possible | |
1140 | values are | |
1141 | <literal>layer2</literal>, | |
1142 | <literal>layer3+4</literal>, | |
1143 | <literal>layer2+3</literal>, | |
4d89618a | 1144 | <literal>encap2+3</literal>, and |
798d3a52 ZJS |
1145 | <literal>encap3+4</literal>. |
1146 | </para> | |
1147 | </listitem> | |
1148 | </varlistentry> | |
1149 | ||
1150 | <varlistentry> | |
1151 | <term><varname>LACPTransmitRate=</varname></term> | |
1152 | <listitem> | |
1153 | <para>Specifies the rate with which link partner transmits | |
1154 | Link Aggregation Control Protocol Data Unit packets in | |
1155 | 802.3ad mode. Possible values are <literal>slow</literal>, | |
1156 | which requests partner to transmit LACPDUs every 30 seconds, | |
1157 | and <literal>fast</literal>, which requests partner to | |
1158 | transmit LACPDUs every second. The default value is | |
1159 | <literal>slow</literal>.</para> | |
1160 | </listitem> | |
1161 | </varlistentry> | |
1162 | ||
1163 | <varlistentry> | |
1164 | <term><varname>MIIMonitorSec=</varname></term> | |
1165 | <listitem> | |
1166 | <para>Specifies the frequency that Media Independent | |
1167 | Interface link monitoring will occur. A value of zero | |
dd2b607b | 1168 | disables MII link monitoring. This value is rounded down to |
798d3a52 ZJS |
1169 | the nearest millisecond. The default value is 0.</para> |
1170 | </listitem> | |
1171 | </varlistentry> | |
1172 | ||
1173 | <varlistentry> | |
1174 | <term><varname>UpDelaySec=</varname></term> | |
1175 | <listitem> | |
1176 | <para>Specifies the delay before a link is enabled after a | |
1177 | link up status has been detected. This value is rounded down | |
1178 | to a multiple of MIIMonitorSec. The default value is | |
1179 | 0.</para> | |
1180 | </listitem> | |
1181 | </varlistentry> | |
1182 | ||
1183 | <varlistentry> | |
1184 | <term><varname>DownDelaySec=</varname></term> | |
1185 | <listitem> | |
1186 | <para>Specifies the delay before a link is disabled after a | |
1187 | link down status has been detected. This value is rounded | |
1188 | down to a multiple of MIIMonitorSec. The default value is | |
1189 | 0.</para> | |
1190 | </listitem> | |
1191 | </varlistentry> | |
1192 | ||
81bd37a8 | 1193 | <varlistentry> |
38422da7 | 1194 | <term><varname>LearnPacketIntervalSec=</varname></term> |
81bd37a8 SS |
1195 | <listitem> |
1196 | <para>Specifies the number of seconds between instances where the bonding | |
a8eaaee7 JE |
1197 | driver sends learning packets to each slave peer switch. |
1198 | The valid range is 1–0x7fffffff; the default value is 1. This option | |
1199 | has an effect only for the balance-tlb and balance-alb modes.</para> | |
81bd37a8 SS |
1200 | </listitem> |
1201 | </varlistentry> | |
1202 | ||
1203 | <varlistentry> | |
1204 | <term><varname>AdSelect=</varname></term> | |
1205 | <listitem> | |
1206 | <para>Specifies the 802.3ad aggregation selection logic to use. Possible values are | |
1207 | <literal>stable</literal>, | |
a8eaaee7 JE |
1208 | <literal>bandwidth</literal> and |
1209 | <literal>count</literal>. | |
81bd37a8 SS |
1210 | </para> |
1211 | </listitem> | |
1212 | </varlistentry> | |
1213 | ||
1214 | <varlistentry> | |
38422da7 | 1215 | <term><varname>FailOverMACPolicy=</varname></term> |
81bd37a8 | 1216 | <listitem> |
a8eaaee7 JE |
1217 | <para>Specifies whether the active-backup mode should set all slaves to |
1218 | the same MAC address at the time of enslavement or, when enabled, to perform special handling of the | |
81bd37a8 SS |
1219 | bond's MAC address in accordance with the selected policy. The default policy is none. |
1220 | Possible values are | |
1221 | <literal>none</literal>, | |
a8eaaee7 JE |
1222 | <literal>active</literal> and |
1223 | <literal>follow</literal>. | |
81bd37a8 SS |
1224 | </para> |
1225 | </listitem> | |
1226 | </varlistentry> | |
1227 | ||
1228 | <varlistentry> | |
38422da7 | 1229 | <term><varname>ARPValidate=</varname></term> |
81bd37a8 SS |
1230 | <listitem> |
1231 | <para>Specifies whether or not ARP probes and replies should be | |
38422da7 | 1232 | validated in any mode that supports ARP monitoring, or whether |
81bd37a8 SS |
1233 | non-ARP traffic should be filtered (disregarded) for link |
1234 | monitoring purposes. Possible values are | |
1235 | <literal>none</literal>, | |
1236 | <literal>active</literal>, | |
a8eaaee7 JE |
1237 | <literal>backup</literal> and |
1238 | <literal>all</literal>. | |
81bd37a8 SS |
1239 | </para> |
1240 | </listitem> | |
1241 | </varlistentry> | |
1242 | ||
1243 | <varlistentry> | |
38422da7 | 1244 | <term><varname>ARPIntervalSec=</varname></term> |
81bd37a8 SS |
1245 | <listitem> |
1246 | <para>Specifies the ARP link monitoring frequency in milliseconds. | |
1247 | A value of 0 disables ARP monitoring. The default value is 0. | |
1248 | </para> | |
1249 | </listitem> | |
1250 | </varlistentry> | |
1251 | ||
1252 | <varlistentry> | |
38422da7 | 1253 | <term><varname>ARPIPTargets=</varname></term> |
81bd37a8 SS |
1254 | <listitem> |
1255 | <para>Specifies the IP addresses to use as ARP monitoring peers when | |
38422da7 | 1256 | ARPIntervalSec is greater than 0. These are the targets of the ARP request |
81bd37a8 | 1257 | sent to determine the health of the link to the targets. |
a8eaaee7 | 1258 | Specify these values in IPv4 dotted decimal format. At least one IP |
81bd37a8 SS |
1259 | address must be given for ARP monitoring to function. The |
1260 | maximum number of targets that can be specified is 16. The | |
1261 | default value is no IP addresses. | |
1262 | </para> | |
1263 | </listitem> | |
1264 | </varlistentry> | |
1265 | ||
1266 | <varlistentry> | |
38422da7 | 1267 | <term><varname>ARPAllTargets=</varname></term> |
81bd37a8 | 1268 | <listitem> |
38422da7 | 1269 | <para>Specifies the quantity of ARPIPTargets that must be reachable |
81bd37a8 SS |
1270 | in order for the ARP monitor to consider a slave as being up. |
1271 | This option affects only active-backup mode for slaves with | |
38422da7 | 1272 | ARPValidate enabled. Possible values are |
a8eaaee7 JE |
1273 | <literal>any</literal> and |
1274 | <literal>all</literal>. | |
81bd37a8 SS |
1275 | </para> |
1276 | </listitem> | |
1277 | </varlistentry> | |
1278 | ||
1279 | <varlistentry> | |
38422da7 | 1280 | <term><varname>PrimaryReselectPolicy=</varname></term> |
81bd37a8 SS |
1281 | <listitem> |
1282 | <para>Specifies the reselection policy for the primary slave. This | |
1283 | affects how the primary slave is chosen to become the active slave | |
1284 | when failure of the active slave or recovery of the primary slave | |
1285 | occurs. This option is designed to prevent flip-flopping between | |
1286 | the primary slave and other slaves. Possible values are | |
1287 | <literal>always</literal>, | |
a8eaaee7 JE |
1288 | <literal>better</literal> and |
1289 | <literal>failure</literal>. | |
81bd37a8 SS |
1290 | </para> |
1291 | </listitem> | |
1292 | </varlistentry> | |
1293 | ||
1294 | <varlistentry> | |
1295 | <term><varname>ResendIGMP=</varname></term> | |
1296 | <listitem> | |
1297 | <para>Specifies the number of IGMP membership reports to be issued after | |
1298 | a failover event. One membership report is issued immediately after | |
1299 | the failover, subsequent packets are sent in each 200ms interval. | |
b938cb90 | 1300 | The valid range is 0–255. Defaults to 1. A value of 0 |
81bd37a8 SS |
1301 | prevents the IGMP membership report from being issued in response |
1302 | to the failover event. | |
1303 | </para> | |
1304 | </listitem> | |
1305 | </varlistentry> | |
1306 | ||
1307 | <varlistentry> | |
1308 | <term><varname>PacketsPerSlave=</varname></term> | |
1309 | <listitem> | |
b938cb90 JE |
1310 | <para>Specify the number of packets to transmit through a slave before |
1311 | moving to the next one. When set to 0, then a slave is chosen at | |
1312 | random. The valid range is 0–65535. Defaults to 1. This option | |
a8eaaee7 | 1313 | only has effect when in balance-rr mode. |
81bd37a8 SS |
1314 | </para> |
1315 | </listitem> | |
1316 | </varlistentry> | |
1317 | ||
1318 | <varlistentry> | |
38422da7 | 1319 | <term><varname>GratuitousARP=</varname></term> |
81bd37a8 SS |
1320 | <listitem> |
1321 | <para>Specify the number of peer notifications (gratuitous ARPs and | |
1322 | unsolicited IPv6 Neighbor Advertisements) to be issued after a | |
b938cb90 | 1323 | failover event. As soon as the link is up on the new slave, |
81bd37a8 SS |
1324 | a peer notification is sent on the bonding device and each |
1325 | VLAN sub-device. This is repeated at each link monitor interval | |
38422da7 | 1326 | (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is |
a8eaaee7 | 1327 | greater than 1. The valid range is 0–255. The default value is 1. |
38422da7 | 1328 | These options affect only the active-backup mode. |
81bd37a8 SS |
1329 | </para> |
1330 | </listitem> | |
1331 | </varlistentry> | |
1332 | ||
1333 | <varlistentry> | |
1334 | <term><varname>AllSlavesActive=</varname></term> | |
1335 | <listitem> | |
a8eaaee7 JE |
1336 | <para>A boolean. Specifies that duplicate frames (received on inactive ports) |
1337 | should be dropped when false, or delivered when true. Normally, bonding will drop | |
81bd37a8 SS |
1338 | duplicate frames (received on inactive ports), which is desirable for |
1339 | most users. But there are some times it is nice to allow duplicate | |
1340 | frames to be delivered. The default value is false (drop duplicate frames | |
1341 | received on inactive ports). | |
1342 | </para> | |
1343 | </listitem> | |
1344 | </varlistentry> | |
1345 | ||
1346 | <varlistentry> | |
1347 | <term><varname>MinLinks=</varname></term> | |
1348 | <listitem> | |
1349 | <para>Specifies the minimum number of links that must be active before | |
1350 | asserting carrier. The default value is 0. | |
1351 | </para> | |
1352 | </listitem> | |
1353 | </varlistentry> | |
798d3a52 | 1354 | </variablelist> |
81bd37a8 SS |
1355 | |
1356 | <para>For more detail information see | |
1357 | <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt"> | |
1358 | Linux Ethernet Bonding Driver HOWTO</ulink></para> | |
1359 | ||
798d3a52 ZJS |
1360 | </refsect1> |
1361 | ||
1362 | <refsect1> | |
1363 | <title>Example</title> | |
1364 | <example> | |
6c1695be | 1365 | <title>/etc/systemd/network/25-bridge.netdev</title> |
798d3a52 ZJS |
1366 | |
1367 | <programlisting>[NetDev] | |
eac684ef TG |
1368 | Name=bridge0 |
1369 | Kind=bridge</programlisting> | |
798d3a52 | 1370 | </example> |
eac684ef | 1371 | |
798d3a52 | 1372 | <example> |
6c1695be | 1373 | <title>/etc/systemd/network/25-vlan1.netdev</title> |
eac684ef | 1374 | |
798d3a52 | 1375 | <programlisting>[Match] |
eac684ef TG |
1376 | Virtualization=no |
1377 | ||
1378 | [NetDev] | |
1379 | Name=vlan1 | |
1380 | Kind=vlan | |
1381 | ||
1382 | [VLAN] | |
1383 | Id=1</programlisting> | |
798d3a52 ZJS |
1384 | </example> |
1385 | <example> | |
6c1695be | 1386 | <title>/etc/systemd/network/25-ipip.netdev</title> |
798d3a52 | 1387 | <programlisting>[NetDev] |
b35a2909 TG |
1388 | Name=ipip-tun |
1389 | Kind=ipip | |
1390 | MTUBytes=1480 | |
1391 | ||
1392 | [Tunnel] | |
1393 | Local=192.168.223.238 | |
1394 | Remote=192.169.224.239 | |
1395 | TTL=64</programlisting> | |
798d3a52 ZJS |
1396 | </example> |
1397 | <example> | |
6c1695be | 1398 | <title>/etc/systemd/network/25-tap.netdev</title> |
798d3a52 | 1399 | <programlisting>[NetDev] |
30ae9dfd SS |
1400 | Name=tap-test |
1401 | Kind=tap | |
1402 | ||
1403 | [Tap] | |
1404 | MultiQueue=true | |
1405 | PacketInfo=true</programlisting> </example> | |
eac684ef | 1406 | |
798d3a52 | 1407 | <example> |
6c1695be | 1408 | <title>/etc/systemd/network/25-sit.netdev</title> |
798d3a52 | 1409 | <programlisting>[NetDev] |
b35a2909 TG |
1410 | Name=sit-tun |
1411 | Kind=sit | |
1412 | MTUBytes=1480 | |
1413 | ||
1414 | [Tunnel] | |
1415 | Local=10.65.223.238 | |
1416 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 1417 | </example> |
eac684ef | 1418 | |
798d3a52 | 1419 | <example> |
6c1695be | 1420 | <title>/etc/systemd/network/25-gre.netdev</title> |
798d3a52 | 1421 | <programlisting>[NetDev] |
b35a2909 TG |
1422 | Name=gre-tun |
1423 | Kind=gre | |
1424 | MTUBytes=1480 | |
1425 | ||
1426 | [Tunnel] | |
1427 | Local=10.65.223.238 | |
1428 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 1429 | </example> |
b35a2909 | 1430 | |
798d3a52 | 1431 | <example> |
6c1695be | 1432 | <title>/etc/systemd/network/25-vti.netdev</title> |
b35a2909 | 1433 | |
798d3a52 | 1434 | <programlisting>[NetDev] |
b35a2909 TG |
1435 | Name=vti-tun |
1436 | Kind=vti | |
1437 | MTUBytes=1480 | |
1438 | ||
1439 | [Tunnel] | |
1440 | Local=10.65.223.238 | |
1441 | Remote=10.65.223.239</programlisting> | |
798d3a52 | 1442 | </example> |
b35a2909 | 1443 | |
798d3a52 | 1444 | <example> |
6c1695be | 1445 | <title>/etc/systemd/network/25-veth.netdev</title> |
798d3a52 | 1446 | <programlisting>[NetDev] |
b35a2909 TG |
1447 | Name=veth-test |
1448 | Kind=veth | |
1449 | ||
1450 | [Peer] | |
1451 | Name=veth-peer</programlisting> | |
798d3a52 | 1452 | </example> |
b35a2909 | 1453 | |
d94facdc | 1454 | <example> |
6c1695be | 1455 | <title>/etc/systemd/network/25-bond.netdev</title> |
d94facdc MH |
1456 | <programlisting>[NetDev] |
1457 | Name=bond1 | |
1458 | Kind=bond | |
1459 | ||
1460 | [Bond] | |
1461 | Mode=802.3ad | |
1462 | TransmitHashPolicy=layer3+4 | |
1463 | MIIMonitorSec=1s | |
1464 | LACPTransmitRate=fast | |
1465 | </programlisting> | |
1466 | </example> | |
1467 | ||
798d3a52 | 1468 | <example> |
6c1695be | 1469 | <title>/etc/systemd/network/25-dummy.netdev</title> |
798d3a52 | 1470 | <programlisting>[NetDev] |
9e358851 TG |
1471 | Name=dummy-test |
1472 | Kind=dummy | |
1473 | MACAddress=12:34:56:78:9a:bc</programlisting> | |
798d3a52 | 1474 | </example> |
20897a0d AR |
1475 | <example> |
1476 | <title>/etc/systemd/network/25-vrf.netdev</title> | |
037a3ded | 1477 | <para>Create a VRF interface with table 42.</para> |
20897a0d AR |
1478 | <programlisting>[NetDev] |
1479 | Name=vrf-test | |
1480 | Kind=vrf | |
798d3a52 | 1481 | |
20897a0d | 1482 | [VRF] |
362f6336 | 1483 | Table=42</programlisting> |
20897a0d | 1484 | </example> |
42125eda SS |
1485 | |
1486 | <example> | |
1487 | <title>/etc/systemd/network/25-macvtap.netdev</title> | |
1488 | <para>Create a MacVTap device.</para> | |
1489 | <programlisting>[NetDev] | |
1490 | Name=macvtap-test | |
1491 | Kind=macvtap | |
1492 | </programlisting> | |
1493 | </example> | |
e5719363 JT |
1494 | <example> |
1495 | <title>/etc/systemd/network/25-wireguard.netdev</title> | |
1496 | <programlisting>[NetDev] | |
1497 | Name=wg0 | |
1498 | Kind=wireguard | |
1499 | ||
1500 | [WireGuard] | |
1501 | PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong= | |
1502 | ListenPort=51820 | |
1503 | ||
1504 | [WireGuardPeer] | |
1505 | PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA= | |
1506 | AllowedIPs=fd31:bf08:57cb::/48,192.168.26.0/24 | |
1507 | Endpoint=wireguard.example.com:51820</programlisting> | |
1508 | </example> | |
798d3a52 ZJS |
1509 | </refsect1> |
1510 | <refsect1> | |
1511 | <title>See Also</title> | |
1512 | <para> | |
1513 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1514 | <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
1515 | <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
1516 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
1517 | </para> | |
1518 | </refsect1> | |
eac684ef TG |
1519 | |
1520 | </refentry> |