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
|
'\" t
.TH "SYSTEMD\&.NET\-NAMING\-SCHEME" "7" "" "systemd 256~rc3" "systemd.net-naming-scheme"
.\" -----------------------------------------------------------------
.\" * 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.net-naming-scheme \- Network device naming schemes
.SH "DESCRIPTION"
.PP
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
\fBsystemd-udevd.service\fR(8)
builtin
\fBnet_id\fR
and exported as udev properties (\fIID_NET_NAME_ONBOARD=\fR,
\fIID_NET_LABEL_ONBOARD=\fR,
\fIID_NET_NAME_PATH=\fR,
\fIID_NET_NAME_SLOT=\fR)\&.
.PP
Names and MAC addresses are derived from various stable device metadata attributes\&. Newer versions of udev 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
\fInet\&.naming_scheme=\fR
kernel command line switch, see
\fBsystemd-udevd.service\fR(8)\&. Available naming schemes are described below\&.
.PP
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
\fINamePolicy=\fR
and
\fIMACAddressPolicy=\fR
in
\fBsystemd.link\fR(5)\&.
.PP
Note that while the concept of network interface naming schemes is primarily relevant in the context of
systemd\-udevd\&.service, the
\fBsystemd-nspawn\fR(1)
container manager also takes it into account when naming network interfaces, see below\&.
.SH "POLICIES"
.PP
All names start with a two\-character prefix that signifies the interface type\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&Two character prefixes based on the type of interface
.TS
allbox tab(:);
lB lB.
T{
Prefix
T}:T{
Description
T}
.T&
l l
l l
l l
l l
l l.
T{
\fBen\fR
T}:T{
Ethernet
T}
T{
\fBib\fR
T}:T{
InfiniBand
T}
T{
\fBsl\fR
T}:T{
Serial line IP (slip)
T}
T{
\fBwl\fR
T}:T{
Wireless local area network (WLAN)
T}
T{
\fBww\fR
T}:T{
Wireless wide area network (WWAN)
T}
.TE
.sp 1
.PP
The udev
\fBnet_id\fR
builtin exports the following udev device properties:
.PP
\fIID_NET_NAME_ONBOARD=\fR\fIprefix\fR\fBo\fR\fInumber\fR, \fIID_NET_NAME_ONBOARD=\fR\fIprefix\fR\fBd\fR\fInumber\fR
.RS 4
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\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&2.\ \&On\-board naming schemes
.TS
allbox tab(:);
lB lB.
T{
Format
T}:T{
Description
T}
.T&
l l
l l.
T{
\fIprefix\fR\fBo\fR\fInumber\fR
T}:T{
PCI on\-board index
T}
T{
\fIprefix\fR\fBd\fR\fInumber\fR
T}:T{
Devicetree alias index
T}
.TE
.sp 1
Added in version 243\&.
.RE
.PP
\fIID_NET_LABEL_ONBOARD=\fR\fIprefix\fR \fIlabel\fR
.RS 4
This property is set based on textual label given by the firmware for on\-board devices\&. The name consists of the prefix concatenated with the label\&. This is only available for PCI devices\&.
.sp
Added in version 243\&.
.RE
.PP
\fIID_NET_NAME_MAC=\fR\fIprefix\fR\fBx\fR\fIAABBCCDDEEFF\fR
.RS 4
This name consists of the prefix, letter
\fBx\fR, 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\&.
.sp
Added in version 243\&.
.RE
.PP
\fIID_NET_NAME_SLOT=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIport_name\fR|\fBd\fR\fIdev_port\fR], \fIID_NET_NAME_SLOT=\fR\fIprefix\fR\fBv\fR\fIslot\fR, \fIID_NET_NAME_SLOT=\fR\fIprefix\fR\fBx\fR\fIslot\fR, \fIID_NET_NAME_SLOT=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIport_name\fR|\fBd\fR\fIdev_port\fR]\fBb\fR\fInumber\fR, \fIID_NET_NAME_SLOT=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIport_name\fR|\fBd\fR\fIdev_port\fR]\fBu\fR\fIport\fR\&...[\fBc\fR\fIconfig\fR][\fBi\fR\fIinterface\fR], \fIID_NET_NAME_SLOT=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIport_name\fR|\fBd\fR\fIdev_port\fR]\fBv\fR\fIslot\fR, \fIID_NET_NAME_SLOT=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIport_name\fR|\fBd\fR\fIdev_port\fR]\fBr\fR\fIslot\fR
.RS 4
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\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&3.\ \&Slot naming schemes
.TS
allbox tab(:);
lB lB.
T{
Format
T}:T{
Description
T}
.T&
l l
l l
l l
l l
l l
l l
l l.
T{
\fIprefix\fR\ \&[\fBP\fR\fIdomain\fR]\ \&\fBs\fR\fIslot\fR\ \&[\fBf\fR\fIfunction\fR]\ \&[\fBn\fR\fIport_name\fR\ \&|\ \&\fBd\fR\fIdev_port\fR]
T}:T{
PCI slot number
T}
T{
\fIprefix\fR\ \&\fBv\fR\fIslot\fR
T}:T{
VIO slot number (IBM PowerVM)
T}
T{
\fIprefix\fR\ \&\fBX\fR\fInumber\fR
T}:T{
VIF interface number (Xen)
T}
T{
\&...\ \&\fBb\fR\fInumber\fR
T}:T{
Broadcom bus (BCMA) core number
T}
T{
\&...\ \&\fBu\fR\fIport\fR\&...\ \&[\fBc\fR\fIconfig\fR]\ \&[\fBi\fR\fIinterface\fR]
T}:T{
USB port number chain
T}
T{
\&...\ \&\fBv\fR\fIslot\fR
T}:T{
SR\-VIO slot number
T}
T{
\&...\ \&\fBr\fR\fIslot\fR
T}:T{
SR\-IOV slot number
T}
.TE
.sp 1
The PCI domain is only prepended when it is not 0\&. All multi\-function PCI devices will carry the
\fBf\fR\fIfunction\fR
number in the device name, including the function 0 device\&. For non\-multi\-function devices, the number is suppressed if 0\&. The port name
\fIport_name\fR
is used, or the port number
\fBd\fR\fIdev_port\fR
if the name is not known\&.
.sp
For BCMA devices, the core number is suppressed when 0\&.
.sp
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\&.
.sp
SR\-IOV virtual devices are named based on the name of the parent interface, with a suffix of
\fBv\fR
and the virtual device number, with any leading zeros removed\&. The bus number is ignored\&.
.sp
SR\-IOV virtual device representors are named based on the name of the physical device interface, with a suffix of
\fBr\fR
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\&.
.sp
In some configurations a parent PCI bridge of a given network controller may be associated with a slot\&. In such case we don\*(Aqt generate this device property to avoid possible naming conflicts\&.
.sp
Added in version 243\&.
.RE
.PP
\fIID_NET_NAME_PATH=\fR\fIprefix\fR\fBc\fR\fIbus_id\fR, \fIID_NET_NAME_PATH=\fR\fIprefix\fR\fBa\fR\fIvendor\fR\fImodel\fR\fBi\fR\fIinstance\fR, \fIID_NET_NAME_PATH=\fR\fIprefix\fR\fBi\fR\fIaddress\fR\fBn\fR\fIport_name\fR, \fIID_NET_NAME_PATH=\fR\fIprefix\fR\fBu\fR\fIport\fR\&..., \fIID_NET_NAME_PATH=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBp\fR\fIbus\fR\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIphys_port_name\fR|\fBd\fR\fIdev_port\fR], \fIID_NET_NAME_PATH=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBp\fR\fIbus\fR\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIphys_port_name\fR|\fBd\fR\fIdev_port\fR]\fBb\fR\fInumber\fR, \fIID_NET_NAME_PATH=\fR\fIprefix\fR[\fBP\fR\fIdomain\fR]\fBp\fR\fIbus\fR\fBs\fR\fIslot\fR[\fBf\fR\fIfunction\fR][\fBn\fR\fIphys_port_name\fR|\fBd\fR\fIdev_port\fR]\fBu\fR\fIport\fR\&...[\fBc\fR\fIconfig\fR][\fBi\fR\fIinterface\fR]
.RS 4
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\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&4.\ \&Path naming schemes
.TS
allbox tab(:);
lB lB.
T{
Format
T}:T{
Description
T}
.T&
l l
l l
l l
l l
l l
l l.
T{
\fIprefix\fR\ \&\fBc\fR\fIbus_id\fR
T}:T{
CCW or grouped CCW device identifier
T}
T{
\fIprefix\fR\ \&\fBa\fR\fIvendor\fR\ \&\fImodel\fR\ \&\fBi\fR\fIinstance\fR
T}:T{
ACPI path names for ARM64 platform devices
T}
T{
\fIprefix\fR\ \&\fBi\fR\fIaddress\fR\ \&\fBn\fR\fIport_name\fR
T}:T{
Netdevsim (simulated networking device) device number and port name
T}
T{
\fIprefix\fR\ \&[\fBP\fR\fIdomain\fR]\ \&\fBp\fR\fIbus\fR\ \&\fBs\fR\fIslot\fR\ \&[\fBf\fR\fIfunction\fR]\ \&[\fBn\fR\fIphys_port_name\fR\ \&|\ \&\fBd\fR\fIdev_port\fR]
T}:T{
PCI geographical location
T}
T{
\&...\ \&\fBb\fR\fInumber\fR
T}:T{
Broadcom bus (BCMA) core number
T}
T{
\&...\ \&\fBu\fR\fIport\fR\&...\ \&[\fBc\fR\fIconfig\fR]\ \&[\fBi\fR\fIinterface\fR]
T}:T{
USB port number chain
T}
.TE
.sp 1
CCW and grouped CCW devices are found in IBM System Z mainframes\&. Any leading zeros and dots are suppressed\&.
.sp
For PCI, BCMA, and USB devices, the same rules as described above for slot naming are used\&.
.sp
Added in version 243\&.
.RE
.SH "HISTORY"
.PP
The following "naming schemes" have been defined (which may be chosen at system boot\-up time via the
\fInet\&.naming_scheme=\fR
kernel command line switch, see above):
.PP
\fBv238\fR
.RS 4
This is the naming scheme that was implemented in systemd 238\&.
.sp
Added in version 243\&.
.RE
.PP
\fBv239\fR
.RS 4
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\&.
.sp
SR\-IOV virtual devices are named based on the name of the parent interface, with a suffix of
"v\fIport\fR", where
\fIport\fR
is the virtual device number\&. Previously those virtual devices were named as if completely independent\&.
.sp
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\fIN\fR") was used\&.
.sp
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\&.
.sp
Added in version 243\&.
.RE
.PP
\fBv240\fR
.RS 4
The
"ib"
prefix and stable names for infiniband devices are introduced\&. Previously those devices were not renamed\&.
.sp
The ACPI index field (used in
\fIID_NET_NAME_ONBOARD=\fR) is now also used when 0\&.
.sp
A new naming policy
\fINamePolicy=keep\fR
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
\fBkeep\fR
is not specified as the naming policy in the
\&.link
file\&. See
\fBsystemd.link\fR(5)
for a description of
\fINamePolicy=\fR\&.
.sp
Added in version 243\&.
.RE
.PP
\fBv241\fR
.RS 4
\fBMACAddressPolicy=persistent\fR
was extended to set MAC addresses based on the device name\&. Previously addresses were only based on the
\fIID_NET_NAME_*\fR
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\&.
.sp
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\&.
.sp
Added in version 243\&.
.RE
.PP
\fBv243\fR
.RS 4
Support for renaming netdevsim (simulated networking) devices was added\&. Previously those devices were not renamed\&.
.sp
Previously two\-letter interface type prefix was prepended to
\fIID_NET_LABEL_ONBOARD=\fR\&. This is not done anymore\&.
.sp
Added in version 243\&.
.RE
.PP
\fBv245\fR
.RS 4
When
\fBsystemd-nspawn\fR(1)
derives the name for the host side of the network interface created with
\fB\-\-network\-veth\fR
from the container name it previously simply truncated the result at 15 characters if longer (since that\*(Aqs 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)\&.
.sp
Added in version 245\&.
.RE
.PP
\fBv247\fR
.RS 4
When a PCI slot is associated with a PCI bridge that has multiple child network controllers, the same value of the
\fIID_NET_NAME_SLOT\fR
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 don\*(Aqt produce the
\fIID_NET_NAME_SLOT\fR
property\&.
.sp
Added in version 247\&.
.RE
.PP
\fBv249\fR
.RS 4
PCI hotplug slot names for the s390 PCI driver are a hexadecimal representation of the
function_id
device attribute\&. This attribute is now used to build the
\fIID_NET_NAME_SLOT\fR\&. Before that, all slot names were parsed as decimal numbers, which could either result in an incorrect value of the
\fIID_NET_NAME_SLOT\fR
property or none at all\&.
.sp
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\(S1⁴\-1) were ignored\&. For s390 PCI devices index values up to 65535 (2\(S1⁶\-1) are valid\&. To account for that, the limit was increased to 65535\&.
.sp
The udev rule
\fINAME=\fR
replaces
":",
"/", and
"%"
with an underscore ("_"), and refuses strings which contain only numerics\&.
.sp
Added in version 249\&.
.RE
.PP
\fBv250\fR
.RS 4
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)\&.
.sp
Added in version 250\&.
.RE
.PP
\fBv251\fR
.RS 4
Since version
\fBv247\fR
we no longer set
\fIID_NET_NAME_SLOT\fR
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\&.
.sp
Added in version 251\&.
.RE
.PP
\fBv252\fR
.RS 4
Added naming scheme for platform devices with devicetree aliases\&.
.sp
Added in version 252\&.
.RE
.PP
\fBv253\fR
.RS 4
Set
\fIID_NET_NAME_PATH\fR
for usb devices not connected via a PCI bus\&.
.sp
Added in version 253\&.
.RE
.PP
\fBv254\fR
.RS 4
Naming was changed for SR\-IOV virtual device representors, optionally settable at compilation time\&. The
"r\fIslot\fR"
suffix was added to differentiate SR\-IOV virtual device representors attached to a single physical device interface\&. Because of a mistake, this scheme was
\fInot the default scheme for systemd version 254\fR\&.
.sp
Added in version 255\&.
.RE
.PP
\fBv255\fR
.RS 4
Naming was changed for SR\-IOV virtual device representors to enable the change introduced in
\fBv254\fR
by default\&.
.sp
Added in version 255\&.
.RE
.PP
Note that
\fBlatest\fR
may be used to denote the latest scheme known (to this particular version of systemd)\&.
.SH "LIMITING THE USE OF SPECIFIC SYSFS ATTRIBUTES"
.PP
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 udev is picked, the network card\*(Aqs name can still change when a new kernel version adds a new sysfs attribute\&. For example if kernel starts setting the
\fBphys_port_name\fR, udev will append the "\fBn\fR\fIphys_port_name\fR" suffix to the device name\&.
.PP
\fIID_NET_NAME_ALLOW=\fR\fIBOOL\fR
.RS 4
This udev property sets a fallback policy for reading a sysfs attribute\&. If set to
\fB0\fR
udev will not read any sysfs attribute by default, unless it is explicitly allowlisted, see below\&. If set to
\fB1\fR
udev can use any sysfs attribute unless it is explicitly forbidden\&. The default value is
\fB1\fR\&.
.sp
Added in version 256\&.
.RE
.PP
\fIID_NET_NAME_ALLOW_\fR\fI\fIsysfsattr\fR\fR\fI=\fR\fI\fIBOOL\fR\fR
.RS 4
This udev property explicitly states if udev shall use the specified
\fIsysfsattr\fR, when composing the device name\&.
.sp
Added in version 256\&.
.RE
.PP
With these options, users can set an allowlist or denylist for sysfs attributes\&. To create an allowlist, the user needs to set
\fIID_NET_NAME_ALLOW=0\fR
for the device and then list the allowed attributes with the
\fIID_NET_NAME_ALLOW_\fR\fI\fIsysfsattr\fR\fR\fI=1\fR
options\&. In case of a denylist, the user needs to provide the list of denied attributes with the
\fIID_NET_NAME_ALLOW_\fR\fI\fIsysfsattr\fR\fR\fI=0\fR
options\&.
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&Using udevadm test\-builtin to display device properties\fR
.sp
.if n \{\
.RS 4
.\}
.nf
$ udevadm test\-builtin net_id /sys/class/net/enp0s31f6
\&.\&.\&.
Using default interface naming scheme \*(Aqv243\*(Aq\&.
ID_NET_NAMING_SCHEME=v243
ID_NET_NAME_MAC=enx54ee75cb1dc0
ID_OUI_FROM_DATABASE=Wistron InfoComm(Kunshan)Co\&.,Ltd\&.
ID_NET_NAME_PATH=enp0s31f6
\&.\&.\&.
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&PCI Ethernet card with firmware index "1"\fR
.sp
.if n \{\
.RS 4
.\}
.nf
ID_NET_NAME_ONBOARD=eno1
ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&3.\ \&PCI Ethernet card in hotplug slot with firmware index number\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /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
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&4.\ \&PCI Ethernet multi\-function card with 2 ports\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /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
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&5.\ \&PCI WLAN card\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /sys/devices/pci0000:00/0000:00:1c\&.1/0000:03:00\&.0/net/wlp3s0
ID_NET_NAME_MAC=wlx0024d7e31130
ID_NET_NAME_PATH=wlp3s0
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&6.\ \&PCI IB host adapter with 2 ports\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /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
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&7.\ \&USB built\-in 3G modem\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /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
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&8.\ \&USB Android phone\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /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
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&9.\ \&s390 grouped CCW interface\fR
.sp
.if n \{\
.RS 4
.\}
.nf
# /sys/devices/css0/0\&.0\&.0007/0\&.0\&.f5f0/group_device/net/encf5f0
ID_NET_NAME_MAC=enx026d3c00000a
ID_NET_NAME_PATH=encf5f0
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&10.\ \&Set an allowlist for reading sysfs attributes for network card naming\fR
.sp
.if n \{\
.RS 4
.\}
.nf
/etc/udev/hwdb\&.d/50\-net\-naming\-allowlist\&.hwdb
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
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&11.\ \&Set a denylist so that specified sysfs attribute are ignored\fR
.sp
.if n \{\
.RS 4
.\}
.nf
/etc/udev/hwdb\&.d/50\-net\-naming\-denylist\&.hwdb
net:naming:drvirtio_net:*
ID_NET_NAME_ALLOW=1
ID_NET_NAME_ALLOW_DEV_PORT=0
ID_NET_NAME_ALLOW_PHYS_PORT_NAME=0
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBudev\fR(7), \fBudevadm\fR(8), \m[blue]\fBPredictable Network Interface Names\fR\m[]\&\s-2\u[1]\d\s+2, \fBsystemd-nspawn\fR(1)
.SH "NOTES"
.IP " 1." 4
Predictable Network Interface Names
.RS 4
\%https://systemd.io/PREDICTABLE_INTERFACE_NAMES
.RE
|