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
|
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd.net-naming-scheme" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd.net-naming-scheme</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd.net-naming-scheme</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd.net-naming-scheme</refname>
<refpurpose>Network device naming schemes</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Network interfaces names and MAC addresses may be generated based on certain stable interface
attributes. This is possible when there is enough information about the device to generate those
attributes and the use of this information is configured. This page describes interface naming, i.e. what
possible names may be generated. Those names are generated by the
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
builtin <command>net_id</command> and exported as
<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
properties (<varname>ID_NET_NAME_ONBOARD=</varname>, <varname>ID_NET_LABEL_ONBOARD=</varname>,
<varname>ID_NET_NAME_PATH=</varname>, <varname>ID_NET_NAME_SLOT=</varname>).</para>
<para>Names and MAC addresses are derived from various stable device metadata attributes. Newer versions
of <command>systemd-udevd</command> take more of these attributes into account, improving (and thus
possibly changing) the names and addresses used for the same devices. Different versions of those
generation rules are called "naming schemes". The default naming scheme is chosen at compilation time.
Usually this will be the latest implemented version, but it is also possible to set one of the older
versions to preserve compatibility. This may be useful for example for distributions, which may introduce
new versions of systemd in stable releases without changing the naming scheme. The naming scheme may also
be overridden using the <varname>net.naming_scheme=</varname> kernel command line switch, see
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
Available naming schemes are described below.</para>
<para>After the udev properties have been generated, appropriate udev rules may be used to actually rename
devices based on those properties. See the description of <varname>NamePolicy=</varname> and
<varname>MACAddressPolicy=</varname> in
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
<para>Note that while the concept of network interface naming schemes is primarily relevant in the
context of <filename>systemd-udevd.service</filename>, the
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
container manager also takes it into account when naming network interfaces, see below.</para>
</refsect1>
<refsect1>
<title>Policies</title>
<para>All names start with a two-character prefix that signifies the interface type.</para>
<table>
<title>Two character prefixes based on the type of interface</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Prefix</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>en</constant></entry>
<entry>Ethernet</entry>
</row>
<row>
<entry><constant>ib</constant></entry>
<entry>InfiniBand</entry>
</row>
<row>
<entry><constant>sl</constant></entry>
<entry>Serial line IP (slip)</entry>
</row>
<row>
<entry><constant>wl</constant></entry>
<entry>Wireless local area network (WLAN)</entry>
</row>
<row>
<entry><constant>ww</constant></entry>
<entry>Wireless wide area network (WWAN)</entry>
</row>
</tbody>
</tgroup>
</table>
<para>The <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
<command>net_id</command> builtin exports the following device properties:</para>
<variablelist>
<varlistentry>
<term><varname>ID_NET_NAME_ONBOARD=</varname><replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></term>
<term><varname>ID_NET_NAME_ONBOARD=</varname><replaceable>prefix</replaceable><constant>d</constant><replaceable>number</replaceable></term>
<listitem><para>This name is set based on the numeric ordering information given by the firmware
for on-board devices. Different schemes are used depending on the firmware type, as described in
the table below.</para>
<table>
<title>On-board naming schemes</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Format</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></entry>
<entry>PCI on-board index</entry>
</row>
<row>
<entry><replaceable>prefix</replaceable><constant>d</constant><replaceable>number</replaceable></entry>
<entry>DeviceTree alias index</entry>
</row>
</tbody>
</tgroup>
</table>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ID_NET_LABEL_ONBOARD=</varname><replaceable>label</replaceable></term>
<listitem><para>This property is set based on textual label given by the firmware for on-board
devices. This is only available for PCI devices.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ID_NET_NAME_MAC=</varname><replaceable>prefix</replaceable><constant>x</constant><replaceable>AABBCCDDEEFF</replaceable></term>
<listitem><para>This name consists of the prefix, letter <constant>x</constant>, and 12 hexadecimal
digits of the MAC address. It is available if the device has a fixed MAC address. Because this name
is based on an attribute of the card itself, it remains "stable" when the device is moved (even
between machines), but will change when the hardware is replaced.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</term>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable><constant>v</constant><replaceable>slot</replaceable></term>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable><constant>x</constant><replaceable>slot</replaceable></term>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></term>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</term>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>v</constant><replaceable>slot</replaceable></term>
<term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>r</constant><replaceable>slot</replaceable></term>
<listitem><para>This property describes the slot position. Different schemes are used depending on
the bus type, as described in the table below. In case of USB, BCMA, and SR-VIO devices, the full
name consists of the prefix, PCI slot identifier, and USB or BCMA or SR-VIO slot identifier. The
first two parts are denoted as "…" in the table below.</para>
<table>
<title>Slot naming schemes</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Format</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><replaceable>prefix</replaceable> [<constant>P</constant><replaceable>domain</replaceable>] <constant>s</constant><replaceable>slot</replaceable> [<constant>f</constant><replaceable>function</replaceable>] [<constant>n</constant><replaceable>port_name</replaceable> | <constant>d</constant><replaceable>dev_port</replaceable>]</entry>
<entry>PCI slot number</entry>
</row>
<row>
<entry><replaceable>prefix</replaceable> <constant>v</constant><replaceable>slot</replaceable></entry>
<entry>VIO slot number (IBM PowerVM)</entry>
</row>
<row>
<entry><replaceable>prefix</replaceable> <constant>X</constant><replaceable>number</replaceable></entry>
<entry>VIF interface number (Xen)</entry>
</row>
<row>
<entry>… <constant>b</constant><replaceable>number</replaceable></entry>
<entry>Broadcom bus (BCMA) core number</entry>
</row>
<row>
<entry>… <constant>u</constant><replaceable>port</replaceable>… [<constant>c</constant><replaceable>config</replaceable>] [<constant>i</constant><replaceable>interface</replaceable>]</entry>
<entry>USB port number chain</entry>
</row>
<row>
<entry>… <constant>v</constant><replaceable>slot</replaceable></entry>
<entry>SR-VIO slot number</entry>
</row>
<row>
<entry>… <constant>r</constant><replaceable>slot</replaceable></entry>
<entry>SR-IOV slot number</entry>
</row>
</tbody>
</tgroup>
</table>
<para>The PCI domain is only prepended when it is not 0. All multi-function PCI devices will carry
the <constant>f</constant><replaceable>function</replaceable> number in the device name, including
the function 0 device. For non-multi-function devices, the number is suppressed if 0. The port name
<replaceable>port_name</replaceable> is used, or the port number
<constant>d</constant><replaceable>dev_port</replaceable> if the name is not known.</para>
<para>For BCMA devices, the core number is suppressed when 0.</para>
<para>For USB devices the full chain of port numbers of hubs is composed. If the name gets longer
than the maximum number of 15 characters, the name is not exported. The usual USB configuration
number 1 and interface number 0 values are suppressed.</para>
<para>SR-IOV virtual devices are named based on the name of the parent interface, with a suffix of
<constant>v</constant> and the virtual device number, with any leading zeros removed. The bus
number is ignored.</para>
<para>SR-IOV virtual device representors are named based on the name of the physical device
interface, with a suffix of <constant>r</constant> and the number of the virtual device that
is linked to the particular representor, with any leading zeros removed. The physical port
name and the bus number are ignored.</para>
<para>In some configurations a parent PCI bridge of a given network controller may be associated
with a slot. In such case we do not generate this device property to avoid possible naming conflicts.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>c</constant><replaceable>bus_id</replaceable></term>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>a</constant><replaceable>vendor</replaceable><replaceable>model</replaceable><constant>i</constant><replaceable>instance</replaceable></term>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>i</constant><replaceable>address</replaceable><constant>n</constant><replaceable>port_name</replaceable></term>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>u</constant><replaceable>port</replaceable>…</term>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</term>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></term>
<term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</term>
<listitem><para>This property describes the device installation location. Different schemes are
used depending on the bus type, as described in the table below. For BCMA and USB devices, PCI path
information must known, and the full name consists of the prefix, PCI slot identifier, and USB or
BCMA location. The first two parts are denoted as "…" in the table below.</para>
<table>
<title>Path naming schemes</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Format</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><replaceable>prefix</replaceable> <constant>c</constant><replaceable>bus_id</replaceable></entry>
<entry>CCW or grouped CCW device identifier</entry>
</row>
<row>
<entry><replaceable>prefix</replaceable> <constant>a</constant><replaceable>vendor</replaceable> <replaceable>model</replaceable> <constant>i</constant><replaceable>instance</replaceable></entry>
<entry>ACPI path names for ARM64 platform devices</entry>
</row>
<row>
<entry><replaceable>prefix</replaceable> <constant>i</constant><replaceable>address</replaceable> <constant>n</constant><replaceable>port_name</replaceable></entry>
<entry>Netdevsim (simulated networking device) device number and port name</entry>
</row>
<row>
<entry><replaceable>prefix</replaceable> [<constant>P</constant><replaceable>domain</replaceable>] <constant>p</constant><replaceable>bus</replaceable> <constant>s</constant><replaceable>slot</replaceable> [<constant>f</constant><replaceable>function</replaceable>] [<constant>n</constant><replaceable>phys_port_name</replaceable> | <constant>d</constant><replaceable>dev_port</replaceable>]</entry>
<entry>PCI geographical location</entry>
</row>
<row>
<entry>… <constant>b</constant><replaceable>number</replaceable></entry>
<entry>Broadcom bus (BCMA) core number</entry>
</row>
<row>
<entry>… <constant>u</constant><replaceable>port</replaceable>… [<constant>c</constant><replaceable>config</replaceable>] [<constant>i</constant><replaceable>interface</replaceable>]</entry>
<entry>USB port number chain</entry>
</row>
</tbody>
</tgroup>
</table>
<para>CCW and grouped CCW devices are found in IBM System Z mainframes. Any leading zeros and
dots are suppressed.</para>
<para>For PCI, BCMA, and USB devices, the same rules as described above for slot naming are
used.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>History</title>
<para>The following "naming schemes" have been defined (which may be chosen at system boot-up time via
the <varname>net.naming_scheme=</varname> kernel command line switch, see above):</para>
<variablelist>
<varlistentry>
<term><constant>v238</constant></term>
<listitem><para>This is the naming scheme that was implemented in systemd 238.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
<term><constant>v239</constant></term>
<listitem><para>Naming was changed for virtual network interfaces created with SR-IOV and NPAR and
for devices where the PCI network controller device does not have a slot number associated.</para>
<para>SR-IOV virtual devices are named based on the name of the parent interface, with a suffix of
<literal>v<replaceable>port</replaceable></literal>, where <replaceable>port</replaceable> is the
virtual device number. Previously those virtual devices were named as if completely independent.
</para>
<para>The ninth and later NPAR virtual devices are named following the scheme used for the first
eight NPAR partitions. Previously those devices were not renamed and the kernel default
("eth<replaceable>N</replaceable>") was used.</para>
<para>Names are also generated for PCI devices where the PCI network controller device does not
have an associated slot number itself, but one of its parents does. Previously those devices were
not renamed and the kernel default was used.</para>
<xi:include href="version-info.xml" xpointer="v243"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v240</constant></term>
<listitem><para>The <literal>ib</literal> prefix and stable names for infiniband devices are
introduced. Previously those devices were not renamed.</para>
<para>The ACPI index field (used in <varname>ID_NET_NAME_ONBOARD=</varname>) is now also used when
0.</para>
<para>A new naming policy <varname>NamePolicy=keep</varname> was introduced. With this policy, if
the network device name was already set by userspace, the device will not be renamed
again. Previously, this naming policy applied implicitly, and now it must be explicitly
requested. Effectively, this means that network devices will be renamed according to the
configuration, even if they have been renamed already, if <constant>keep</constant> is not
specified as the naming policy in the <filename index="false">.link</filename> file. See
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for a description of <varname>NamePolicy=</varname>.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
<term><constant>v241</constant></term>
<listitem><para><option>MACAddressPolicy=persistent</option> was extended to set MAC addresses
based on the device name. Previously addresses were only based on the
<varname index="false">ID_NET_NAME_*</varname> attributes, which meant that interface names would
never be generated for virtual devices. Now a persistent address will be generated for most
devices, including in particular bridges.</para>
<para>Note: when userspace does not set a MAC address for a bridge device, the kernel will
initially assign a random address, and then change it when the first device is enslaved to the
bridge. With this naming policy change, bridges get a persistent MAC address based on the bridge
name instead of the first enslaved device.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
<term><constant>v243</constant></term>
<listitem><para>Support for renaming netdevsim (simulated networking) devices was added. Previously
those devices were not renamed.</para>
<para>Previously two-letter interface type prefix was prepended to
<varname>ID_NET_LABEL_ONBOARD=</varname>. This is not done anymore.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
<term><constant>v245</constant></term>
<listitem><para>When
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
derives the name for the host side of the network interface created with
<option>--network-veth</option> from the container name it previously simply truncated the result
at 15 characters if longer (since that's the maximum length for network interface names). From now
on, for any interface name that would be longer than 15 characters the last 4 characters are set to
a 24bit hash value of the full interface name. This way network interface name collisions between
multiple similarly named containers (who only differ in container name suffix) should be less
likely (but still possible, since the 24bit hash value is very small).</para>
<xi:include href="version-info.xml" xpointer="v245"/></listitem>
</varlistentry>
<varlistentry>
<term><constant>v247</constant></term>
<listitem><para>When a PCI slot is associated with a PCI bridge that has multiple child network
controllers, the same value of the <varname>ID_NET_NAME_SLOT</varname> property might be derived
for those controllers. This would cause a naming conflict if the property is selected as the device
name. Now, we detect this situation and do not produce the <varname>ID_NET_NAME_SLOT</varname>
property.</para>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
</varlistentry>
<varlistentry>
<term><constant>v249</constant></term>
<listitem><para>PCI hotplug slot names for the s390 PCI driver are a hexadecimal representation
of the <filename>function_id</filename> device attribute. This attribute is now used to build the
<varname>ID_NET_NAME_SLOT</varname>. Before that, all slot names were parsed as decimal
numbers, which could either result in an incorrect value of the <varname>ID_NET_NAME_SLOT</varname>
property or none at all.</para>
<para>Some firmware and hypervisor implementations report unreasonably high numbers for the
on-board index. To prevent the generation of bogus on-board interface names, index numbers greater
than 16381 (2¹⁴-1) were ignored. For s390 PCI devices index values up to 65535 (2¹⁶-1) are valid.
To account for that, the limit was increased to 65535.</para>
<para>The <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
rule <varname>NAME=</varname> replaces <literal>:</literal>, <literal>/</literal>, and
<literal>%</literal> with an underscore (<literal>_</literal>), and refuses strings which contain
only digits.</para>
<xi:include href="version-info.xml" xpointer="v249"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v250</constant></term>
<listitem><para>Added naming scheme for Xen netfront "vif" interfaces based on the guest side
VIF number set from the Xen config (or the interface index in AWS EC2).</para>
<xi:include href="version-info.xml" xpointer="v250"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v251</constant></term>
<listitem><para>Since version <constant>v247</constant> we no longer set
<varname>ID_NET_NAME_SLOT</varname> if we detect that a PCI device associated with a slot is a PCI
bridge as that would create naming conflict when there are more child devices on that bridge. Now,
this is relaxed and we will use slot information to generate the name based on it but only if
the PCI device has multiple functions. This is safe because distinct function number is a part of
the device name for multifunction devices. Note, this is reverted in <constant>v255</constant>.
See below.</para>
<xi:include href="version-info.xml" xpointer="v251"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v252</constant></term>
<listitem><para>Added naming scheme for platform devices with devicetree aliases.</para>
<xi:include href="version-info.xml" xpointer="v252"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v253</constant></term>
<listitem><para>Set <varname>ID_NET_NAME_PATH</varname> for usb devices not connected via a PCI bus.</para>
<xi:include href="version-info.xml" xpointer="v253"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v254</constant></term>
<listitem><para>Naming was changed for SR-IOV virtual device representors, optionally settable at
compilation time. The <literal>r<replaceable>slot</replaceable></literal> suffix was added to
differentiate SR-IOV virtual device representors attached to a single physical device interface.
Because of a mistake, this scheme was <emphasis>not the default scheme for systemd version
254</emphasis>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v255</constant></term>
<listitem><para>Naming was changed for SR-IOV virtual device representors to enable the
change introduced in <constant>v254</constant> by default.</para>
<para>If we detect that a PCI device associated with a slot is a PCI bridge, we no longer set
<varname>ID_NET_NAME_SLOT</varname>, reverting a change that was introduced in
<constant>v251</constant>.</para>
<xi:include href="version-info.xml" xpointer="v255"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v257</constant></term>
<listitem><para>PCI slot number is now read from <constant>firmware_node/sun</constant> sysfs file.</para>
<para>The naming scheme based on devicetree aliases was extended to support aliases for individual
interfaces of controllers with multiple ports.</para>
<xi:include href="version-info.xml" xpointer="v257"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v258</constant></term>
<listitem><para>When no renaming is requested, <varname>ID_NET_NAME</varname> property is now
equivalent to <varname>INTERFACE</varname> property.</para>
<xi:include href="version-info.xml" xpointer="v258"/>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>v259</constant></term>
<listitem><para>The naming scheme based on devicetree aliases was extended to support WLAN devices.</para>
<xi:include href="version-info.xml" xpointer="v259"/>
</listitem>
</varlistentry>
</variablelist>
<para>Note that <constant>latest</constant> may be used to denote the latest scheme known (to this
particular version of systemd).</para>
</refsect1>
<refsect1>
<title>Limiting the use of specific sysfs attributes</title>
<para>When creating names for network cards, some naming schemes use data from sysfs populated by the
kernel. This means that although a specific naming scheme in
<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> is picked, the
network card's name can still change when a new kernel version adds a new sysfs attribute. For example,
if kernel starts setting the <constant>phys_port_name</constant>, <command>udev</command> will append the
"<constant>n</constant><replaceable>phys_port_name</replaceable>" suffix to the device name.</para>
<variablelist>
<varlistentry>
<term><varname>ID_NET_NAME_ALLOW=</varname><replaceable>BOOL</replaceable></term>
<listitem><para>This udev property sets a fallback policy for reading a sysfs attribute.
If set to <constant>0</constant> udev will not read any sysfs attribute by default, unless it is
explicitly allowlisted, see below. If set to <constant>1</constant> udev can use any sysfs attribute
unless it is explicitly forbidden. The default value is <constant>1</constant>.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ID_NET_NAME_ALLOW_<replaceable>sysfsattr</replaceable>=<replaceable>BOOL</replaceable></varname></term>
<listitem><para>This udev property explicitly states if udev shall use the specified
<replaceable>sysfsattr</replaceable>, when composing the device name.</para>
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
</variablelist>
<para>With these options, users can set an allowlist or denylist for sysfs attributes. To create
an allowlist, the user needs to set <varname>ID_NET_NAME_ALLOW=0</varname> for the device and then list
the allowed attributes with the
<varname>ID_NET_NAME_ALLOW_<replaceable>sysfsattr</replaceable>=1</varname>
options. In case of a denylist, the user needs to provide the list of denied attributes with
the <varname>ID_NET_NAME_ALLOW_<replaceable>sysfsattr</replaceable>=0</varname> options.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<example>
<title>Using <command>udevadm test-builtin</command> to display device properties</title>
<programlisting>$ udevadm test-builtin net_id /sys/class/net/enp0s31f6
...
Using default interface naming scheme 'v243'.
ID_NET_NAMING_SCHEME=v243
ID_NET_NAME_MAC=enx54ee75cb1dc0
ID_OUI_FROM_DATABASE=Wistron InfoComm(Kunshan)Co.,Ltd.
ID_NET_NAME_PATH=enp0s31f6
...</programlisting>
</example>
<example>
<title>PCI Ethernet card with firmware index "1"</title>
<programlisting>ID_NET_NAME_ONBOARD=eno1
ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
</programlisting>
</example>
<example>
<title>PCI Ethernet card in slot with firmware index number</title>
<programlisting># /sys/devices/pci0000:00/0000:00:1c.3/0000:05:00.0/net/ens1
ID_NET_NAME_MAC=enx000000000466
ID_NET_NAME_PATH=enp5s0
ID_NET_NAME_SLOT=ens1</programlisting>
</example>
<example>
<title>PCI Ethernet multi-function card with 2 ports</title>
<programlisting># /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.0/net/enp2s0f0
ID_NET_NAME_MAC=enx78e7d1ea46da
ID_NET_NAME_PATH=enp2s0f0
# /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.1/net/enp2s0f1
ID_NET_NAME_MAC=enx78e7d1ea46dc
ID_NET_NAME_PATH=enp2s0f1</programlisting>
</example>
<example>
<title>PCI WLAN card</title>
<programlisting># /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlp3s0
ID_NET_NAME_MAC=wlx0024d7e31130
ID_NET_NAME_PATH=wlp3s0</programlisting>
</example>
<example>
<title>PCI IB host adapter with 2 ports</title>
<programlisting># /sys/devices/pci0000:00/0000:00:03.0/0000:15:00.0/net/ibp21s0f0
ID_NET_NAME_PATH=ibp21s0f0
# /sys/devices/pci0000:00/0000:00:03.0/0000:15:00.1/net/ibp21s0f1
ID_NET_NAME_PATH=ibp21s0f1</programlisting>
</example>
<example>
<title>USB built-in 3G modem</title>
<programlisting># /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.4/2-1.4:1.6/net/wwp0s29u1u4i6
ID_NET_NAME_MAC=wwx028037ec0200
ID_NET_NAME_PATH=wwp0s29u1u4i6</programlisting>
</example>
<example>
<title>USB Android phone</title>
<programlisting># /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.2/2-1.2:1.0/net/enp0s29u1u2
ID_NET_NAME_MAC=enxd626b3450fb5
ID_NET_NAME_PATH=enp0s29u1u2</programlisting>
</example>
<example>
<title>s390 grouped CCW interface</title>
<programlisting># /sys/devices/css0/0.0.0007/0.0.f5f0/group_device/net/encf5f0
ID_NET_NAME_MAC=enx026d3c00000a
ID_NET_NAME_PATH=encf5f0</programlisting>
</example>
<example>
<title>Set an allowlist for reading sysfs attributes for network card naming</title>
<programlisting><filename>/etc/udev/hwdb.d/50-net-naming-allowlist.hwdb</filename>
net:naming:drvirtio_net:*
ID_NET_NAME_ALLOW=0
ID_NET_NAME_ALLOW_ACPI_INDEX=1
ID_NET_NAME_ALLOW_ADDR_ASSIGN_TYPE=1
ID_NET_NAME_ALLOW_ADDRESS=1
ID_NET_NAME_ALLOW_ARI_ENABLED=1
ID_NET_NAME_ALLOW_DEV_PORT=1
ID_NET_NAME_ALLOW_FUNCTION_ID=1
ID_NET_NAME_ALLOW_IFLINK=1
ID_NET_NAME_ALLOW_INDEX=1
ID_NET_NAME_ALLOW_LABEL=1
ID_NET_NAME_ALLOW_PHYS_PORT_NAME=1
ID_NET_NAME_ALLOW_TYPE=1</programlisting>
</example>
<example>
<title>Set a denylist so that specified sysfs attribute are ignored</title>
<programlisting><filename>/etc/udev/hwdb.d/50-net-naming-denylist.hwdb</filename>
net:naming:drvirtio_net:*
ID_NET_NAME_ALLOW=1
ID_NET_NAME_ALLOW_DEV_PORT=0
ID_NET_NAME_ALLOW_PHYS_PORT_NAME=0
</programlisting>
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><ulink url="https://systemd.io/PREDICTABLE_INTERFACE_NAMES">Predictable Network Interface Names</ulink></member>
<member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
</refsect1>
</refentry>
|
