summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man5/systemd.netdev.5
blob: 556d88ac0ad33281239a9bd2a348e22fe002700e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
'\" t
.TH "SYSTEMD\&.NETDEV" "5" "" "systemd 254" "systemd.network"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
systemd.netdev \- Virtual Network Device configuration
.SH "SYNOPSIS"
.PP
\fInetdev\fR\&.netdev
.SH "DESCRIPTION"
.PP
A plain ini\-style text file that encodes configuration about a virtual network device, used by
\fBsystemd-networkd\fR(8)\&. See
\fBsystemd.syntax\fR(7)
for a general description of the syntax\&.
.PP
The main Virtual Network Device file must have the extension
\&.netdev; other extensions are ignored\&. Virtual network devices are created as soon as networkd is started\&. If a netdev with the specified name already exists, networkd will use that as\-is rather than create its own\&. Note that the settings of the pre\-existing netdev will not be changed by networkd\&.
.PP
The
\&.netdev
files are read from the files located in the system network directory
/usr/lib/systemd/network
and
/usr/local/lib/systemd/network, the volatile runtime network directory
/run/systemd/network
and the local administration network directory
/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 (e\&.g\&.
10\-vlan\&.netdev)\&. Otherwise,
\&.netdev
files generated by
\fBsystemd-network-generator.service\fR(8)
may take precedence over user configured files\&. Files in
/etc/
have the highest priority, files in
/run/
take precedence over files with the same name in
/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
/dev/null
disables the configuration file entirely (it is "masked")\&.
.PP
Along with the netdev file
foo\&.netdev, a "drop\-in" directory
foo\&.netdev\&.d/
may exist\&. All files with the suffix
"\&.conf"
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\&.
.PP
In addition to
/etc/systemd/network, drop\-in
"\&.d"
directories can be placed in
/usr/lib/systemd/network
or
/run/systemd/network
directories\&. Drop\-in files in
/etc/
take precedence over those in
/run/
which in turn take precedence over those in
/usr/lib/\&. Drop\-in files under any of these directories take precedence over the main netdev file wherever located\&. (Of course, since
/run/
is temporary and
/usr/lib/
is for vendors, it is unlikely drop\-ins should be used in either of those places\&.)
.SH "SUPPORTED NETDEV KINDS"
.PP
The following kinds of virtual network devices may be configured in
\&.netdev
files:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&Supported kinds of virtual network devices
.TS
allbox tab(:);
lB lB.
T{
Kind
T}:T{
Description
T}
.T&
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l.
T{
\fIbond\fR
T}:T{
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\&.
T}
T{
\fIbridge\fR
T}:T{
A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch\&.
T}
T{
\fIdummy\fR
T}:T{
A dummy device drops all packets sent to it\&.
T}
T{
\fIgre\fR
T}:T{
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\&.
T}
T{
\fIgretap\fR
T}:T{
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\&.
T}
T{
\fIerspan\fR
T}:T{
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\&.
T}
T{
\fIip6gre\fR
T}:T{
A Level 3 GRE tunnel over IPv6\&.
T}
T{
\fIip6tnl\fR
T}:T{
An IPv4 or IPv6 tunnel over IPv6
T}
T{
\fIip6gretap\fR
T}:T{
A Level 2 GRE tunnel over IPv6\&.
T}
T{
\fIipip\fR
T}:T{
An IPv4 over IPv4 tunnel\&.
T}
T{
\fIipvlan\fR
T}:T{
An IPVLAN device is a stacked device which receives packets from its underlying device based on IP address filtering\&.
T}
T{
\fIipvtap\fR
T}:T{
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\&.
T}
T{
\fImacvlan\fR
T}:T{
A macvlan device is a stacked device which receives packets from its underlying device based on MAC address filtering\&.
T}
T{
\fImacvtap\fR
T}:T{
A macvtap device is a stacked device which receives packets from its underlying device based on MAC address filtering\&.
T}
T{
\fIsit\fR
T}:T{
An IPv6 over IPv4 tunnel\&.
T}
T{
\fItap\fR
T}:T{
A persistent Level 2 tunnel between a network device and a device node\&.
T}
T{
\fItun\fR
T}:T{
A persistent Level 3 tunnel between a network device and a device node\&.
T}
T{
\fIveth\fR
T}:T{
An Ethernet tunnel between a pair of network devices\&.
T}
T{
\fIvlan\fR
T}:T{
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\&.
T}
T{
\fIvti\fR
T}:T{
An IPv4 over IPSec tunnel\&.
T}
T{
\fIvti6\fR
T}:T{
An IPv6 over IPSec tunnel\&.
T}
T{
\fIvxlan\fR
T}:T{
A virtual extensible LAN (vxlan), for connecting Cloud computing deployments\&.
T}
T{
\fIgeneve\fR
T}:T{
A GEneric NEtwork Virtualization Encapsulation (GENEVE) netdev driver\&.
T}
T{
\fIl2tp\fR
T}:T{
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
T}
T{
\fImacsec\fR
T}:T{
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\&.
T}
T{
\fIvrf\fR
T}:T{
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\&.
T}
T{
\fIvcan\fR
T}:T{
The virtual CAN driver (vcan)\&. Similar to the network loopback devices, vcan offers a virtual local CAN interface\&.
T}
T{
\fIvxcan\fR
T}:T{
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\&.
T}
T{
\fIwireguard\fR
T}:T{
WireGuard Secure Network Tunnel\&.
T}
T{
\fInlmon\fR
T}:T{
A Netlink monitor device\&. Use an nlmon device when you want to monitor system Netlink messages\&.
T}
T{
\fIfou\fR
T}:T{
Foo\-over\-UDP tunneling\&.
T}
T{
\fIxfrm\fR
T}:T{
A virtual tunnel interface like vti/vti6 but with several advantages\&.
T}
T{
\fIifb\fR
T}:T{
The Intermediate Functional Block (ifb) pseudo network interface acts as a QoS concentrator for multiple different sources of traffic\&.
T}
T{
\fIbareudp\fR
T}:T{
Bare UDP tunnels provide a generic L3 encapsulation support for tunnelling different L3 protocols like MPLS, IP etc\&. inside of a UDP tunnel\&.
T}
T{
\fIbatadv\fR
T}:T{
\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\&.
T}
T{
\fIipoib\fR
T}:T{
An IP over Infiniband subinterface\&.
T}
T{
\fIwlan\fR
T}:T{
A virtual wireless network (WLAN) interface\&.
T}
.TE
.sp 1
.SH "[MATCH] SECTION OPTIONS"
.PP
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:
.PP
\fIHost=\fR
.RS 4
Matches against the hostname or machine ID of the host\&. See
\fIConditionHost=\fR
in
\fBsystemd.unit\fR(5)
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.PP
\fIVirtualization=\fR
.RS 4
Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation\&. See
\fIConditionVirtualization=\fR
in
\fBsystemd.unit\fR(5)
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.PP
\fIKernelCommandLine=\fR
.RS 4
Checks whether a specific kernel command line option is set\&. See
\fIConditionKernelCommandLine=\fR
in
\fBsystemd.unit\fR(5)
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.PP
\fIKernelVersion=\fR
.RS 4
Checks whether the kernel version (as reported by
\fBuname \-r\fR) matches a certain expression\&. See
\fIConditionKernelVersion=\fR
in
\fBsystemd.unit\fR(5)
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.PP
\fICredential=\fR
.RS 4
Checks whether the specified credential was passed to the
systemd\-udevd\&.service
service\&. See
\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[6]\d\s+2
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.PP
\fIArchitecture=\fR
.RS 4
Checks whether the system is running on a specific architecture\&. See
\fIConditionArchitecture=\fR
in
\fBsystemd.unit\fR(5)
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.PP
\fIFirmware=\fR
.RS 4
Checks whether the system is running on a machine with the specified firmware\&. See
\fIConditionFirmware=\fR
in
\fBsystemd.unit\fR(5)
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.RE
.SH "[NETDEV] SECTION OPTIONS"
.PP
The [NetDev] section accepts the following keys:
.PP
\fIDescription=\fR
.RS 4
A free\-form description of the netdev\&.
.RE
.PP
\fIName=\fR
.RS 4
The interface name used when creating the netdev\&. This setting is compulsory\&.
.RE
.PP
\fIKind=\fR
.RS 4
The netdev kind\&. This setting is compulsory\&. See the
"Supported netdev kinds"
section for the valid keys\&.
.RE
.PP
\fIMTUBytes=\fR
.RS 4
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
"tun"
or
"tap"
devices,
\fIMTUBytes=\fR
setting is not currently supported in [NetDev] section\&. Please specify it in [Link] section of corresponding
\fBsystemd.network\fR(5)
files\&.
.RE
.PP
\fIMACAddress=\fR
.RS 4
Specifies the MAC address to use for the device, or takes the special value
"none"\&. When
"none",
\fBsystemd\-networkd\fR
does not request the MAC address for the device, and the kernel will assign a random MAC address\&. For
"tun",
"tap", or
"l2tp"
devices, the
\fIMACAddress=\fR
setting in the [NetDev] section is not supported and will be ignored\&. Please specify it in the [Link] section of the corresponding
\fBsystemd.network\fR(5)
file\&. If this option is not set,
"vlan"
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
\fBmachine-id\fR(5)\&.
.sp
Note, even if
"none"
is specified,
\fBsystemd\-udevd\fR
will assign the persistent MAC address for the device, as
99\-default\&.link
has
\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\&.
.RE
.SH "[BRIDGE] SECTION OPTIONS"
.PP
The [Bridge] section only applies for netdevs of kind
"bridge", and accepts the following keys:
.PP
\fIHelloTimeSec=\fR
.RS 4
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\&.
.RE
.PP
\fIMaxAgeSec=\fR
.RS 4
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\&.
.RE
.PP
\fIForwardDelaySec=\fR
.RS 4
ForwardDelaySec specifies the number of seconds spent in each of the Listening and Learning states before the Forwarding state is entered\&.
.RE
.PP
\fIAgeingTimeSec=\fR
.RS 4
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\&.
.RE
.PP
\fIPriority=\fR
.RS 4
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\&.
.RE
.PP
\fIGroupForwardMask=\fR
.RS 4
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)\&.
.RE
.PP
\fIDefaultPVID=\fR
.RS 4
This specifies the default port VLAN ID of a newly attached bridge port\&. Set this to an integer in the range 1\&...4094 or
"none"
to disable the PVID\&.
.RE
.PP
\fIMulticastQuerier=\fR
.RS 4
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\&.
.RE
.PP
\fIMulticastSnooping=\fR
.RS 4
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\&.
.RE
.PP
\fIVLANFiltering=\fR
.RS 4
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\&.
.RE
.PP
\fIVLANProtocol=\fR
.RS 4
Allows setting the protocol used for VLAN filtering\&. Takes
\fB802\&.1q\fR
or,
\fB802\&.1ad\fR, and defaults to unset and kernel\*(Aqs default is used\&.
.RE
.PP
\fISTP=\fR
.RS 4
Takes a boolean\&. This enables the bridge\*(Aqs Spanning Tree Protocol (STP)\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIMulticastIGMPVersion=\fR
.RS 4
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\&.
.RE
.SH "[VLAN] SECTION OPTIONS"
.PP
The [VLAN] section only applies for netdevs of kind
"vlan", and accepts the following key:
.PP
\fIId=\fR
.RS 4
The VLAN ID to use\&. An integer in the range 0\&...4094\&. This setting is compulsory\&.
.RE
.PP
\fIProtocol=\fR
.RS 4
Allows setting the protocol used for the VLAN interface\&. Takes
"802\&.1q"
or,
"802\&.1ad", and defaults to unset and kernel\*(Aqs default is used\&.
.RE
.PP
\fIGVRP=\fR
.RS 4
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\&.
.RE
.PP
\fIMVRP=\fR
.RS 4
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\&.
.RE
.PP
\fILooseBinding=\fR
.RS 4
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\&.
.RE
.PP
\fIReorderHeader=\fR
.RS 4
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\&.
.RE
.PP
\fIEgressQOSMaps=\fR, \fIIngressQOSMaps=\fR
.RS 4
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
"from"\-"to", e\&.g\&.,
"21\-7 45\-5"\&. Note that
"from"
must be greater than or equal to
"to"\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.SH "[MACVLAN] SECTION OPTIONS"
.PP
The [MACVLAN] section only applies for netdevs of kind
"macvlan", and accepts the following key:
.PP
\fIMode=\fR
.RS 4
The MACVLAN mode to use\&. The supported options are
"private",
"vepa",
"bridge",
"passthru", and
"source"\&.
.RE
.PP
\fISourceMACAddress=\fR
.RS 4
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\&.
.RE
.PP
\fIBroadcastMulticastQueueLength=\fR
.RS 4
Specifies the length of the receive queue for broadcast/multicast packets\&. An unsigned integer in the range 0\&...4294967294\&. Defaults to unset\&.
.RE
.SH "[MACVTAP] SECTION OPTIONS"
.PP
The [MACVTAP] section applies for netdevs of kind
"macvtap"
and accepts the same keys as [MACVLAN]\&.
.SH "[IPVLAN] SECTION OPTIONS"
.PP
The [IPVLAN] section only applies for netdevs of kind
"ipvlan", and accepts the following key:
.PP
\fIMode=\fR
.RS 4
The IPVLAN mode to use\&. The supported options are
"L2","L3"
and
"L3S"\&.
.RE
.PP
\fIFlags=\fR
.RS 4
The IPVLAN flags to use\&. The supported options are
"bridge","private"
and
"vepa"\&.
.RE
.SH "[IPVTAP] SECTION OPTIONS"
.PP
The [IPVTAP] section only applies for netdevs of kind
"ipvtap"
and accepts the same keys as [IPVLAN]\&.
.SH "[VXLAN] SECTION OPTIONS"
.PP
The [VXLAN] section only applies for netdevs of kind
"vxlan", and accepts the following keys:
.PP
\fIVNI=\fR
.RS 4
The VXLAN Network Identifier (or VXLAN Segment ID)\&. Takes a number in the range 1\&...16777215\&.
.RE
.PP
\fIRemote=\fR
.RS 4
Configures destination IP address\&.
.RE
.PP
\fILocal=\fR
.RS 4
Configures local IP address\&. It must be an address on the underlying interface of the VXLAN interface, or one of the special values
"ipv4_link_local",
"ipv6_link_local",
"dhcp4",
"dhcp6", and
"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\&.
.RE
.PP
\fIGroup=\fR
.RS 4
Configures VXLAN multicast group IP address\&. All members of a VXLAN must use the same multicast group address\&.
.RE
.PP
\fITOS=\fR
.RS 4
The Type Of Service byte value for a vxlan interface\&.
.RE
.PP
\fITTL=\fR
.RS 4
A fixed Time To Live N on Virtual eXtensible Local Area Network packets\&. Takes
"inherit"
or a number in the range 0\&...255\&. 0 is a special value meaning inherit the inner protocol\*(Aqs TTL value\&.
"inherit"
means that it will inherit the outer protocol\*(Aqs TTL value\&.
.RE
.PP
\fIMacLearning=\fR
.RS 4
Takes a boolean\&. When true, enables dynamic MAC learning to discover remote MAC addresses\&.
.RE
.PP
\fIFDBAgeingSec=\fR
.RS 4
The lifetime of Forwarding Database entry learnt by the kernel, in seconds\&.
.RE
.PP
\fIMaximumFDBEntries=\fR
.RS 4
Configures maximum number of FDB entries\&.
.RE
.PP
\fIReduceARPProxy=\fR
.RS 4
Takes a boolean\&. When true, bridge\-connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote Distributed Overlay Virtual Ethernet
\m[blue]\fB(DOVE)\fR\m[]\&\s-2\u[7]\d\s+2
clients\&. Defaults to false\&.
.RE
.PP
\fIL2MissNotification=\fR
.RS 4
Takes a boolean\&. When true, enables netlink LLADDR miss notifications\&.
.RE
.PP
\fIL3MissNotification=\fR
.RS 4
Takes a boolean\&. When true, enables netlink IP address miss notifications\&.
.RE
.PP
\fIRouteShortCircuit=\fR
.RS 4
Takes a boolean\&. When true, route short circuiting is turned on\&.
.RE
.PP
\fIUDPChecksum=\fR
.RS 4
Takes a boolean\&. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on\&.
.RE
.PP
\fIUDP6ZeroChecksumTx=\fR
.RS 4
Takes a boolean\&. When true, sending zero checksums in VXLAN/IPv6 is turned on\&.
.RE
.PP
\fIUDP6ZeroChecksumRx=\fR
.RS 4
Takes a boolean\&. When true, receiving zero checksums in VXLAN/IPv6 is turned on\&.
.RE
.PP
\fIRemoteChecksumTx=\fR
.RS 4
Takes a boolean\&. When true, remote transmit checksum offload of VXLAN is turned on\&.
.RE
.PP
\fIRemoteChecksumRx=\fR
.RS 4
Takes a boolean\&. When true, remote receive checksum offload in VXLAN is turned on\&.
.RE
.PP
\fIGroupPolicyExtension=\fR
.RS 4
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
\m[blue]\fBVXLAN Group Policy\fR\m[]\&\s-2\u[8]\d\s+2
document\&. Defaults to false\&.
.RE
.PP
\fIGenericProtocolExtension=\fR
.RS 4
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
\m[blue]\fBGeneric Protocol Extension for VXLAN\fR\m[]\&\s-2\u[9]\d\s+2
document\&. If destination port is not specified and Generic Protocol Extension is set then default port of 4790 is used\&. Defaults to false\&.
.RE
.PP
\fIDestinationPort=\fR
.RS 4
Configures the default destination UDP port\&. If the destination port is not specified then Linux kernel default will be used\&. Set to 4789 to get the IANA assigned value\&.
.RE
.PP
\fIPortRange=\fR
.RS 4
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\&.
.RE
.PP
\fIFlowLabel=\fR
.RS 4
Specifies the flow label to use in outgoing packets\&. The valid range is 0\-1048575\&.
.RE
.PP
\fIIPDoNotFragment=\fR
.RS 4
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
"inherit"\&. Set to
"inherit"
if the encapsulated protocol is IPv6\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIIndependent=\fR
.RS 4
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
\fIVXLAN=\fR
is required for the VXLAN to be created\&.
.RE
.SH "[GENEVE] SECTION OPTIONS"
.PP
The [GENEVE] section only applies for netdevs of kind
"geneve", and accepts the following keys:
.PP
\fIId=\fR
.RS 4
Specifies the Virtual Network Identifier (VNI) to use, a number between 0 and 16777215\&. This field is mandatory\&.
.RE
.PP
\fIRemote=\fR
.RS 4
Specifies the unicast destination IP address to use in outgoing packets\&.
.RE
.PP
\fITOS=\fR
.RS 4
Specifies the TOS value to use in outgoing packets\&. Takes a number between 1 and 255\&.
.RE
.PP
\fITTL=\fR
.RS 4
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
/proc/sys/net/ipv4/ip_default_ttl\&.
.RE
.PP
\fIUDPChecksum=\fR
.RS 4
Takes a boolean\&. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4\&.
.RE
.PP
\fIUDP6ZeroChecksumTx=\fR
.RS 4
Takes a boolean\&. When true, skip UDP checksum calculation for transmitted packets over IPv6\&.
.RE
.PP
\fIUDP6ZeroChecksumRx=\fR
.RS 4
Takes a boolean\&. When true, allows incoming UDP packets over IPv6 with zero checksum field\&.
.RE
.PP
\fIDestinationPort=\fR
.RS 4
Specifies destination port\&. Defaults to 6081\&. If not set or assigned the empty string, the default port of 6081 is used\&.
.RE
.PP
\fIFlowLabel=\fR
.RS 4
Specifies the flow label to use in outgoing packets\&.
.RE
.PP
\fIIPDoNotFragment=\fR
.RS 4
Accepts the same key as in [VXLAN] section\&.
.RE
.PP
\fIInheritInnerProtocol=\fR
.RS 4
Takes a boolean\&. When true, inner Layer 3 protocol is set as Protocol Type in the GENEVE header instead of Ethernet\&. Defaults to false\&.
.RE
.SH "[BAREUDP] SECTION OPTIONS"
.PP
The [BareUDP] section only applies for netdevs of kind
"bareudp", and accepts the following keys:
.PP
\fIDestinationPort=\fR
.RS 4
Specifies the destination UDP port (in range 1\&...65535)\&. This is mandatory\&.
.RE
.PP
\fIEtherType=\fR
.RS 4
Specifies the L3 protocol\&. Takes one of
"ipv4",
"ipv6",
"mpls\-uc"
or
"mpls\-mc"\&. This is mandatory\&.
.RE
.SH "[L2TP] SECTION OPTIONS"
.PP
The [L2TP] section only applies for netdevs of kind
"l2tp", and accepts the following keys:
.PP
\fITunnelId=\fR
.RS 4
Specifies the tunnel identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the
"PeerTunnelId="
value being used at the peer\&. This setting is compulsory\&.
.RE
.PP
\fIPeerTunnelId=\fR
.RS 4
Specifies the peer tunnel id\&. Takes a number in the range 1\&...4294967295\&. The value used must match the
"TunnelId="
value being used at the peer\&. This setting is compulsory\&.
.RE
.PP
\fIRemote=\fR
.RS 4
Specifies the IP address of the remote peer\&. This setting is compulsory\&.
.RE
.PP
\fILocal=\fR
.RS 4
Specifies the IP address of a local interface\&. Takes an IP address, or the special values
"auto",
"static", or
"dynamic"\&. Optionally a name of a local interface can be specified after
"@", e\&.g\&.
"192\&.168\&.0\&.1@eth0"
or
"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
"auto", then one of the addresses on a local or specified interface which is accessible to the remote address will be used\&. Similarly, if
"static"
or
"dynamic"
is set, then one of the static or dynamic addresses will be used\&. Defaults to
"auto"\&.
.RE
.PP
\fIEncapsulationType=\fR
.RS 4
Specifies the encapsulation type of the tunnel\&. Takes one of
"udp"
or
"ip"\&.
.RE
.PP
\fIUDPSourcePort=\fR
.RS 4
Specifies the UDP source port to be used for the tunnel\&. When UDP encapsulation is selected it\*(Aqs mandatory\&. Ignored when IP encapsulation is selected\&.
.RE
.PP
\fIUDPDestinationPort=\fR
.RS 4
Specifies destination port\&. When UDP encapsulation is selected it\*(Aqs mandatory\&. Ignored when IP encapsulation is selected\&.
.RE
.PP
\fIUDPChecksum=\fR
.RS 4
Takes a boolean\&. When true, specifies that UDP checksum is calculated for transmitted packets over IPv4\&.
.RE
.PP
\fIUDP6ZeroChecksumTx=\fR
.RS 4
Takes a boolean\&. When true, skip UDP checksum calculation for transmitted packets over IPv6\&.
.RE
.PP
\fIUDP6ZeroChecksumRx=\fR
.RS 4
Takes a boolean\&. When true, allows incoming UDP packets over IPv6 with zero checksum field\&.
.RE
.SH "[L2TPSESSION] SECTION OPTIONS"
.PP
The [L2TPSession] section only applies for netdevs of kind
"l2tp", and accepts the following keys:
.PP
\fIName=\fR
.RS 4
Specifies the name of the session\&. This setting is compulsory\&.
.RE
.PP
\fISessionId=\fR
.RS 4
Specifies the session identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the
"SessionId="
value being used at the peer\&. This setting is compulsory\&.
.RE
.PP
\fIPeerSessionId=\fR
.RS 4
Specifies the peer session identifier\&. Takes an number in the range 1\&...4294967295\&. The value used must match the
"PeerSessionId="
value being used at the peer\&. This setting is compulsory\&.
.RE
.PP
\fILayer2SpecificHeader=\fR
.RS 4
Specifies layer2specific header type of the session\&. One of
"none"
or
"default"\&. Defaults to
"default"\&.
.RE
.SH "[MACSEC] SECTION OPTIONS"
.PP
The [MACsec] section only applies for network devices of kind
"macsec", and accepts the following keys:
.PP
\fIPort=\fR
.RS 4
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\&.
.RE
.PP
\fIEncrypt=\fR
.RS 4
Takes a boolean\&. When true, enable encryption\&. Defaults to unset\&.
.RE
.SH "[MACSECRECEIVECHANNEL] SECTION OPTIONS"
.PP
The [MACsecReceiveChannel] section only applies for network devices of kind
"macsec", and accepts the following keys:
.PP
\fIPort=\fR
.RS 4
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\&.
.RE
.PP
\fIMACAddress=\fR
.RS 4
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\&.
.RE
.SH "[MACSECTRANSMITASSOCIATION] SECTION OPTIONS"
.PP
The [MACsecTransmitAssociation] section only applies for network devices of kind
"macsec", and accepts the following keys:
.PP
\fIPacketNumber=\fR
.RS 4
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\&.
.RE
.PP
\fIKeyId=\fR
.RS 4
Specifies the identification for the key\&. Takes a number between 0\-255\&. This option is compulsory, and is not set by default\&.
.RE
.PP
\fIKey=\fR
.RS 4
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
"dffafc8d7b9a43d5b9a3dfbbf6a30c16"\&.
.RE
.PP
\fIKeyFile=\fR
.RS 4
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,
\fIKey=\fR
is ignored\&. Note that the file must be readable by the user
"systemd\-network", so it should be, e\&.g\&., owned by
"root:systemd\-network"
with a
"0640"
file mode\&. If the path refers to an
\fBAF_UNIX\fR
stream socket in the file system a connection is made to it and the key read from it\&.
.RE
.PP
\fIActivate=\fR
.RS 4
Takes a boolean\&. If enabled, then the security association is activated\&. Defaults to unset\&.
.RE
.PP
\fIUseForEncoding=\fR
.RS 4
Takes a boolean\&. If enabled, then the security association is used for encoding\&. Only one [MACsecTransmitAssociation] section can enable this option\&. When enabled,
\fIActivate=yes\fR
is implied\&. Defaults to unset\&.
.RE
.SH "[MACSECRECEIVEASSOCIATION] SECTION OPTIONS"
.PP
The [MACsecReceiveAssociation] section only applies for network devices of kind
"macsec", and accepts the following keys:
.PP
\fIPort=\fR
.RS 4
Accepts the same key as in [MACsecReceiveChannel] section\&.
.RE
.PP
\fIMACAddress=\fR
.RS 4
Accepts the same key as in [MACsecReceiveChannel] section\&.
.RE
.PP
\fIPacketNumber=\fR
.RS 4
Accepts the same key as in [MACsecTransmitAssociation] section\&.
.RE
.PP
\fIKeyId=\fR
.RS 4
Accepts the same key as in [MACsecTransmitAssociation] section\&.
.RE
.PP
\fIKey=\fR
.RS 4
Accepts the same key as in [MACsecTransmitAssociation] section\&.
.RE
.PP
\fIKeyFile=\fR
.RS 4
Accepts the same key as in [MACsecTransmitAssociation] section\&.
.RE
.PP
\fIActivate=\fR
.RS 4
Accepts the same key as in [MACsecTransmitAssociation] section\&.
.RE
.SH "[TUNNEL] SECTION OPTIONS"
.PP
The [Tunnel] section only applies for netdevs of kind
"ipip",
"sit",
"gre",
"gretap",
"ip6gre",
"ip6gretap",
"vti",
"vti6",
"ip6tnl", and
"erspan"
and accepts the following keys:
.PP
\fIExternal=\fR
.RS 4
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
\fILocal=\fR
or
\fIRemote=\fR
are ignored\&. This implies
\fIIndependent=\fR\&. Defaults to false\&.
.RE
.PP
\fILocal=\fR
.RS 4
A static local address for tunneled packets\&. It must be an address on another interface of this host, or one of the special values
"any",
"ipv4_link_local",
"ipv6_link_local",
"dhcp4",
"dhcp6", and
"slaac"\&. If one of the special values except for
"any"
is specified, an address which matches the corresponding type on the underlying interface will be used\&. Defaults to
"any"\&.
.RE
.PP
\fIRemote=\fR
.RS 4
The remote endpoint of the tunnel\&. Takes an IP address or the special value
"any"\&.
.RE
.PP
\fITOS=\fR
.RS 4
The Type Of Service byte value for a tunnel interface\&. For details about the TOS, see the
\m[blue]\fBType of Service in the Internet Protocol Suite\fR\m[]\&\s-2\u[10]\d\s+2
document\&.
.RE
.PP
\fITTL=\fR
.RS 4
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\&.
.RE
.PP
\fIDiscoverPathMTU=\fR
.RS 4
Takes a boolean\&. When true, enables Path MTU Discovery on the tunnel\&. When
\fIIgnoreDontFragment=\fR
is enabled, defaults to false\&. Otherwise, defaults to true\&.
.RE
.PP
\fIIgnoreDontFragment=\fR
.RS 4
Takes a boolean\&. When true, enables IPv4 Don\*(Aqt Fragment (DF) suppression on the tunnel\&. Defaults to false\&. Note that if
\fIIgnoreDontFragment=\fR
is set to true,
\fIDiscoverPathMTU=\fR
cannot be set to true\&. Only applicable to GRE, GRETAP, and ERSPAN tunnels\&.
.RE
.PP
\fIIPv6FlowLabel=\fR
.RS 4
Configures the 20\-bit flow label (see
\m[blue]\fBRFC 6437\fR\m[]\&\s-2\u[11]\d\s+2) field in the IPv6 header (see
\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
"inherit", in which case the original flowlabel is used\&.
.RE
.PP
\fICopyDSCP=\fR
.RS 4
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
"no"\&.
.RE
.PP
\fIEncapsulationLimit=\fR
.RS 4
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
\m[blue]\fBRFC 2473\fR\m[]\&\s-2\u[13]\d\s+2)\&. The valid range is 0\&...255 and
"none"\&. Defaults to 4\&.
.RE
.PP
\fIKey=\fR
.RS 4
The
\fIKey=\fR
parameter specifies the same key to use in both directions (\fIInputKey=\fR
and
\fIOutputKey=\fR)\&. The
\fIKey=\fR
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
\m[blue]\fBip\-xfrm \(em transform configuration\fR\m[]\&\s-2\u[14]\d\s+2
for details\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&.
.RE
.PP
\fIInputKey=\fR
.RS 4
The
\fIInputKey=\fR
parameter specifies the key to use for input\&. The format is same as
\fIKey=\fR\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&.
.RE
.PP
\fIOutputKey=\fR
.RS 4
The
\fIOutputKey=\fR
parameter specifies the key to use for output\&. The format is same as
\fIKey=\fR\&. It is only used for VTI/VTI6, GRE, GRETAP, and ERSPAN tunnels\&.
.RE
.PP
\fIMode=\fR
.RS 4
An
"ip6tnl"
tunnel can be in one of three modes
"ip6ip6"
for IPv6 over IPv6,
"ipip6"
for IPv4 over IPv6 or
"any"
for either\&.
.RE
.PP
\fIIndependent=\fR
.RS 4
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
\fITunnel=\fR
is required for the tunnel to be created\&. When true, the tunnel is created independently of any network as "tunnel@NONE"\&.
.RE
.PP
\fIAssignToLoopback=\fR
.RS 4
Takes a boolean\&. If set to
"yes", the loopback interface
"lo"
is used as the underlying device of the tunnel interface\&. Defaults to
"no"\&.
.RE
.PP
\fIAllowLocalRemote=\fR
.RS 4
Takes a boolean\&. When true allows tunnel traffic on
\fIip6tnl\fR
devices where the remote endpoint is a local host address\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIFooOverUDP=\fR
.RS 4
Takes a boolean\&. Specifies whether
\fIFooOverUDP=\fR
tunnel is to be configured\&. Defaults to false\&. This takes effects only for IPIP, SIT, GRE, and GRETAP tunnels\&. For more detail information see
\m[blue]\fBFoo over UDP\fR\m[]\&\s-2\u[15]\d\s+2
.RE
.PP
\fIFOUDestinationPort=\fR
.RS 4
This setting specifies the UDP destination port for encapsulation\&. This field is mandatory when
\fIFooOverUDP=yes\fR, and is not set by default\&.
.RE
.PP
\fIFOUSourcePort=\fR
.RS 4
This setting specifies the UDP source port for encapsulation\&. Defaults to
\fB0\fR
\(em that is, the source port for packets is left to the network stack to decide\&.
.RE
.PP
\fIEncapsulation=\fR
.RS 4
Accepts the same key as in the [FooOverUDP] section\&.
.RE
.PP
\fIIPv6RapidDeploymentPrefix=\fR
.RS 4
Reconfigure the tunnel for
\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\&.
.RE
.PP
\fIISATAP=\fR
.RS 4
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\&.
.RE
.PP
\fISerializeTunneledPackets=\fR
.RS 4
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\&.
.RE
.PP
\fIERSPANVersion=\fR
.RS 4
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\&.
.RE
.PP
\fIERSPANIndex=\fR
.RS 4
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
\fIERSPANVersion=1\fR\&. Defaults to 0\&.
.RE
.PP
\fIERSPANDirection=\fR
.RS 4
Specifies the ERSPAN v2 mirrored traffic\*(Aqs direction\&. Takes
"ingress"
or
"egress"\&. Only used when
\fIERSPANVersion=2\fR\&. Defaults to
"ingress"\&.
.RE
.PP
\fIERSPANHardwareId=\fR
.RS 4
Specifies an unique identifier of the ERSPAN v2 engine\&. Takes an integer in the range 0\&...63\&. Only used when
\fIERSPANVersion=2\fR\&. Defaults to 0\&.
.RE
.SH "[FOOOVERUDP] SECTION OPTIONS"
.PP
The [FooOverUDP] section only applies for netdevs of kind
"fou"
and accepts the following keys:
.PP
\fIEncapsulation=\fR
.RS 4
Specifies the encapsulation mechanism used to store networking packets of various protocols inside the UDP packets\&. Supports the following values:
"FooOverUDP"
provides the simplest no\-frills model of UDP encapsulation, it simply encapsulates packets directly in the UDP payload\&.
"GenericUDPEncapsulation"
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
\m[blue]\fBGeneric UDP Encapsulation\fR\m[]\&\s-2\u[17]\d\s+2\&. Defaults to
"FooOverUDP"\&.
.RE
.PP
\fIPort=\fR
.RS 4
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\&.
.RE
.PP
\fIPeerPort=\fR
.RS 4
Specifies the peer port number\&. Defaults to unset\&. Note that when peer port is set
"Peer="
address is mandatory\&.
.RE
.PP
\fIProtocol=\fR
.RS 4
The
\fIProtocol=\fR
specifies the protocol number of the packets arriving at the UDP port\&. When
\fIEncapsulation=FooOverUDP\fR, this field is mandatory and is not set by default\&. Takes an IP protocol name such as
"gre"
or
"ipip", or an integer within the range 1\&...255\&. When
\fIEncapsulation=GenericUDPEncapsulation\fR, this must not be specified\&.
.RE
.PP
\fIPeer=\fR
.RS 4
Configures peer IP address\&. Note that when peer address is set
"PeerPort="
is mandatory\&.
.RE
.PP
\fILocal=\fR
.RS 4
Configures local IP address\&.
.RE
.SH "[PEER] SECTION OPTIONS"
.PP
The [Peer] section only applies for netdevs of kind
"veth"
and accepts the following keys:
.PP
\fIName=\fR
.RS 4
The interface name used when creating the netdev\&. This setting is compulsory\&.
.RE
.PP
\fIMACAddress=\fR
.RS 4
The peer MACAddress, if not set, it is generated in the same way as the MAC address of the main interface\&.
.RE
.SH "[VXCAN] SECTION OPTIONS"
.PP
The [VXCAN] section only applies for netdevs of kind
"vxcan"
and accepts the following key:
.PP
\fIPeer=\fR
.RS 4
The peer interface name used when creating the netdev\&. This setting is compulsory\&.
.RE
.SH "[TUN] SECTION OPTIONS"
.PP
The [Tun] section only applies for netdevs of kind
"tun", and accepts the following keys:
.PP
\fIMultiQueue=\fR
.RS 4
Takes a boolean\&. Configures whether to use multiple file descriptors (queues) to parallelize packets sending and receiving\&. Defaults to
"no"\&.
.RE
.PP
\fIPacketInfo=\fR
.RS 4
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
"no"\&.
.RE
.PP
\fIVNetHeader=\fR
.RS 4
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
"no"\&.
.RE
.PP
\fIUser=\fR
.RS 4
User to grant access to the
/dev/net/tun
device\&.
.RE
.PP
\fIGroup=\fR
.RS 4
Group to grant access to the
/dev/net/tun
device\&.
.RE
.PP
\fIKeepCarrier=\fR
.RS 4
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
"no"\&.
.RE
.SH "[TAP] SECTION OPTIONS"
.PP
The [Tap] section only applies for netdevs of kind
"tap", and accepts the same keys as the [Tun] section\&.
.SH "[WIREGUARD] SECTION OPTIONS"
.PP
The [WireGuard] section accepts the following keys:
.PP
\fIPrivateKey=\fR
.RS 4
The Base64 encoded private key for the interface\&. It can be generated using the
\fBwg genkey\fR
command (see
\fBwg\fR(8))\&. This option or
\fIPrivateKeyFile=\fR
is mandatory to use WireGuard\&. Note that because this information is secret, you may want to set the permissions of the \&.netdev file to be owned by
"root:systemd\-network"
with a
"0640"
file mode\&.
.RE
.PP
\fIPrivateKeyFile=\fR
.RS 4
Takes an absolute path to a file which contains the Base64 encoded private key for the interface\&. When this option is specified, then
\fIPrivateKey=\fR
is ignored\&. Note that the file must be readable by the user
"systemd\-network", so it should be, e\&.g\&., owned by
"root:systemd\-network"
with a
"0640"
file mode\&. If the path refers to an
\fBAF_UNIX\fR
stream socket in the file system a connection is made to it and the key read from it\&.
.RE
.PP
\fIListenPort=\fR
.RS 4
Sets UDP port for listening\&. Takes either value between 1 and 65535 or
"auto"\&. If
"auto"
is specified, the port is automatically generated based on interface name\&. Defaults to
"auto"\&.
.RE
.PP
\fIFirewallMark=\fR
.RS 4
Sets a firewall mark on outgoing WireGuard packets from this interface\&. Takes a number between 1 and 4294967295\&.
.RE
.PP
\fIRouteTable=\fR
.RS 4
The table identifier for the routes to the addresses specified in the
\fIAllowedIPs=\fR\&. Takes a negative boolean value, one of the predefined names
"default",
"main", and
"local", names defined in
\fIRouteTable=\fR
in
\fBnetworkd.conf\fR(5), or a number in the range 1\&...4294967295\&. When
"off"
the routes to the addresses specified in the
\fIAllowedIPs=\fR
setting will not be configured\&. Defaults to false\&. This setting will be ignored when the same setting is specified in the [WireGuardPeer] section\&.
.RE
.PP
\fIRouteMetric=\fR
.RS 4
The priority of the routes to the addresses specified in the
\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\&.
.RE
.SH "[WIREGUARDPEER] SECTION OPTIONS"
.PP
The [WireGuardPeer] section accepts the following keys:
.PP
\fIPublicKey=\fR
.RS 4
Sets a Base64 encoded public key calculated by
\fBwg pubkey\fR
(see
\fBwg\fR(8)) from a private key, and usually transmitted out of band to the author of the configuration file\&. This option is mandatory for this section\&.
.RE
.PP
\fIPresharedKey=\fR
.RS 4
Optional preshared key for the interface\&. It can be generated by the
\fBwg genpsk\fR
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\&. Note that because this information is secret, you may want to set the permissions of the \&.netdev file to be owned by
"root:systemd\-network"
with a
"0640"
file mode\&.
.RE
.PP
\fIPresharedKeyFile=\fR
.RS 4
Takes an absolute path to a file which contains the Base64 encoded preshared key for the peer\&. When this option is specified, then
\fIPresharedKey=\fR
is ignored\&. Note that the file must be readable by the user
"systemd\-network", so it should be, e\&.g\&., owned by
"root:systemd\-network"
with a
"0640"
file mode\&. If the path refers to an
\fBAF_UNIX\fR
stream socket in the file system a connection is made to it and the key read from it\&.
.RE
.PP
\fIAllowedIPs=\fR
.RS 4
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\&.
.sp
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\&.
.sp
Note that this only affects
\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
"[Routes]"
section on the
"\&.network"
matching the wireguard interface, or externally to
systemd\-networkd\&.
.RE
.PP
\fIEndpoint=\fR
.RS 4
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,
"111\&.222\&.333\&.444:51820"
for IPv4 and
"[1111:2222::3333]:51820"
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\&.
.RE
.PP
\fIPersistentKeepalive=\fR
.RS 4
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\&.
.RE
.PP
\fIRouteTable=\fR
.RS 4
The table identifier for the routes to the addresses specified in the
\fIAllowedIPs=\fR\&. Takes a negative boolean value, one of the predefined names
"default",
"main", and
"local", names defined in
\fIRouteTable=\fR
in
\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\&.
.RE
.PP
\fIRouteMetric=\fR
.RS 4
The priority of the routes to the addresses specified in the
\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\&.
.RE
.SH "[BOND] SECTION OPTIONS"
.PP
The [Bond] section accepts the following key:
.PP
\fIMode=\fR
.RS 4
Specifies one of the bonding policies\&. The default is
"balance\-rr"
(round robin)\&. Possible values are
"balance\-rr",
"active\-backup",
"balance\-xor",
"broadcast",
"802\&.3ad",
"balance\-tlb", and
"balance\-alb"\&.
.RE
.PP
\fITransmitHashPolicy=\fR
.RS 4
Selects the transmit hash policy to use for slave selection in balance\-xor, 802\&.3ad, and tlb modes\&. Possible values are
"layer2",
"layer3+4",
"layer2+3",
"encap2+3", and
"encap3+4"\&.
.RE
.PP
\fILACPTransmitRate=\fR
.RS 4
Specifies the rate with which link partner transmits Link Aggregation Control Protocol Data Unit packets in 802\&.3ad mode\&. Possible values are
"slow", which requests partner to transmit LACPDUs every 30 seconds, and
"fast", which requests partner to transmit LACPDUs every second\&. The default value is
"slow"\&.
.RE
.PP
\fIMIIMonitorSec=\fR
.RS 4
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\&.
.RE
.PP
\fIUpDelaySec=\fR
.RS 4
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
\fIMIIMonitorSec=\fR\&. The default value is 0\&.
.RE
.PP
\fIDownDelaySec=\fR
.RS 4
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
\fIMIIMonitorSec=\fR\&. The default value is 0\&.
.RE
.PP
\fILearnPacketIntervalSec=\fR
.RS 4
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\&.
.RE
.PP
\fIAdSelect=\fR
.RS 4
Specifies the 802\&.3ad aggregation selection logic to use\&. Possible values are
"stable",
"bandwidth"
and
"count"\&.
.RE
.PP
\fIAdActorSystemPriority=\fR
.RS 4
Specifies the 802\&.3ad actor system priority\&. Takes a number in the range 1\&...65535\&.
.RE
.PP
\fIAdUserPortKey=\fR
.RS 4
Specifies the 802\&.3ad user defined portion of the port key\&. Takes a number in the range 0\&...1023\&.
.RE
.PP
\fIAdActorSystem=\fR
.RS 4
Specifies the 802\&.3ad system MAC address\&. This cannot be a null or multicast address\&.
.RE
.PP
\fIFailOverMACPolicy=\fR
.RS 4
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
"none",
"active"
and
"follow"\&.
.RE
.PP
\fIARPValidate=\fR
.RS 4
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
"none",
"active",
"backup"
and
"all"\&.
.RE
.PP
\fIARPIntervalSec=\fR
.RS 4
Specifies the ARP link monitoring frequency\&. A value of 0 disables ARP monitoring\&. The default value is 0, and the default unit seconds\&.
.RE
.PP
\fIARPIPTargets=\fR
.RS 4
Specifies the IP addresses to use as ARP monitoring peers when
\fIARPIntervalSec=\fR
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\&.
.RE
.PP
\fIARPAllTargets=\fR
.RS 4
Specifies the quantity of
\fIARPIPTargets=\fR
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
"any"
and
"all"\&.
.RE
.PP
\fIPrimaryReselectPolicy=\fR
.RS 4
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
"always",
"better"
and
"failure"\&.
.RE
.PP
\fIResendIGMP=\fR
.RS 4
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\&.
.RE
.PP
\fIPacketsPerSlave=\fR
.RS 4
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\&.
.RE
.PP
\fIGratuitousARP=\fR
.RS 4
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\&.
.RE
.PP
\fIAllSlavesActive=\fR
.RS 4
Takes a boolean\&. Specifies that duplicate frames (received on inactive ports) should be dropped when false, or delivered when true\&. Normally, bonding will drop duplicate frames (received on inactive ports), which is desirable for most users\&. But there are some times it is nice to allow duplicate frames to be delivered\&. The default value is false (drop duplicate frames received on inactive ports)\&.
.RE
.PP
\fIDynamicTransmitLoadBalancing=\fR
.RS 4
Takes a boolean\&. Specifies if dynamic shuffling of flows is enabled\&. Applies only for balance\-tlb mode\&. Defaults to unset\&.
.RE
.PP
\fIMinLinks=\fR
.RS 4
Specifies the minimum number of links that must be active before asserting carrier\&. The default value is 0\&.
.RE
.PP
For more detail information see
\m[blue]\fBLinux Ethernet Bonding Driver HOWTO\fR\m[]\&\s-2\u[1]\d\s+2
.SH "[XFRM] SECTION OPTIONS"
.PP
The [Xfrm] section accepts the following keys:
.PP
\fIInterfaceId=\fR
.RS 4
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\&.
.RE
.PP
\fIIndependent=\fR
.RS 4
Takes a boolean\&. If false (the default), the xfrm interface must have an underlying device which can be used for hardware offloading\&.
.RE
.PP
For more detail information see
\m[blue]\fBVirtual XFRM Interfaces\fR\m[]\&\s-2\u[18]\d\s+2\&.
.SH "[VRF] SECTION OPTIONS"
.PP
The [VRF] section only applies for netdevs of kind
"vrf"
and accepts the following key:
.PP
\fITable=\fR
.RS 4
The numeric routing table identifier\&. This setting is compulsory\&.
.RE
.SH "[BATMANADVANCED] SECTION OPTIONS"
.PP
The [BatmanAdvanced] section only applies for netdevs of kind
"batadv"
and accepts the following keys:
.PP
\fIGatewayMode=\fR
.RS 4
Takes one of
"off",
"server", or
"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)\&.
.RE
.PP
\fIAggregation=\fR
.RS 4
Takes a boolean value\&. Enables or disables aggregation of originator messages\&. Defaults to true\&.
.RE
.PP
\fIBridgeLoopAvoidance=\fR
.RS 4
Takes a boolean value\&. Enables or disables avoidance of loops on bridges\&. Defaults to true\&.
.RE
.PP
\fIDistributedArpTable=\fR
.RS 4
Takes a boolean value\&. Enables or disables the distributed ARP table\&. Defaults to true\&.
.RE
.PP
\fIFragmentation=\fR
.RS 4
Takes a boolean value\&. Enables or disables fragmentation\&. Defaults to true\&.
.RE
.PP
\fIHopPenalty=\fR
.RS 4
The hop penalty setting allows one to modify
\fBbatctl\fR(8)
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\&.
.RE
.PP
\fIOriginatorIntervalSec=\fR
.RS 4
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
\fBsystemd.time\fR(7)
for more information\&.
.RE
.PP
\fIGatewayBandwidthDown=\fR
.RS 4
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\&.
.RE
.PP
\fIGatewayBandwidthUp=\fR
.RS 4
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\&.
.RE
.PP
\fIRoutingAlgorithm=\fR
.RS 4
This can be either
"batman\-v"
or
"batman\-iv"
and describes which routing_algo of
\fBbatctl\fR(8)
to use\&. The algorithm cannot be changed after interface creation\&. Defaults to
"batman\-v"\&.
.RE
.SH "[IPOIB] SECTION OPTIONS"
.PP
The [IPoIB] section only applies for netdevs of kind
"ipoib"
and accepts the following keys:
.PP
\fIPartitionKey=\fR
.RS 4
Takes an integer in the range 1\&...0xffff, except for 0x8000\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
.RE
.PP
\fIMode=\fR
.RS 4
Takes one of the special values
"datagram"
or
"connected"\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
.sp
When
"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\&.
.sp
When
"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\&.
.RE
.PP
\fIIgnoreUserspaceMulticastGroup=\fR
.RS 4
Takes an boolean value\&. When true, the kernel ignores multicast groups handled by userspace\&. Defaults to unset, and the kernel\*(Aqs default is used\&.
.RE
.SH "[WLAN] SECTION OPTIONS"
.PP
The [WLAN] section only applies to WLAN interfaces, and accepts the following keys:
.PP
\fIPhysicalDevice=\fR
.RS 4
Specifies the name or index of the physical WLAN device (e\&.g\&.
"0"
or
"phy0")\&. The list of the physical WLAN devices that exist on the host can be obtained by
\fBiw phy\fR
command\&. This option is mandatory\&.
.RE
.PP
\fIType=\fR
.RS 4
Specifies the type of the interface\&. Takes one of the
"ad\-hoc",
"station",
"ap",
"ap\-vlan",
"wds",
"monitor",
"mesh\-point",
"p2p\-client",
"p2p\-go",
"p2p\-device",
"ocb", and
"nan"\&. This option is mandatory\&.
.RE
.PP
\fIWDS=\fR
.RS 4
Enables the Wireless Distribution System (WDS) mode on the interface\&. The mode is also known as the
"4 address mode"\&. Takes a boolean value\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
.RE
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&/etc/systemd/network/25\-bridge\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=bridge0
Kind=bridge
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&/etc/systemd/network/25\-vlan1\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[Match]
Virtualization=no

[NetDev]
Name=vlan1
Kind=vlan

[VLAN]
Id=1
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&3.\ \&/etc/systemd/network/25\-ipip\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=ipip\-tun
Kind=ipip
MTUBytes=1480

[Tunnel]
Local=192\&.168\&.223\&.238
Remote=192\&.169\&.224\&.239
TTL=64
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&4.\ \&/etc/systemd/network/1\-fou\-tunnel\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=fou\-tun
Kind=fou

[FooOverUDP]
Port=5555
Protocol=4
      
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&5.\ \&/etc/systemd/network/25\-fou\-ipip\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=ipip\-tun
Kind=ipip

[Tunnel]
Independent=yes
Local=10\&.65\&.208\&.212
Remote=10\&.65\&.208\&.211
FooOverUDP=yes
FOUDestinationPort=5555
      
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&6.\ \&/etc/systemd/network/25\-tap\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=tap\-test
Kind=tap

[Tap]
MultiQueue=yes
PacketInfo=yes
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&7.\ \&/etc/systemd/network/25\-sit\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=sit\-tun
Kind=sit
MTUBytes=1480

[Tunnel]
Local=10\&.65\&.223\&.238
Remote=10\&.65\&.223\&.239
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&8.\ \&/etc/systemd/network/25\-6rd\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=6rd\-tun
Kind=sit
MTUBytes=1480

[Tunnel]
Local=10\&.65\&.223\&.238
IPv6RapidDeploymentPrefix=2602::/24
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&9.\ \&/etc/systemd/network/25\-gre\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=gre\-tun
Kind=gre
MTUBytes=1480

[Tunnel]
Local=10\&.65\&.223\&.238
Remote=10\&.65\&.223\&.239
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&10.\ \&/etc/systemd/network/25\-ip6gre\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=ip6gre\-tun
Kind=ip6gre

[Tunnel]
Key=123
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&11.\ \&/etc/systemd/network/25\-vti\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=vti\-tun
Kind=vti
MTUBytes=1480

[Tunnel]
Local=10\&.65\&.223\&.238
Remote=10\&.65\&.223\&.239
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&12.\ \&/etc/systemd/network/25\-veth\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=veth\-test
Kind=veth

[Peer]
Name=veth\-peer
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&13.\ \&/etc/systemd/network/25\-bond\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=bond1
Kind=bond

[Bond]
Mode=802\&.3ad
TransmitHashPolicy=layer3+4
MIIMonitorSec=1s
LACPTransmitRate=fast
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&14.\ \&/etc/systemd/network/25\-dummy\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=dummy\-test
Kind=dummy
MACAddress=12:34:56:78:9a:bc
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&15.\ \&/etc/systemd/network/25\-vrf\&.netdev\fR
.PP
Create a VRF interface with table 42\&.
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=vrf\-test
Kind=vrf

[VRF]
Table=42
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&16.\ \&/etc/systemd/network/25\-macvtap\&.netdev\fR
.PP
Create a MacVTap device\&.
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=macvtap\-test
Kind=macvtap
      
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&17.\ \&/etc/systemd/network/25\-wireguard\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=wg0
Kind=wireguard

[WireGuard]
PrivateKey=EEGlnEPYJV//kbvvIqxKkQwOiS+UENyPncC4bF46ong=
ListenPort=51820

[WireGuardPeer]
PublicKey=RDf+LSpeEre7YEIKaxg+wbpsNV7du+ktR99uBEtIiCA=
AllowedIPs=fd31:bf08:57cb::/48,192\&.168\&.26\&.0/24
Endpoint=wireguard\&.example\&.com:51820
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&18.\ \&/etc/systemd/network/27\-xfrm\&.netdev\fR
.sp
.if n \{\
.RS 4
.\}
.nf
[NetDev]
Name=xfrm0
Kind=xfrm

[Xfrm]
Independent=yes
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsystemd-networkd\fR(8),
\fBsystemd.link\fR(5),
\fBsystemd.network\fR(5),
\fBsystemd-network-generator.service\fR(8)
.SH "NOTES"
.IP " 1." 4
Linux Ethernet Bonding Driver HOWTO
.RS 4
\%https://docs.kernel.org/networking/bonding.html
.RE
.IP " 2." 4
RFC 2784
.RS 4
\%https://tools.ietf.org/html/rfc2784
.RE
.IP " 3." 4
IEEE 802.1Q
.RS 4
\%http://www.ieee802.org/1/pages/802.1Q.html
.RE
.IP " 4." 4
VRF
.RS 4
\%https://docs.kernel.org/networking/vrf.html
.RE
.IP " 5." 4
B.A.T.M.A.N. Advanced
.RS 4
\%https://www.open-mesh.org/projects/open-mesh/wiki
.RE
.IP " 6." 4
System and Service Credentials
.RS 4
\%https://systemd.io/CREDENTIALS
.RE
.IP " 7." 4
(DOVE)
.RS 4
\%https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet
.RE
.IP " 8." 4
VXLAN Group Policy
.RS 4
\%https://tools.ietf.org/html/draft-smith-vxlan-group-policy
.RE
.IP " 9." 4
Generic Protocol Extension for VXLAN
.RS 4
\%https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-07
.RE
.IP "10." 4
Type of Service in the Internet Protocol Suite
.RS 4
\%http://tools.ietf.org/html/rfc1349
.RE
.IP "11." 4
RFC 6437
.RS 4
\%https://tools.ietf.org/html/rfc6437
.RE
.IP "12." 4
RFC 2460
.RS 4
\%https://tools.ietf.org/html/rfc2460
.RE
.IP "13." 4
RFC 2473
.RS 4
\%https://tools.ietf.org/html/rfc2473#section-4.1.1
.RE
.IP "14." 4
ip-xfrm \(em transform configuration
.RS 4
\%https://man7.org/linux/man-pages/man8/ip-xfrm.8.html
.RE
.IP "15." 4
Foo over UDP
.RS 4
\%https://lwn.net/Articles/614348
.RE
.IP "16." 4
IPv6 Rapid Deployment
.RS 4
\%https://tools.ietf.org/html/rfc5569
.RE
.IP "17." 4
Generic UDP Encapsulation
.RS 4
\%https://lwn.net/Articles/615044
.RE
.IP "18." 4
Virtual XFRM Interfaces
.RS 4
\%https://lwn.net/Articles/757391
.RE