Debian Codegraph @

upstream/debian-trixie/man5/systemd.netdev.5

raw
1 '\" t
2 .TH "SYSTEMD\&.NETDEV" "5" "" "systemd 257.13" "systemd.network"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd.netdev \- Virtual Network Device configuration
24 .SH "SYNOPSIS"
25 .PP
26 \fInetdev\fR\&.netdev
27 .SH "DESCRIPTION"
28 .PP
29 A plain ini\-style text file that encodes configuration about a virtual network device, used by
30 \fBsystemd-networkd\fR(8)\&. See
31 \fBsystemd.syntax\fR(7)
32 for a general description of the syntax\&.
33 .PP
34 The main Virtual Network Device file must have the extension
35 \&.netdev; other extensions are ignored\&. Virtual network devices are created as soon as
36 \fBsystemd\-networkd\fR
37 is started if possible\&. If a netdev with the specified name already exists,
38 \fBsystemd\-networkd\fR
39 will try to update the config if the kind of the existing netdev is equivalent to the requested one, otherwise (e\&.g\&. when bridge device
40 foo
41 exists but bonding device with the same name is configured in a \&.netdev file) use the existing netdev as\-is rather than replacing with the requested netdev\&. Note, several settings (e\&.g\&. vlan ID) cannot be changed after the netdev is created\&. To change such settings, it is necessary to first remove the existing netdev, and then run
42 \fBnetworkctl reload\fR
43 command or restart
44 \fBsystemd\-networkd\fR\&. See also
45 \fBnetworkctl\fR(1)\&.
46 .PP
47 The
48 \&.netdev
49 files are read from the files located in the system network directory
50 /usr/lib/systemd/network
51 and
52 /usr/local/lib/systemd/network, the volatile runtime network directory
53 /run/systemd/network
54 and the local administration network directory
55 /etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than
56 "70"
57 (e\&.g\&.
58 10\-vlan\&.netdev)\&. Otherwise,
59 \&.netdev
60 files generated by
61 \fBsystemd-network-generator.service\fR(8)
62 may take precedence over user configured files\&. Files in
63 /etc/
64 have the highest priority, files in
65 /run/
66 take precedence over files with the same name in
67 /usr/lib/\&. This can be used to override a system\-supplied configuration file with a local file if needed\&. As a special case, an empty file (file size 0) or symlink with the same name pointing to
68 /dev/null
69 disables the configuration file entirely (it is "masked")\&.
70 .PP
71 Along with the netdev file
72 foo\&.netdev, a "drop\-in" directory
73 foo\&.netdev\&.d/
74 may exist\&. All files with the suffix
75 "\&.conf"
76 from this directory will be merged in the alphanumeric order and parsed after the main file itself has been parsed\&. This is useful to alter or add configuration settings, without having to modify the main configuration file\&. Each drop\-in file must have appropriate section headers\&.
77 .PP
78 In addition to
79 /etc/systemd/network, drop\-in
80 "\&.d"
81 directories can be placed in
82 /usr/lib/systemd/network
83 or
84 /run/systemd/network
85 directories\&. Drop\-in files in
86 /etc/
87 take precedence over those in
88 /run/
89 which in turn take precedence over those in
90 /usr/lib/\&. Drop\-in files under any of these directories take precedence over the main netdev file wherever located\&. (Of course, since
91 /run/
92 is temporary and
93 /usr/lib/
94 is for vendors, it is unlikely drop\-ins should be used in either of those places\&.)
95 .SH "SUPPORTED NETDEV KINDS"
96 .PP
97 The following kinds of virtual network devices may be configured in
98 \&.netdev
99 files:
100 .sp
101 .it 1 an-trap
102 .nr an-no-space-flag 1
103 .nr an-break-flag 1
104 .br
105 .B Table\ \&1.\ \&Supported kinds of virtual network devices
106 .TS
107 allbox tab(:);
108 lB lB.
109 T{
110 Kind
111 T}:T{
112 Description
113 T}
114 .T&
115 l l
116 l l
117 l l
118 l l
119 l l
120 l l
121 l l
122 l l
123 l l
124 l l
125 l l
126 l l
127 l l
128 l l
129 l l
130 l l
131 l l
132 l l
133 l l
134 l l
135 l l
136 l l
137 l l
138 l l
139 l l
140 l l
141 l l
142 l l
143 l l
144 l l
145 l l
146 l l
147 l l
148 l l
149 l l
150 l l
151 l l.
152 T{
153 \fIbond\fR
154 T}:T{
155 A bond device is an aggregation of all its slave devices\&. See \m[blue]\fBLinux Ethernet Bonding Driver HOWTO\fR\m[]\&\s-2\u[1]\d\s+2 for details\&.
156 T}
157 T{
158 \fIbridge\fR
159 T}:T{
160 A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch\&.
161 T}
162 T{
163 \fIdummy\fR
164 T}:T{
165 A dummy device drops all packets sent to it\&.
166 T}
167 T{
168 \fIgre\fR
169 T}:T{
170 A Level 3 GRE tunnel over IPv4\&. See \m[blue]\fBRFC 2784\fR\m[]\&\s-2\u[2]\d\s+2 for details\&. Name "gre0" should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded\&.
171 T}
172 T{
173 \fIgretap\fR
174 T}:T{
175 A Level 2 GRE tunnel over IPv4\&. Name "gretap0" should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded\&.
176 T}
177 T{
178 \fIerspan\fR
179 T}:T{
180 ERSPAN mirrors traffic on one or more source ports and delivers the mirrored traffic to one or more destination ports on another switch\&. The traffic is encapsulated in generic routing encapsulation (GRE) and is therefore routable across a layer 3 network between the source switch and the destination switch\&. Name "erspan0" should not be used, as the kernel creates a device with this name when the corresponding kernel module is loaded\&.
181 T}
182 T{
183 \fIip6gre\fR
184 T}:T{
185 A Level 3 GRE tunnel over IPv6\&.
186 T}
187 T{
188 \fIip6tnl\fR
189 T}:T{
190 An IPv4 or IPv6 tunnel over IPv6
191 T}
192 T{
193 \fIip6gretap\fR
194 T}:T{
195 A Level 2 GRE tunnel over IPv6\&.
196 T}
197 T{
198 \fIipip\fR
199 T}:T{
200 An IPv4 over IPv4 tunnel\&.
201 T}
202 T{
203 \fIipvlan\fR
204 T}:T{
205 An IPVLAN device is a stacked device which receives packets from its underlying device based on IP address filtering\&.
206 T}
207 T{
208 \fIipvtap\fR
209 T}:T{
210 An IPVTAP device is a stacked device which receives packets from its underlying device based on IP address filtering and can be accessed using the tap user space interface\&.
211 T}
212 T{
213 \fImacvlan\fR
214 T}:T{
215 A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering\&.
216 T}
217 T{
218 \fImacvtap\fR
219 T}:T{
220 A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering\&.
221 T}
222 T{
223 \fIsit\fR
224 T}:T{
225 An IPv6 over IPv4 tunnel\&.
226 T}
227 T{
228 \fItap\fR
229 T}:T{
230 A persistent Level 2 tunnel between a network device and a device node\&.
231 T}
232 T{
233 \fItun\fR
234 T}:T{
235 A persistent Level 3 tunnel between a network device and a device node\&.
236 T}
237 T{
238 \fIveth\fR
239 T}:T{
240 An Ethernet tunnel between a pair of network devices\&.
241 T}
242 T{
243 \fIvlan\fR
244 T}:T{
245 A VLAN is a stacked device which receives packets from its underlying device based on VLAN tagging\&. See \m[blue]\fBIEEE 802\&.1Q\fR\m[]\&\s-2\u[3]\d\s+2 for details\&.
246 T}
247 T{
248 \fIvti\fR
249 T}:T{
250 An IPv4 over IPSec tunnel\&.
251 T}
252 T{
253 \fIvti6\fR
254 T}:T{
255 An IPv6 over IPSec tunnel\&.
256 T}
257 T{
258 \fIvxlan\fR
259 T}:T{
260 A virtual extensible LAN (vxlan), for connecting Cloud computing deployments\&.
261 T}
262 T{
263 \fIgeneve\fR
264 T}:T{
265 A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver\&.
266 T}
267 T{
268 \fIl2tp\fR
269 T}:T{
270 A Layer 2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual private networks (VPNs) or as part of the delivery of services by ISPs\&. It does not provide any encryption or confidentiality by itself
271 T}
272 T{
273 \fImacsec\fR
274 T}:T{
275 Media Access Control Security (MACsec) is an 802\&.1AE IEEE industry\-standard security technology that provides secure communication for all traffic on Ethernet links\&. MACsec provides point\-to\-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats\&.
276 T}
277 T{
278 \fIvrf\fR
279 T}:T{
280 A Virtual Routing and Forwarding (\m[blue]\fBVRF\fR\m[]\&\s-2\u[4]\d\s+2) interface to create separate routing and forwarding domains\&.
281 T}
282 T{
283 \fIvcan\fR
284 T}:T{
285 The virtual CAN driver (vcan)\&. Similar to the network loopback devices, vcan offers a virtual local CAN interface\&.
286 T}
287 T{
288 \fIvxcan\fR
289 T}:T{
290 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\&.
291 T}
292 T{
293 \fIwireguard\fR
294 T}:T{
295 WireGuard Secure Network Tunnel\&.
296 T}
297 T{
298 \fInlmon\fR
299 T}:T{
300 A Netlink monitor device\&. Use an nlmon device when you want to monitor system Netlink messages\&.
301 T}
302 T{
303 \fIfou\fR
304 T}:T{
305 Foo\-over\-UDP tunneling\&.
306 T}
307 T{
308 \fIxfrm\fR
309 T}:T{
310 A virtual tunnel interface like vti/vti6 but with several advantages\&.
311 T}
312 T{
313 \fIifb\fR
314 T}:T{
315 The Intermediate Functional Block (ifb) pseudo network interface acts as a QoS concentrator for multiple different sources of traffic\&.
316 T}
317 T{
318 \fIbareudp\fR
319 T}:T{
320 Bare UDP tunnels provide a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP etc\&. inside of a UDP tunnel\&.
321 T}
322 T{
323 \fIbatadv\fR
324 T}:T{
325 \m[blue]\fBB\&.A\&.T\&.M\&.A\&.N\&. Advanced\fR\m[]\&\s-2\u[5]\d\s+2 is a routing protocol for multi\-hop mobile ad\-hoc networks which operates on layer 2\&.
326 T}
327 T{
328 \fIipoib\fR
329 T}:T{
330 An IP over Infiniband subinterface\&.
331 T}
332 T{
333 \fIwlan\fR
334 T}:T{
335 A virtual wireless network (WLAN) interface\&.
336 T}
337 .TE
338 .sp 1
339 .SH "[MATCH] SECTION OPTIONS"
340 .PP
341 A virtual network device is only created if the [Match] section matches the current environment, or if the section is empty\&. The following keys are accepted:
342 .PP
343 \fIHost=\fR
344 .RS 4
345 Matches against the hostname or machine ID of the host\&. See
346 \fIConditionHost=\fR
347 in
348 \fBsystemd.unit\fR(5)
349 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
350 .sp
351 Added in version 211\&.
352 .RE
353 .PP
354 \fIVirtualization=\fR
355 .RS 4
356 Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation\&. See
357 \fIConditionVirtualization=\fR
358 in
359 \fBsystemd.unit\fR(5)
360 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
361 .sp
362 Added in version 211\&.
363 .RE
364 .PP
365 \fIKernelCommandLine=\fR
366 .RS 4
367 Checks whether a specific kernel command line option is set\&. See
368 \fIConditionKernelCommandLine=\fR
369 in
370 \fBsystemd.unit\fR(5)
371 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
372 .sp
373 Added in version 211\&.
374 .RE
375 .PP
376 \fIKernelVersion=\fR
377 .RS 4
378 Checks whether the kernel version (as reported by
379 \fBuname \-r\fR) matches a certain expression\&. See
380 \fIConditionKernelVersion=\fR
381 in
382 \fBsystemd.unit\fR(5)
383 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
384 .sp
385 Added in version 237\&.
386 .RE
387 .PP
388 \fICredential=\fR
389 .RS 4
390 Checks whether the specified credential was passed to the
391 systemd\-udevd\&.service
392 service\&. See
393 \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[6]\d\s+2
394 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
395 .sp
396 Added in version 252\&.
397 .RE
398 .PP
399 \fIArchitecture=\fR
400 .RS 4
401 Checks whether the system is running on a specific architecture\&. See
402 \fIConditionArchitecture=\fR
403 in
404 \fBsystemd.unit\fR(5)
405 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
406 .sp
407 Added in version 211\&.
408 .RE
409 .PP
410 \fIFirmware=\fR
411 .RS 4
412 Checks whether the system is running on a machine with the specified firmware\&. See
413 \fIConditionFirmware=\fR
414 in
415 \fBsystemd.unit\fR(5)
416 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
417 .sp
418 Added in version 249\&.
419 .RE
420 .SH "[NETDEV] SECTION OPTIONS"
421 .PP
422 The [NetDev] section accepts the following keys:
423 .PP
424 \fIDescription=\fR
425 .RS 4
426 A free\-form description of the netdev\&.
427 .sp
428 Added in version 215\&.
429 .RE
430 .PP
431 \fIName=\fR
432 .RS 4
433 The interface name used when creating the netdev\&. This setting is compulsory\&.
434 .sp
435 Added in version 211\&.
436 .RE
437 .PP
438 \fIKind=\fR
439 .RS 4
440 The netdev kind\&. This setting is compulsory\&. See the
441 "Supported netdev kinds"
442 section for the valid keys\&.
443 .sp
444 Added in version 211\&.
445 .RE
446 .PP
447 \fIMTUBytes=\fR
448 .RS 4
449 The maximum transmission unit in bytes to set for the device\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&. For
450 "tun"
451 or
452 "tap"
453 devices,
454 \fIMTUBytes=\fR
455 setting is not currently supported in [NetDev] section\&. Please specify it in [Link] section of corresponding
456 \fBsystemd.network\fR(5)
457 files\&.
458 .sp
459 Added in version 215\&.
460 .RE
461 .PP
462 \fIMACAddress=\fR
463 .RS 4
464 Specifies the MAC address to use for the device, or takes the special value
465 "none"\&. When
466 "none",
467 \fBsystemd\-networkd\fR
468 does not request the MAC address for the device, and the kernel will assign a random MAC address\&. For
469 "tun",
470 "tap", or
471 "l2tp"
472 devices, the
473 \fIMACAddress=\fR
474 setting in the [NetDev] section is not supported and will be ignored\&. Please specify it in the [Link] section of the corresponding
475 \fBsystemd.network\fR(5)
476 file\&. If this option is not set,
477 "vlan"
478 device inherits the MAC address of the master interface\&. For other kind of netdevs, if this option is not set, then the MAC address is generated based on the interface name and the
479 \fBmachine-id\fR(5)\&.
480 .sp
481 Note, even if
482 "none"
483 is specified,
484 \fBsystemd\-udevd\fR
485 will assign the persistent MAC address for the device, as
486 99\-default\&.link
487 has
488 \fIMACAddressPolicy=persistent\fR\&. So, it is also necessary to create a custom \&.link file for the device, if the MAC address assignment is not desired\&.
489 .sp
490 Added in version 215\&.
491 .RE
492 .SH "[BRIDGE] SECTION OPTIONS"
493 .PP
494 The [Bridge] section only applies for netdevs of kind
495 "bridge", and accepts the following keys:
496 .PP
497 \fIHelloTimeSec=\fR
498 .RS 4
499 HelloTimeSec specifies the number of seconds between two hello packets sent out by the root bridge and the designated bridges\&. Hello packets are used to communicate information about the topology throughout the entire bridged local area network\&.
500 .sp
501 Added in version 227\&.
502 .RE
503 .PP
504 \fIMaxAgeSec=\fR
505 .RS 4
506 MaxAgeSec specifies the number of seconds of maximum message age\&. If the last seen (received) hello packet is more than this number of seconds old, the bridge in question will start the takeover procedure in attempt to become the Root Bridge itself\&.
507 .sp
508 Added in version 227\&.
509 .RE
510 .PP
511 \fIForwardDelaySec=\fR
512 .RS 4
513 ForwardDelaySec specifies the number of seconds spent in each of the Listening and Learning states before the Forwarding state is entered\&.
514 .sp
515 Added in version 227\&.
516 .RE
517 .PP
518 \fIAgeingTimeSec=\fR
519 .RS 4
520 This specifies the number of seconds a MAC Address will be kept in the forwarding database after having a packet received from this MAC Address\&.
521 .sp
522 Added in version 232\&.
523 .RE
524 .PP
525 \fIPriority=\fR
526 .RS 4
527 The priority of the bridge\&. An integer between 0 and 65535\&. A lower value means higher priority\&. The bridge having the lowest priority will be elected as root bridge\&.
528 .sp
529 Added in version 232\&.
530 .RE
531 .PP
532 \fIGroupForwardMask=\fR
533 .RS 4
534 A 16\-bit bitmask represented as an integer which allows forwarding of link local frames with 802\&.1D reserved addresses (01:80:C2:00:00:0X)\&. A logical AND is performed between the specified bitmask and the exponentiation of 2^X, the lower nibble of the last octet of the MAC address\&. For example, a value of 8 would allow forwarding of frames addressed to 01:80:C2:00:00:03 (802\&.1X PAE)\&.
535 .sp
536 Added in version 235\&.
537 .RE
538 .PP
539 \fIDefaultPVID=\fR
540 .RS 4
541 This specifies the default port VLAN ID of a newly attached bridge port\&. Set this to an integer in the range 1\&...4094 or
542 "none"
543 to disable the PVID\&.
544 .sp
545 Added in version 232\&.
546 .RE
547 .PP
548 \fIMulticastQuerier=\fR
549 .RS 4
550 Takes a boolean\&. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel\&. If enabled, the kernel will send general ICMP queries from a zero source address\&. This feature should allow faster convergence on startup, but it causes some multicast\-aware switches to misbehave and disrupt forwarding of multicast packets\&. When unset, the kernel\*(Aqs default will be used\&.
551 .sp
552 Added in version 230\&.
553 .RE
554 .PP
555 \fIMulticastSnooping=\fR
556 .RS 4
557 Takes a boolean\&. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel\&. If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic between hosts and multicast routers\&. When unset, the kernel\*(Aqs default will be used\&.
558 .sp
559 Added in version 230\&.
560 .RE
561 .PP
562 \fIVLANFiltering=\fR
563 .RS 4
564 Takes a boolean\&. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel\&. If enabled, the bridge will be started in VLAN\-filtering mode\&. When unset, the kernel\*(Aqs default will be used\&.
565 .sp
566 Added in version 231\&.
567 .RE
568 .PP
569 \fIVLANProtocol=\fR
570 .RS 4
571 Allows setting the protocol used for VLAN filtering\&. Takes
572 \fB802\&.1q\fR
573 or,
574 \fB802\&.1ad\fR, and defaults to unset and kernel\*(Aqs default is used\&.
575 .sp
576 Added in version 246\&.
577 .RE
578 .PP
579 \fISTP=\fR
580 .RS 4
581 Takes a boolean\&. This enables the bridge\*(Aqs Spanning Tree Protocol (STP)\&. When unset, the kernel\*(Aqs default will be used\&.
582 .sp
583 Added in version 232\&.
584 .RE
585 .PP
586 \fIMulticastIGMPVersion=\fR
587 .RS 4
588 Allows changing bridge\*(Aqs multicast Internet Group Management Protocol (IGMP) version\&. Takes an integer 2 or 3\&. When unset, the kernel\*(Aqs default will be used\&.
589 .sp
590 Added in version 243\&.
591 .RE
592 .PP
593 \fIFDBMaxLearned=\fR
594 .RS 4
595 Specifies the maximum number of learned Ethernet addresses for the bridge\&. When the limit is reached, no more addresses are learned\&. When unset, the kernel\*(Aqs default will be used\&. 0 disables the limit\&.
596 .sp
597 Added in version 257\&.
598 .RE
599 .SH "[VLAN] SECTION OPTIONS"
600 .PP
601 The [VLAN] section only applies for netdevs of kind
602 "vlan", and accepts the following key:
603 .PP
604 \fIId=\fR
605 .RS 4
606 The VLAN ID to use\&. An integer in the range 0\&...4094\&. This setting is compulsory\&.
607 .sp
608 Added in version 211\&.
609 .RE
610 .PP
611 \fIProtocol=\fR
612 .RS 4
613 Allows setting the protocol used for the VLAN interface\&. Takes
614 "802\&.1q"
615 or,
616 "802\&.1ad", and defaults to unset and kernel\*(Aqs default is used\&.
617 .sp
618 Added in version 248\&.
619 .RE
620 .PP
621 \fIGVRP=\fR
622 .RS 4
623 Takes a boolean\&. The Generic VLAN Registration Protocol (GVRP) is a protocol that allows automatic learning of VLANs on a network\&. When unset, the kernel\*(Aqs default will be used\&.
624 .sp
625 Added in version 234\&.
626 .RE
627 .PP
628 \fIMVRP=\fR
629 .RS 4
630 Takes a boolean\&. Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN Registration Protocol (GVRP) is a standards\-based Layer 2 network protocol, for automatic configuration of VLAN information on switches\&. It was defined in the 802\&.1ak amendment to 802\&.1Q\-2005\&. When unset, the kernel\*(Aqs default will be used\&.
631 .sp
632 Added in version 234\&.
633 .RE
634 .PP
635 \fILooseBinding=\fR
636 .RS 4
637 Takes a boolean\&. The VLAN loose binding mode, in which only the operational state is passed from the parent to the associated VLANs, but the VLAN device state is not changed\&. When unset, the kernel\*(Aqs default will be used\&.
638 .sp
639 Added in version 234\&.
640 .RE
641 .PP
642 \fIReorderHeader=\fR
643 .RS 4
644 Takes a boolean\&. When enabled, the VLAN reorder header is used and VLAN interfaces behave like physical interfaces\&. When unset, the kernel\*(Aqs default will be used\&.
645 .sp
646 Added in version 234\&.
647 .RE
648 .PP
649 \fIEgressQOSMaps=\fR, \fIIngressQOSMaps=\fR
650 .RS 4
651 Defines a mapping of Linux internal packet priority (\fBSO_PRIORITY\fR) to VLAN header PCP field for outgoing and incoming frames, respectively\&. Takes a whitespace\-separated list of integer pairs, where each integer must be in the range 1\&...4294967294, in the format
652 "from"\-"to", e\&.g\&.,
653 "21\-7 45\-5"\&. Note that
654 "from"
655 must be greater than or equal to
656 "to"\&. When unset, the kernel\*(Aqs default will be used\&.
657 .sp
658 Added in version 248\&.
659 .RE
660 .SH "[MACVLAN] SECTION OPTIONS"
661 .PP
662 The [MACVLAN] section only applies for netdevs of kind
663 "macvlan", and accepts the following key:
664 .PP
665 \fIMode=\fR
666 .RS 4
667 The MACVLAN mode to use\&. The supported options are
668 "private",
669 "vepa",
670 "bridge",
671 "passthru", and
672 "source"\&.
673 .sp
674 Added in version 211\&.
675 .RE
676 .PP
677 \fISourceMACAddress=\fR
678 .RS 4
679 A whitespace\-separated list of remote hardware addresses allowed on the MACVLAN\&. This option only has an effect in source mode\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal\&. This option may appear more than once, in which case the lists are merged\&. If the empty string is assigned to this option, the list of hardware addresses defined prior to this is reset\&. Defaults to unset\&.
680 .sp
681 Added in version 246\&.
682 .RE
683 .PP
684 \fIBroadcastMulticastQueueLength=\fR
685 .RS 4
686 Specifies the length of the receive queue for broadcast/multicast packets\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset\&.
687 .sp
688 Added in version 248\&.
689 .RE
690 .PP
691 \fIBroadcastQueueThreshold=\fR
692 .RS 4
693 Controls the threshold for broadcast queueing of the macvlan device\&. Takes the special value
694 "no", or an integer in the range 0\&...2147483647\&. When
695 "no"
696 is specified, the broadcast queueing is disabled altogether\&. When an integer is specified, a multicast address will be queued as broadcast if the number of devices using the macvlan is greater than the given value\&. Defaults to unset, and the kernel default will be used\&.
697 .sp
698 Added in version 256\&.
699 .RE
700 .SH "[MACVTAP] SECTION OPTIONS"
701 .PP
702 The [MACVTAP] section applies for netdevs of kind
703 "macvtap"
704 and accepts the same keys as [MACVLAN]\&.
705 .SH "[IPVLAN] SECTION OPTIONS"
706 .PP
707 The [IPVLAN] section only applies for netdevs of kind
708 "ipvlan", and accepts the following key:
709 .PP
710 \fIMode=\fR
711 .RS 4
712 The IPVLAN mode to use\&. The supported options are
713 "L2","L3"
714 and
715 "L3S"\&.
716 .sp
717 Added in version 219\&.
718 .RE
719 .PP
720 \fIFlags=\fR
721 .RS 4
722 The IPVLAN flags to use\&. The supported options are
723 "bridge","private"
724 and
725 "vepa"\&.
726 .sp
727 Added in version 237\&.
728 .RE
729 .SH "[IPVTAP] SECTION OPTIONS"
730 .PP
731 The [IPVTAP] section only applies for netdevs of kind
732 "ipvtap"
733 and accepts the same keys as [IPVLAN]\&.
734 .SH "[VXLAN] SECTION OPTIONS"
735 .PP
736 The [VXLAN] section only applies for netdevs of kind
737 "vxlan", and accepts the following keys:
738 .PP
739 \fIVNI=\fR
740 .RS 4
741 The VXLAN Network Identifier (or VXLAN Segment ID)\&. Takes a number in the range 1\&...16777215\&.
742 .sp
743 Added in version 243\&.
744 .RE
745 .PP
746 \fIRemote=\fR
747 .RS 4
748 Configures destination IP address\&.
749 .sp
750 Added in version 233\&.
751 .RE
752 .PP
753 \fILocal=\fR
754 .RS 4
755 Configures local IP address\&. It must be an address on the underlying interface of the VXLAN interface, or one of the special values
756 "ipv4_link_local",
757 "ipv6_link_local",
758 "dhcp4",
759 "dhcp6", and
760 "slaac"\&. If one of the special values is specified, an address which matches the corresponding type on the underlying interface will be used\&. Defaults to unset\&.
761 .sp
762 Added in version 233\&.
763 .RE
764 .PP
765 \fIGroup=\fR
766 .RS 4
767 Configures VXLAN multicast group IP address\&. All members of a VXLAN must use the same multicast group address\&.
768 .sp
769 Added in version 243\&.
770 .RE
771 .PP
772 \fITOS=\fR
773 .RS 4
774 The Type Of Service byte value for a vxlan interface\&.
775 .sp
776 Added in version 215\&.
777 .RE
778 .PP
779 \fITTL=\fR
780 .RS 4
781 A fixed Time To Live N on Virtual eXtensible Local Area Network packets\&. Takes
782 "inherit"
783 or a number in the range 0\&...255\&. 0 is a special value meaning inherit the inner protocol\*(Aqs TTL value\&.
784 "inherit"
785 means that it will inherit the outer protocol\*(Aqs TTL value\&.
786 .sp
787 Added in version 215\&.
788 .RE
789 .PP
790 \fIMacLearning=\fR
791 .RS 4
792 Takes a boolean\&. When true, enables dynamic MAC learning to discover remote MAC addresses\&.
793 .sp
794 Added in version 215\&.
795 .RE
796 .PP
797 \fIFDBAgeingSec=\fR
798 .RS 4
799 The lifetime of Forwarding Database entry learnt by the kernel, in seconds\&.
800 .sp
801 Added in version 218\&.
802 .RE
803 .PP
804 \fIMaximumFDBEntries=\fR
805 .RS 4
806 Configures maximum number of FDB entries\&.
807 .sp
808 Added in version 228\&.
809 .RE
810 .PP
811 \fIReduceARPProxy=\fR
812 .RS 4
813 Takes a boolean\&. When true, bridge\-connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote
814 \m[blue]\fBDistributed Overlay Virtual Ethernet (DOVE)\fR\m[]\&\s-2\u[7]\d\s+2
815 clients\&. Defaults to false\&.
816 .sp
817 Added in version 233\&.
818 .RE
819 .PP
820 \fIL2MissNotification=\fR
821 .RS 4
822 Takes a boolean\&. When true, enables netlink LLADDR miss notifications\&.
823 .sp
824 Added in version 218\&.
825 .RE
826 .PP
827 \fIL3MissNotification=\fR
828 .RS 4
829 Takes a boolean\&. When true, enables netlink IP address miss notifications\&.
830 .sp
831 Added in version 218\&.
832 .RE
833 .PP
834 \fIRouteShortCircuit=\fR
835 .RS 4
836 Takes a boolean\&. When true, route short circuiting is turned on\&.
837 .sp
838 Added in version 218\&.
839 .RE
840 .PP
841 \fIUDPChecksum=\fR
842 .RS 4
843 Takes a boolean\&. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on\&.
844 .sp
845 Added in version 220\&.
846 .RE
847 .PP
848 \fIUDP6ZeroChecksumTx=\fR
849 .RS 4
850 Takes a boolean\&. When true, sending zero checksums in VXLAN/IPv6 is turned on\&.
851 .sp
852 Added in version 220\&.
853 .RE
854 .PP
855 \fIUDP6ZeroChecksumRx=\fR
856 .RS 4
857 Takes a boolean\&. When true, receiving zero checksums in VXLAN/IPv6 is turned on\&.
858 .sp
859 Added in version 220\&.
860 .RE
861 .PP
862 \fIRemoteChecksumTx=\fR
863 .RS 4
864 Takes a boolean\&. When true, remote transmit checksum offload of VXLAN is turned on\&.
865 .sp
866 Added in version 232\&.
867 .RE
868 .PP
869 \fIRemoteChecksumRx=\fR
870 .RS 4
871 Takes a boolean\&. When true, remote receive checksum offload in VXLAN is turned on\&.
872 .sp
873 Added in version 232\&.
874 .RE
875 .PP
876 \fIGroupPolicyExtension=\fR
877 .RS 4
878 Takes a boolean\&. When true, it enables Group Policy VXLAN extension security label mechanism across network peers based on VXLAN\&. For details about the Group Policy VXLAN, see the
879 \m[blue]\fBVXLAN Group Policy\fR\m[]\&\s-2\u[8]\d\s+2
880 document\&. Defaults to false\&.
881 .sp
882 Added in version 224\&.
883 .RE
884 .PP
885 \fIGenericProtocolExtension=\fR
886 .RS 4
887 Takes a boolean\&. When true, Generic Protocol Extension extends the existing VXLAN protocol to provide protocol typing, OAM, and versioning capabilities\&. For details about the VXLAN GPE Header, see the
888 \m[blue]\fBGeneric Protocol Extension for VXLAN\fR\m[]\&\s-2\u[9]\d\s+2
889 document\&. If destination port is not specified and Generic Protocol Extension is set, the default port of 4790 is used\&. Defaults to false\&.
890 .sp
891 Added in version 243\&.
892 .RE
893 .PP
894 \fIDestinationPort=\fR
895 .RS 4
896 Configures the default destination UDP port\&. If the destination port is not specified, the Linux kernel default will be used\&. Set to 4789 to get the IANA assigned value\&.
897 .sp
898 Added in version 229\&.
899 .RE
900 .PP
901 \fIPortRange=\fR
902 .RS 4
903 Configures the source port range for the VXLAN\&. The kernel assigns the source UDP port based on the flow to help the receiver to do load balancing\&. When this option is not set, the normal range of local UDP ports is used\&.
904 .sp
905 Added in version 229\&.
906 .RE
907 .PP
908 \fIFlowLabel=\fR
909 .RS 4
910 Specifies the flow label to use in outgoing packets\&. The valid range is 0\-1048575\&.
911 .sp
912 Added in version 234\&.
913 .RE
914 .PP
915 \fIIPDoNotFragment=\fR
916 .RS 4
917 Allows setting the IPv4 Do not Fragment (DF) bit in outgoing packets, or to inherit its value from the IPv4 inner header\&. Takes a boolean value, or
918 "inherit"\&. Set to
919 "inherit"
920 if the encapsulated protocol is IPv6\&. When unset, the kernel\*(Aqs default will be used\&.
921 .sp
922 Added in version 243\&.
923 .RE
924 .PP
925 \fIIndependent=\fR
926 .RS 4
927 Takes a boolean\&. When true, the vxlan interface is created without any underlying network interface\&. Defaults to false, which means that a \&.network file that requests this VXLAN interface using
928 \fIVXLAN=\fR
929 is required for the VXLAN to be created\&.
930 .sp
931 Added in version 247\&.
932 .RE
933 .SH "[GENEVE] SECTION OPTIONS"
934 .PP
935 The [GENEVE] section only applies for netdevs of kind
936 "geneve", and accepts the following keys:
937 .PP
938 \fIId=\fR
939 .RS 4
940 Specifies the Virtual Network Identifier (VNI) to use, a number between 0 and 16777215\&. This field is mandatory\&.
941 .sp
942 Added in version 234\&.
943 .RE
944 .PP
945 \fIRemote=\fR
946 .RS 4
947 Specifies the unicast destination IP address to use in outgoing packets\&.
948 .sp
949 Added in version 234\&.
950 .RE
951 .PP
952 \fITOS=\fR
953 .RS 4
954 Specifies the TOS value to use in outgoing packets\&. Takes a number between 1 and 255\&.
955 .sp
956 Added in version 234\&.
957 .RE
958 .PP
959 \fITTL=\fR
960 .RS 4
961 Accepts the same values as in the [VXLAN] section, except that when unset or set to 0, the kernel\*(Aqs default will be used, meaning that packet TTL will be set from
962 /proc/sys/net/ipv4/ip_default_ttl\&.
963 .sp
964 Added in version 234\&.
965 .RE
966 .PP
967 \fIUDPChecksum=\fR
968 .RS 4
969 Takes a boolean\&. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4\&.
970 .sp
971 Added in version 234\&.
972 .RE
973 .PP
974 \fIUDP6ZeroChecksumTx=\fR
975 .RS 4
976 Takes a boolean\&. When true, skip UDP checksum calculation for transmitted packets over IPv6\&.
977 .sp
978 Added in version 234\&.
979 .RE
980 .PP
981 \fIUDP6ZeroChecksumRx=\fR
982 .RS 4
983 Takes a boolean\&. When true, allows incoming UDP packets over IPv6 with zero checksum field\&.
984 .sp
985 Added in version 234\&.
986 .RE
987 .PP
988 \fIDestinationPort=\fR
989 .RS 4
990 Specifies destination port\&. Defaults to 6081\&. If not set or assigned the empty string, the default port of 6081 is used\&.
991 .sp
992 Added in version 234\&.
993 .RE
994 .PP
995 \fIFlowLabel=\fR
996 .RS 4
997 Specifies the flow label to use in outgoing packets\&.
998 .sp
999 Added in version 234\&.
1000 .RE
1001 .PP
1002 \fIIPDoNotFragment=\fR
1003 .RS 4
1004 Accepts the same key as in [VXLAN] section\&.
1005 .sp
1006 Added in version 243\&.
1007 .RE
1008 .PP
1009 \fIInheritInnerProtocol=\fR
1010 .RS 4
1011 Takes a boolean\&. When true, inner Layer 3 protocol is set as Protocol Type in the GENEVE header instead of Ethernet\&. Defaults to false\&.
1012 .sp
1013 Added in version 254\&.
1014 .RE
1015 .SH "[BAREUDP] SECTION OPTIONS"
1016 .PP
1017 The [BareUDP] section only applies for netdevs of kind
1018 "bareudp", and accepts the following keys:
1019 .PP
1020 \fIDestinationPort=\fR
1021 .RS 4
1022 Specifies the destination UDP port (in range 1\&...65535)\&. This is mandatory\&.
1023 .sp
1024 Added in version 247\&.
1025 .RE
1026 .PP
1027 \fIEtherType=\fR
1028 .RS 4
1029 Specifies the L3 protocol\&. Takes one of
1030 "ipv4",
1031 "ipv6",
1032 "mpls\-uc"
1033 or
1034 "mpls\-mc"\&. This is mandatory\&.
1035 .sp
1036 Added in version 247\&.
1037 .RE
1038 .PP
1039 \fIMinSourcePort=\fR
1040 .RS 4
1041 Specifies the lowest value of the UDP tunnel source port (in range 1\&...65535)\&. Defaults to unset\&.
1042 .sp
1043 Added in version 257\&.
1044 .RE
1045 .SH "[L2TP] SECTION OPTIONS"
1046 .PP
1047 The [L2TP] section only applies for netdevs of kind
1048 "l2tp", and accepts the following keys:
1049 .PP
1050 \fITunnelId=\fR
1051 .RS 4
1052 Specifies the tunnel identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the
1053 "PeerTunnelId="
1054 value being used at the peer\&. This setting is compulsory\&.
1055 .sp
1056 Added in version 242\&.
1057 .RE
1058 .PP
1059 \fIPeerTunnelId=\fR
1060 .RS 4
1061 Specifies the peer tunnel id\&. Takes a number in the range 1\&...4294967295\&. The value used must match the
1062 "TunnelId="
1063 value being used at the peer\&. This setting is compulsory\&.
1064 .sp
1065 Added in version 242\&.
1066 .RE
1067 .PP
1068 \fIRemote=\fR
1069 .RS 4
1070 Specifies the IP address of the remote peer\&. This setting is compulsory\&.
1071 .sp
1072 Added in version 242\&.
1073 .RE
1074 .PP
1075 \fILocal=\fR
1076 .RS 4
1077 Specifies the IP address of a local interface\&. Takes an IP address, or the special values
1078 "auto",
1079 "static", or
1080 "dynamic"\&. Optionally a name of a local interface can be specified after
1081 "@", e\&.g\&.
1082 "192\&.168\&.0\&.1@eth0"
1083 or
1084 "auto@eth0"\&. When an address is specified, then a local or specified interface must have the address, and the remote address must be accessible through the local address\&. If
1085 "auto", then one of the addresses on a local or specified interface which is accessible to the remote address will be used\&. Similarly, if
1086 "static"
1087 or
1088 "dynamic"
1089 is set, then one of the static or dynamic addresses will be used\&. Defaults to
1090 "auto"\&.
1091 .sp
1092 Added in version 242\&.
1093 .RE
1094 .PP
1095 \fIEncapsulationType=\fR
1096 .RS 4
1097 Specifies the encapsulation type of the tunnel\&. Takes one of
1098 "udp"
1099 or
1100 "ip"\&.
1101 .sp
1102 Added in version 242\&.
1103 .RE
1104 .PP
1105 \fIUDPSourcePort=\fR
1106 .RS 4
1107 Specifies the UDP source port to be used for the tunnel\&. When UDP encapsulation is selected it is mandatory\&. Ignored when IP encapsulation is selected\&.
1108 .sp
1109 Added in version 242\&.
1110 .RE
1111 .PP
1112 \fIUDPDestinationPort=\fR
1113 .RS 4
1114 Specifies destination port\&. When UDP encapsulation is selected it is mandatory\&. Ignored when IP encapsulation is selected\&.
1115 .sp
1116 Added in version 245\&.
1117 .RE
1118 .PP
1119 \fIUDPChecksum=\fR
1120 .RS 4
1121 Takes a boolean\&. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4\&.
1122 .sp
1123 Added in version 242\&.
1124 .RE
1125 .PP
1126 \fIUDP6ZeroChecksumTx=\fR
1127 .RS 4
1128 Takes a boolean\&. When true, skip UDP checksum calculation for transmitted packets over IPv6\&.
1129 .sp
1130 Added in version 242\&.
1131 .RE
1132 .PP
1133 \fIUDP6ZeroChecksumRx=\fR
1134 .RS 4
1135 Takes a boolean\&. When true, allows incoming UDP packets over IPv6 with zero checksum field\&.
1136 .sp
1137 Added in version 242\&.
1138 .RE
1139 .SH "[L2TPSESSION] SECTION OPTIONS"
1140 .PP
1141 The [L2TPSession] section only applies for netdevs of kind
1142 "l2tp", and accepts the following keys:
1143 .PP
1144 \fIName=\fR
1145 .RS 4
1146 Specifies the name of the session\&. This setting is compulsory\&.
1147 .sp
1148 Added in version 242\&.
1149 .RE
1150 .PP
1151 \fISessionId=\fR
1152 .RS 4
1153 Specifies the session identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the
1154 "SessionId="
1155 value being used at the peer\&. This setting is compulsory\&.
1156 .sp
1157 Added in version 242\&.
1158 .RE
1159 .PP
1160 \fIPeerSessionId=\fR
1161 .RS 4
1162 Specifies the peer session identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the
1163 "PeerSessionId="
1164 value being used at the peer\&. This setting is compulsory\&.
1165 .sp
1166 Added in version 242\&.
1167 .RE
1168 .PP
1169 \fILayer2SpecificHeader=\fR
1170 .RS 4
1171 Specifies layer2specific header type of the session\&. One of
1172 "none"
1173 or
1174 "default"\&. Defaults to
1175 "default"\&.
1176 .sp
1177 Added in version 242\&.
1178 .RE
1179 .SH "[MACSEC] SECTION OPTIONS"
1180 .PP
1181 The [MACsec] section only applies for network devices of kind
1182 "macsec", and accepts the following keys:
1183 .PP
1184 \fIPort=\fR
1185 .RS 4
1186 Specifies the port to be used for the MACsec transmit channel\&. The port is used to make secure channel identifier (SCI)\&. Takes a value between 1 and 65535\&. Defaults to unset\&.
1187 .sp
1188 Added in version 243\&.
1189 .RE
1190 .PP
1191 \fIEncrypt=\fR
1192 .RS 4
1193 Takes a boolean\&. When true, enable encryption\&. Defaults to unset\&.
1194 .sp
1195 Added in version 243\&.
1196 .RE
1197 .SH "[MACSECRECEIVECHANNEL] SECTION OPTIONS"
1198 .PP
1199 The [MACsecReceiveChannel] section only applies for network devices of kind
1200 "macsec", and accepts the following keys:
1201 .PP
1202 \fIPort=\fR
1203 .RS 4
1204 Specifies the port to be used for the MACsec receive channel\&. The port is used to make secure channel identifier (SCI)\&. Takes a value between 1 and 65535\&. This option is compulsory, and is not set by default\&.
1205 .sp
1206 Added in version 243\&.
1207 .RE
1208 .PP
1209 \fIMACAddress=\fR
1210 .RS 4
1211 Specifies the MAC address to be used for the MACsec receive channel\&. The MAC address used to make secure channel identifier (SCI)\&. This setting is compulsory, and is not set by default\&.
1212 .sp
1213 Added in version 243\&.
1214 .RE
1215 .SH "[MACSECTRANSMITASSOCIATION] SECTION OPTIONS"
1216 .PP
1217 The [MACsecTransmitAssociation] section only applies for network devices of kind
1218 "macsec", and accepts the following keys:
1219 .PP
1220 \fIPacketNumber=\fR
1221 .RS 4
1222 Specifies the packet number to be used for replay protection and the construction of the initialization vector (along with the secure channel identifier [SCI])\&. Takes a value between 1\-4,294,967,295\&. Defaults to unset\&.
1223 .sp
1224 Added in version 243\&.
1225 .RE
1226 .PP
1227 \fIKeyId=\fR
1228 .RS 4
1229 Specifies the identification for the key\&. Takes a number between 0\-255\&. This option is compulsory, and is not set by default\&.
1230 .sp
1231 Added in version 243\&.
1232 .RE
1233 .PP
1234 \fIKey=\fR
1235 .RS 4
1236 Specifies the encryption key used in the transmission channel\&. The same key must be configured on the peer\(cqs matching receive channel\&. This setting is compulsory, and is not set by default\&. Takes a 128\-bit key encoded in a hexadecimal string, for example
1237 "dffafc8d7b9a43d5b9a3dfbbf6a30c16"\&.
1238 .sp
1239 Added in version 243\&.
1240 .RE
1241 .PP
1242 \fIKeyFile=\fR
1243 .RS 4
1244 Takes an absolute path to a file which contains a 128\-bit key encoded in a hexadecimal string, which will be used in the transmission channel\&. When this option is specified,
1245 \fIKey=\fR
1246 is ignored\&. Note that the file must be readable by the user
1247 "systemd\-network", so it should be, e\&.g\&., owned by
1248 "root:systemd\-network"
1249 with a
1250 "0640"
1251 file mode\&. If the path refers to an
1252 \fBAF_UNIX\fR
1253 stream socket in the file system a connection is made to it and the key read from it\&.
1254 .sp
1255 Added in version 243\&.
1256 .RE
1257 .PP
1258 \fIActivate=\fR
1259 .RS 4
1260 Takes a boolean\&. If enabled, then the security association is activated\&. Defaults to unset\&.
1261 .sp
1262 Added in version 243\&.
1263 .RE
1264 .PP
1265 \fIUseForEncoding=\fR
1266 .RS 4
1267 Takes a boolean\&. If enabled, then the security association is used for encoding\&. Only one [MACsecTransmitAssociation] section can enable this option\&. When enabled,
1268 \fIActivate=yes\fR
1269 is implied\&. Defaults to unset\&.
1270 .sp
1271 Added in version 243\&.
1272 .RE
1273 .SH "[MACSECRECEIVEASSOCIATION] SECTION OPTIONS"
1274 .PP
1275 The [MACsecReceiveAssociation] section only applies for network devices of kind
1276 "macsec", and accepts the following keys:
1277 .PP
1278 \fIPort=\fR
1279 .RS 4
1280 Accepts the same key as in [MACsecReceiveChannel] section\&.
1281 .sp
1282 Added in version 243\&.
1283 .RE
1284 .PP
1285 \fIMACAddress=\fR
1286 .RS 4
1287 Accepts the same key as in [MACsecReceiveChannel] section\&.
1288 .sp
1289 Added in version 243\&.
1290 .RE
1291 .PP
1292 \fIPacketNumber=\fR
1293 .RS 4
1294 Accepts the same key as in [MACsecTransmitAssociation] section\&.
1295 .sp
1296 Added in version 243\&.
1297 .RE
1298 .PP
1299 \fIKeyId=\fR
1300 .RS 4
1301 Accepts the same key as in [MACsecTransmitAssociation] section\&.
1302 .sp
1303 Added in version 243\&.
1304 .RE
1305 .PP
1306 \fIKey=\fR
1307 .RS 4
1308 Accepts the same key as in [MACsecTransmitAssociation] section\&.
1309 .sp
1310 Added in version 243\&.
1311 .RE
1312 .PP
1313 \fIKeyFile=\fR
1314 .RS 4
1315 Accepts the same key as in [MACsecTransmitAssociation] section\&.
1316 .sp
1317 Added in version 243\&.
1318 .RE
1319 .PP
1320 \fIActivate=\fR
1321 .RS 4
1322 Accepts the same key as in [MACsecTransmitAssociation] section\&.
1323 .sp
1324 Added in version 243\&.
1325 .RE
1326 .SH "[TUNNEL] SECTION OPTIONS"
1327 .PP
1328 The [Tunnel] section only applies for netdevs of kind
1329 "ipip",
1330 "sit",
1331 "gre",
1332 "gretap",
1333 "ip6gre",
1334 "ip6gretap",
1335 "vti",
1336 "vti6",
1337 "ip6tnl", and
1338 "erspan"
1339 and accepts the following keys:
1340 .PP
1341 \fIExternal=\fR
1342 .RS 4
1343 Takes a boolean value\&. When true, then the tunnel is externally controlled, which is also known as collect metadata mode, and most settings below like
1344 \fILocal=\fR
1345 or
1346 \fIRemote=\fR
1347 are ignored\&. This implies
1348 \fIIndependent=\fR\&. Defaults to false\&.
1349 .sp
1350 Added in version 251\&.
1351 .RE
1352 .PP
1353 \fILocal=\fR
1354 .RS 4
1355 A static local address for tunneled packets\&. It must be an address on another interface of this host, or one of the special values
1356 "any",
1357 "ipv4_link_local",
1358 "ipv6_link_local",
1359 "dhcp4",
1360 "dhcp6", and
1361 "slaac"\&. If one of the special values except for
1362 "any"
1363 is specified, an address which matches the corresponding type on the underlying interface will be used\&. Defaults to
1364 "any"\&.
1365 .sp
1366 Added in version 215\&.
1367 .RE
1368 .PP
1369 \fIRemote=\fR
1370 .RS 4
1371 The remote endpoint of the tunnel\&. Takes an IP address or the special value
1372 "any"\&.
1373 .sp
1374 Added in version 215\&.
1375 .RE
1376 .PP
1377 \fITOS=\fR
1378 .RS 4
1379 The Type Of Service byte value for a tunnel interface\&. For details about the TOS, see the
1380 \m[blue]\fBType of Service in the Internet Protocol Suite\fR\m[]\&\s-2\u[10]\d\s+2
1381 document\&.
1382 .sp
1383 Added in version 215\&.
1384 .RE
1385 .PP
1386 \fITTL=\fR
1387 .RS 4
1388 A fixed Time To Live N on tunneled packets\&. N is a number in the range 1\&...255\&. 0 is a special value meaning that packets inherit the TTL value\&. The default value for IPv4 tunnels is 0 (inherit)\&. The default value for IPv6 tunnels is 64\&.
1389 .sp
1390 Added in version 215\&.
1391 .RE
1392 .PP
1393 \fIDiscoverPathMTU=\fR
1394 .RS 4
1395 Takes a boolean\&. When true, enables Path MTU Discovery on the tunnel\&. When
1396 \fIIgnoreDontFragment=\fR
1397 is enabled, defaults to false\&. Otherwise, defaults to true\&.
1398 .sp
1399 Added in version 215\&.
1400 .RE
1401 .PP
1402 \fIIgnoreDontFragment=\fR
1403 .RS 4
1404 Takes a boolean\&. When true, enables IPv4 Don\*(Aqt Fragment (DF) suppression on the tunnel\&. Defaults to false\&. Note that if
1405 \fIIgnoreDontFragment=\fR
1406 is set to true,
1407 \fIDiscoverPathMTU=\fR
1408 cannot be set to true\&. Only applicable to GRE, GRETAP, and ERSPAN tunnels\&.
1409 .sp
1410 Added in version 254\&.
1411 .RE
1412 .PP
1413 \fIIPv6FlowLabel=\fR
1414 .RS 4
1415 Configures the 20\-bit flow label (see
1416 \m[blue]\fBRFC 6437\fR\m[]\&\s-2\u[11]\d\s+2) field in the IPv6 header (see
1417 \m[blue]\fBRFC 2460\fR\m[]\&\s-2\u[12]\d\s+2), which is used by a node to label packets of a flow\&. It is only used for IPv6 tunnels\&. A flow label of zero is used to indicate packets that have not been labeled\&. It can be configured to a value in the range 0\&...0xFFFFF, or be set to
1418 "inherit", in which case the original flowlabel is used\&.
1419 .sp
1420 Added in version 223\&.
1421 .RE
1422 .PP
1423 \fICopyDSCP=\fR
1424 .RS 4
1425 Takes a boolean\&. When true, the Differentiated Service Code Point (DSCP) field will be copied to the inner header from outer header during the decapsulation of an IPv6 tunnel packet\&. DSCP is a field in an IP packet that enables different levels of service to be assigned to network traffic\&. Defaults to
1426 "no"\&.
1427 .sp
1428 Added in version 223\&.
1429 .RE
1430 .PP
1431 \fIEncapsulationLimit=\fR
1432 .RS 4
1433 The Tunnel Encapsulation Limit option specifies how many additional levels of encapsulation are permitted to be prepended to the packet\&. For example, a Tunnel Encapsulation Limit option containing a limit value of zero means that a packet carrying that option may not enter another tunnel before exiting the current tunnel\&. (see
1434 \m[blue]\fBRFC 2473\fR\m[]\&\s-2\u[13]\d\s+2)\&. The valid range is 0\&...255 and
1435 "none"\&. Defaults to 4\&.
1436 .sp
1437 Added in version 226\&.
1438 .RE
1439 .PP
1440 \fIKey=\fR
1441 .RS 4
1442 The
1443 \fIKey=\fR
1444 parameter specifies the same key to use in both directions (\fIInputKey=\fR
1445 and
1446 \fIOutputKey=\fR)\&. The
1447 \fIKey=\fR
1448 is either a number or an IPv4 address\-like dotted quad\&. It is used as mark\-configured SAD/SPD entry as part of the lookup key (both in data and control path) in IP XFRM (framework used to implement IPsec protocol)\&. See
1449 \m[blue]\fBip\-xfrm \(em transform configuration\fR\m[]\&\s-2\u[14]\d\s+2
1450 for details\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&.
1451 .sp
1452 Added in version 231\&.
1453 .RE
1454 .PP
1455 \fIInputKey=\fR
1456 .RS 4
1457 The
1458 \fIInputKey=\fR
1459 parameter specifies the key to use for input\&. The format is same as
1460 \fIKey=\fR\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&.
1461 .sp
1462 Added in version 231\&.
1463 .RE
1464 .PP
1465 \fIOutputKey=\fR
1466 .RS 4
1467 The
1468 \fIOutputKey=\fR
1469 parameter specifies the key to use for output\&. The format is same as
1470 \fIKey=\fR\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&.
1471 .sp
1472 Added in version 231\&.
1473 .RE
1474 .PP
1475 \fIMode=\fR
1476 .RS 4
1477 An
1478 "ip6tnl"
1479 tunnel can be in one of three modes
1480 "ip6ip6"
1481 for IPv6 over IPv6,
1482 "ipip6"
1483 for IPv4 over IPv6 or
1484 "any"
1485 for either\&.
1486 .sp
1487 Added in version 219\&.
1488 .RE
1489 .PP
1490 \fIIndependent=\fR
1491 .RS 4
1492 Takes a boolean\&. When false (the default), the tunnel is always created over some network device, and a \&.network file that requests this tunnel using
1493 \fITunnel=\fR
1494 is required for the tunnel to be created\&. When true, the tunnel is created independently of any network as "tunnel@NONE"\&.
1495 .sp
1496 Added in version 235\&.
1497 .RE
1498 .PP
1499 \fIAssignToLoopback=\fR
1500 .RS 4
1501 Takes a boolean\&. If set to
1502 "yes", the loopback interface
1503 "lo"
1504 is used as the underlying device of the tunnel interface\&. Defaults to
1505 "no"\&.
1506 .sp
1507 Added in version 243\&.
1508 .RE
1509 .PP
1510 \fIAllowLocalRemote=\fR
1511 .RS 4
1512 Takes a boolean\&. When true allows tunnel traffic on
1513 \fIip6tnl\fR
1514 devices where the remote endpoint is a local host address\&. When unset, the kernel\*(Aqs default will be used\&.
1515 .sp
1516 Added in version 237\&.
1517 .RE
1518 .PP
1519 \fIFooOverUDP=\fR
1520 .RS 4
1521 Takes a boolean\&. Specifies whether
1522 \fIFooOverUDP=\fR
1523 tunnel is to be configured\&. Defaults to false\&. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels\&. For more detail information see
1524 \m[blue]\fBFoo over UDP\fR\m[]\&\s-2\u[15]\d\s+2
1525 .sp
1526 Added in version 240\&.
1527 .RE
1528 .PP
1529 \fIFOUDestinationPort=\fR
1530 .RS 4
1531 This setting specifies the UDP destination port for encapsulation\&. This field is mandatory when
1532 \fIFooOverUDP=yes\fR, and is not set by default\&.
1533 .sp
1534 Added in version 240\&.
1535 .RE
1536 .PP
1537 \fIFOUSourcePort=\fR
1538 .RS 4
1539 This setting specifies the UDP source port for encapsulation\&. Defaults to
1540 \fB0\fR
1541 \(em that is, the source port for packets is left to the network stack to decide\&.
1542 .sp
1543 Added in version 240\&.
1544 .RE
1545 .PP
1546 \fIEncapsulation=\fR
1547 .RS 4
1548 Accepts the same key as in the [FooOverUDP] section\&.
1549 .sp
1550 Added in version 240\&.
1551 .RE
1552 .PP
1553 \fIIPv6RapidDeploymentPrefix=\fR
1554 .RS 4
1555 Reconfigure the tunnel for
1556 \m[blue]\fBIPv6 Rapid Deployment\fR\m[]\&\s-2\u[16]\d\s+2, also known as 6rd\&. The value is an ISP\-specific IPv6 prefix with a non\-zero length\&. Only applicable to SIT tunnels\&.
1557 .sp
1558 Added in version 240\&.
1559 .RE
1560 .PP
1561 \fIISATAP=\fR
1562 .RS 4
1563 Takes a boolean\&. If set, configures the tunnel as Intra\-Site Automatic Tunnel Addressing Protocol (ISATAP) tunnel\&. Only applicable to SIT tunnels\&. When unset, the kernel\*(Aqs default will be used\&.
1564 .sp
1565 Added in version 240\&.
1566 .RE
1567 .PP
1568 \fISerializeTunneledPackets=\fR
1569 .RS 4
1570 Takes a boolean\&. If set to yes, then packets are serialized\&. Only applies for GRE, GRETAP, and ERSPAN tunnels\&. When unset, the kernel\*(Aqs default will be used\&.
1571 .sp
1572 Added in version 240\&.
1573 .RE
1574 .PP
1575 \fIERSPANVersion=\fR
1576 .RS 4
1577 Specifies the ERSPAN version number\&. Takes 0 for version 0 (a\&.k\&.a\&. type I), 1 for version 1 (a\&.k\&.a\&. type II), or 2 for version 2 (a\&.k\&.a\&. type III)\&. Defaults to 1\&.
1578 .sp
1579 Added in version 252\&.
1580 .RE
1581 .PP
1582 \fIERSPANIndex=\fR
1583 .RS 4
1584 Specifies the ERSPAN v1 index field for the interface\&. Takes an integer in the range 0\&...1048575, which is associated with the ERSPAN traffic\*(Aqs source port and direction\&. Only used when
1585 \fIERSPANVersion=1\fR\&. Defaults to 0\&.
1586 .sp
1587 Added in version 240\&.
1588 .RE
1589 .PP
1590 \fIERSPANDirection=\fR
1591 .RS 4
1592 Specifies the ERSPAN v2 mirrored traffic\*(Aqs direction\&. Takes
1593 "ingress"
1594 or
1595 "egress"\&. Only used when
1596 \fIERSPANVersion=2\fR\&. Defaults to
1597 "ingress"\&.
1598 .sp
1599 Added in version 252\&.
1600 .RE
1601 .PP
1602 \fIERSPANHardwareId=\fR
1603 .RS 4
1604 Specifies an unique identifier of the ERSPAN v2 engine\&. Takes an integer in the range 0\&...63\&. Only used when
1605 \fIERSPANVersion=2\fR\&. Defaults to 0\&.
1606 .sp
1607 Added in version 252\&.
1608 .RE
1609 .SH "[FOOOVERUDP] SECTION OPTIONS"
1610 .PP
1611 The [FooOverUDP] section only applies for netdevs of kind
1612 "fou"
1613 and accepts the following keys:
1614 .PP
1615 \fIEncapsulation=\fR
1616 .RS 4
1617 Specifies the encapsulation mechanism used to store networking packets of various protocols inside the UDP packets\&. Supports the following values:
1618 "FooOverUDP"
1619 provides the simplest no\-frills model of UDP encapsulation, it simply encapsulates packets directly in the UDP payload\&.
1620 "GenericUDPEncapsulation"
1621 is a generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and optional data as part of the encapsulation\&. For more detailed information see
1622 \m[blue]\fBGeneric UDP Encapsulation\fR\m[]\&\s-2\u[17]\d\s+2\&. Defaults to
1623 "FooOverUDP"\&.
1624 .sp
1625 Added in version 240\&.
1626 .RE
1627 .PP
1628 \fIPort=\fR
1629 .RS 4
1630 Specifies the port number where the encapsulated packets will arrive\&. Those packets will be removed and manually fed back into the network stack with the encapsulation removed to be sent to the real destination\&. This option is mandatory\&.
1631 .sp
1632 Added in version 240\&.
1633 .RE
1634 .PP
1635 \fIPeerPort=\fR
1636 .RS 4
1637 Specifies the peer port number\&. Defaults to unset\&. Note that when peer port is set
1638 "Peer="
1639 address is mandatory\&.
1640 .sp
1641 Added in version 243\&.
1642 .RE
1643 .PP
1644 \fIProtocol=\fR
1645 .RS 4
1646 The
1647 \fIProtocol=\fR
1648 specifies the protocol number of the packets arriving at the UDP port\&. When
1649 \fIEncapsulation=FooOverUDP\fR, this field is mandatory and is not set by default\&. Takes an IP protocol name such as
1650 "gre"
1651 or
1652 "ipip", or an integer within the range 1\&...255\&. When
1653 \fIEncapsulation=GenericUDPEncapsulation\fR, this must not be specified\&.
1654 .sp
1655 Added in version 240\&.
1656 .RE
1657 .PP
1658 \fIPeer=\fR
1659 .RS 4
1660 Configures peer IP address\&. Note that when peer address is set
1661 "PeerPort="
1662 is mandatory\&.
1663 .sp
1664 Added in version 243\&.
1665 .RE
1666 .PP
1667 \fILocal=\fR
1668 .RS 4
1669 Configures local IP address\&.
1670 .sp
1671 Added in version 243\&.
1672 .RE
1673 .SH "[PEER] SECTION OPTIONS"
1674 .PP
1675 The [Peer] section only applies for netdevs of kind
1676 "veth"
1677 and accepts the following keys:
1678 .PP
1679 \fIName=\fR
1680 .RS 4
1681 The interface name used when creating the netdev\&. This setting is compulsory\&.
1682 .sp
1683 Added in version 215\&.
1684 .RE
1685 .PP
1686 \fIMACAddress=\fR
1687 .RS 4
1688 The peer MACAddress, if not set, it is generated in the same way as the MAC address of the main interface\&.
1689 .sp
1690 Added in version 215\&.
1691 .RE
1692 .SH "[VXCAN] SECTION OPTIONS"
1693 .PP
1694 The [VXCAN] section only applies for netdevs of kind
1695 "vxcan"
1696 and accepts the following key:
1697 .PP
1698 \fIPeer=\fR
1699 .RS 4
1700 The peer interface name used when creating the netdev\&. This setting is compulsory\&.
1701 .sp
1702 Added in version 236\&.
1703 .RE
1704 .SH "[TUN] SECTION OPTIONS"
1705 .PP
1706 The [Tun] section only applies for netdevs of kind
1707 "tun", and accepts the following keys:
1708 .PP
1709 \fIMultiQueue=\fR
1710 .RS 4
1711 Takes a boolean\&. Configures whether to use multiple file descriptors (queues) to parallelize packets sending and receiving\&. Defaults to
1712 "no"\&.
1713 .sp
1714 Added in version 215\&.
1715 .RE
1716 .PP
1717 \fIPacketInfo=\fR
1718 .RS 4
1719 Takes a boolean\&. Configures whether packets should be prepended with four extra bytes (two flag bytes and two protocol bytes)\&. If disabled, it indicates that the packets will be pure IP packets\&. Defaults to
1720 "no"\&.
1721 .sp
1722 Added in version 215\&.
1723 .RE
1724 .PP
1725 \fIVNetHeader=\fR
1726 .RS 4
1727 Takes a boolean\&. Configures IFF_VNET_HDR flag for a tun or tap device\&. It allows sending and receiving larger Generic Segmentation Offload (GSO) packets\&. This may increase throughput significantly\&. Defaults to
1728 "no"\&.
1729 .sp
1730 Added in version 223\&.
1731 .RE
1732 .PP
1733 \fIUser=\fR
1734 .RS 4
1735 User to grant access to the
1736 /dev/net/tun
1737 device\&.
1738 .sp
1739 Added in version 215\&.
1740 .RE
1741 .PP
1742 \fIGroup=\fR
1743 .RS 4
1744 Group to grant access to the
1745 /dev/net/tun
1746 device\&.
1747 .sp
1748 Added in version 215\&.
1749 .RE
1750 .PP
1751 \fIKeepCarrier=\fR
1752 .RS 4
1753 Takes a boolean\&. If enabled, to make the interface maintain its carrier status, the file descriptor of the interface is kept open\&. This may be useful to keep the interface in running state, for example while the backing process is temporarily shutdown\&. Defaults to
1754 "no"\&.
1755 .sp
1756 Added in version 252\&.
1757 .RE
1758 .SH "[TAP] SECTION OPTIONS"
1759 .PP
1760 The [Tap] section only applies for netdevs of kind
1761 "tap", and accepts the same keys as the [Tun] section\&.
1762 .SH "[WIREGUARD] SECTION OPTIONS"
1763 .PP
1764 The [WireGuard] section accepts the following keys:
1765 .PP
1766 \fIPrivateKey=\fR
1767 .RS 4
1768 The Base64 encoded private key for the interface\&. It can be generated using the
1769 \fBwg genkey\fR
1770 command (see
1771 \fBwg\fR(8))\&. Specially, if the specified key is prefixed with
1772 "@", it is interpreted as the name of the credential from which the actual key shall be read\&.
1773 \fBsystemd-networkd.service\fR(8)
1774 automatically imports credentials matching
1775 "network\&.wireguard\&.*"\&. For more details on credentials, refer to
1776 \fBsystemd.exec\fR(5)\&. A private key is mandatory to use WireGuard\&. If not set, the credential
1777 "network\&.wireguard\&.private\&.\fInetdev\fR"
1778 is used if exists\&. I\&.e\&. for
1779 50\-foobar\&.netdev,
1780 "network\&.wireguard\&.private\&.50\-foobar"
1781 is tried\&.
1782 .sp
1783 Note that because this information is secret, it is strongly recommended to use an (encrypted) credential\&. Alternatively, you may want to set the permissions of the \&.netdev file to be owned by
1784 "root:systemd\-network"
1785 with a
1786 "0640"
1787 file mode\&.
1788 .sp
1789 Added in version 237\&.
1790 .RE
1791 .PP
1792 \fIPrivateKeyFile=\fR
1793 .RS 4
1794 Takes an absolute path to a file which contains the Base64 encoded private key for the interface\&. When this option is specified, then
1795 \fIPrivateKey=\fR
1796 is ignored\&. Note that the file must be readable by the user
1797 "systemd\-network", so it should be, e\&.g\&., owned by
1798 "root:systemd\-network"
1799 with a
1800 "0640"
1801 file mode\&. If the path refers to an
1802 \fBAF_UNIX\fR
1803 stream socket in the file system a connection is made to it and the key read from it\&.
1804 .sp
1805 Added in version 242\&.
1806 .RE
1807 .PP
1808 \fIListenPort=\fR
1809 .RS 4
1810 Sets UDP port for listening\&. Takes either value between 1 and 65535 or
1811 "auto"\&. If
1812 "auto"
1813 is specified, the port is automatically generated based on interface name\&. Defaults to
1814 "auto"\&.
1815 .sp
1816 Added in version 237\&.
1817 .RE
1818 .PP
1819 \fIFirewallMark=\fR
1820 .RS 4
1821 Sets a firewall mark on outgoing WireGuard packets from this interface\&. Takes a number between 1 and 4294967295\&.
1822 .sp
1823 Added in version 243\&.
1824 .RE
1825 .PP
1826 \fIRouteTable=\fR
1827 .RS 4
1828 The table identifier for the routes to the addresses specified in the
1829 \fIAllowedIPs=\fR\&. Takes a negative boolean value, one of the predefined names
1830 "default",
1831 "main", and
1832 "local", names defined in
1833 \fIRouteTable=\fR
1834 in
1835 \fBnetworkd.conf\fR(5), or a number in the range 1\&...4294967295\&. When
1836 "off"
1837 the routes to the addresses specified in the
1838 \fIAllowedIPs=\fR
1839 setting will not be configured\&. Defaults to false\&. This setting will be ignored when the same setting is specified in the [WireGuardPeer] section\&.
1840 .sp
1841 Added in version 250\&.
1842 .RE
1843 .PP
1844 \fIRouteMetric=\fR
1845 .RS 4
1846 The priority of the routes to the addresses specified in the
1847 \fIAllowedIPs=\fR\&. Takes an integer in the range 0\&...4294967295\&. Defaults to 0 for IPv4 addresses, and 1024 for IPv6 addresses\&. This setting will be ignored when the same setting is specified in the [WireGuardPeer] section\&.
1848 .sp
1849 Added in version 250\&.
1850 .RE
1851 .SH "[WIREGUARDPEER] SECTION OPTIONS"
1852 .PP
1853 The [WireGuardPeer] section accepts the following keys:
1854 .PP
1855 \fIPublicKey=\fR
1856 .RS 4
1857 Sets a Base64 encoded public key calculated by
1858 \fBwg pubkey\fR
1859 (see
1860 \fBwg\fR(8)) from a private key, and usually transmitted out of band to the author of the configuration file\&. This option honors the
1861 "@"
1862 prefix in the same way as the
1863 \fBPrivateKey=\fR
1864 setting of the
1865 \fB[WireGuard]\fR
1866 section\&. This option is mandatory for this section\&.
1867 .sp
1868 Added in version 237\&.
1869 .RE
1870 .PP
1871 \fIPublicKeyFile=\fR
1872 .RS 4
1873 Takes an absolute path to a file which contains the Base64 encoded public key for the peer\&. When this option is specified, then
1874 \fIPublicKey=\fR
1875 will be ignored\&. Note that the file must be readable by the user
1876 "systemd\-network", so it should be, e\&.g\&., owned by
1877 "root:systemd\-network"
1878 with a
1879 "0640"
1880 file mode\&. If the path refers to an
1881 \fBAF_UNIX\fR
1882 stream socket in the file system a connection is made to it and the key read from it\&.
1883 .sp
1884 Added in version 257\&.
1885 .RE
1886 .PP
1887 \fIPresharedKey=\fR
1888 .RS 4
1889 Optional preshared key for the interface\&. It can be generated by the
1890 \fBwg genpsk\fR
1891 command\&. This option adds an additional layer of symmetric\-key cryptography to be mixed into the already existing public\-key cryptography, for post\-quantum resistance\&. This option honors the
1892 "@"
1893 prefix in the same way as the
1894 \fBPrivateKey=\fR
1895 setting of the
1896 \fB[WireGuard]\fR
1897 section\&.
1898 .sp
1899 Note that because this information is secret, it is strongly recommended to use an (encrypted) credential\&. Alternatively, you may want to set the permissions of the \&.netdev file to be owned by
1900 "root:systemd\-network"
1901 with a
1902 "0640"
1903 file mode\&.
1904 .sp
1905 Added in version 237\&.
1906 .RE
1907 .PP
1908 \fIPresharedKeyFile=\fR
1909 .RS 4
1910 Takes an absolute path to a file which contains the Base64 encoded preshared key for the peer\&. When this option is specified, then
1911 \fIPresharedKey=\fR
1912 is ignored\&. Note that the file must be readable by the user
1913 "systemd\-network", so it should be, e\&.g\&., owned by
1914 "root:systemd\-network"
1915 with a
1916 "0640"
1917 file mode\&. If the path refers to an
1918 \fBAF_UNIX\fR
1919 stream socket in the file system a connection is made to it and the key read from it\&.
1920 .sp
1921 Added in version 242\&.
1922 .RE
1923 .PP
1924 \fIAllowedIPs=\fR
1925 .RS 4
1926 Sets a comma\-separated list of IP (v4 or v6) addresses with CIDR masks from which this peer is allowed to send incoming traffic and to which outgoing traffic for this peer is directed\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
1927 .sp
1928 The catch\-all 0\&.0\&.0\&.0/0 may be specified for matching all IPv4 addresses, and ::/0 may be specified for matching all IPv6 addresses\&.
1929 .sp
1930 Note that this only affects
1931 \fIrouting inside the network interface itself\fR, i\&.e\&. the packets that pass through the tunnel itself\&. To cause packets to be sent via the tunnel in the first place, an appropriate route needs to be added as well \(em either in the
1932 "[Routes]"
1933 section on the
1934 "\&.network"
1935 matching the wireguard interface, or externally to
1936 \fBsystemd\-networkd\fR\&.
1937 .sp
1938 Added in version 237\&.
1939 .RE
1940 .PP
1941 \fIEndpoint=\fR
1942 .RS 4
1943 Sets an endpoint IP address or hostname, followed by a colon, and then a port number\&. IPv6 address must be in the square brackets\&. For example,
1944 "111\&.222\&.333\&.444:51820"
1945 for IPv4 and
1946 "[1111:2222::3333]:51820"
1947 for IPv6 address\&. This endpoint will be updated automatically once to the most recent source IP address and port of correctly authenticated packets from the peer at configuration time\&.
1948 .sp
1949 This option honors the
1950 "@"
1951 prefix in the same way as the
1952 \fBPrivateKey=\fR
1953 setting of the
1954 \fB[WireGuard]\fR
1955 section\&.
1956 .sp
1957 Added in version 237\&.
1958 .RE
1959 .PP
1960 \fIPersistentKeepalive=\fR
1961 .RS 4
1962 Sets a seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently\&. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from a peer, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds\&. If set to 0 or "off", this option is disabled\&. By default or when unspecified, this option is off\&. Most users will not need this\&.
1963 .sp
1964 Added in version 237\&.
1965 .RE
1966 .PP
1967 \fIRouteTable=\fR
1968 .RS 4
1969 The table identifier for the routes to the addresses specified in the
1970 \fIAllowedIPs=\fR\&. Takes a negative boolean value, one of the predefined names
1971 "default",
1972 "main", and
1973 "local", names defined in
1974 \fIRouteTable=\fR
1975 in
1976 \fBnetworkd.conf\fR(5), or a number in the range 1\&...4294967295\&. Defaults to unset, and the value specified in the same setting in the [WireGuard] section will be used\&.
1977 .sp
1978 Added in version 250\&.
1979 .RE
1980 .PP
1981 \fIRouteMetric=\fR
1982 .RS 4
1983 The priority of the routes to the addresses specified in the
1984 \fIAllowedIPs=\fR\&. Takes an integer in the range 0\&...4294967295\&. Defaults to unset, and the value specified in the same setting in the [WireGuard] section will be used\&.
1985 .sp
1986 Added in version 250\&.
1987 .RE
1988 .SH "[BOND] SECTION OPTIONS"
1989 .PP
1990 The [Bond] section accepts the following key:
1991 .PP
1992 \fIMode=\fR
1993 .RS 4
1994 Specifies one of the bonding policies\&. The default is
1995 "balance\-rr"
1996 (round robin)\&. Possible values are
1997 "balance\-rr",
1998 "active\-backup",
1999 "balance\-xor",
2000 "broadcast",
2001 "802\&.3ad",
2002 "balance\-tlb", and
2003 "balance\-alb"\&.
2004 .sp
2005 Added in version 216\&.
2006 .RE
2007 .PP
2008 \fITransmitHashPolicy=\fR
2009 .RS 4
2010 Selects the transmit hash policy to use for slave selection in balance\-xor, 802\&.3ad, and tlb modes\&. Possible values are
2011 "layer2",
2012 "layer3+4",
2013 "layer2+3",
2014 "encap2+3", and
2015 "encap3+4"\&.
2016 .sp
2017 Added in version 216\&.
2018 .RE
2019 .PP
2020 \fILACPTransmitRate=\fR
2021 .RS 4
2022 Specifies the rate with which link partner transmits Link Aggregation Control Protocol Data Unit packets in 802\&.3ad mode\&. Possible values are
2023 "slow", which requests partner to transmit LACPDUs every 30 seconds, and
2024 "fast", which requests partner to transmit LACPDUs every second\&. The default value is
2025 "slow"\&.
2026 .sp
2027 Added in version 216\&.
2028 .RE
2029 .PP
2030 \fIMIIMonitorSec=\fR
2031 .RS 4
2032 Specifies the frequency that Media Independent Interface link monitoring will occur\&. A value of zero disables MII link monitoring\&. This value is rounded down to the nearest millisecond\&. The default value is 0\&.
2033 .sp
2034 Added in version 216\&.
2035 .RE
2036 .PP
2037 \fIPeerNotifyDelaySec=\fR
2038 .RS 4
2039 Specifies the number of seconds the delay between each peer notification (gratuitous ARP and unsolicited IPv6 Neighbor Advertisement) when they are issued after a failover event\&. This delay should be a multiple of the MII link monitor interval (miimon)\&. The valid range is 0\&.\&.\&.300s\&. The default value is 0, which means to match the value of the
2040 \fIMIIMonitorSec=\fR\&.
2041 .sp
2042 Added in version 256\&.
2043 .RE
2044 .PP
2045 \fIUpDelaySec=\fR
2046 .RS 4
2047 Specifies the delay before a link is enabled after a link up status has been detected\&. This value is rounded down to a multiple of
2048 \fIMIIMonitorSec=\fR\&. The default value is 0\&.
2049 .sp
2050 Added in version 216\&.
2051 .RE
2052 .PP
2053 \fIDownDelaySec=\fR
2054 .RS 4
2055 Specifies the delay before a link is disabled after a link down status has been detected\&. This value is rounded down to a multiple of
2056 \fIMIIMonitorSec=\fR\&. The default value is 0\&.
2057 .sp
2058 Added in version 216\&.
2059 .RE
2060 .PP
2061 \fILearnPacketIntervalSec=\fR
2062 .RS 4
2063 Specifies the number of seconds between instances where the bonding driver sends learning packets to each slave peer switch\&. The valid range is 1\&...0x7fffffff; the default value is 1\&. This option has an effect only for the balance\-tlb and balance\-alb modes\&.
2064 .sp
2065 Added in version 220\&.
2066 .RE
2067 .PP
2068 \fIAdSelect=\fR
2069 .RS 4
2070 Specifies the 802\&.3ad aggregation selection logic to use\&. Possible values are
2071 "stable",
2072 "bandwidth"
2073 and
2074 "count"\&.
2075 .sp
2076 Added in version 220\&.
2077 .RE
2078 .PP
2079 \fIAdActorSystemPriority=\fR
2080 .RS 4
2081 Specifies the 802\&.3ad actor system priority\&. Takes a number in the range 1\&...65535\&.
2082 .sp
2083 Added in version 240\&.
2084 .RE
2085 .PP
2086 \fIAdUserPortKey=\fR
2087 .RS 4
2088 Specifies the 802\&.3ad user defined portion of the port key\&. Takes a number in the range 0\&...1023\&.
2089 .sp
2090 Added in version 240\&.
2091 .RE
2092 .PP
2093 \fIAdActorSystem=\fR
2094 .RS 4
2095 Specifies the 802\&.3ad system MAC address\&. This cannot be a null or multicast address\&.
2096 .sp
2097 Added in version 240\&.
2098 .RE
2099 .PP
2100 \fIFailOverMACPolicy=\fR
2101 .RS 4
2102 Specifies whether the active\-backup mode should set all slaves to the same MAC address at the time of enslavement or, when enabled, to perform special handling of the bond\*(Aqs MAC address in accordance with the selected policy\&. The default policy is none\&. Possible values are
2103 "none",
2104 "active"
2105 and
2106 "follow"\&.
2107 .sp
2108 Added in version 220\&.
2109 .RE
2110 .PP
2111 \fIARPValidate=\fR
2112 .RS 4
2113 Specifies whether or not ARP probes and replies should be validated in any mode that supports ARP monitoring, or whether non\-ARP traffic should be filtered (disregarded) for link monitoring purposes\&. Possible values are
2114 "none",
2115 "active",
2116 "backup"
2117 and
2118 "all"\&.
2119 .sp
2120 Added in version 220\&.
2121 .RE
2122 .PP
2123 \fIARPIntervalSec=\fR
2124 .RS 4
2125 Specifies the ARP link monitoring frequency\&. A value of 0 disables ARP monitoring\&. The default value is 0, and the default unit seconds\&.
2126 .sp
2127 Added in version 220\&.
2128 .RE
2129 .PP
2130 \fIARPIPTargets=\fR
2131 .RS 4
2132 Specifies the IP addresses to use as ARP monitoring peers when
2133 \fIARPIntervalSec=\fR
2134 is greater than 0\&. These are the targets of the ARP request sent to determine the health of the link to the targets\&. Specify these values in IPv4 dotted decimal format\&. At least one IP address must be given for ARP monitoring to function\&. The maximum number of targets that can be specified is 16\&. The default value is no IP addresses\&.
2135 .sp
2136 Added in version 220\&.
2137 .RE
2138 .PP
2139 \fIARPAllTargets=\fR
2140 .RS 4
2141 Specifies the quantity of
2142 \fIARPIPTargets=\fR
2143 that must be reachable in order for the ARP monitor to consider a slave as being up\&. This option affects only active\-backup mode for slaves with ARPValidate enabled\&. Possible values are
2144 "any"
2145 and
2146 "all"\&.
2147 .sp
2148 Added in version 220\&.
2149 .RE
2150 .PP
2151 \fIPrimaryReselectPolicy=\fR
2152 .RS 4
2153 Specifies the reselection policy for the primary slave\&. This affects how the primary slave is chosen to become the active slave when failure of the active slave or recovery of the primary slave occurs\&. This option is designed to prevent flip\-flopping between the primary slave and other slaves\&. Possible values are
2154 "always",
2155 "better"
2156 and
2157 "failure"\&.
2158 .sp
2159 Added in version 220\&.
2160 .RE
2161 .PP
2162 \fIResendIGMP=\fR
2163 .RS 4
2164 Specifies the number of IGMP membership reports to be issued after a failover event\&. One membership report is issued immediately after the failover, subsequent packets are sent in each 200ms interval\&. The valid range is 0\&...255\&. Defaults to 1\&. A value of 0 prevents the IGMP membership report from being issued in response to the failover event\&.
2165 .sp
2166 Added in version 220\&.
2167 .RE
2168 .PP
2169 \fIPacketsPerSlave=\fR
2170 .RS 4
2171 Specify the number of packets to transmit through a slave before moving to the next one\&. When set to 0, then a slave is chosen at random\&. The valid range is 0\&...65535\&. Defaults to 1\&. This option only has effect when in balance\-rr mode\&.
2172 .sp
2173 Added in version 220\&.
2174 .RE
2175 .PP
2176 \fIGratuitousARP=\fR
2177 .RS 4
2178 Specify the number of peer notifications (gratuitous ARPs and unsolicited IPv6 Neighbor Advertisements) to be issued after a failover event\&. As soon as the link is up on the new slave, a peer notification is sent on the bonding device and each VLAN sub\-device\&. This is repeated at each link monitor interval (ARPIntervalSec or MIIMonitorSec, whichever is active) if the number is greater than 1\&. The valid range is 0\&...255\&. The default value is 1\&. These options affect only the active\-backup mode\&.
2179 .sp
2180 Added in version 220\&.
2181 .RE
2182 .PP
2183 \fIAllSlavesActive=\fR
2184 .RS 4
2185 Takes a boolean\&. Specifies that duplicate frames (received on inactive ports) should be dropped when false, or delivered when true\&. Normally, bonding will drop duplicate frames (received on inactive ports), which is desirable for most users\&. But there are some times it is nice to allow duplicate frames to be delivered\&. The default value is false (drop duplicate frames received on inactive ports)\&.
2186 .sp
2187 Added in version 220\&.
2188 .RE
2189 .PP
2190 \fIDynamicTransmitLoadBalancing=\fR
2191 .RS 4
2192 Takes a boolean\&. Specifies if dynamic shuffling of flows is enabled\&. Applies only for balance\-tlb mode\&. Defaults to unset\&.
2193 .sp
2194 Added in version 240\&.
2195 .RE
2196 .PP
2197 \fIMinLinks=\fR
2198 .RS 4
2199 Specifies the minimum number of links that must be active before asserting carrier\&. The default value is 0\&.
2200 .sp
2201 Added in version 220\&.
2202 .RE
2203 .PP
2204 \fIARPMissedMax=\fR
2205 .RS 4
2206 Specify the maximum number of arp interval monitor cycle for missed ARP replies\&. If this number is exceeded, link is reported as down\&. Defaults to unset\&.
2207 .sp
2208 Added in version 256\&.
2209 .RE
2210 .PP
2211 For more detail information see
2212 \m[blue]\fBLinux Ethernet Bonding Driver HOWTO\fR\m[]\&\s-2\u[1]\d\s+2
2213 .SH "[XFRM] SECTION OPTIONS"
2214 .PP
2215 The [Xfrm] section accepts the following keys:
2216 .PP
2217 \fIInterfaceId=\fR
2218 .RS 4
2219 Sets the ID/key of the xfrm interface which needs to be associated with a SA/policy\&. Can be decimal or hexadecimal, valid range is 1\-0xffffffff\&. This is mandatory\&.
2220 .sp
2221 Added in version 243\&.
2222 .RE
2223 .PP
2224 \fIIndependent=\fR
2225 .RS 4
2226 Takes a boolean\&. If false (the default), the xfrm interface must have an underlying device which can be used for hardware offloading\&.
2227 .sp
2228 Added in version 243\&.
2229 .RE
2230 .PP
2231 For more detail information see
2232 \m[blue]\fBVirtual XFRM Interfaces\fR\m[]\&\s-2\u[18]\d\s+2\&.
2233 .SH "[VRF] SECTION OPTIONS"
2234 .PP
2235 The [VRF] section only applies for netdevs of kind
2236 "vrf"
2237 and accepts the following key:
2238 .PP
2239 \fITable=\fR
2240 .RS 4
2241 The numeric routing table identifier\&. This setting is compulsory\&.
2242 .sp
2243 Added in version 243\&.
2244 .RE
2245 .SH "[BATMANADVANCED] SECTION OPTIONS"
2246 .PP
2247 The [BatmanAdvanced] section only applies for netdevs of kind
2248 "batadv"
2249 and accepts the following keys:
2250 .PP
2251 \fIGatewayMode=\fR
2252 .RS 4
2253 Takes one of
2254 "off",
2255 "server", or
2256 "client"\&. A batman\-adv node can either run in server mode (sharing its internet connection with the mesh) or in client mode (searching for the most suitable internet connection in the mesh) or having the gateway support turned off entirely (which is the default setting)\&.
2257 .sp
2258 Added in version 248\&.
2259 .RE
2260 .PP
2261 \fIAggregation=\fR
2262 .RS 4
2263 Takes a boolean value\&. Enables or disables aggregation of originator messages\&. Defaults to true\&.
2264 .sp
2265 Added in version 248\&.
2266 .RE
2267 .PP
2268 \fIBridgeLoopAvoidance=\fR
2269 .RS 4
2270 Takes a boolean value\&. Enables or disables avoidance of loops on bridges\&. Defaults to true\&.
2271 .sp
2272 Added in version 248\&.
2273 .RE
2274 .PP
2275 \fIDistributedArpTable=\fR
2276 .RS 4
2277 Takes a boolean value\&. Enables or disables the distributed ARP table\&. Defaults to true\&.
2278 .sp
2279 Added in version 248\&.
2280 .RE
2281 .PP
2282 \fIFragmentation=\fR
2283 .RS 4
2284 Takes a boolean value\&. Enables or disables fragmentation\&. Defaults to true\&.
2285 .sp
2286 Added in version 248\&.
2287 .RE
2288 .PP
2289 \fIHopPenalty=\fR
2290 .RS 4
2291 The hop penalty setting allows one to modify
2292 \fBbatctl\fR(8)
2293 preference for multihop routes vs\&. short routes\&. This integer value is applied to the TQ (Transmit Quality) of each forwarded OGM (Originator Message), thereby propagating the cost of an extra hop (the packet has to be received and retransmitted which costs airtime)\&. A higher hop penalty will make it more unlikely that other nodes will choose this node as intermediate hop towards any given destination\&. The default hop penalty of \*(Aq15\*(Aq is a reasonable value for most setups and probably does not need to be changed\&. However, mobile nodes could choose a value of 255 (maximum value) to avoid being chosen as a router by other nodes\&. The minimum value is 0\&.
2294 .sp
2295 Added in version 248\&.
2296 .RE
2297 .PP
2298 \fIOriginatorIntervalSec=\fR
2299 .RS 4
2300 The value specifies the interval in seconds, unless another time unit is specified in which batman\-adv floods the network with its protocol information\&. See
2301 \fBsystemd.time\fR(7)
2302 for more information\&.
2303 .sp
2304 Added in version 248\&.
2305 .RE
2306 .PP
2307 \fIGatewayBandwidthDown=\fR
2308 .RS 4
2309 If the node is a server, this parameter is used to inform other nodes in the network about this node\*(Aqs internet connection download bandwidth in bits per second\&. Just enter any number suffixed with K, M, G or T (base 1000) and the batman\-adv module will propagate the entered value in the mesh\&.
2310 .sp
2311 Added in version 248\&.
2312 .RE
2313 .PP
2314 \fIGatewayBandwidthUp=\fR
2315 .RS 4
2316 If the node is a server, this parameter is used to inform other nodes in the network about this node\*(Aqs internet connection upload bandwidth in bits per second\&. Just enter any number suffixed with K, M, G or T (base 1000) and the batman\-adv module will propagate the entered value in the mesh\&.
2317 .sp
2318 Added in version 248\&.
2319 .RE
2320 .PP
2321 \fIRoutingAlgorithm=\fR
2322 .RS 4
2323 This can be either
2324 "batman\-v"
2325 or
2326 "batman\-iv"
2327 and describes which routing_algo of
2328 \fBbatctl\fR(8)
2329 to use\&. The algorithm cannot be changed after interface creation\&. Defaults to
2330 "batman\-v"\&.
2331 .sp
2332 Added in version 248\&.
2333 .RE
2334 .SH "[IPOIB] SECTION OPTIONS"
2335 .PP
2336 The [IPoIB] section only applies for netdevs of kind
2337 "ipoib"
2338 and accepts the following keys:
2339 .PP
2340 \fIPartitionKey=\fR
2341 .RS 4
2342 Takes an integer in the range 1\&...0xffff, except for 0x8000\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
2343 .sp
2344 Added in version 250\&.
2345 .RE
2346 .PP
2347 \fIMode=\fR
2348 .RS 4
2349 Takes one of the special values
2350 "datagram"
2351 or
2352 "connected"\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
2353 .sp
2354 When
2355 "datagram", the Infiniband unreliable datagram (UD) transport is used, and so the interface MTU is equal to the IB L2 MTU minus the IPoIB encapsulation header (4 bytes)\&. For example, in a typical IB fabric with a 2K MTU, the IPoIB MTU will be 2048 \- 4 = 2044 bytes\&.
2356 .sp
2357 When
2358 "connected", the Infiniband reliable connected (RC) transport is used\&. Connected mode takes advantage of the connected nature of the IB transport and allows an MTU up to the maximal IP packet size of 64K, which reduces the number of IP packets needed for handling large UDP datagrams, TCP segments, etc and increases the performance for large messages\&.
2359 .sp
2360 Added in version 250\&.
2361 .RE
2362 .PP
2363 \fIIgnoreUserspaceMulticastGroup=\fR
2364 .RS 4
2365 Takes an boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
2366 .sp
2367 Added in version 250\&.
2368 .RE
2369 .SH "[WLAN] SECTION OPTIONS"
2370 .PP
2371 The [WLAN] section only applies to WLAN interfaces, and accepts the following keys:
2372 .PP
2373 \fIPhysicalDevice=\fR
2374 .RS 4
2375 Specifies the name or index of the physical WLAN device (e\&.g\&.
2376 "0"
2377 or
2378 "phy0")\&. The list of the physical WLAN devices that exist on the host can be obtained by
2379 \fBiw phy\fR
2380 command\&. This option is mandatory\&.
2381 .sp
2382 Added in version 251\&.
2383 .RE
2384 .PP
2385 \fIType=\fR
2386 .RS 4
2387 Specifies the type of the interface\&. Takes one of the
2388 "ad\-hoc",
2389 "station",
2390 "ap",
2391 "ap\-vlan",
2392 "wds",
2393 "monitor",
2394 "mesh\-point",
2395 "p2p\-client",
2396 "p2p\-go",
2397 "p2p\-device",
2398 "ocb", and
2399 "nan"\&. This option is mandatory\&.
2400 .sp
2401 Added in version 251\&.
2402 .RE
2403 .PP
2404 \fIWDS=\fR
2405 .RS 4
2406 Enables the Wireless Distribution System (WDS) mode on the interface\&. The mode is also known as the
2407 "4 address mode"\&. Takes a boolean value\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
2408 .sp
2409 Added in version 251\&.
2410 .RE
2411 .SH "EXAMPLES"
2412 .PP
2413 \fBExample\ \&1.\ \&/etc/systemd/network/25\-bridge\&.netdev\fR
2414 .sp
2415 .if n \{\
2416 .RS 4
2417 .\}
2418 .nf
2419 [NetDev]
2420 Name=bridge0
2421 Kind=bridge
2422 .fi
2423 .if n \{\
2424 .RE
2425 .\}
2426 .PP
2427 \fBExample\ \&2.\ \&/etc/systemd/network/25\-vlan1\&.netdev\fR
2428 .sp
2429 .if n \{\
2430 .RS 4
2431 .\}
2432 .nf
2433 [Match]
2434 Virtualization=no
2435
2436 [NetDev]
2437 Name=vlan1
2438 Kind=vlan
2439
2440 [VLAN]
2441 Id=1
2442 .fi
2443 .if n \{\
2444 .RE
2445 .\}
2446 .PP
2447 \fBExample\ \&3.\ \&/etc/systemd/network/25\-ipip\&.netdev\fR
2448 .sp
2449 .if n \{\
2450 .RS 4
2451 .\}
2452 .nf
2453 [NetDev]
2454 Name=ipip\-tun
2455 Kind=ipip
2456 MTUBytes=1480
2457
2458 [Tunnel]
2459 Local=192\&.168\&.223\&.238
2460 Remote=192\&.169\&.224\&.239
2461 TTL=64
2462 .fi
2463 .if n \{\
2464 .RE
2465 .\}
2466 .PP
2467 \fBExample\ \&4.\ \&/etc/systemd/network/1\-fou\-tunnel\&.netdev\fR
2468 .sp
2469 .if n \{\
2470 .RS 4
2471 .\}
2472 .nf
2473 [NetDev]
2474 Name=fou\-tun
2475 Kind=fou
2476
2477 [FooOverUDP]
2478 Port=5555
2479 Protocol=4
2480 .fi
2481 .if n \{\
2482 .RE
2483 .\}
2484 .PP
2485 \fBExample\ \&5.\ \&/etc/systemd/network/25\-fou\-ipip\&.netdev\fR
2486 .sp
2487 .if n \{\
2488 .RS 4
2489 .\}
2490 .nf
2491 [NetDev]
2492 Name=ipip\-tun
2493 Kind=ipip
2494
2495 [Tunnel]
2496 Independent=yes
2497 Local=10\&.65\&.208\&.212
2498 Remote=10\&.65\&.208\&.211
2499 FooOverUDP=yes
2500 FOUDestinationPort=5555
2501 .fi
2502 .if n \{\
2503 .RE
2504 .\}
2505 .PP
2506 \fBExample\ \&6.\ \&/etc/systemd/network/25\-tap\&.netdev\fR
2507 .sp
2508 .if n \{\
2509 .RS 4
2510 .\}
2511 .nf
2512 [NetDev]
2513 Name=tap\-test
2514 Kind=tap
2515
2516 [Tap]
2517 MultiQueue=yes
2518 PacketInfo=yes
2519 .fi
2520 .if n \{\
2521 .RE
2522 .\}
2523 .PP
2524 \fBExample\ \&7.\ \&/etc/systemd/network/25\-sit\&.netdev\fR
2525 .sp
2526 .if n \{\
2527 .RS 4
2528 .\}
2529 .nf
2530 [NetDev]
2531 Name=sit\-tun
2532 Kind=sit
2533 MTUBytes=1480
2534
2535 [Tunnel]
2536 Local=10\&.65\&.223\&.238
2537 Remote=10\&.65\&.223\&.239
2538 .fi
2539 .if n \{\
2540 .RE
2541 .\}
2542 .PP
2543 \fBExample\ \&8.\ \&/etc/systemd/network/25\-6rd\&.netdev\fR
2544 .sp
2545 .if n \{\
2546 .RS 4
2547 .\}
2548 .nf
2549 [NetDev]
2550 Name=6rd\-tun
2551 Kind=sit
2552 MTUBytes=1480
2553
2554 [Tunnel]
2555 Local=10\&.65\&.223\&.238
2556 IPv6RapidDeploymentPrefix=2602::/24
2557 .fi
2558 .if n \{\
2559 .RE
2560 .\}
2561 .PP
2562 \fBExample\ \&9.\ \&/etc/systemd/network/25\-gre\&.netdev\fR
2563 .sp
2564 .if n \{\
2565 .RS 4
2566 .\}
2567 .nf
2568 [NetDev]
2569 Name=gre\-tun
2570 Kind=gre
2571 MTUBytes=1480
2572
2573 [Tunnel]
2574 Local=10\&.65\&.223\&.238
2575 Remote=10\&.65\&.223\&.239
2576 .fi
2577 .if n \{\
2578 .RE
2579 .\}
2580 .PP
2581 \fBExample\ \&10.\ \&/etc/systemd/network/25\-ip6gre\&.netdev\fR
2582 .sp
2583 .if n \{\
2584 .RS 4
2585 .\}
2586 .nf
2587 [NetDev]
2588 Name=ip6gre\-tun
2589 Kind=ip6gre
2590
2591 [Tunnel]
2592 Key=123
2593 .fi
2594 .if n \{\
2595 .RE
2596 .\}
2597 .PP
2598 \fBExample\ \&11.\ \&/etc/systemd/network/25\-vti\&.netdev\fR
2599 .sp
2600 .if n \{\
2601 .RS 4
2602 .\}
2603 .nf
2604 [NetDev]
2605 Name=vti\-tun
2606 Kind=vti
2607 MTUBytes=1480
2608
2609 [Tunnel]
2610 Local=10\&.65\&.223\&.238
2611 Remote=10\&.65\&.223\&.239
2612 .fi
2613 .if n \{\
2614 .RE
2615 .\}
2616 .PP
2617 \fBExample\ \&12.\ \&/etc/systemd/network/25\-veth\&.netdev\fR
2618 .sp
2619 .if n \{\
2620 .RS 4
2621 .\}
2622 .nf
2623 [NetDev]
2624 Name=veth\-test
2625 Kind=veth
2626
2627 [Peer]
2628 Name=veth\-peer
2629 .fi
2630 .if n \{\
2631 .RE
2632 .\}
2633 .PP
2634 \fBExample\ \&13.\ \&/etc/systemd/network/25\-bond\&.netdev\fR
2635 .sp
2636 .if n \{\
2637 .RS 4
2638 .\}
2639 .nf
2640 [NetDev]
2641 Name=bond1
2642 Kind=bond
2643
2644 [Bond]
2645 Mode=802\&.3ad
2646 TransmitHashPolicy=layer3+4
2647 MIIMonitorSec=1s
2648 LACPTransmitRate=fast
2649 .fi
2650 .if n \{\
2651 .RE
2652 .\}
2653 .PP
2654 \fBExample\ \&14.\ \&/etc/systemd/network/25\-dummy\&.netdev\fR
2655 .sp
2656 .if n \{\
2657 .RS 4
2658 .\}
2659 .nf
2660 [NetDev]
2661 Name=dummy\-test
2662 Kind=dummy
2663 MACAddress=12:34:56:78:9a:bc
2664 .fi
2665 .if n \{\
2666 .RE
2667 .\}
2668 .PP
2669 \fBExample\ \&15.\ \&/etc/systemd/network/25\-vrf\&.netdev\fR
2670 .PP
2671 Create a VRF interface with table 42\&.
2672 .sp
2673 .if n \{\
2674 .RS 4
2675 .\}
2676 .nf
2677 [NetDev]
2678 Name=vrf\-test
2679 Kind=vrf
2680
2681 [VRF]
2682 Table=42
2683 .fi
2684 .if n \{\
2685 .RE
2686 .\}
2687 .PP
2688 \fBExample\ \&16.\ \&/etc/systemd/network/25\-macvtap\&.netdev\fR
2689 .PP
2690 Create a MacVTap device\&.
2691 .sp
2692 .if n \{\
2693 .RS 4
2694 .\}
2695 .nf
2696 [NetDev]
2697 Name=macvtap\-test
2698 Kind=macvtap
2699 .fi
2700 .if n \{\
2701 .RE
2702 .\}
2703 .PP
2704 \fBExample\ \&17.\ \&/etc/systemd/network/25\-wireguard\&.netdev\fR
2705 .sp
2706 .if n \{\
2707 .RS 4
2708 .\}
2709 .nf
2710 [NetDev]
2711 Name=wg0
2712 Kind=wireguard
2713
2714 [WireGuard]
2715 PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
2716 ListenPort=51820
2717
2718 [WireGuardPeer]
2719 PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
2720 AllowedIPs=fd31:bf08:57cb::/48,192\&.168\&.26\&.0/24
2721 Endpoint=wireguard\&.example\&.com:51820
2722 .fi
2723 .if n \{\
2724 .RE
2725 .\}
2726 .PP
2727 \fBExample\ \&18.\ \&/etc/systemd/network/27\-xfrm\&.netdev\fR
2728 .sp
2729 .if n \{\
2730 .RS 4
2731 .\}
2732 .nf
2733 [NetDev]
2734 Name=xfrm0
2735 Kind=xfrm
2736
2737 [Xfrm]
2738 Independent=yes
2739 .fi
2740 .if n \{\
2741 .RE
2742 .\}
2743 .SH "SEE ALSO"
2744 .PP
2745 \fBsystemd\fR(1), \fBsystemd-networkd.service\fR(8), \fBsystemd.link\fR(5), \fBsystemd.network\fR(5), \fBsystemd-network-generator.service\fR(8)
2746 .SH "NOTES"
2747 .IP " 1." 4
2748 Linux Ethernet Bonding Driver HOWTO
2749 .RS 4
2750 \%https://docs.kernel.org/networking/bonding.html
2751 .RE
2752 .IP " 2." 4
2753 RFC 2784
2754 .RS 4
2755 \%https://tools.ietf.org/html/rfc2784
2756 .RE
2757 .IP " 3." 4
2758 IEEE 802.1Q
2759 .RS 4
2760 \%http://www.ieee802.org/1/pages/802.1Q.html
2761 .RE
2762 .IP " 4." 4
2763 VRF
2764 .RS 4
2765 \%https://docs.kernel.org/networking/vrf.html
2766 .RE
2767 .IP " 5." 4
2768 B.A.T.M.A.N. Advanced
2769 .RS 4
2770 \%https://www.open-mesh.org/projects/open-mesh/wiki
2771 .RE
2772 .IP " 6." 4
2773 System and Service Credentials
2774 .RS 4
2775 \%https://systemd.io/CREDENTIALS
2776 .RE
2777 .IP " 7." 4
2778 Distributed Overlay Virtual Ethernet (DOVE)
2779 .RS 4
2780 \%https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet
2781 .RE
2782 .IP " 8." 4
2783 VXLAN Group Policy
2784 .RS 4
2785 \%https://tools.ietf.org/html/draft-smith-vxlan-group-policy
2786 .RE
2787 .IP " 9." 4
2788 Generic Protocol Extension for VXLAN
2789 .RS 4
2790 \%https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07
2791 .RE
2792 .IP "10." 4
2793 Type of Service in the Internet Protocol Suite
2794 .RS 4
2795 \%http://tools.ietf.org/html/rfc1349
2796 .RE
2797 .IP "11." 4
2798 RFC 6437
2799 .RS 4
2800 \%https://tools.ietf.org/html/rfc6437
2801 .RE
2802 .IP "12." 4
2803 RFC 2460
2804 .RS 4
2805 \%https://tools.ietf.org/html/rfc2460
2806 .RE
2807 .IP "13." 4
2808 RFC 2473
2809 .RS 4
2810 \%https://tools.ietf.org/html/rfc2473#section-4.1.1
2811 .RE
2812 .IP "14." 4
2813 ip-xfrm \(em transform configuration
2814 .RS 4
2815 \%https://man7.org/linux/man-pages/man8/ip-xfrm.8.html
2816 .RE
2817 .IP "15." 4
2818 Foo over UDP
2819 .RS 4
2820 \%https://lwn.net/Articles/614348
2821 .RE
2822 .IP "16." 4
2823 IPv6 Rapid Deployment
2824 .RS 4
2825 \%https://tools.ietf.org/html/rfc5569
2826 .RE
2827 .IP "17." 4
2828 Generic UDP Encapsulation
2829 .RS 4
2830 \%https://lwn.net/Articles/615044
2831 .RE
2832 .IP "18." 4
2833 Virtual XFRM Interfaces
2834 .RS 4
2835 \%https://lwn.net/Articles/757391
2836 .RE