summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man5/systemd.link.5
blob: c4da47e49e27ab86ae79f04d484ffe4f4011e327 (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
'\" t
.TH "SYSTEMD\&.LINK" "5" "" "systemd 254" "systemd.link"
.\" -----------------------------------------------------------------
.\" * 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.link \- Network device configuration
.SH "SYNOPSIS"
.PP
\fIlink\fR\&.link
.SH "DESCRIPTION"
.PP
A plain ini\-style text file that encodes configuration for matching network devices, used by
\fBsystemd-udevd\fR(8)
and in particular its
\fBnet_setup_link\fR
builtin\&. See
\fBsystemd.syntax\fR(7)
for a general description of the syntax\&.
.PP
The
\&.link
files are read from the files located in the system network directory
/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\-eth0\&.link)\&. Otherwise, the default
\&.link
files or those 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
/lib/\&. This can be used to override a system\-supplied link 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 link file
foo\&.link, a "drop\-in" directory
foo\&.link\&.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
/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
/lib/\&. Drop\-in files under any of these directories take precedence over the main link file wherever located\&.
.PP
The link file contains a [Match] section, which determines if a given link file may be applied to a given device, as well as a [Link] section specifying how the device should be configured\&. The first (in lexical order) of the link files that matches a given device is applied\&. Note that a default file
99\-default\&.link
is shipped by the system\&. Any user\-supplied
\&.link
should hence have a lexically earlier name to be considered at all\&.
.PP
See
\fBudevadm\fR(8)
for diagnosing problems with
\&.link
files\&.
.SH "[MATCH] SECTION OPTIONS"
.PP
A link file is said to match an interface if all matches specified by the [Match] section are satisfied\&. When a link file does not contain valid settings in [Match] section, then the file will match all interfaces and
\fBsystemd\-udevd\fR
warns about that\&. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following:
.sp
.if n \{\
.RS 4
.\}
.nf
OriginalName=*
.fi
.if n \{\
.RE
.\}
.sp
The first (in alphanumeric order) of the link files that matches a given interface is applied, all later files are ignored, even if they match as well\&. The following keys are accepted:
.PP
\fIMACAddress=\fR
.RS 4
A whitespace\-separated list of hardware addresses\&. The acceptable formats are:
.PP
\fBcolon\-delimited hexadecimal\fR
.RS 4
Each field must be one byte\&. E\&.g\&.
"12:34:56:78:90:ab"
or
"AA:BB:CC:DD:EE:FF"\&.
.RE
.PP
\fBhyphen\-delimited hexadecimal\fR
.RS 4
Each field must be one byte\&. E\&.g\&.
"12\-34\-56\-78\-90\-ab"
or
"AA\-BB\-CC\-DD\-EE\-FF"\&.
.RE
.PP
\fBdot\-delimited hexadecimal\fR
.RS 4
Each field must be two bytes\&. E\&.g\&.
"1234\&.5678\&.90ab"
or
"AABB\&.CCDD\&.EEFF"\&.
.RE
.PP
\fBIPv4 address format\fR
.RS 4
E\&.g\&.
"127\&.0\&.0\&.1"
or
"192\&.168\&.0\&.1"\&.
.RE
.PP
\fBIPv6 address format\fR
.RS 4
E\&.g\&.
"2001:0db8:85a3::8a2e:0370:7334"
or
"::1"\&.
.RE
.sp
The total length of each MAC address must be 4 (for IPv4 tunnel), 6 (for Ethernet), 16 (for IPv6 tunnel), or 20 (for InfiniBand)\&. 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
\fIPermanentMACAddress=\fR
.RS 4
A whitespace\-separated list of hardware\*(Aqs permanent addresses\&. While
\fIMACAddress=\fR
matches the device\*(Aqs current MAC address, this matches the device\*(Aqs permanent MAC address, which may be different from the current one\&. Use full colon\-, hyphen\- or dot\-delimited hexadecimal, or IPv4 or IPv6 address format\&. 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
\fIPath=\fR
.RS 4
A whitespace\-separated list of shell\-style globs matching the persistent path, as exposed by the udev property
\fIID_PATH\fR\&.
.RE
.PP
\fIDriver=\fR
.RS 4
A whitespace\-separated list of shell\-style globs matching the driver currently bound to the device, as exposed by the udev property
\fIID_NET_DRIVER\fR
of its parent device, or if that is not set, the driver as exposed by
\fBethtool \-i\fR
of the device itself\&. If the list is prefixed with a "!", the test is inverted\&.
.RE
.PP
\fIType=\fR
.RS 4
A whitespace\-separated list of shell\-style globs matching the device type, as exposed by
\fBnetworkctl list\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
"ether",
"loopback",
"wlan",
"wwan"\&. Valid types are named either from the udev
"DEVTYPE"
attribute, or
"ARPHRD_"
macros in
linux/if_arp\&.h, so this is not comprehensive\&.
.RE
.PP
\fIKind=\fR
.RS 4
A whitespace\-separated list of shell\-style globs matching the device kind, as exposed by
\fBnetworkctl status \fR\fB\fIINTERFACE\fR\fR
or
\fBip \-d link show \fR\fB\fIINTERFACE\fR\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
"bond",
"bridge",
"gre",
"tun",
"veth"\&. Valid kinds are given by netlink\*(Aqs
"IFLA_INFO_KIND"
attribute, so this is not comprehensive\&.
.RE
.PP
\fIProperty=\fR
.RS 4
A whitespace\-separated list of udev property names with their values after equals sign ("=")\&. If multiple properties are specified, the test results are ANDed\&. If the list is prefixed with a "!", the test is inverted\&. If a value contains white spaces, then please quote whole key and value pair\&. If a value contains quotation, then please escape the quotation with
"\e"\&.
.sp
Example: if a \&.link file has the following:
.sp
.if n \{\
.RS 4
.\}
.nf
Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \e"quotation\e""
.fi
.if n \{\
.RE
.\}
.sp
then, the \&.link file matches only when an interface has all the above three properties\&.
.RE
.PP
\fIOriginalName=\fR
.RS 4
A whitespace\-separated list of shell\-style globs matching the device name, as exposed by the udev property "INTERFACE"\&. This cannot be used to match on names that have already been changed from userspace\&. Caution is advised when matching on kernel\-assigned names, as they are known to be unstable between reboots\&.
.RE
.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[1]\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 "[LINK] SECTION OPTIONS"
.PP
The [Link] section accepts the following keys:
.PP
\fIDescription=\fR
.RS 4
A description of the device\&.
.RE
.PP
\fIAlias=\fR
.RS 4
The
\fIifalias\fR
interface property is set to this value\&.
.RE
.PP
\fIMACAddressPolicy=\fR
.RS 4
The policy by which the MAC address should be set\&. The available policies are:
.PP
\fBpersistent\fR
.RS 4
If the hardware has a persistent MAC address, as most hardware should, and if it is used by the kernel, nothing is done\&. Otherwise, a new MAC address is generated which is guaranteed to be the same on every boot for the given machine and the given device, but which is otherwise random\&. This feature depends on ID_NET_NAME_* properties to exist for the link\&. On hardware where these properties are not set, the generation of a persistent MAC address will fail\&.
.RE
.PP
\fBrandom\fR
.RS 4
If the kernel is using a random MAC address, nothing is done\&. Otherwise, a new address is randomly generated each time the device appears, typically at boot\&. Either way, the random address will have the
"unicast"
and
"locally administered"
bits set\&.
.RE
.PP
\fBnone\fR
.RS 4
Keeps the MAC address assigned by the kernel\&. Or use the MAC address specified in
\fIMACAddress=\fR\&.
.RE
.sp
An empty string assignment is equivalent to setting
"none"\&.
.RE
.PP
\fIMACAddress=\fR
.RS 4
The interface MAC address to use\&. For this setting to take effect,
\fIMACAddressPolicy=\fR
must either be unset, empty, or
"none"\&.
.RE
.PP
\fINamePolicy=\fR
.RS 4
An ordered, space\-separated list of policies by which the interface name should be set\&.
\fINamePolicy=\fR
may be disabled by specifying
\fBnet\&.ifnames=0\fR
on the kernel command line\&. Each of the policies may fail, and the first successful one is used\&. The name is not set directly, but is exported to udev as the property
\fBID_NET_NAME\fR, which is, by default, used by a
\fBudev\fR(7), rule to set
\fINAME\fR\&. The available policies are:
.PP
\fBkernel\fR
.RS 4
If the kernel claims that the name it has set for a device is predictable, then no renaming is performed\&.
.RE
.PP
\fBdatabase\fR
.RS 4
The name is set based on entries in the udev\*(Aqs Hardware Database with the key
\fIID_NET_NAME_FROM_DATABASE\fR\&.
.RE
.PP
\fBonboard\fR
.RS 4
The name is set based on information given by the firmware for on\-board devices, as exported by the udev property
\fIID_NET_NAME_ONBOARD\fR\&. See
\fBsystemd.net-naming-scheme\fR(7)\&.
.RE
.PP
\fBslot\fR
.RS 4
The name is set based on information given by the firmware for hot\-plug devices, as exported by the udev property
\fIID_NET_NAME_SLOT\fR\&. See
\fBsystemd.net-naming-scheme\fR(7)\&.
.RE
.PP
\fBpath\fR
.RS 4
The name is set based on the device\*(Aqs physical location, as exported by the udev property
\fIID_NET_NAME_PATH\fR\&. See
\fBsystemd.net-naming-scheme\fR(7)\&.
.RE
.PP
\fBmac\fR
.RS 4
The name is set based on the device\*(Aqs persistent MAC address, as exported by the udev property
\fIID_NET_NAME_MAC\fR\&. See
\fBsystemd.net-naming-scheme\fR(7)\&.
.RE
.PP
\fBkeep\fR
.RS 4
If the device already had a name given by userspace (as part of creation of the device or a rename), keep it\&.
.RE
.RE
.PP
\fIName=\fR
.RS 4
The interface name to use\&. This option has lower precedence than
\fINamePolicy=\fR, so for this setting to take effect,
\fINamePolicy=\fR
must either be unset, empty, disabled, or all policies configured there must fail\&. Also see the example below with
"Name=dmz0"\&.
.sp
Note that specifying a name that the kernel might use for another interface (for example
"eth0") is dangerous because the name assignment done by udev will race with the assignment done by the kernel, and only one interface may use the name\&. Depending on the order of operations, either udev or the kernel will win, making the naming unpredictable\&. It is best to use some different prefix, for example
"internal0"/"external0"
or
"lan0"/"lan1"/"lan3"\&.
.sp
Interface names must have a minimum length of 1 character and a maximum length of 15 characters, and may contain any 7bit ASCII character, with the exception of control characters,
":",
"/"
and
"%"\&. While
"\&."
is an allowed character, it\*(Aqs recommended to avoid it when naming interfaces as various tools (such as
\fBresolvconf\fR(1)) use it as separator character\&. Also, fully numeric interface names are not allowed (in order to avoid ambiguity with interface specification by numeric indexes), as are the special strings
"\&.",
"\&.\&.",
"all"
and
"default"\&.
.RE
.PP
\fIAlternativeNamesPolicy=\fR
.RS 4
A space\-separated list of policies by which the interface\*(Aqs alternative names should be set\&. Each of the policies may fail, and all successful policies are used\&. The available policies are
"database",
"onboard",
"slot",
"path", and
"mac"\&. If the kernel does not support the alternative names, then this setting will be ignored\&.
.RE
.PP
\fIAlternativeName=\fR
.RS 4
The alternative interface name to use\&. This option can be specified multiple times\&. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect\&. If the kernel does not support the alternative names, then this setting will be ignored\&.
.sp
Alternative interface names may be used to identify interfaces in various tools\&. In contrast to the primary name (as configured with
\fIName=\fR
above) there may be multiple alternative names referring to the same interface\&. Alternative names may have a maximum length of 127 characters, in contrast to the 15 allowed for the primary interface name, but otherwise are subject to the same naming constraints\&.
.RE
.PP
\fITransmitQueues=\fR
.RS 4
Specifies the device\*(Aqs number of transmit queues\&. An integer in the range 1\&...4096\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIReceiveQueues=\fR
.RS 4
Specifies the device\*(Aqs number of receive queues\&. An integer in the range 1\&...4096\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITransmitQueueLength=\fR
.RS 4
Specifies the transmit queue length of the device in number of packets\&. An unsigned integer in the range 0\&...4294967294\&. When unset, the kernel\*(Aqs default will be used\&.
.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\&.
.RE
.PP
\fIBitsPerSecond=\fR
.RS 4
The speed to set for the device, the value is rounded down to the nearest Mbps\&. The usual suffixes K, M, G are supported and are understood to the base of 1000\&.
.RE
.PP
\fIDuplex=\fR
.RS 4
The duplex mode to set for the device\&. The accepted values are
\fBhalf\fR
and
\fBfull\fR\&.
.RE
.PP
\fIAutoNegotiation=\fR
.RS 4
Takes a boolean\&. If set to yes, automatic negotiation of transmission parameters is enabled\&. Autonegotiation is a procedure by which two connected ethernet devices choose common transmission parameters, such as speed, duplex mode, and flow control\&. When unset, the kernel\*(Aqs default will be used\&.
.sp
Note that if autonegotiation is enabled, speed and duplex settings are read\-only\&. If autonegotiation is disabled, speed and duplex settings are writable if the driver supports multiple link modes\&.
.RE
.PP
\fIWakeOnLan=\fR
.RS 4
The Wake\-on\-LAN policy to set for the device\&. Takes the special value
"off"
which disables Wake\-on\-LAN, or space separated list of the following words:
.PP
\fBphy\fR
.RS 4
Wake on PHY activity\&.
.RE
.PP
\fBunicast\fR
.RS 4
Wake on unicast messages\&.
.RE
.PP
\fBmulticast\fR
.RS 4
Wake on multicast messages\&.
.RE
.PP
\fBbroadcast\fR
.RS 4
Wake on broadcast messages\&.
.RE
.PP
\fBarp\fR
.RS 4
Wake on ARP\&.
.RE
.PP
\fBmagic\fR
.RS 4
Wake on receipt of a magic packet\&.
.RE
.PP
\fBsecureon\fR
.RS 4
Enable SecureOn password for MagicPacket\&. Implied when
\fIWakeOnLanPassword=\fR
is specified\&. If specified without
\fIWakeOnLanPassword=\fR
option, then the password is read from the credential
"\fILINK\fR\&.link\&.wol\&.password"
(e\&.g\&.,
"60\-foo\&.link\&.wol\&.password"), and if the credential not found, then read from
"wol\&.password"\&. See
\fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR
in
\fBsystemd.exec\fR(1)
for details\&. The password in the credential, must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e\&.g\&.,
"aa:bb:cc:dd:ee:ff"\&.
.RE
.sp
Defaults to unset, and the device\*(Aqs default will be used\&. This setting can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
.RE
.PP
\fIWakeOnLanPassword=\fR
.RS 4
Specifies the SecureOn password for MagicPacket\&. Takes an absolute path to a regular file or an
\fBAF_UNIX\fR
stream socket, or the plain password\&. When a path to a regular file is specified, the password is read from it\&. When an
\fBAF_UNIX\fR
stream socket is specified, a connection is made to it and the password is read from it\&. The password must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e\&.g\&.,
"aa:bb:cc:dd:ee:ff"\&. This implies
\fIWakeOnLan=secureon\fR\&. Defaults to unset, and the current value will not be changed\&.
.RE
.PP
\fIPort=\fR
.RS 4
The port option is used to select the device port\&. The supported values are:
.PP
\fBtp\fR
.RS 4
An Ethernet interface using Twisted\-Pair cable as the medium\&.
.RE
.PP
\fBaui\fR
.RS 4
Attachment Unit Interface (AUI)\&. Normally used with hubs\&.
.RE
.PP
\fBbnc\fR
.RS 4
An Ethernet interface using BNC connectors and co\-axial cable\&.
.RE
.PP
\fBmii\fR
.RS 4
An Ethernet interface using a Media Independent Interface (MII)\&.
.RE
.PP
\fBfibre\fR
.RS 4
An Ethernet interface using Optical Fibre as the medium\&.
.RE
.RE
.PP
\fIAdvertise=\fR
.RS 4
This sets what speeds and duplex modes of operation are advertised for auto\-negotiation\&. This implies
"AutoNegotiation=yes"\&. The supported values are:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&Supported advertise values
.TS
allbox tab(:);
lB lB lB.
T{
Advertise
T}:T{
Speed (Mbps)
T}:T{
Duplex Mode
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 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 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
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 l.
T{
\fB10baset\-full\fR
T}:T{
10
T}:T{
full
T}
T{
\fB10baset1l\-full\fR
T}:T{
10
T}:T{
full
T}
T{
\fB10baset\-half\fR
T}:T{
10
T}:T{
half
T}
T{
\fB100basefx\-full\fR
T}:T{
100
T}:T{
full
T}
T{
\fB100baset\-full\fR
T}:T{
100
T}:T{
full
T}
T{
\fB100baset1\-full\fR
T}:T{
100
T}:T{
full
T}
T{
\fB100basefx\-half\fR
T}:T{
100
T}:T{
half
T}
T{
\fB100baset\-half\fR
T}:T{
100
T}:T{
half
T}
T{
\fB1000basekx\-full\fR
T}:T{
1000
T}:T{
full
T}
T{
\fB1000baset\-full\fR
T}:T{
1000
T}:T{
full
T}
T{
\fB1000baset1\-full\fR
T}:T{
1000
T}:T{
full
T}
T{
\fB1000basex\-full\fR
T}:T{
1000
T}:T{
full
T}
T{
\fB1000baset\-half\fR
T}:T{
1000
T}:T{
half
T}
T{
\fB2500baset\-full\fR
T}:T{
2500
T}:T{
full
T}
T{
\fB2500basex\-full\fR
T}:T{
2500
T}:T{
full
T}
T{
\fB5000baset\-full\fR
T}:T{
5000
T}:T{
full
T}
T{
\fB10000baser\-fec\fR
T}:T{
10000
T}:T{
\ \&
T}
T{
\fB10000basecr\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000baseer\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000basekr\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000basekx4\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000baselr\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000baselrm\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000basesr\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB10000baset\-full\fR
T}:T{
10000
T}:T{
full
T}
T{
\fB20000basekr2\-full\fR
T}:T{
20000
T}:T{
full
T}
T{
\fB20000basemld2\-full\fR
T}:T{
20000
T}:T{
full
T}
T{
\fB25000basecr\-full\fR
T}:T{
25000
T}:T{
full
T}
T{
\fB25000basekr\-full\fR
T}:T{
25000
T}:T{
full
T}
T{
\fB25000basesr\-full\fR
T}:T{
25000
T}:T{
full
T}
T{
\fB40000basecr4\-full\fR
T}:T{
40000
T}:T{
full
T}
T{
\fB40000basekr4\-full\fR
T}:T{
40000
T}:T{
full
T}
T{
\fB40000baselr4\-full\fR
T}:T{
40000
T}:T{
full
T}
T{
\fB40000basesr4\-full\fR
T}:T{
40000
T}:T{
full
T}
T{
\fB50000basecr\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000basecr2\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000basedr\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000basekr\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000basekr2\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000baselr\-er\-fr\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000basesr\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB50000basesr2\-full\fR
T}:T{
50000
T}:T{
full
T}
T{
\fB56000basecr4\-full\fR
T}:T{
56000
T}:T{
full
T}
T{
\fB56000basekr4\-full\fR
T}:T{
56000
T}:T{
full
T}
T{
\fB56000baselr4\-full\fR
T}:T{
56000
T}:T{
full
T}
T{
\fB56000basesr4\-full\fR
T}:T{
56000
T}:T{
full
T}
T{
\fB100000basecr\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basecr2\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basecr4\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basedr\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basedr2\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basekr\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basekr2\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basekr4\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000baselr\-er\-fr\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000baselr2\-er2\-fr2\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000baselr4\-er4\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basesr\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basesr2\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB100000basesr4\-full\fR
T}:T{
100000
T}:T{
full
T}
T{
\fB200000basecr2\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basecr4\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basedr2\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basedr4\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basekr2\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basekr4\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000baselr2\-er2\-fr2\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000baselr4\-er4\-fr4\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basesr2\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB200000basesr4\-full\fR
T}:T{
200000
T}:T{
full
T}
T{
\fB400000basecr4\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basecr8\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basedr4\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basedr8\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basekr4\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basekr8\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000baselr4\-er4\-fr4\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000baselr8\-er8\-fr8\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basesr4\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB400000basesr8\-full\fR
T}:T{
400000
T}:T{
full
T}
T{
\fB800000basecr8\-full\fR
T}:T{
800000
T}:T{
full
T}
T{
\fB800000basedr8\-2\-full\fR
T}:T{
800000
T}:T{
full
T}
T{
\fB800000basedr8\-full\fR
T}:T{
800000
T}:T{
full
T}
T{
\fB800000basekr8\-full\fR
T}:T{
800000
T}:T{
full
T}
T{
\fB800000basesr8\-full\fR
T}:T{
800000
T}:T{
full
T}
T{
\fB800000basevr8\-full\fR
T}:T{
800000
T}:T{
full
T}
T{
\fBasym\-pause\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBaui\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBautonegotiation\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBbackplane\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBbnc\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBfec\-baser\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBfec\-llrs\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBfec\-none\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBfec\-rs\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBfibre\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBmii\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBpause\fR
T}:T{
\ \&
T}:T{
\ \&
T}
T{
\fBtp\fR
T}:T{
\ \&
T}:T{
\ \&
T}
.TE
.sp 1
By default this is unset, i\&.e\&. all possible modes will be advertised\&. This option may be specified more than once, in which case all specified speeds and modes are advertised\&. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect\&.
.RE
.PP
\fIReceiveChecksumOffload=\fR
.RS 4
Takes a boolean\&. If set to true, hardware offload for checksumming of ingress network packets is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITransmitChecksumOffload=\fR
.RS 4
Takes a boolean\&. If set to true, hardware offload for checksumming of egress network packets is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITCPSegmentationOffload=\fR
.RS 4
Takes a boolean\&. If set to true, TCP Segmentation Offload (TSO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITCP6SegmentationOffload=\fR
.RS 4
Takes a boolean\&. If set to true, TCP6 Segmentation Offload (tx\-tcp6\-segmentation) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIGenericSegmentationOffload=\fR
.RS 4
Takes a boolean\&. If set to true, Generic Segmentation Offload (GSO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIGenericReceiveOffload=\fR
.RS 4
Takes a boolean\&. If set to true, Generic Receive Offload (GRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIGenericReceiveOffloadHardware=\fR
.RS 4
Takes a boolean\&. If set to true, hardware accelerated Generic Receive Offload (GRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fILargeReceiveOffload=\fR
.RS 4
Takes a boolean\&. If set to true, Large Receive Offload (LRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIReceiveVLANCTAGHardwareAcceleration=\fR
.RS 4
Takes a boolean\&. If set to true, receive VLAN CTAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITransmitVLANCTAGHardwareAcceleration=\fR
.RS 4
Takes a boolean\&. If set to true, transmit VLAN CTAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIReceiveVLANCTAGFilter=\fR
.RS 4
Takes a boolean\&. If set to true, receive filtering on VLAN CTAGs is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITransmitVLANSTAGHardwareAcceleration=\fR
.RS 4
Takes a boolean\&. If set to true, transmit VLAN STAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fINTupleFilter=\fR
.RS 4
Takes a boolean\&. If set to true, receive N\-tuple filters and actions are enabled\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIRxChannels=\fR, \fITxChannels=\fR, \fIOtherChannels=\fR, \fICombinedChannels=\fR
.RS 4
Specifies the number of receive, transmit, other, or combined channels, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or
"max"\&. If set to
"max", the advertised maximum value of the hardware will be used\&. When unset, the number will not be changed\&. Defaults to unset\&.
.RE
.PP
\fIRxBufferSize=\fR, \fIRxMiniBufferSize=\fR, \fIRxJumboBufferSize=\fR, \fITxBufferSize=\fR
.RS 4
Specifies the maximum number of pending packets in the NIC receive buffer, mini receive buffer, jumbo receive buffer, or transmit buffer, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or
"max"\&. If set to
"max", the advertised maximum value of the hardware will be used\&. When unset, the number will not be changed\&. Defaults to unset\&.
.RE
.PP
\fIRxFlowControl=\fR
.RS 4
Takes a boolean\&. When set, enables receive flow control, also known as the ethernet receive PAUSE message (generate and send ethernet PAUSE frames)\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITxFlowControl=\fR
.RS 4
Takes a boolean\&. When set, enables transmit flow control, also known as the ethernet transmit PAUSE message (respond to received ethernet PAUSE frames)\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIAutoNegotiationFlowControl=\fR
.RS 4
Takes a boolean\&. When set, auto negotiation enables the interface to exchange state advertisements with the connected peer so that the two devices can agree on the ethernet PAUSE configuration\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIGenericSegmentOffloadMaxBytes=\fR
.RS 4
Specifies the maximum size of a Generic Segment Offload (GSO) packet the device should accept\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&. An unsigned integer in the range 1\&...65536\&. Defaults to unset\&.
.RE
.PP
\fIGenericSegmentOffloadMaxSegments=\fR
.RS 4
Specifies the maximum number of Generic Segment Offload (GSO) segments the device should accept\&. An unsigned integer in the range 1\&...65535\&. Defaults to unset\&.
.RE
.PP
\fIUseAdaptiveRxCoalesce=\fR, \fIUseAdaptiveTxCoalesce=\fR
.RS 4
Boolean properties that, when set, enable/disable adaptive Rx/Tx coalescing if the hardware supports it\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIRxCoalesceSec=\fR, \fIRxCoalesceIrqSec=\fR, \fIRxCoalesceLowSec=\fR, \fIRxCoalesceHighSec=\fR, \fITxCoalesceSec=\fR, \fITxCoalesceIrqSec=\fR, \fITxCoalesceLowSec=\fR, \fITxCoalesceHighSec=\fR
.RS 4
These properties configure the delay before Rx/Tx interrupts are generated after a packet is sent/received\&. The
"Irq"
properties come into effect when the host is servicing an IRQ\&. The
"Low"
and
"High"
properties come into effect when the packet rate drops below the low packet rate threshold or exceeds the high packet rate threshold respectively if adaptive Rx/Tx coalescing is enabled\&. When unset, the kernel\*(Aqs defaults will be used\&.
.RE
.PP
\fIRxMaxCoalescedFrames=\fR, \fIRxMaxCoalescedIrqFrames=\fR, \fIRxMaxCoalescedLowFrames=\fR, \fIRxMaxCoalescedHighFrames=\fR, \fITxMaxCoalescedFrames=\fR, \fITxMaxCoalescedIrqFrames=\fR, \fITxMaxCoalescedLowFrames=\fR, \fITxMaxCoalescedHighFrames=\fR
.RS 4
These properties configure the maximum number of frames that are sent/received before a Rx/Tx interrupt is generated\&. The
"Irq"
properties come into effect when the host is servicing an IRQ\&. The
"Low"
and
"High"
properties come into effect when the packet rate drops below the low packet rate threshold or exceeds the high packet rate threshold respectively if adaptive Rx/Tx coalescing is enabled\&. When unset, the kernel\*(Aqs defaults will be used\&.
.RE
.PP
\fICoalescePacketRateLow=\fR, \fICoalescePacketRateHigh=\fR
.RS 4
These properties configure the low and high packet rate (expressed in packets per second) threshold respectively and are used to determine when the corresponding coalescing settings for low and high packet rates come into effect if adaptive Rx/Tx coalescing is enabled\&. If unset, the kernel\*(Aqs defaults will be used\&.
.RE
.PP
\fICoalescePacketRateSampleIntervalSec=\fR
.RS 4
Configures how often to sample the packet rate used for adaptive Rx/Tx coalescing\&. This property cannot be zero\&. This lowest time granularity supported by this property is seconds\&. Partial seconds will be rounded up before being passed to the kernel\&. If unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIStatisticsBlockCoalesceSec=\fR
.RS 4
How long to delay driver in\-memory statistics block updates\&. If the driver does not have an in\-memory statistic block, this property is ignored\&. This property cannot be zero\&. If unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIMDI=\fR
.RS 4
Specifies the medium dependent interface (MDI) mode for the interface\&. A MDI describes the interface from a physical layer implementation to the physical medium used to carry the transmission\&. Takes one of the following words:
"straight"
(or equivalently:
"mdi"),
"crossover"
(or equivalently:
"mdi\-x",
"mdix"), and
"auto"\&. When
"straight", the MDI straight through mode will be used\&. When
"crossover", the MDI crossover (MDI\-X) mode will be used\&. When
"auto", the MDI status is automatically detected\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
.RE
.PP
\fISR\-IOVVirtualFunctions=\fR
.RS 4
Specifies the number of SR\-IOV virtual functions\&. Takes an integer in the range 0\&...2147483647\&. Defaults to unset, and automatically determined from the values specified in the
\fIVirtualFunction=\fR
settings in the [SR\-IOV] sections\&.
.RE
.SH "[SR\-IOV] SECTION OPTIONS"
.PP
The [SR\-IOV] section accepts the following keys\&. Specify several [SR\-IOV] sections to configure several SR\-IOVs\&. SR\-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be injected into a VM\&. In the case of network VFs, SR\-IOV improves north\-south network performance (that is, traffic with endpoints outside the host machine) by allowing traffic to bypass the host machine\(cqs network stack\&.
.PP
\fIVirtualFunction=\fR
.RS 4
Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data in and out\&. Takes an integer in the range 0\&...2147483646\&. This option is compulsory\&.
.RE
.PP
\fIVLANId=\fR
.RS 4
Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&.
.RE
.PP
\fIQualityOfService=\fR
.RS 4
Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&.
.RE
.PP
\fIVLANProtocol=\fR
.RS 4
Specifies VLAN protocol of the virtual function\&. Takes
"802\&.1Q"
or
"802\&.1ad"\&.
.RE
.PP
\fIMACSpoofCheck=\fR
.RS 4
Takes a boolean\&. Controls the MAC spoof checking\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIQueryReceiveSideScaling=\fR
.RS 4
Takes a boolean\&. Toggle the ability of querying the receive side scaling (RSS) configuration of the virtual function (VF)\&. The VF RSS information like RSS hash key may be considered sensitive on some devices where this information is shared between VF and the physical function (PF)\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fITrust=\fR
.RS 4
Takes a boolean\&. Allows one to set trust mode of the virtual function (VF)\&. When set, VF users can set a specific feature which may impact security and/or performance\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fILinkState=\fR
.RS 4
Allows one to set the link state of the virtual function (VF)\&. Takes a boolean or a special value
"auto"\&. Setting to
"auto"
means a reflection of the physical function (PF) link state,
"yes"
lets the VF to communicate with other VFs on this host even if the PF link state is down,
"no"
causes the hardware to drop any packets sent by the VF\&. When unset, the kernel\*(Aqs default will be used\&.
.RE
.PP
\fIMACAddress=\fR
.RS 4
Specifies the MAC address for the virtual function\&.
.RE
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&/lib/systemd/network/99\-default\&.link\fR
.PP
The link file
99\-default\&.link
that is shipped with systemd defines the default policies for the interface name, alternative names, and MAC address of links\&.
.sp
.if n \{\
.RS 4
.\}
.nf
[Match]
OriginalName=*

[Link]
NamePolicy=keep kernel database onboard slot path
AlternativeNamesPolicy=database onboard slot path
MACAddressPolicy=persistent
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&/etc/systemd/network/10\-dmz\&.link\fR
.PP
This example assigns the fixed name
"dmz0"
to the interface with the MAC address 00:a0:de:63:7a:e6:
.sp
.if n \{\
.RS 4
.\}
.nf
[Match]
MACAddress=00:a0:de:63:7a:e6

[Link]
Name=dmz0
.fi
.if n \{\
.RE
.\}
.PP
\fINamePolicy=\fR
is not set, so
\fIName=\fR
takes effect\&. We use the
"10\-"
prefix to order this file early in the list\&. Note that it needs to be before
99\-default\&.link, i\&.e\&. it needs a numerical prefix, to have any effect at all\&.
.PP
\fBExample\ \&3.\ \&(Re\-)applying a \&.link file to an interface\fR
.PP
After a new \&.link file has been created, or an existing \&.link file modified, the new settings may be applied to the matching interface with the following commands:
.sp
.if n \{\
.RS 4
.\}
.nf
$ sudo udevadm control \-\-reload
$ sudo ip link set eth0 down
$ sudo udevadm trigger \-\-verbose \-\-settle \-\-action add /sys/class/net/eth0
.fi
.if n \{\
.RE
.\}
.PP
You may also need to stop the service that manages the network interface, e\&.g\&.
systemd\-networkd\&.service
or
NetworkManager\&.service
before the above operation, and then restart the service after that\&. For more details about
\fBudevadm\fR
command, see
\fBudevadm\fR(8)\&.
.PP
\fBExample\ \&4.\ \&Debugging \fINamePolicy=\fR assignments\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ sudo SYSTEMD_LOG_LEVEL=debug udevadm test\-builtin net_setup_link /sys/class/net/hub0
\&...
Parsed configuration file /lib/systemd/network/99\-default\&.link
Parsed configuration file /etc/systemd/network/10\-eth0\&.link
ID_NET_DRIVER=cdc_ether
Config file /etc/systemd/network/10\-eth0\&.link applies to device hub0
link_config: autonegotiation is unset or enabled, the speed and duplex are not writable\&.
hub0: Device has name_assign_type=4
Using default interface naming scheme \*(Aqv240\*(Aq\&.
hub0: Policies didn\*(Aqt yield a name, using specified Name=hub0\&.
ID_NET_LINK_FILE=/etc/systemd/network/10\-eth0\&.link
ID_NET_NAME=hub0
\&...
.fi
.if n \{\
.RE
.\}
.PP
Explicit
\fIName=\fR
configuration wins in this case\&.
.sp
.if n \{\
.RS 4
.\}
.nf
sudo SYSTEMD_LOG_LEVEL=debug udevadm test\-builtin net_setup_link /sys/class/net/enp0s31f6
\&...
Parsed configuration file /lib/systemd/network/99\-default\&.link
Parsed configuration file /etc/systemd/network/10\-eth0\&.link
Created link configuration context\&.
ID_NET_DRIVER=e1000e
Config file /lib/systemd/network/99\-default\&.link applies to device enp0s31f6
link_config: autonegotiation is unset or enabled, the speed and duplex are not writable\&.
enp0s31f6: Device has name_assign_type=4
Using default interface naming scheme \*(Aqv240\*(Aq\&.
enp0s31f6: Policy *keep*: keeping existing userspace name
enp0s31f6: Device has addr_assign_type=0
enp0s31f6: MAC on the device already matches policy *persistent*
ID_NET_LINK_FILE=/lib/systemd/network/99\-default\&.link
\&...
.fi
.if n \{\
.RE
.\}
.PP
In this case, the interface was already renamed, so the
\fBkeep\fR
policy specified as the first option in
99\-default\&.link
means that the existing name is preserved\&. If
\fBkeep\fR
was removed, or if were in boot before the renaming has happened, we might get the following instead:
.sp
.if n \{\
.RS 4
.\}
.nf
enp0s31f6: Policy *path* yields "enp0s31f6"\&.
enp0s31f6: Device has addr_assign_type=0
enp0s31f6: MAC on the device already matches policy *persistent*
ID_NET_LINK_FILE=/lib/systemd/network/99\-default\&.link
ID_NET_NAME=enp0s31f6
\&...
.fi
.if n \{\
.RE
.\}
.PP
Please note that the details of output are subject to change\&.
.PP
\fBExample\ \&5.\ \&/etc/systemd/network/10\-internet\&.link\fR
.PP
This example assigns the fixed name
"internet0"
to the interface with the device path
"pci\-0000:00:1a\&.0\-*":
.sp
.if n \{\
.RS 4
.\}
.nf
[Match]
Path=pci\-0000:00:1a\&.0\-*

[Link]
Name=internet0
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&6.\ \&/etc/systemd/network/25\-wireless\&.link\fR
.PP
Here\*(Aqs an overly complex example that shows the use of a large number of [Match] and [Link] settings\&.
.sp
.if n \{\
.RS 4
.\}
.nf
[Match]
MACAddress=12:34:56:78:9a:bc
Driver=brcmsmac
Path=pci\-0000:02:00\&.0\-*
Type=wlan
Virtualization=no
Host=my\-laptop
Architecture=x86\-64

[Link]
Name=wireless0
MTUBytes=1450
BitsPerSecond=10M
WakeOnLan=magic
MACAddress=cb:a9:87:65:43:21
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBsystemd-udevd.service\fR(8),
\fBudevadm\fR(8),
\fBsystemd.netdev\fR(5),
\fBsystemd.network\fR(5),
\fBsystemd-network-generator.service\fR(8)
.SH "NOTES"
.IP " 1." 4
System and Service Credentials
.RS 4
\%https://systemd.io/CREDENTIALS
.RE