Debian Codegraph @

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

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