]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.net-naming-scheme.xml
man: slightly extend documentation on difference between ID_NET_NAME_ONBOARD and...
[thirdparty/systemd.git] / man / systemd.net-naming-scheme.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
5
6 <refentry id="systemd.net-naming-scheme">
7 <refentryinfo>
8 <title>systemd.net-naming-scheme</title>
9 <productname>systemd</productname>
10 </refentryinfo>
11
12 <refmeta>
13 <refentrytitle>systemd.net-naming-scheme</refentrytitle>
14 <manvolnum>7</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>systemd.net-naming-scheme</refname>
19 <refpurpose>Network device naming schemes</refpurpose>
20 </refnamediv>
21
22 <refsect1>
23 <title>Description</title>
24
25 <para>Network interfaces names and MAC addresses may be generated based on certain stable interface
26 attributes. This is possible when there is enough information about the device to generate those
27 attributes and the use of this information is configured. This page describes interface naming, i.e. what
28 possible names may be generated. Those names are generated by the
29 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
30 builtin <command>net_id</command> and exported as udev properties
31 (<varname>ID_NET_NAME_ONBOARD=</varname>, <varname>ID_NET_LABEL_ONBOARD=</varname>,
32 <varname>ID_NET_NAME_PATH=</varname>, <varname>ID_NET_NAME_SLOT=</varname>).</para>
33
34 <para>Names and MAC addresses are derived from various stable device metadata attributes. Newer versions
35 of udev take more of these attributes into account, improving (and thus possibly changing) the names and
36 addresses used for the same devices. Different versions of those generation rules are called "naming
37 schemes". The default naming scheme is chosen at compilation time. Usually this will be the latest
38 implemented version, but it is also possible to set one of the older versions to preserve
39 compatibility. This may be useful for example for distributions, which may introduce new versions of
40 systemd in stable releases without changing the naming scheme. The naming scheme may also be overridden
41 using the <varname>net.naming-scheme=</varname> kernel command line switch, see
42 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
43 Available naming schemes are described below.</para>
44
45 <para>After the udev properties have been generated, appropriate udev rules may be used to actually rename
46 devices based on those properties. See the description of <varname>NamePolicy=</varname> and
47 <varname>MACAddressPolicy=</varname> in
48 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
49
50 <para>Note that while the concept of network interface naming schemes is primarily relevant in the
51 context of <filename>systemd-udevd.service</filename>, the
52 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
53 container manager also takes it into account when naming network interfaces, see below.</para>
54 </refsect1>
55
56 <refsect1>
57 <title>Naming</title>
58
59 <para>All names start with a two-character prefix that signifies the interface type.</para>
60
61 <table>
62 <title>Two character prefixes based on the type of interface</title>
63
64 <tgroup cols='2'>
65 <thead>
66 <row>
67 <entry>Prefix</entry>
68 <entry>Description</entry>
69 </row>
70 </thead>
71 <tbody>
72 <row>
73 <entry><constant>en</constant></entry>
74 <entry>Ethernet</entry>
75 </row>
76 <row>
77 <entry><constant>ib</constant></entry>
78 <entry>InfiniBand</entry>
79 </row>
80 <row>
81 <entry><constant>sl</constant></entry>
82 <entry>serial line IP (slip)</entry>
83 </row>
84 <row>
85 <entry><constant>wl</constant></entry>
86 <entry>Wireless local area network (WLAN)</entry>
87 </row>
88 <row>
89 <entry><constant>ww</constant></entry>
90 <entry>Wireless wide area network (WWAN)</entry>
91 </row>
92 </tbody>
93 </tgroup>
94 </table>
95
96 <para>The udev <command>net_id</command> builtin exports the following udev device properties:</para>
97
98 <variablelist>
99 <varlistentry>
100 <term><varname>ID_NET_NAME_ONBOARD=<replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></varname></term>
101
102 <listitem><para>This name is set based on the numeric ordering information given by the firmware
103 for on-board devices. The name consists of the prefix, letter <constant>o</constant>, and a number
104 specified by the firmware. This is only available for PCI devices.</para>
105 </listitem>
106 </varlistentry>
107
108 <varlistentry>
109 <term><varname>ID_NET_LABEL_ONBOARD=<replaceable>prefix</replaceable> <replaceable>label</replaceable></varname></term>
110
111 <listitem><para>This property is set based on textual label given by the firmware for on-board
112 devices. The name consists of the prefix concatenated with the label. This is only available for
113 PCI devices.
114 </para>
115 </listitem>
116 </varlistentry>
117
118 <varlistentry>
119 <term><varname>ID_NET_NAME_MAC=<replaceable>prefix</replaceable><constant>x</constant><replaceable>AABBCCDDEEFF</replaceable></varname></term>
120
121 <listitem><para>This name consists of the prefix, letter <constant>x</constant>, and 12 hexadecimal
122 digits of the MAC address. It is available if the device has a fixed MAC address. Because this name
123 is based on an attribute of the card itself, it remains "stable" when the device is moved (even
124 between machines), but will change when the hardware is replaced.</para>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry>
129 <term><varname>ID_NET_NAME_SLOT=<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>]</varname></term>
130 <term><varname>ID_NET_NAME_SLOT=<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></varname></term>
131 <term><varname>ID_NET_NAME_SLOT=<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>]</varname></term>
132 <term><varname>ID_NET_NAME_SLOT=<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></varname></term>
133
134 <listitem><para>This property describes the slot position. Different schemes are used depending on
135 the bus type, as described in the table below. In all cases, PCI slot information must be known. In
136 case of USB, BCMA, and SR-VIO devices, the full name consists of the prefix, PCI slot identifier,
137 and USB or BCMA or SR-VIO slot identifier. The first two parts are denoted as "…" in the table
138 below.</para>
139
140 <table>
141 <title>Slot naming schemes</title>
142
143 <tgroup cols='2'>
144 <thead>
145 <row>
146 <entry>Format</entry>
147 <entry>Description</entry>
148 </row>
149 </thead>
150
151 <tbody>
152 <row>
153 <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>
154 <entry>PCI slot number</entry>
155 </row>
156
157 <row>
158 <entry>… <constant>b</constant><replaceable>number</replaceable></entry>
159 <entry>Broadcom bus (BCMA) core number</entry>
160 </row>
161
162 <row>
163 <entry>… <constant>u</constant><replaceable>port</replaceable>… [<constant>c</constant><replaceable>config</replaceable>] [<constant>i</constant><replaceable>interface</replaceable>]</entry>
164 <entry>USB port number chain</entry>
165 </row>
166
167 <row>
168 <entry>… <constant>v</constant><replaceable>slot</replaceable></entry>
169 <entry>SR-VIO slot number</entry>
170 </row>
171 </tbody>
172 </tgroup>
173 </table>
174
175 <para>The PCI domain is only prepended when it is not 0. All multi-function PCI devices will carry
176 the <constant>f<replaceable>function</replaceable></constant> number in the device name, including
177 the function 0 device. For non-multi-function devices, the number is suppressed if 0. The port name
178 <replaceable>port_name</replaceable> is used, or the port number
179 <constant>d</constant><replaceable>dev_port</replaceable> if the name is not known.</para>
180
181 <para>For BCMA devices, the core number is suppressed when 0.</para>
182
183 <para>For USB devices the full chain of port numbers of hubs is composed. If the name gets longer
184 than the maximum number of 15 characters, the name is not exported. The usual USB configuration
185 number 1 and interface number 0 values are suppressed.</para>
186 </listitem>
187
188 <para>SR-IOV virtual devices are named based on the name of the parent interface, with a suffix of
189 <constant>v</constant> and the virtual device number, with any leading zeros removed. The bus
190 number is ignored. This device type is found in IBM PowerVMs.</para>
191 </varlistentry>
192
193 <varlistentry>
194 <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>c</constant><replaceable>bus_id</replaceable></varname></term>
195 <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>a</constant><replaceable>vendor</replaceable><replaceable>model</replaceable><constant>i</constant><replaceable>instance</replaceable></varname></term>
196 <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>i</constant><replaceable>address</replaceable><constant>n</constant><replaceable>port_name</replaceable></varname></term>
197 <term><varname>ID_NET_NAME_PATH=<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>]</varname></term>
198 <term><varname>ID_NET_NAME_PATH=<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></varname></term>
199 <term><varname>ID_NET_NAME_PATH=<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>]</varname></term>
200
201 <listitem><para>This property describes the device installation location. Different schemes are
202 used depending on the bus type, as described in the table below. For BCMA and USB devices, PCI path
203 information must known, and the full name consists of the prefix, PCI slot identifier, and USB or
204 BCMA location. The first two parts are denoted as "…" in the table below.</para>
205
206 <table>
207 <title>Path naming schemes</title>
208
209 <tgroup cols='2'>
210 <thead>
211 <row>
212 <entry>Format</entry>
213 <entry>Description</entry>
214 </row>
215 </thead>
216
217 <tbody>
218 <row>
219 <entry><replaceable>prefix</replaceable> <constant>c</constant><replaceable>bus_id</replaceable></entry>
220 <entry>CCW or grouped CCW device identifier</entry>
221 </row>
222
223 <row>
224 <entry><replaceable>prefix</replaceable> <constant>a</constant><replaceable>vendor</replaceable> <replaceable>model</replaceable> <constant>i</constant><replaceable>instance</replaceable></entry>
225 <entry>ACPI path names for ARM64 platform devices</entry>
226 </row>
227
228 <row>
229 <entry><replaceable>prefix</replaceable> <constant>i</constant><replaceable>address</replaceable> <constant>n</constant><replaceable>port_name</replaceable></entry>
230 <entry>Netdevsim (simulated networking device) device number and port name</entry>
231 </row>
232
233 <row>
234 <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>
235 <entry>PCI geographical location</entry>
236 </row>
237
238 <row>
239 <entry>… <constant>b</constant><replaceable>number</replaceable></entry>
240 <entry>Broadcom bus (BCMA) core number</entry>
241 </row>
242
243 <row>
244 <entry>… <constant>u</constant><replaceable>port</replaceable>… [<constant>c</constant><replaceable>config</replaceable>] [<constant>i</constant><replaceable>interface</replaceable>]</entry>
245 <entry>USB port number chain</entry>
246 </row>
247
248 </tbody>
249 </tgroup>
250 </table>
251
252 <para>CCW and grouped CCW devices are found in IBM System Z mainframes. Any leading zeros and
253 dots are suppressed.</para>
254
255 <para>For PCI, BCMA, and USB devices, the same rules as described above for slot naming are
256 used.</para>
257 </listitem>
258 </varlistentry>
259 </variablelist>
260 </refsect1>
261
262 <refsect1>
263 <title>History</title>
264
265 <para>The following "naming schemes" have been defined:</para>
266
267 <variablelist>
268 <varlistentry>
269 <term><constant>v238</constant></term>
270
271 <listitem><para>This is the naming scheme that was implemented in systemd 238.</para></listitem>
272 </varlistentry>
273
274 <varlistentry>
275 <term><constant>v239</constant></term>
276
277 <listitem><para>Naming was changed for virtual network interfaces created with SR-IOV and NPAR and
278 for devices where the PCI network controller device does not have a slot number associated.</para>
279
280 <para>SR-IOV virtual devices are named based on the name of the parent interface, with a suffix of
281 <literal>v<replaceable>port</replaceable></literal>, where <replaceable>port</replaceable> is the
282 virtual device number. Previously those virtual devices were named as if completely independent.
283 </para>
284
285 <para>The ninth and later NPAR virtual devices are named following the scheme used for the first
286 eight NPAR partitions. Previously those devices were not renamed and the kernel default
287 ("eth<replaceable>N</replaceable>") was used.</para>
288
289 <para>Names are also generated for PCI devices where the PCI network controller device does not
290 have an associated slot number itself, but one of its parents does. Previously those devices were
291 not renamed and the kernel default was used.</para>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry>
296 <term><constant>v240</constant></term>
297
298 <listitem><para>The <literal>ib</literal> prefix and stable names for infiniband devices are
299 introduced. Previously those devices were not renamed.</para>
300
301 <para>The ACPI index field (used in <varname>ID_NET_NAME_ONBOARD=</varname>) is now also used when
302 0.</para>
303
304 <para>A new naming policy <varname>NamePolicy=keep</varname> was introduced. With this policy, if
305 the network device name was already set by userspace, the device will not be renamed
306 again. Previously, this naming policy applied implicitly, and now it must be explicitly
307 requested. Effectively, this means that network devices will be renamed according to the
308 configuration, even if they have been renamed already, if <constant>keep</constant> is not
309 specified as the naming policy in the <filename index="false">.link</filename> file. See
310 <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
311 for a description of <varname>NamePolicy=</varname>.</para></listitem>
312 </varlistentry>
313
314 <varlistentry>
315 <term><constant>v241</constant></term>
316
317 <listitem><para><option>MACAddressPolicy=persistent</option> was extended to set MAC addresses
318 based on the device name. Previously addresses were only based on the
319 <varname index="false">ID_NET_NAME_*</varname> attributes, which meant that interface names would
320 never be generated for virtual devices. Now a persistent address will be generated for most
321 devices, including in particular bridges.</para>
322
323 <para>Note: when userspace does not set a MAC address for a bridge device, the kernel will
324 initially assign a random address, and then change it when the first device is enslaved to the
325 bridge. With this naming policy change, bridges get a persistent MAC address based on the bridge
326 name instead of the first enslaved device.</para></listitem>
327 </varlistentry>
328
329 <varlistentry>
330 <term><constant>v243</constant></term>
331
332 <listitem><para>Support for renaming netdevsim (simulated networking) devices was added. Previously
333 those devices were not renamed.</para>
334
335 <para>Previously two-letter interface type prefix was prepended to
336 <varname>ID_NET_LABEL_ONBOARD=</varname>. This is not done anymore.</para></listitem>
337 </varlistentry>
338
339 <varlistentry>
340 <term><constant>v245</constant></term>
341
342 <listitem><para>When
343 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
344 derives the name for the host side of the network interface created with
345 <option>--network-veth</option> from the container name it previously simply truncated the result
346 at 15 characters if longer (since that's the maximum length for network interface names). From now
347 on, for any interface name that would be longer than 15 characters the last 4 characters are set to
348 a 24bit hash value of the full interface name. This way network interface name collisions between
349 multiple similarly named containers (who only differ in container name suffix) should be less
350 likely (but still possible, since the 24bit hash value is very small).</para></listitem>
351 </varlistentry>
352 </variablelist>
353
354 <para>Note that <constant>latest</constant> may be used to denote the latest scheme known (to this
355 particular version of systemd.</para>
356 </refsect1>
357
358 <refsect1>
359 <title>Examples</title>
360
361 <example>
362 <title>Using <command>udevadm test-builtin</command> to display device properties</title>
363
364 <programlisting>$ udevadm test-builtin net_id /sys/class/net/enp0s31f6
365 ...
366 Using default interface naming scheme 'v243'.
367 ID_NET_NAMING_SCHEME=v243
368 ID_NET_NAME_MAC=enx54ee75cb1dc0
369 ID_OUI_FROM_DATABASE=Wistron InfoComm(Kunshan)Co.,Ltd.
370 ID_NET_NAME_PATH=enp0s31f6
371 ...</programlisting>
372 </example>
373
374 <example>
375 <title>PCI Ethernet card with firmware index "1"</title>
376
377 <programlisting>ID_NET_NAME_ONBOARD=eno1
378 ID_NET_NAME_ONBOARD_LABEL=Ethernet Port 1
379 </programlisting>
380 </example>
381
382 <example>
383 <title>PCI Ethernet card in hotplug slot with firmware index number</title>
384
385 <programlisting># /sys/devices/pci0000:00/0000:00:1c.3/0000:05:00.0/net/ens1
386 ID_NET_NAME_MAC=enx000000000466
387 ID_NET_NAME_PATH=enp5s0
388 ID_NET_NAME_SLOT=ens1</programlisting>
389 </example>
390
391 <example>
392 <title>PCI Ethernet multi-function card with 2 ports</title>
393
394 <programlisting># /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.0/net/enp2s0f0
395 ID_NET_NAME_MAC=enx78e7d1ea46da
396 ID_NET_NAME_PATH=enp2s0f0
397
398 # /sys/devices/pci0000:00/0000:00:1c.0/0000:02:00.1/net/enp2s0f1
399 ID_NET_NAME_MAC=enx78e7d1ea46dc
400 ID_NET_NAME_PATH=enp2s0f1</programlisting>
401 </example>
402
403 <example>
404 <title>PCI WLAN card</title>
405
406 <programlisting># /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlp3s0
407 ID_NET_NAME_MAC=wlx0024d7e31130
408 ID_NET_NAME_PATH=wlp3s0</programlisting>
409 </example>
410
411 <example>
412 <title>PCI IB host adapter with 2 ports</title>
413
414 <programlisting># /sys/devices/pci0000:00/0000:00:03.0/0000:15:00.0/net/ibp21s0f0
415 ID_NET_NAME_PATH=ibp21s0f0
416
417 # /sys/devices/pci0000:00/0000:00:03.0/0000:15:00.1/net/ibp21s0f1
418 ID_NET_NAME_PATH=ibp21s0f1</programlisting>
419 </example>
420
421 <example>
422 <title>USB built-in 3G modem</title>
423
424 <programlisting># /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.4/2-1.4:1.6/net/wwp0s29u1u4i6
425 ID_NET_NAME_MAC=wwx028037ec0200
426 ID_NET_NAME_PATH=wwp0s29u1u4i6</programlisting>
427 </example>
428
429 <example>
430 <title>USB Android phone</title>
431
432 <programlisting># /sys/devices/pci0000:00/0000:00:1d.0/usb2/2-1/2-1.2/2-1.2:1.0/net/enp0s29u1u2
433 ID_NET_NAME_MAC=enxd626b3450fb5
434 ID_NET_NAME_PATH=enp0s29u1u2</programlisting>
435 </example>
436
437 <example>
438 <title>s390 grouped CCW interface</title>
439
440 <programlisting># /sys/devices/css0/0.0.0007/0.0.f5f0/group_device/net/encf5f0
441 ID_NET_NAME_MAC=enx026d3c00000a
442 ID_NET_NAME_PATH=encf5f0</programlisting>
443 </example>
444 </refsect1>
445
446 <refsect1>
447 <title>See Also</title>
448 <para>
449 <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
450 <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
451 <ulink url="https://systemd.io/PREDICTABLE_INTERFACE_NAMES">Predictable Network Interface Names</ulink>,
452 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
453 </para>
454 </refsect1>
455
456 </refentry>