Debian Codegraph @

upstream/debian-unstable/man5/systemd.link.5

raw
1 '\" t
2 .TH "SYSTEMD\&.LINK" "5" "" "systemd 261~rc3" "systemd.link"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd.link \- Network device configuration
24 .SH "SYNOPSIS"
25 .PP
26 \fIlink\fR\&.link
27 .SH "DESCRIPTION"
28 .PP
29 A plain ini\-style text file that encodes configuration for matching network devices, used by
30 \fBsystemd-udevd\fR(8)
31 and in particular its
32 \fBnet_setup_link\fR
33 builtin\&. See
34 \fBsystemd.syntax\fR(7)
35 for a general description of the syntax\&.
36 .PP
37 Note that some distributions may incorporate
38 \&.link
39 files in their early boot facilities (e\&.g\&. by including copies of the
40 \&.link
41 files in initramfs)\&. As such it may be necessary to take manual steps to ensure that any local changes are consistent with early\-boot storage facilities\&. The relevant distribution\-specific documentation should be consulted\&.
42 .PP
43 The
44 \&.link
45 files are read from the files located in the system network directory
46 /usr/lib/systemd/network
47 and
48 /usr/local/lib/systemd/network
49 \&\s-2\u[1]\d\s+2, the volatile runtime network directory
50 /run/systemd/network, and the local administration network directory
51 /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 smaller than
52 "70"
53 (e\&.g\&.
54 10\-eth0\&.link)\&. Otherwise, the default
55 \&.link
56 files or those generated by
57 \fBsystemd-network-generator.service\fR(8)
58 may take precedence over user configured files\&. Files in
59 /etc/
60 have the highest priority, files in
61 /run/
62 take precedence over files with the same name in
63 /usr/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
64 /dev/null
65 disables the configuration file entirely (it is "masked")\&.
66 .PP
67 Along with the link file
68 foo\&.link, a "drop\-in" directory
69 foo\&.link\&.d/
70 may exist\&. All files with the suffix
71 "\&.conf"
72 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\&.
73 .PP
74 In addition to
75 /etc/systemd/network, drop\-in
76 "\&.d"
77 directories can be placed in
78 /usr/lib/systemd/network
79 or
80 /run/systemd/network
81 directories\&. Drop\-in files in
82 /etc/
83 take precedence over those in
84 /run/
85 which in turn take precedence over those in
86 /usr/lib/\&. Drop\-in files under any of these directories take precedence over the main link file wherever located\&.
87 .PP
88 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 lexicographic order) of the link files that matches a given device is applied\&. Note that a default file
89 99\-default\&.link
90 is shipped by the system\&. Any user\-supplied
91 \&.link
92 should hence have a lexicographically earlier name to be considered at all\&.
93 .PP
94 See
95 \fBudevadm\fR(8)
96 for diagnosing problems with
97 \&.link
98 files\&.
99 .SH "[MATCH] SECTION OPTIONS"
100 .PP
101 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
102 \fBsystemd\-udevd\fR
103 warns about that\&. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following:
104 .sp
105 .if n \{\
106 .RS 4
107 .\}
108 .nf
109 OriginalName=*
110 .fi
111 .if n \{\
112 .RE
113 .\}
114 .sp
115 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:
116 .PP
117 \fIMACAddress=\fR
118 .RS 4
119 A whitespace\-separated list of hardware addresses\&. The acceptable formats are:
120 .PP
121 \fBcolon\-delimited hexadecimal\fR
122 .RS 4
123 Each field must be one byte\&. E\&.g\&.
124 "12:34:56:78:90:ab"
125 or
126 "AA:BB:CC:DD:EE:FF"\&.
127 .sp
128 Added in version 250\&.
129 .RE
130 .PP
131 \fBhyphen\-delimited hexadecimal\fR
132 .RS 4
133 Each field must be one byte\&. E\&.g\&.
134 "12\-34\-56\-78\-90\-ab"
135 or
136 "AA\-BB\-CC\-DD\-EE\-FF"\&.
137 .sp
138 Added in version 250\&.
139 .RE
140 .PP
141 \fBdot\-delimited hexadecimal\fR
142 .RS 4
143 Each field must be two bytes\&. E\&.g\&.
144 "1234\&.5678\&.90ab"
145 or
146 "AABB\&.CCDD\&.EEFF"\&.
147 .sp
148 Added in version 250\&.
149 .RE
150 .PP
151 \fBIPv4 address format\fR
152 .RS 4
153 E\&.g\&.
154 "127\&.0\&.0\&.1"
155 or
156 "192\&.168\&.0\&.1"\&.
157 .sp
158 Added in version 250\&.
159 .RE
160 .PP
161 \fBIPv6 address format\fR
162 .RS 4
163 E\&.g\&.
164 "2001:0db8:85a3::8a2e:0370:7334"
165 or
166 "::1"\&.
167 .sp
168 Added in version 250\&.
169 .RE
170 .sp
171 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\&.
172 .sp
173 Added in version 211\&.
174 .RE
175 .PP
176 \fIPermanentMACAddress=\fR
177 .RS 4
178 A whitespace\-separated list of hardware\*(Aqs permanent addresses\&. While
179 \fIMACAddress=\fR
180 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\&.
181 .sp
182 Added in version 245\&.
183 .RE
184 .PP
185 \fIPath=\fR
186 .RS 4
187 A whitespace\-separated list of shell\-style globs matching the persistent path, as exposed by the udev property
188 \fIID_PATH\fR\&.
189 .sp
190 Added in version 211\&.
191 .RE
192 .PP
193 \fIDriver=\fR
194 .RS 4
195 A whitespace\-separated list of shell\-style globs matching the driver currently bound to the device, as exposed by the udev property
196 \fIID_NET_DRIVER\fR
197 of its parent device, or if that is not set, the driver as exposed by
198 \fBethtool \-i\fR
199 of the device itself\&. If the list is prefixed with a "!", the test is inverted\&.
200 .sp
201 Added in version 211\&.
202 .RE
203 .PP
204 \fIType=\fR
205 .RS 4
206 A whitespace\-separated list of shell\-style globs matching the device type, as exposed by
207 \fBnetworkctl list\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
208 "ether",
209 "loopback",
210 "wlan",
211 "wwan"\&. Valid types are named either from the udev
212 "DEVTYPE"
213 attribute, or
214 "ARPHRD_"
215 macros in
216 linux/if_arp\&.h, so this is not comprehensive\&.
217 .sp
218 Added in version 211\&.
219 .RE
220 .PP
221 \fIKind=\fR
222 .RS 4
223 A whitespace\-separated list of shell\-style globs matching the device kind, as exposed by
224 \fBnetworkctl status \fR\fB\fIINTERFACE\fR\fR
225 or
226 \fBip \-d link show \fR\fB\fIINTERFACE\fR\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
227 "bond",
228 "bridge",
229 "gre",
230 "tun",
231 "veth"\&. Valid kinds are given by netlink\*(Aqs
232 "IFLA_INFO_KIND"
233 attribute, so this is not comprehensive\&.
234 .sp
235 Added in version 251\&.
236 .RE
237 .PP
238 \fIProperty=\fR
239 .RS 4
240 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
241 "\e"\&.
242 .sp
243 Example: if a \&.link file has the following:
244 .sp
245 .if n \{\
246 .RS 4
247 .\}
248 .nf
249 Property=ID_MODEL_ID=9999 "ID_VENDOR_FROM_DATABASE=vendor name" "KEY=with \e"quotation\e""
250 .fi
251 .if n \{\
252 .RE
253 .\}
254 .sp
255 then, the \&.link file matches only when an interface has all the above three properties\&.
256 .sp
257 Added in version 243\&.
258 .RE
259 .PP
260 \fIOriginalName=\fR
261 .RS 4
262 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\&.
263 .sp
264 Added in version 218\&.
265 .RE
266 .PP
267 \fIHost=\fR
268 .RS 4
269 Matches against the hostname or machine ID of the host\&. See
270 \fIConditionHost=\fR
271 in
272 \fBsystemd.unit\fR(5)
273 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
274 .sp
275 Added in version 211\&.
276 .RE
277 .PP
278 \fIVirtualization=\fR
279 .RS 4
280 Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation\&. See
281 \fIConditionVirtualization=\fR
282 in
283 \fBsystemd.unit\fR(5)
284 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
285 .sp
286 Added in version 211\&.
287 .RE
288 .PP
289 \fIKernelCommandLine=\fR
290 .RS 4
291 Checks whether a specific kernel command line option is set\&. See
292 \fIConditionKernelCommandLine=\fR
293 in
294 \fBsystemd.unit\fR(5)
295 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
296 .sp
297 Added in version 211\&.
298 .RE
299 .PP
300 \fIKernelVersion=\fR
301 .RS 4
302 Checks whether the kernel version (as reported by
303 \fBuname \-r\fR) matches a certain expression\&. See
304 \fIConditionKernelVersion=\fR
305 in
306 \fBsystemd.unit\fR(5)
307 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
308 .sp
309 Added in version 237\&.
310 .RE
311 .PP
312 \fIVersion=\fR
313 .RS 4
314 Checks whether a software version matches a certain expression\&. See
315 \fIConditionVersion=\fR
316 in
317 \fBsystemd.unit\fR(5)
318 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
319 .sp
320 Added in version 258\&.
321 .RE
322 .PP
323 \fICredential=\fR
324 .RS 4
325 Checks whether the specified credential was passed to the
326 systemd\-udevd\&.service
327 service\&. See
328 \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[2]\d\s+2
329 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
330 .sp
331 Added in version 252\&.
332 .RE
333 .PP
334 \fIArchitecture=\fR
335 .RS 4
336 Checks whether the system is running on a specific architecture\&. See
337 \fIConditionArchitecture=\fR
338 in
339 \fBsystemd.unit\fR(5)
340 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
341 .sp
342 Added in version 211\&.
343 .RE
344 .PP
345 \fIFirmware=\fR
346 .RS 4
347 Checks whether the system is running on a machine with the specified firmware\&. See
348 \fIConditionFirmware=\fR
349 in
350 \fBsystemd.unit\fR(5)
351 for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
352 .sp
353 Added in version 249\&.
354 .RE
355 .SH "[LINK] SECTION OPTIONS"
356 .PP
357 The [Link] section accepts the following keys:
358 .PP
359 \fIDescription=\fR
360 .RS 4
361 A description of the device\&.
362 .sp
363 Added in version 211\&.
364 .RE
365 .PP
366 \fIProperty=\fR
367 .RS 4
368 Set specified udev properties\&. This takes space separated list of key\-value pairs concatenated with equal sign ("=")\&. Example:
369 .sp
370 .if n \{\
371 .RS 4
372 .\}
373 .nf
374 Property=HOGE=foo BAR=baz
375 .fi
376 .if n \{\
377 .RE
378 .\}
379 .sp
380 This option supports simple specifier expansion, see the Specifiers section below\&. This option can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
381 .sp
382 This setting is useful to configure the
383 "ID_NET_MANAGED_BY="
384 property which declares which network management service shall manage the interface, which is respected by
385 \fBsystemd-networkd\fR(8)
386 and others\&. Use
387 .sp
388 .if n \{\
389 .RS 4
390 .\}
391 .nf
392 Property=ID_NET_MANAGED_BY=io\&.systemd\&.Network
393 .fi
394 .if n \{\
395 .RE
396 .\}
397 .sp
398 to declare explicitly that
399 \fBsystemd\-networkd\fR
400 shall manage the interface, or set the property to something else to declare explicitly it shall not do so\&. See
401 \fBsystemd.network\fR(5)
402 for details how this property is used to match interface names\&.
403 .sp
404 Added in version 256\&.
405 .RE
406 .PP
407 \fIImportProperty=\fR
408 .RS 4
409 Import specified udev properties from the saved database\&. This takes space separated list of property names\&. Example:
410 .sp
411 .if n \{\
412 .RS 4
413 .\}
414 .nf
415 ImportProperty=HOGE BAR
416 .fi
417 .if n \{\
418 .RE
419 .\}
420 .sp
421 This option supports simple specifier expansion, see the Specifiers section below\&. This option can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
422 .sp
423 If the same property is also set in
424 \fIProperty=\fR
425 in the above, then the imported property value will be overridden by the value specified in
426 \fIProperty=\fR\&.
427 .sp
428 Added in version 256\&.
429 .RE
430 .PP
431 \fIUnsetProperty=\fR
432 .RS 4
433 Unset specified udev properties\&. This takes space separated list of property names\&. Example:
434 .sp
435 .if n \{\
436 .RS 4
437 .\}
438 .nf
439 UnsetProperty=HOGE BAR
440 .fi
441 .if n \{\
442 .RE
443 .\}
444 .sp
445 This option supports simple specifier expansion, see the Specifiers section below\&. This option can be specified multiple times\&. If an empty string is assigned, then the all previous assignments are cleared\&.
446 .sp
447 This setting is applied after
448 \fIImportProperty=\fR
449 and
450 \fIProperty=\fR
451 are applied\&. Hence, if the same property is specified in
452 \fIImportProperty=\fR
453 or
454 \fIProperty=\fR, then the imported or specified property value will be ignored, and the property will be unset\&.
455 .sp
456 Added in version 256\&.
457 .RE
458 .PP
459 \fIAlias=\fR
460 .RS 4
461 The
462 \fIifalias\fR
463 interface property is set to this value\&.
464 .sp
465 Added in version 211\&.
466 .RE
467 .PP
468 \fIMACAddressPolicy=\fR
469 .RS 4
470 The policy by which the MAC address should be set\&. The available policies are:
471 .PP
472 \fBpersistent\fR
473 .RS 4
474 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\&.
475 .sp
476 Added in version 211\&.
477 .RE
478 .PP
479 \fBrandom\fR
480 .RS 4
481 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
482 "unicast"
483 and
484 "locally administered"
485 bits set\&.
486 .sp
487 Added in version 211\&.
488 .RE
489 .PP
490 \fBnone\fR
491 .RS 4
492 Keeps the MAC address assigned by the kernel\&. Or use the MAC address specified in
493 \fIMACAddress=\fR\&.
494 .sp
495 Added in version 227\&.
496 .RE
497 .sp
498 An empty string assignment is equivalent to setting
499 "none"\&.
500 .sp
501 Added in version 211\&.
502 .RE
503 .PP
504 \fIMACAddress=\fR
505 .RS 4
506 The interface MAC address to use\&. For this setting to take effect,
507 \fIMACAddressPolicy=\fR
508 must either be unset, empty, or
509 "none"\&.
510 .sp
511 Added in version 211\&.
512 .RE
513 .PP
514 \fINamePolicy=\fR
515 .RS 4
516 An ordered, space\-separated list of policies by which the interface name should be set\&.
517 \fINamePolicy=\fR
518 may be disabled by specifying
519 \fBnet\&.ifnames=0\fR
520 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
521 \fBID_NET_NAME\fR, which is, by default, used by a
522 \fBudev\fR(7), rule to set
523 \fINAME\fR\&. The available policies are:
524 .PP
525 \fBkernel\fR
526 .RS 4
527 If the kernel claims that the name it has set for a device is predictable, then no renaming is performed\&.
528 .sp
529 Added in version 216\&.
530 .RE
531 .PP
532 \fBdatabase\fR
533 .RS 4
534 The name is set based on entries in the udev\*(Aqs Hardware Database with the key
535 \fIID_NET_NAME_FROM_DATABASE\fR\&.
536 .sp
537 Added in version 211\&.
538 .RE
539 .PP
540 \fBonboard\fR
541 .RS 4
542 The name is set based on information given by the firmware for on\-board devices, as exported by the udev property
543 \fIID_NET_NAME_ONBOARD\fR\&. See
544 \fBsystemd.net-naming-scheme\fR(7)\&.
545 .sp
546 Added in version 211\&.
547 .RE
548 .PP
549 \fBslot\fR
550 .RS 4
551 The name is set based on information given by the firmware for hot\-plug devices, as exported by the udev property
552 \fIID_NET_NAME_SLOT\fR\&. See
553 \fBsystemd.net-naming-scheme\fR(7)\&.
554 .sp
555 Added in version 211\&.
556 .RE
557 .PP
558 \fBpath\fR
559 .RS 4
560 The name is set based on the device\*(Aqs physical location, as exported by the udev property
561 \fIID_NET_NAME_PATH\fR\&. See
562 \fBsystemd.net-naming-scheme\fR(7)\&.
563 .sp
564 Added in version 211\&.
565 .RE
566 .PP
567 \fBmac\fR
568 .RS 4
569 The name is set based on the device\*(Aqs persistent MAC address, as exported by the udev property
570 \fIID_NET_NAME_MAC\fR\&. See
571 \fBsystemd.net-naming-scheme\fR(7)\&.
572 .sp
573 Added in version 211\&.
574 .RE
575 .PP
576 \fBkeep\fR
577 .RS 4
578 If the device already had a name given by userspace (as part of creation of the device or a rename), keep it\&.
579 .sp
580 Added in version 241\&.
581 .RE
582 .sp
583 Added in version 211\&.
584 .RE
585 .PP
586 \fIName=\fR
587 .RS 4
588 The interface name to use\&. This option has lower precedence than
589 \fINamePolicy=\fR, so for this setting to take effect,
590 \fINamePolicy=\fR
591 must either be unset, empty, disabled, or all policies configured there must fail\&. Also see the example below with
592 "Name=dmz0"\&.
593 .sp
594 Note that specifying a name that the kernel might use for another interface (for example
595 "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
596 "internal0"/"external0"
597 or
598 "lan0"/"lan1"/"lan3"\&.
599 .sp
600 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,
601 ":",
602 "/"
603 and
604 "%"\&. While
605 "\&."
606 is an allowed character, it is recommended to avoid it when naming interfaces as various tools (such as
607 \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), nor are the special strings
608 "\&.",
609 "\&.\&.",
610 "all"
611 and
612 "default"\&.
613 .sp
614 Added in version 211\&.
615 .RE
616 .PP
617 \fIAlternativeNamesPolicy=\fR
618 .RS 4
619 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
620 "database",
621 "onboard",
622 "slot",
623 "path", and
624 "mac"\&. If the kernel does not support the alternative names, then this setting will be ignored\&.
625 .sp
626 Added in version 245\&.
627 .RE
628 .PP
629 \fIAlternativeName=\fR
630 .RS 4
631 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\&.
632 .sp
633 Alternative interface names may be used to identify interfaces in various tools\&. In contrast to the primary name (as configured with
634 \fIName=\fR
635 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\&.
636 .sp
637 Added in version 245\&.
638 .RE
639 .PP
640 \fITransmitQueues=\fR
641 .RS 4
642 Specifies the device\*(Aqs number of transmit queues\&. An integer in the range 1\&...16384\&. When unset, the kernel\*(Aqs default will be used\&.
643 .sp
644 Added in version 248\&.
645 .RE
646 .PP
647 \fIReceiveQueues=\fR
648 .RS 4
649 Specifies the device\*(Aqs number of receive queues\&. An integer in the range 1\&...16384\&. When unset, the kernel\*(Aqs default will be used\&.
650 .sp
651 Added in version 248\&.
652 .RE
653 .PP
654 \fITransmitQueueLength=\fR
655 .RS 4
656 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\&.
657 .sp
658 Added in version 248\&.
659 .RE
660 .PP
661 \fIMTUBytes=\fR
662 .RS 4
663 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\&.
664 .sp
665 Added in version 211\&.
666 .RE
667 .PP
668 \fIBitsPerSecond=\fR
669 .RS 4
670 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\&.
671 .sp
672 Added in version 211\&.
673 .RE
674 .PP
675 \fIDuplex=\fR
676 .RS 4
677 The duplex mode to set for the device\&. The accepted values are
678 \fBhalf\fR
679 and
680 \fBfull\fR\&.
681 .sp
682 Added in version 211\&.
683 .RE
684 .PP
685 \fIAutoNegotiation=\fR
686 .RS 4
687 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\&.
688 .sp
689 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\&.
690 .sp
691 Added in version 233\&.
692 .RE
693 .PP
694 \fIWakeOnLan=\fR
695 .RS 4
696 The Wake\-on\-LAN policy to set for the device\&. Takes the special value
697 "off"
698 which disables Wake\-on\-LAN, or space separated list of the following words:
699 .PP
700 \fBphy\fR
701 .RS 4
702 Wake on PHY activity\&.
703 .sp
704 Added in version 211\&.
705 .RE
706 .PP
707 \fBunicast\fR
708 .RS 4
709 Wake on unicast messages\&.
710 .sp
711 Added in version 235\&.
712 .RE
713 .PP
714 \fBmulticast\fR
715 .RS 4
716 Wake on multicast messages\&.
717 .sp
718 Added in version 235\&.
719 .RE
720 .PP
721 \fBbroadcast\fR
722 .RS 4
723 Wake on broadcast messages\&.
724 .sp
725 Added in version 235\&.
726 .RE
727 .PP
728 \fBarp\fR
729 .RS 4
730 Wake on ARP\&.
731 .sp
732 Added in version 235\&.
733 .RE
734 .PP
735 \fBmagic\fR
736 .RS 4
737 Wake on receipt of a magic packet\&.
738 .sp
739 Added in version 211\&.
740 .RE
741 .PP
742 \fBsecureon\fR
743 .RS 4
744 Enable SecureOn password for MagicPacket\&. Implied when
745 \fIWakeOnLanPassword=\fR
746 is specified\&. If specified without
747 \fIWakeOnLanPassword=\fR
748 option, then the password is read from the credential
749 "\fILINK\fR\&.link\&.wol\&.password"
750 (e\&.g\&.,
751 "60\-foo\&.link\&.wol\&.password"), and if the credential not found, then read from
752 "wol\&.password"\&. See
753 \fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR
754 in
755 \fBsystemd.exec\fR(5)
756 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\&.,
757 "aa:bb:cc:dd:ee:ff"\&.
758 .sp
759 Added in version 235\&.
760 .RE
761 .sp
762 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\&.
763 .sp
764 Added in version 211\&.
765 .RE
766 .PP
767 \fIWakeOnLanPassword=\fR
768 .RS 4
769 Specifies the SecureOn password for MagicPacket\&. Takes an absolute path to a regular file or an
770 \fBAF_UNIX\fR
771 stream socket, or the plain password\&. When a path to a regular file is specified, the password is read from it\&. When an
772 \fBAF_UNIX\fR
773 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\&.,
774 "aa:bb:cc:dd:ee:ff"\&. This implies
775 \fIWakeOnLan=secureon\fR\&. Defaults to unset, and the current value will not be changed\&.
776 .sp
777 Added in version 250\&.
778 .RE
779 .PP
780 \fIPort=\fR
781 .RS 4
782 The port option is used to select the device port\&. The supported values are:
783 .PP
784 \fBtp\fR
785 .RS 4
786 An Ethernet interface using Twisted\-Pair cable as the medium\&.
787 .sp
788 Added in version 234\&.
789 .RE
790 .PP
791 \fBaui\fR
792 .RS 4
793 Attachment Unit Interface (AUI)\&. Normally used with hubs\&.
794 .sp
795 Added in version 234\&.
796 .RE
797 .PP
798 \fBbnc\fR
799 .RS 4
800 An Ethernet interface using BNC connectors and co\-axial cable\&.
801 .sp
802 Added in version 234\&.
803 .RE
804 .PP
805 \fBmii\fR
806 .RS 4
807 An Ethernet interface using a Media Independent Interface (MII)\&.
808 .sp
809 Added in version 234\&.
810 .RE
811 .PP
812 \fBfibre\fR
813 .RS 4
814 An Ethernet interface using Optical Fibre as the medium\&.
815 .sp
816 Added in version 234\&.
817 .RE
818 .sp
819 Added in version 234\&.
820 .RE
821 .PP
822 \fIAdvertise=\fR
823 .RS 4
824 This sets what speeds and duplex modes of operation are advertised for auto\-negotiation\&. This implies
825 "AutoNegotiation=yes"\&. The supported values are:
826 .sp
827 .it 1 an-trap
828 .nr an-no-space-flag 1
829 .nr an-break-flag 1
830 .br
831 .B Table\ \&1.\ \&Supported advertise values
832 .TS
833 allbox tab(:);
834 lB lB lB.
835 T{
836 Advertise
837 T}:T{
838 Speed (Mbps)
839 T}:T{
840 Duplex Mode
841 T}
842 .T&
843 l l l
844 l l l
845 l l l
846 l l l
847 l l l
848 l l l
849 l l l
850 l l l
851 l l l
852 l l l
853 l l l
854 l l l
855 l l l
856 l l l
857 l l l
858 l l l
859 l l l
860 l l l
861 l l l
862 l l l
863 l l l
864 l l l
865 l l l
866 l l l
867 l l l
868 l l l
869 l l l
870 l l l
871 l l l
872 l l l
873 l l l
874 l l l
875 l l l
876 l l l
877 l l l
878 l l l
879 l l l
880 l l l
881 l l l
882 l l l
883 l l l
884 l l l
885 l l l
886 l l l
887 l l l
888 l l l
889 l l l
890 l l l
891 l l l
892 l l l
893 l l l
894 l l l
895 l l l
896 l l l
897 l l l
898 l l l
899 l l l
900 l l l
901 l l l
902 l l l
903 l l l
904 l l l
905 l l l
906 l l l
907 l l l
908 l l l
909 l l l
910 l l l
911 l l l
912 l l l
913 l l l
914 l l l
915 l l l
916 l l l
917 l l l
918 l l l
919 l l l
920 l l l
921 l l l
922 l l l
923 l l l
924 l l l
925 l l l
926 l l l
927 l l l
928 l l l
929 l l l
930 l l l
931 l l l
932 l l l
933 l l l
934 l l l
935 l l l
936 l l l
937 l l l
938 l l l
939 l l l
940 l l l
941 l l l
942 l l l
943 l l l
944 l l l
945 l l l
946 l l l
947 l l l
948 l l l
949 l l l
950 l l l
951 l l l
952 l l l
953 l l l
954 l l l
955 l l l
956 l l l
957 l l l
958 l l l
959 l l l
960 l l l
961 l l l
962 l l l
963 l l l
964 l l l
965 l l l
966 l l l
967 l l l.
968 T{
969 \fB10baset\-full\fR
970 T}:T{
971 10
972 T}:T{
973 full
974 T}
975 T{
976 \fB10baset1brr\-full\fR
977 T}:T{
978 10
979 T}:T{
980 full
981 T}
982 T{
983 \fB10baset1l\-full\fR
984 T}:T{
985 10
986 T}:T{
987 full
988 T}
989 T{
990 \fB10baset1s\-full\fR
991 T}:T{
992 10
993 T}:T{
994 full
995 T}
996 T{
997 \fB10baset\-half\fR
998 T}:T{
999 10
1000 T}:T{
1001 half
1002 T}
1003 T{
1004 \fB10baset1s\-half\fR
1005 T}:T{
1006 10
1007 T}:T{
1008 half
1009 T}
1010 T{
1011 \fB10baset1s\-p2mp\-half\fR
1012 T}:T{
1013 10
1014 T}:T{
1015 half
1016 T}
1017 T{
1018 \fB100basefx\-full\fR
1019 T}:T{
1020 100
1021 T}:T{
1022 full
1023 T}
1024 T{
1025 \fB100baset\-full\fR
1026 T}:T{
1027 100
1028 T}:T{
1029 full
1030 T}
1031 T{
1032 \fB100baset1\-full\fR
1033 T}:T{
1034 100
1035 T}:T{
1036 full
1037 T}
1038 T{
1039 \fB100basefx\-half\fR
1040 T}:T{
1041 100
1042 T}:T{
1043 half
1044 T}
1045 T{
1046 \fB100baset\-half\fR
1047 T}:T{
1048 100
1049 T}:T{
1050 half
1051 T}
1052 T{
1053 \fB1000basekx\-full\fR
1054 T}:T{
1055 1000
1056 T}:T{
1057 full
1058 T}
1059 T{
1060 \fB1000baset\-full\fR
1061 T}:T{
1062 1000
1063 T}:T{
1064 full
1065 T}
1066 T{
1067 \fB1000baset1\-full\fR
1068 T}:T{
1069 1000
1070 T}:T{
1071 full
1072 T}
1073 T{
1074 \fB1000basex\-full\fR
1075 T}:T{
1076 1000
1077 T}:T{
1078 full
1079 T}
1080 T{
1081 \fB1000baset\-half\fR
1082 T}:T{
1083 1000
1084 T}:T{
1085 half
1086 T}
1087 T{
1088 \fB2500baset\-full\fR
1089 T}:T{
1090 2500
1091 T}:T{
1092 full
1093 T}
1094 T{
1095 \fB2500basex\-full\fR
1096 T}:T{
1097 2500
1098 T}:T{
1099 full
1100 T}
1101 T{
1102 \fB5000baset\-full\fR
1103 T}:T{
1104 5000
1105 T}:T{
1106 full
1107 T}
1108 T{
1109 \fB10000baser\-fec\fR
1110 T}:T{
1111 10000
1112 T}:T{
1113 \ \&
1114 T}
1115 T{
1116 \fB10000basecr\-full\fR
1117 T}:T{
1118 10000
1119 T}:T{
1120 full
1121 T}
1122 T{
1123 \fB10000baseer\-full\fR
1124 T}:T{
1125 10000
1126 T}:T{
1127 full
1128 T}
1129 T{
1130 \fB10000basekr\-full\fR
1131 T}:T{
1132 10000
1133 T}:T{
1134 full
1135 T}
1136 T{
1137 \fB10000basekx4\-full\fR
1138 T}:T{
1139 10000
1140 T}:T{
1141 full
1142 T}
1143 T{
1144 \fB10000baselr\-full\fR
1145 T}:T{
1146 10000
1147 T}:T{
1148 full
1149 T}
1150 T{
1151 \fB10000baselrm\-full\fR
1152 T}:T{
1153 10000
1154 T}:T{
1155 full
1156 T}
1157 T{
1158 \fB10000basesr\-full\fR
1159 T}:T{
1160 10000
1161 T}:T{
1162 full
1163 T}
1164 T{
1165 \fB10000baset\-full\fR
1166 T}:T{
1167 10000
1168 T}:T{
1169 full
1170 T}
1171 T{
1172 \fB20000basekr2\-full\fR
1173 T}:T{
1174 20000
1175 T}:T{
1176 full
1177 T}
1178 T{
1179 \fB20000basemld2\-full\fR
1180 T}:T{
1181 20000
1182 T}:T{
1183 full
1184 T}
1185 T{
1186 \fB25000basecr\-full\fR
1187 T}:T{
1188 25000
1189 T}:T{
1190 full
1191 T}
1192 T{
1193 \fB25000basekr\-full\fR
1194 T}:T{
1195 25000
1196 T}:T{
1197 full
1198 T}
1199 T{
1200 \fB25000basesr\-full\fR
1201 T}:T{
1202 25000
1203 T}:T{
1204 full
1205 T}
1206 T{
1207 \fB40000basecr4\-full\fR
1208 T}:T{
1209 40000
1210 T}:T{
1211 full
1212 T}
1213 T{
1214 \fB40000basekr4\-full\fR
1215 T}:T{
1216 40000
1217 T}:T{
1218 full
1219 T}
1220 T{
1221 \fB40000baselr4\-full\fR
1222 T}:T{
1223 40000
1224 T}:T{
1225 full
1226 T}
1227 T{
1228 \fB40000basesr4\-full\fR
1229 T}:T{
1230 40000
1231 T}:T{
1232 full
1233 T}
1234 T{
1235 \fB50000basecr\-full\fR
1236 T}:T{
1237 50000
1238 T}:T{
1239 full
1240 T}
1241 T{
1242 \fB50000basecr2\-full\fR
1243 T}:T{
1244 50000
1245 T}:T{
1246 full
1247 T}
1248 T{
1249 \fB50000basedr\-full\fR
1250 T}:T{
1251 50000
1252 T}:T{
1253 full
1254 T}
1255 T{
1256 \fB50000basekr\-full\fR
1257 T}:T{
1258 50000
1259 T}:T{
1260 full
1261 T}
1262 T{
1263 \fB50000basekr2\-full\fR
1264 T}:T{
1265 50000
1266 T}:T{
1267 full
1268 T}
1269 T{
1270 \fB50000baselr\-er\-fr\-full\fR
1271 T}:T{
1272 50000
1273 T}:T{
1274 full
1275 T}
1276 T{
1277 \fB50000basesr\-full\fR
1278 T}:T{
1279 50000
1280 T}:T{
1281 full
1282 T}
1283 T{
1284 \fB50000basesr2\-full\fR
1285 T}:T{
1286 50000
1287 T}:T{
1288 full
1289 T}
1290 T{
1291 \fB56000basecr4\-full\fR
1292 T}:T{
1293 56000
1294 T}:T{
1295 full
1296 T}
1297 T{
1298 \fB56000basekr4\-full\fR
1299 T}:T{
1300 56000
1301 T}:T{
1302 full
1303 T}
1304 T{
1305 \fB56000baselr4\-full\fR
1306 T}:T{
1307 56000
1308 T}:T{
1309 full
1310 T}
1311 T{
1312 \fB56000basesr4\-full\fR
1313 T}:T{
1314 56000
1315 T}:T{
1316 full
1317 T}
1318 T{
1319 \fB100000basecr\-full\fR
1320 T}:T{
1321 100000
1322 T}:T{
1323 full
1324 T}
1325 T{
1326 \fB100000basecr2\-full\fR
1327 T}:T{
1328 100000
1329 T}:T{
1330 full
1331 T}
1332 T{
1333 \fB100000basecr4\-full\fR
1334 T}:T{
1335 100000
1336 T}:T{
1337 full
1338 T}
1339 T{
1340 \fB100000basedr\-full\fR
1341 T}:T{
1342 100000
1343 T}:T{
1344 full
1345 T}
1346 T{
1347 \fB100000basedr2\-full\fR
1348 T}:T{
1349 100000
1350 T}:T{
1351 full
1352 T}
1353 T{
1354 \fB100000basekr\-full\fR
1355 T}:T{
1356 100000
1357 T}:T{
1358 full
1359 T}
1360 T{
1361 \fB100000basekr2\-full\fR
1362 T}:T{
1363 100000
1364 T}:T{
1365 full
1366 T}
1367 T{
1368 \fB100000basekr4\-full\fR
1369 T}:T{
1370 100000
1371 T}:T{
1372 full
1373 T}
1374 T{
1375 \fB100000baselr\-er\-fr\-full\fR
1376 T}:T{
1377 100000
1378 T}:T{
1379 full
1380 T}
1381 T{
1382 \fB100000baselr2\-er2\-fr2\-full\fR
1383 T}:T{
1384 100000
1385 T}:T{
1386 full
1387 T}
1388 T{
1389 \fB100000baselr4\-er4\-full\fR
1390 T}:T{
1391 100000
1392 T}:T{
1393 full
1394 T}
1395 T{
1396 \fB100000basesr\-full\fR
1397 T}:T{
1398 100000
1399 T}:T{
1400 full
1401 T}
1402 T{
1403 \fB100000basesr2\-full\fR
1404 T}:T{
1405 100000
1406 T}:T{
1407 full
1408 T}
1409 T{
1410 \fB100000basesr4\-full\fR
1411 T}:T{
1412 100000
1413 T}:T{
1414 full
1415 T}
1416 T{
1417 \fB200000basecr\-full\fR
1418 T}:T{
1419 200000
1420 T}:T{
1421 full
1422 T}
1423 T{
1424 \fB200000basecr2\-full\fR
1425 T}:T{
1426 200000
1427 T}:T{
1428 full
1429 T}
1430 T{
1431 \fB200000basecr4\-full\fR
1432 T}:T{
1433 200000
1434 T}:T{
1435 full
1436 T}
1437 T{
1438 \fB200000basedr\-2\-full\fR
1439 T}:T{
1440 200000
1441 T}:T{
1442 full
1443 T}
1444 T{
1445 \fB200000basedr\-full\fR
1446 T}:T{
1447 200000
1448 T}:T{
1449 full
1450 T}
1451 T{
1452 \fB200000basedr2\-full\fR
1453 T}:T{
1454 200000
1455 T}:T{
1456 full
1457 T}
1458 T{
1459 \fB200000basedr4\-full\fR
1460 T}:T{
1461 200000
1462 T}:T{
1463 full
1464 T}
1465 T{
1466 \fB200000basekr\-full\fR
1467 T}:T{
1468 200000
1469 T}:T{
1470 full
1471 T}
1472 T{
1473 \fB200000basekr2\-full\fR
1474 T}:T{
1475 200000
1476 T}:T{
1477 full
1478 T}
1479 T{
1480 \fB200000basekr4\-full\fR
1481 T}:T{
1482 200000
1483 T}:T{
1484 full
1485 T}
1486 T{
1487 \fB200000baselr2\-er2\-fr2\-full\fR
1488 T}:T{
1489 200000
1490 T}:T{
1491 full
1492 T}
1493 T{
1494 \fB200000baselr4\-er4\-fr4\-full\fR
1495 T}:T{
1496 200000
1497 T}:T{
1498 full
1499 T}
1500 T{
1501 \fB200000basesr\-full\fR
1502 T}:T{
1503 200000
1504 T}:T{
1505 full
1506 T}
1507 T{
1508 \fB200000basesr2\-full\fR
1509 T}:T{
1510 200000
1511 T}:T{
1512 full
1513 T}
1514 T{
1515 \fB200000basesr4\-full\fR
1516 T}:T{
1517 200000
1518 T}:T{
1519 full
1520 T}
1521 T{
1522 \fB200000basevr\-full\fR
1523 T}:T{
1524 200000
1525 T}:T{
1526 full
1527 T}
1528 T{
1529 \fB400000basecr2\-full\fR
1530 T}:T{
1531 400000
1532 T}:T{
1533 full
1534 T}
1535 T{
1536 \fB400000basecr4\-full\fR
1537 T}:T{
1538 400000
1539 T}:T{
1540 full
1541 T}
1542 T{
1543 \fB400000basecr8\-full\fR
1544 T}:T{
1545 400000
1546 T}:T{
1547 full
1548 T}
1549 T{
1550 \fB400000basedr2\-2\-full\fR
1551 T}:T{
1552 400000
1553 T}:T{
1554 full
1555 T}
1556 T{
1557 \fB400000basedr2\-full\fR
1558 T}:T{
1559 400000
1560 T}:T{
1561 full
1562 T}
1563 T{
1564 \fB400000basedr4\-full\fR
1565 T}:T{
1566 400000
1567 T}:T{
1568 full
1569 T}
1570 T{
1571 \fB400000basedr8\-full\fR
1572 T}:T{
1573 400000
1574 T}:T{
1575 full
1576 T}
1577 T{
1578 \fB400000basekr2\-full\fR
1579 T}:T{
1580 400000
1581 T}:T{
1582 full
1583 T}
1584 T{
1585 \fB400000basekr4\-full\fR
1586 T}:T{
1587 400000
1588 T}:T{
1589 full
1590 T}
1591 T{
1592 \fB400000basekr8\-full\fR
1593 T}:T{
1594 400000
1595 T}:T{
1596 full
1597 T}
1598 T{
1599 \fB400000baselr4\-er4\-fr4\-full\fR
1600 T}:T{
1601 400000
1602 T}:T{
1603 full
1604 T}
1605 T{
1606 \fB400000baselr8\-er8\-fr8\-full\fR
1607 T}:T{
1608 400000
1609 T}:T{
1610 full
1611 T}
1612 T{
1613 \fB400000basesr2\-full\fR
1614 T}:T{
1615 400000
1616 T}:T{
1617 full
1618 T}
1619 T{
1620 \fB400000basesr4\-full\fR
1621 T}:T{
1622 400000
1623 T}:T{
1624 full
1625 T}
1626 T{
1627 \fB400000basesr8\-full\fR
1628 T}:T{
1629 400000
1630 T}:T{
1631 full
1632 T}
1633 T{
1634 \fB400000basevr2\-full\fR
1635 T}:T{
1636 400000
1637 T}:T{
1638 full
1639 T}
1640 T{
1641 \fB800000basecr4\-full\fR
1642 T}:T{
1643 800000
1644 T}:T{
1645 full
1646 T}
1647 T{
1648 \fB800000basecr8\-full\fR
1649 T}:T{
1650 800000
1651 T}:T{
1652 full
1653 T}
1654 T{
1655 \fB800000basedr4\-2\-full\fR
1656 T}:T{
1657 800000
1658 T}:T{
1659 full
1660 T}
1661 T{
1662 \fB800000basedr4\-full\fR
1663 T}:T{
1664 800000
1665 T}:T{
1666 full
1667 T}
1668 T{
1669 \fB800000basedr8\-2\-full\fR
1670 T}:T{
1671 800000
1672 T}:T{
1673 full
1674 T}
1675 T{
1676 \fB800000basedr8\-full\fR
1677 T}:T{
1678 800000
1679 T}:T{
1680 full
1681 T}
1682 T{
1683 \fB800000basekr4\-full\fR
1684 T}:T{
1685 800000
1686 T}:T{
1687 full
1688 T}
1689 T{
1690 \fB800000basekr8\-full\fR
1691 T}:T{
1692 800000
1693 T}:T{
1694 full
1695 T}
1696 T{
1697 \fB800000basesr4\-full\fR
1698 T}:T{
1699 800000
1700 T}:T{
1701 full
1702 T}
1703 T{
1704 \fB800000basesr8\-full\fR
1705 T}:T{
1706 800000
1707 T}:T{
1708 full
1709 T}
1710 T{
1711 \fB800000basevr4\-full\fR
1712 T}:T{
1713 800000
1714 T}:T{
1715 full
1716 T}
1717 T{
1718 \fB800000basevr8\-full\fR
1719 T}:T{
1720 800000
1721 T}:T{
1722 full
1723 T}
1724 T{
1725 \fB1600000basecr8\-full\fR
1726 T}:T{
1727 1600000
1728 T}:T{
1729 full
1730 T}
1731 T{
1732 \fB1600000basedr8\-2\-full\fR
1733 T}:T{
1734 1600000
1735 T}:T{
1736 full
1737 T}
1738 T{
1739 \fB1600000basedr8\-full\fR
1740 T}:T{
1741 1600000
1742 T}:T{
1743 full
1744 T}
1745 T{
1746 \fB1600000basekr8\-full\fR
1747 T}:T{
1748 1600000
1749 T}:T{
1750 full
1751 T}
1752 T{
1753 \fBasym\-pause\fR
1754 T}:T{
1755 \ \&
1756 T}:T{
1757 \ \&
1758 T}
1759 T{
1760 \fBaui\fR
1761 T}:T{
1762 \ \&
1763 T}:T{
1764 \ \&
1765 T}
1766 T{
1767 \fBautonegotiation\fR
1768 T}:T{
1769 \ \&
1770 T}:T{
1771 \ \&
1772 T}
1773 T{
1774 \fBbackplane\fR
1775 T}:T{
1776 \ \&
1777 T}:T{
1778 \ \&
1779 T}
1780 T{
1781 \fBbnc\fR
1782 T}:T{
1783 \ \&
1784 T}:T{
1785 \ \&
1786 T}
1787 T{
1788 \fBfec\-baser\fR
1789 T}:T{
1790 \ \&
1791 T}:T{
1792 \ \&
1793 T}
1794 T{
1795 \fBfec\-llrs\fR
1796 T}:T{
1797 \ \&
1798 T}:T{
1799 \ \&
1800 T}
1801 T{
1802 \fBfec\-none\fR
1803 T}:T{
1804 \ \&
1805 T}:T{
1806 \ \&
1807 T}
1808 T{
1809 \fBfec\-rs\fR
1810 T}:T{
1811 \ \&
1812 T}:T{
1813 \ \&
1814 T}
1815 T{
1816 \fBfibre\fR
1817 T}:T{
1818 \ \&
1819 T}:T{
1820 \ \&
1821 T}
1822 T{
1823 \fBmii\fR
1824 T}:T{
1825 \ \&
1826 T}:T{
1827 \ \&
1828 T}
1829 T{
1830 \fBpause\fR
1831 T}:T{
1832 \ \&
1833 T}:T{
1834 \ \&
1835 T}
1836 T{
1837 \fBtp\fR
1838 T}:T{
1839 \ \&
1840 T}:T{
1841 \ \&
1842 T}
1843 .TE
1844 .sp 1
1845 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\&.
1846 .sp
1847 Added in version 240\&.
1848 .RE
1849 .PP
1850 \fIReceiveChecksumOffload=\fR
1851 .RS 4
1852 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\&.
1853 .sp
1854 Added in version 245\&.
1855 .RE
1856 .PP
1857 \fITransmitChecksumOffload=\fR
1858 .RS 4
1859 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\&.
1860 .sp
1861 Added in version 245\&.
1862 .RE
1863 .PP
1864 \fIScatterGather=\fR
1865 .RS 4
1866 Takes a boolean\&. If set to true, enables offload feature where the hardware builds a network packet from multiple non\-contiguous memory buffers\&. When unset, the kernel\*(Aqs default will be used\&. This corresponds to the command
1867 \fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-scatter\-gather on|off\fR\&.
1868 .sp
1869 Added in version 260\&.
1870 .RE
1871 .PP
1872 \fIScatterGatherFragmentList=\fR
1873 .RS 4
1874 Takes a boolean\&. If set to true, enables offload feature where the hardware builds a network packet from a chained list of socket buffers\&. When unset, the kernel\*(Aqs default will be used\&. This corresponds to the command
1875 \fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-scatter\-gather\-fraglist on|off\fR\&.
1876 .sp
1877 Added in version 260\&.
1878 .RE
1879 .PP
1880 \fITCPSegmentationOffload=\fR
1881 .RS 4
1882 Takes a boolean\&. If set to true, TCP Segmentation Offload (TSO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
1883 .sp
1884 Added in version 232\&.
1885 .RE
1886 .PP
1887 \fITCPECNSegmentationOffload=\fR
1888 .RS 4
1889 Takes a boolean\&. If set to true, TCP Segmentation Offload (TSO) is performed even when ECN (Explicit Congestion Notification) flags are active in the TCP stream\&. When unset, the kernel\*(Aqs default will be used\&. This corresponds to the command
1890 \fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-tcp\-ecn\-segmentation on|off\fR\&.
1891 .sp
1892 Added in version 260\&.
1893 .RE
1894 .PP
1895 \fITCPMangleIdSegmentationOffload=\fR
1896 .RS 4
1897 Takes a boolean\&. If set to true, TCP Segmentation Offload (TSO) is performed even if the hardware is incapable of correctly incrementing the IPv4 Identification (ID) field for each resulting packet\&. When unset, the kernel\*(Aqs default will be used\&. This corresponds to the command
1898 \fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-tcp\-mangleid\-segmentation on|off\fR\&.
1899 .sp
1900 Added in version 260\&.
1901 .RE
1902 .PP
1903 \fITCP6SegmentationOffload=\fR
1904 .RS 4
1905 Takes a boolean\&. If set to true, TCP6 Segmentation Offload (tx\-tcp6\-segmentation) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
1906 .sp
1907 Added in version 235\&.
1908 .RE
1909 .PP
1910 \fIGenericSegmentationOffload=\fR
1911 .RS 4
1912 Takes a boolean\&. If set to true, Generic Segmentation Offload (GSO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
1913 .sp
1914 Added in version 232\&.
1915 .RE
1916 .PP
1917 \fIPartialGenericSegmentationOffload=\fR
1918 .RS 4
1919 Takes a boolean\&. If set to true, Partial Generic Segmentation Offload (GSO_Partial) is enabled\&. See
1920 \m[blue]\fBPartial Generic Segmentation Offload\fR\m[]\&\s-2\u[3]\d\s+2
1921 for more details\&. When unset, the kernel\*(Aqs default will be used\&.
1922 .sp
1923 Added in version 258\&.
1924 .RE
1925 .PP
1926 \fIGenericReceiveOffload=\fR
1927 .RS 4
1928 Takes a boolean\&. If set to true, Generic Receive Offload (GRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
1929 .sp
1930 Added in version 232\&.
1931 .RE
1932 .PP
1933 \fIGenericReceiveOffloadHardware=\fR
1934 .RS 4
1935 Takes a boolean\&. If set to true, hardware accelerated Generic Receive Offload (GRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
1936 .sp
1937 Added in version 250\&.
1938 .RE
1939 .PP
1940 \fIGenericReceiveOffloadList=\fR
1941 .RS 4
1942 Takes a boolean\&. If set to true, Generic Receive Offload (GRO) List for UDP is enabled\&. When unset, the kernel\*(Aqs default will be used\&. This corresponds to the command
1943 \fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB rx\-gro\-list on|off\fR\&.
1944 .sp
1945 Added in version 260\&.
1946 .RE
1947 .PP
1948 \fIGenericReceiveOffloadUDPForwarding=\fR
1949 .RS 4
1950 Takes a boolean\&. If set to true, Generic Receive Offload (GRO) for aggregating incoming UDP packets is enabled\&. When unset, the kernel\*(Aqs default will be used\&. This corresponds to the command
1951 \fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB rx\-udp\-gro\-forwarding on|off\fR\&.
1952 .sp
1953 Added in version 260\&.
1954 .RE
1955 .PP
1956 \fILargeReceiveOffload=\fR
1957 .RS 4
1958 Takes a boolean\&. If set to true, Large Receive Offload (LRO) is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
1959 .sp
1960 Added in version 232\&.
1961 .RE
1962 .PP
1963 \fIReceivePacketSteeringCPUMask=\fR
1964 .RS 4
1965 Configures Receive Packet Steering (RPS) list of CPUs to which RPS may forward traffic\&. Takes a list of CPU indices or ranges separated by either whitespace or commas\&. Alternatively, takes the special value
1966 "all", which will include all available CPUs in the mask\&. CPU ranges are specified by the lower and upper CPU indices separated by a dash (e\&.g\&.
1967 "2\-6")\&. This option may be specified more than once, in which case the specified list of CPU ranges are merged\&. If an empty string is assigned, the list is reset, all assignments prior to this will have no effect\&. Defaults to unset and RPS CPU list is unchanged\&. To disable RPS when it was previously enabled, use the special value
1968 "disable"\&.
1969 .sp
1970 Added in version 256\&.
1971 .RE
1972 .PP
1973 \fIIRQAffinityPolicy=\fR
1974 .RS 4
1975 Specifies the IRQ distribution strategy for network interface MSI/MSI\-X interrupts\&. Takes one of
1976 "spread"
1977 or
1978 "single"\&. When set to
1979 "spread", queue IRQs are distributed across CPUs using a topology\-aware maximum distance algorithm that prefers CPUs on different NUMA nodes, then different physical cores, then different hyperthreads\&. When set to
1980 "single", all IRQs are pinned to a single CPU (CPU 0 by default, or the first CPU in the set specified by
1981 \fIIRQAffinity=\fR)\&. When there are more IRQs than available CPUs, queues wrap around using round\-robin assignment\&. When unset, no affinity management is performed\&. Setting this to an empty string explicitly disables affinity management\&.
1982 .sp
1983 This option only applies to devices with MSI/MSI\-X interrupts discoverable via
1984 /sys/class/net/\fIiface\fR/device/msi_irqs/\&. Virtual devices (veth, tap) and legacy INTx devices are skipped with a notice logged\&.
1985 .sp
1986 Note that if
1987 \fBirqbalance\fR(1)
1988 or similar IRQ management daemons are running, they may override the configured affinity\&. Consider disabling such daemons or configuring them to exclude managed interfaces\&.
1989 .sp
1990 Added in version 260\&.
1991 .RE
1992 .PP
1993 \fIIRQAffinity=\fR
1994 .RS 4
1995 Filters the set of CPUs eligible for IRQ placement\&. Takes a list of CPU indices or ranges separated by either whitespace or commas (e\&.g\&.,
1996 "0\-3",
1997 "0,2,4,6",
1998 "0\-3,8\-11")\&. This option works in conjunction with
1999 \fIIRQAffinityPolicy=\fR
2000 and
2001 \fIIRQAffinityNUMA=\fR
2002 to constrain which CPUs receive network IRQs\&. When specified with
2003 "spread"
2004 policy, only the listed CPUs are considered for IRQ distribution\&. When specified with
2005 "single"
2006 policy, IRQs are pinned to the first CPU in the allowed set instead of CPU 0\&. Has no effect if
2007 \fIIRQAffinityPolicy=\fR
2008 is not set\&.
2009 .sp
2010 Added in version 260\&.
2011 .RE
2012 .PP
2013 \fIIRQAffinityNUMA=\fR
2014 .RS 4
2015 Filters CPUs to those belonging to the specified NUMA node\&. Takes either
2016 "local"
2017 or an explicit NUMA node number (0, 1, 2, \&.\&.\&.)\&. When set to
2018 "local", the NUMA node local to the NIC\*(Aqs PCIe slot is used (determined from
2019 /sys/class/net/\fIiface\fR/device/numa_node)\&. If the device\*(Aqs NUMA node cannot be determined (e\&.g\&., non\-NUMA system), a warning is logged and IRQ affinity configuration is skipped\&.
2020 .sp
2021 When both
2022 \fIIRQAffinity=\fR
2023 and
2024 \fIIRQAffinityNUMA=\fR
2025 are specified, their intersection is used\&. If the intersection results in an empty set, an error is logged and no affinity is applied\&. Has no effect if
2026 \fIIRQAffinityPolicy=\fR
2027 is not set\&.
2028 .sp
2029 Added in version 260\&.
2030 .RE
2031 .PP
2032 \fIReceiveVLANCTAGHardwareAcceleration=\fR
2033 .RS 4
2034 Takes a boolean\&. If set to true, receive VLAN CTAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
2035 .sp
2036 Added in version 250\&.
2037 .RE
2038 .PP
2039 \fITransmitVLANCTAGHardwareAcceleration=\fR
2040 .RS 4
2041 Takes a boolean\&. If set to true, transmit VLAN CTAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
2042 .sp
2043 Added in version 250\&.
2044 .RE
2045 .PP
2046 \fIReceiveVLANCTAGFilter=\fR
2047 .RS 4
2048 Takes a boolean\&. If set to true, receive filtering on VLAN CTAGs is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
2049 .sp
2050 Added in version 250\&.
2051 .RE
2052 .PP
2053 \fITransmitVLANSTAGHardwareAcceleration=\fR
2054 .RS 4
2055 Takes a boolean\&. If set to true, transmit VLAN STAG hardware acceleration is enabled\&. When unset, the kernel\*(Aqs default will be used\&.
2056 .sp
2057 Added in version 250\&.
2058 .RE
2059 .PP
2060 \fINTupleFilter=\fR
2061 .RS 4
2062 Takes a boolean\&. If set to true, receive N\-tuple filters and actions are enabled\&. When unset, the kernel\*(Aqs default will be used\&.
2063 .sp
2064 Added in version 250\&.
2065 .RE
2066 .PP
2067 \fIReceiveFCS=\fR
2068 .RS 4
2069 Takes a boolean\&. If set to true, pass the Frame Check Sequence (FCS) value up the stack without trimming it, and allow userspace to calculate error rate or link health\&. When unset, the kernel\*(Aqs default will be used\&.
2070 .sp
2071 Added in version 258\&.
2072 .RE
2073 .PP
2074 \fIReceiveAll=\fR
2075 .RS 4
2076 Takes a boolean\&. If set to true, allow the interface to also receive damaged ethernet frames\&. When unset, the kernel\*(Aqs default will be used\&.
2077 .sp
2078 Added in version 258\&.
2079 .RE
2080 .PP
2081 \fIRxChannels=\fR, \fITxChannels=\fR, \fIOtherChannels=\fR, \fICombinedChannels=\fR
2082 .RS 4
2083 Specifies the number of receive, transmit, other, or combined channels, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or
2084 "max"\&. If set to
2085 "max", the advertised maximum value of the hardware will be used\&. When unset, the number will not be changed\&. Defaults to unset\&.
2086 .sp
2087 Added in version 239\&.
2088 .RE
2089 .PP
2090 \fIRxBufferSize=\fR, \fIRxMiniBufferSize=\fR, \fIRxJumboBufferSize=\fR, \fITxBufferSize=\fR
2091 .RS 4
2092 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
2093 "max"\&. If set to
2094 "max", the advertised maximum value of the hardware will be used\&. When unset, the number will not be changed\&. Defaults to unset\&.
2095 .sp
2096 Added in version 244\&.
2097 .RE
2098 .PP
2099 \fIRxFlowControl=\fR
2100 .RS 4
2101 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\&.
2102 .sp
2103 Added in version 246\&.
2104 .RE
2105 .PP
2106 \fITxFlowControl=\fR
2107 .RS 4
2108 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\&.
2109 .sp
2110 Added in version 246\&.
2111 .RE
2112 .PP
2113 \fIAutoNegotiationFlowControl=\fR
2114 .RS 4
2115 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\&.
2116 .sp
2117 Added in version 246\&.
2118 .RE
2119 .PP
2120 \fIGenericSegmentOffloadMaxBytes=\fR
2121 .RS 4
2122 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\&.
2123 .sp
2124 Added in version 248\&.
2125 .RE
2126 .PP
2127 \fIGenericSegmentOffloadMaxSegments=\fR
2128 .RS 4
2129 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\&.
2130 .sp
2131 Added in version 248\&.
2132 .RE
2133 .PP
2134 \fIUseAdaptiveRxCoalesce=\fR, \fIUseAdaptiveTxCoalesce=\fR
2135 .RS 4
2136 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\&.
2137 .sp
2138 Added in version 250\&.
2139 .RE
2140 .PP
2141 \fIRxCoalesceSec=\fR, \fIRxCoalesceIrqSec=\fR, \fIRxCoalesceLowSec=\fR, \fIRxCoalesceHighSec=\fR, \fITxCoalesceSec=\fR, \fITxCoalesceIrqSec=\fR, \fITxCoalesceLowSec=\fR, \fITxCoalesceHighSec=\fR
2142 .RS 4
2143 These properties configure the delay before Rx/Tx interrupts are generated after a packet is sent/received\&. The
2144 "Irq"
2145 properties come into effect when the host is servicing an IRQ\&. The
2146 "Low"
2147 and
2148 "High"
2149 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\&.
2150 .sp
2151 Added in version 250\&.
2152 .RE
2153 .PP
2154 \fIRxMaxCoalescedFrames=\fR, \fIRxMaxCoalescedIrqFrames=\fR, \fIRxMaxCoalescedLowFrames=\fR, \fIRxMaxCoalescedHighFrames=\fR, \fITxMaxCoalescedFrames=\fR, \fITxMaxCoalescedIrqFrames=\fR, \fITxMaxCoalescedLowFrames=\fR, \fITxMaxCoalescedHighFrames=\fR
2155 .RS 4
2156 These properties configure the maximum number of frames that are sent/received before a Rx/Tx interrupt is generated\&. The
2157 "Irq"
2158 properties come into effect when the host is servicing an IRQ\&. The
2159 "Low"
2160 and
2161 "High"
2162 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\&.
2163 .sp
2164 Added in version 250\&.
2165 .RE
2166 .PP
2167 \fICoalescePacketRateLow=\fR, \fICoalescePacketRateHigh=\fR
2168 .RS 4
2169 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\&.
2170 .sp
2171 Added in version 250\&.
2172 .RE
2173 .PP
2174 \fICoalescePacketRateSampleIntervalSec=\fR
2175 .RS 4
2176 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\&.
2177 .sp
2178 Added in version 250\&.
2179 .RE
2180 .PP
2181 \fIStatisticsBlockCoalesceSec=\fR
2182 .RS 4
2183 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\&.
2184 .sp
2185 Added in version 250\&.
2186 .RE
2187 .PP
2188 \fIMDI=\fR
2189 .RS 4
2190 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:
2191 "straight"
2192 (or equivalently:
2193 "mdi"),
2194 "crossover"
2195 (or equivalently:
2196 "mdi\-x",
2197 "mdix"), and
2198 "auto"\&. When
2199 "straight", the MDI straight through mode will be used\&. When
2200 "crossover", the MDI crossover (MDI\-X) mode will be used\&. When
2201 "auto", the MDI status is automatically detected\&. Defaults to unset, and the kernel\*(Aqs default will be used\&.
2202 .sp
2203 Added in version 251\&.
2204 .RE
2205 .PP
2206 \fISR\-IOVVirtualFunctions=\fR
2207 .RS 4
2208 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
2209 \fIVirtualFunction=\fR
2210 settings in the [SR\-IOV] sections\&.
2211 .sp
2212 Added in version 251\&.
2213 .RE
2214 .SH "[SR\-IOV] SECTION OPTIONS"
2215 .PP
2216 SR\-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be e\&.g\&. injected into a VM\&. In the case of network VFs, SR\-IOV reduces latency and CPU utilisation for north\-south network traffic (that is, traffic with endpoints outside the host machine), by allowing traffic to bypass the host machine\(cqs network stack\&.
2217 .PP
2218 The presence of an [SR\-IOV] section in a \&.link file will cause the creation and configuration of the specified virtual function\&. Within a \&.network file, the specified virtual function will be configured, but must already exist\&. Specify several [SR\-IOV] sections to configure several SR\-IOVs\&.
2219 .PP
2220 The [SR\-IOV] section accepts the following keys\&.
2221 .PP
2222 \fIVirtualFunction=\fR
2223 .RS 4
2224 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\&.
2225 .sp
2226 Added in version 251\&.
2227 .RE
2228 .PP
2229 \fIVLANId=\fR
2230 .RS 4
2231 Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&.
2232 .sp
2233 Added in version 251\&.
2234 .RE
2235 .PP
2236 \fIQualityOfService=\fR
2237 .RS 4
2238 Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&.
2239 .sp
2240 Added in version 251\&.
2241 .RE
2242 .PP
2243 \fIVLANProtocol=\fR
2244 .RS 4
2245 Specifies VLAN protocol of the virtual function\&. Takes
2246 "802\&.1Q"
2247 or
2248 "802\&.1ad"\&.
2249 .sp
2250 Added in version 251\&.
2251 .RE
2252 .PP
2253 \fIMACSpoofCheck=\fR
2254 .RS 4
2255 Takes a boolean\&. Controls the MAC spoof checking\&. When unset, the kernel\*(Aqs default will be used\&.
2256 .sp
2257 Added in version 251\&.
2258 .RE
2259 .PP
2260 \fIQueryReceiveSideScaling=\fR
2261 .RS 4
2262 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\&.
2263 .sp
2264 Added in version 251\&.
2265 .RE
2266 .PP
2267 \fITrust=\fR
2268 .RS 4
2269 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\&.
2270 .sp
2271 Added in version 251\&.
2272 .RE
2273 .PP
2274 \fILinkState=\fR
2275 .RS 4
2276 Allows one to set the link state of the virtual function (VF)\&. Takes a boolean or a special value
2277 "auto"\&. Setting to
2278 "auto"
2279 means a reflection of the physical function (PF) link state,
2280 "yes"
2281 lets the VF to communicate with other VFs on this host even if the PF link state is down,
2282 "no"
2283 causes the hardware to drop any packets sent by the VF\&. When unset, the kernel\*(Aqs default will be used\&.
2284 .sp
2285 Added in version 251\&.
2286 .RE
2287 .PP
2288 \fIMACAddress=\fR
2289 .RS 4
2290 Specifies the MAC address for the virtual function\&.
2291 .sp
2292 Added in version 251\&.
2293 .RE
2294 .SH "[ENERGYEFFICIENTETHERNET] SECTION OPTIONS"
2295 .PP
2296 The [EnergyEfficientEthernet] section controls the Energy Efficient Ethernet (EEE) feature of the interface, and accepts the following keys\&.
2297 .PP
2298 \fIEnable=\fR
2299 .RS 4
2300 Takes a boolean argument\&. When true, the Energy Efficient Ethernet (EEE) feature will be enabled on the interface\&. Defaults to unset, and the enablement of EEE will be unchanged\&.
2301 .sp
2302 Added in version 258\&.
2303 .RE
2304 .PP
2305 \fITxLowPowerIdle=\fR
2306 .RS 4
2307 Takes a boolean argument\&. When true, the transmit Low Power Idle (Tx\-LPI) mode of the Energy Efficient Ethernet feature will be enabled on the interface\&. Defaults to unset, and the enablement of the mode will be unchanged\&.
2308 .sp
2309 Added in version 258\&.
2310 .RE
2311 .PP
2312 \fITxLowPowerIdleSec=\fR
2313 .RS 4
2314 Takes a timespan\&. This configures how long the interface should not enter the Low Power Idle mode after transmission\&. If it is too short, may decrease performance\&. If it is too long, may not gain energy saving\&. Defaults to unset, and the timespan will be unchanged\&.
2315 .sp
2316 Added in version 258\&.
2317 .RE
2318 .PP
2319 \fILinkMode=\fR
2320 .RS 4
2321 Takes a list of link modes, e\&.g\&.
2322 "1000baset\-full"\&. See the table for
2323 \fIAdvertise=\fR
2324 setting in [Link] section in the above for possible values\&. This configures the Energy Efficient Ethernet capable connection modes to be advertised\&. Defaults to unset, and the advertised modes will be unchanged\&.
2325 .sp
2326 Added in version 258\&.
2327 .RE
2328 .SH "SPECIFIERS"
2329 .PP
2330 Some settings resolve specifiers which may be used to write generic unit files referring to runtime or unit parameters that are replaced when the unit files are loaded\&. Specifiers must be known and resolvable for the setting to be valid\&. The following specifiers are understood:
2331 .sp
2332 .it 1 an-trap
2333 .nr an-no-space-flag 1
2334 .nr an-break-flag 1
2335 .br
2336 .B Table\ \&2.\ \&Specifiers available in unit files
2337 .TS
2338 allbox tab(:);
2339 lB lB lB.
2340 T{
2341 Specifier
2342 T}:T{
2343 Meaning
2344 T}:T{
2345 Details
2346 T}
2347 .T&
2348 l l l
2349 l l l
2350 l l l
2351 l l l
2352 l l l
2353 l l l
2354 l l l
2355 l l l
2356 l l l
2357 l l l
2358 l l l
2359 l l l
2360 l l l
2361 l l l
2362 l l l.
2363 T{
2364 "%a"
2365 T}:T{
2366 Architecture
2367 T}:T{
2368 A short string identifying the architecture of the local system\&. A string such as \fBx86\fR, \fBx86\-64\fR or \fBarm64\fR\&. See the architectures defined for \fIConditionArchitecture=\fR in \fBsystemd.unit\fR(5) for a full list\&.
2369 T}
2370 T{
2371 "%A"
2372 T}:T{
2373 Operating system image version
2374 T}:T{
2375 The operating system image version identifier of the running system, as read from the \fIIMAGE_VERSION=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
2376 T}
2377 T{
2378 "%b"
2379 T}:T{
2380 Boot ID
2381 T}:T{
2382 The boot ID of the running system, formatted as string\&. See \fBrandom\fR(4) for more information\&.
2383 T}
2384 T{
2385 "%B"
2386 T}:T{
2387 Operating system build ID
2388 T}:T{
2389 The operating system build identifier of the running system, as read from the \fIBUILD_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
2390 T}
2391 T{
2392 "%H"
2393 T}:T{
2394 Host name
2395 T}:T{
2396 The hostname of the running system\&.
2397 T}
2398 T{
2399 "%l"
2400 T}:T{
2401 Short host name
2402 T}:T{
2403 The hostname of the running system, truncated at the first dot to remove any domain component\&.
2404 T}
2405 T{
2406 "%m"
2407 T}:T{
2408 Machine ID
2409 T}:T{
2410 The machine ID of the running system, formatted as string\&. See \fBmachine-id\fR(5) for more information\&.
2411 T}
2412 T{
2413 "%M"
2414 T}:T{
2415 Operating system image identifier
2416 T}:T{
2417 The operating system image identifier of the running system, as read from the \fIIMAGE_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
2418 T}
2419 T{
2420 "%o"
2421 T}:T{
2422 Operating system ID
2423 T}:T{
2424 The operating system identifier of the running system, as read from the \fIID=\fR field of /etc/os\-release\&. See \fBos-release\fR(5) for more information\&.
2425 T}
2426 T{
2427 "%q"
2428 T}:T{
2429 Pretty host name
2430 T}:T{
2431 The pretty hostname of the running system, as read from the \fIPRETTY_HOSTNAME=\fR field of /etc/machine\-info\&. If not set, resolves to the short hostname\&. See \fBmachine-info\fR(5) for more information\&.
2432 T}
2433 T{
2434 "%T"
2435 T}:T{
2436 Directory for temporary files
2437 T}:T{
2438 This is either /tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.)
2439 T}
2440 T{
2441 "%v"
2442 T}:T{
2443 Kernel release
2444 T}:T{
2445 Identical to \fBuname \-r\fR output\&.
2446 T}
2447 T{
2448 "%V"
2449 T}:T{
2450 Directory for larger and persistent temporary files
2451 T}:T{
2452 This is either /var/tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.)
2453 T}
2454 T{
2455 "%w"
2456 T}:T{
2457 Operating system version ID
2458 T}:T{
2459 The operating system version identifier of the running system, as read from the \fIVERSION_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
2460 T}
2461 T{
2462 "%W"
2463 T}:T{
2464 Operating system variant ID
2465 T}:T{
2466 The operating system variant identifier of the running system, as read from the \fIVARIANT_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
2467 T}
2468 .TE
2469 .sp 1
2470 .SH "EXAMPLES"
2471 .PP
2472 \fBExample\ \&1.\ \&/usr/lib/systemd/network/99\-default\&.link\fR
2473 .PP
2474 The link file
2475 99\-default\&.link
2476 that is shipped with systemd defines the default policies for the interface name, alternative names, and MAC address of links\&.
2477 .sp
2478 .if n \{\
2479 .RS 4
2480 .\}
2481 .nf
2482 [Match]
2483 OriginalName=*
2484
2485 [Link]
2486 NamePolicy=keep kernel database onboard slot path
2487 AlternativeNamesPolicy=database onboard slot path
2488 MACAddressPolicy=persistent
2489 .fi
2490 .if n \{\
2491 .RE
2492 .\}
2493 .PP
2494 \fBExample\ \&2.\ \&/etc/systemd/network/10\-dmz\&.link\fR
2495 .PP
2496 This example assigns the fixed name
2497 "dmz0"
2498 to the interface with the MAC address 00:a0:de:63:7a:e6:
2499 .sp
2500 .if n \{\
2501 .RS 4
2502 .\}
2503 .nf
2504 [Match]
2505 MACAddress=00:a0:de:63:7a:e6
2506
2507 [Link]
2508 Name=dmz0
2509 .fi
2510 .if n \{\
2511 .RE
2512 .\}
2513 .PP
2514 \fINamePolicy=\fR
2515 is not set, so
2516 \fIName=\fR
2517 takes effect\&. We use the
2518 "10\-"
2519 prefix to order this file early in the list\&. Note that it needs to be before
2520 99\-default\&.link, i\&.e\&. it needs a numerical prefix, to have any effect at all\&.
2521 .PP
2522 \fBExample\ \&3.\ \&(Re\-)applying a \&.link file to an interface\fR
2523 .PP
2524 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:
2525 .sp
2526 .if n \{\
2527 .RS 4
2528 .\}
2529 .nf
2530 $ sudo udevadm control \-\-reload
2531 $ sudo ip link set eth0 down
2532 $ sudo udevadm trigger \-\-verbose \-\-settle \-\-action add /sys/class/net/eth0
2533 .fi
2534 .if n \{\
2535 .RE
2536 .\}
2537 .PP
2538 You may also need to stop the service that manages the network interface, e\&.g\&.
2539 \fBsystemd-networkd.service\fR(8)
2540 or
2541 NetworkManager\&.service
2542 before the above operation, and then restart the service after that\&. For more details about
2543 \fBudevadm\fR
2544 command, see
2545 \fBudevadm\fR(8)\&.
2546 .PP
2547 \fBExample\ \&4.\ \&Debugging \fINamePolicy=\fR assignments\fR
2548 .sp
2549 .if n \{\
2550 .RS 4
2551 .\}
2552 .nf
2553 $ sudo SYSTEMD_LOG_LEVEL=debug udevadm test\-builtin net_setup_link /sys/class/net/hub0
2554 \&...
2555 Parsed configuration file /usr/lib/systemd/network/99\-default\&.link
2556 Parsed configuration file /etc/systemd/network/10\-eth0\&.link
2557 ID_NET_DRIVER=cdc_ether
2558 Config file /etc/systemd/network/10\-eth0\&.link applies to device hub0
2559 link_config: autonegotiation is unset or enabled, the speed and duplex are not writable\&.
2560 hub0: Device has name_assign_type=4
2561 Using default interface naming scheme \*(Aqv240\*(Aq\&.
2562 hub0: Policies did not yield a name, using specified Name=hub0\&.
2563 ID_NET_LINK_FILE=/etc/systemd/network/10\-eth0\&.link
2564 ID_NET_NAME=hub0
2565 \&...
2566 .fi
2567 .if n \{\
2568 .RE
2569 .\}
2570 .PP
2571 Explicit
2572 \fIName=\fR
2573 configuration wins in this case\&.
2574 .sp
2575 .if n \{\
2576 .RS 4
2577 .\}
2578 .nf
2579 sudo SYSTEMD_LOG_LEVEL=debug udevadm test\-builtin net_setup_link /sys/class/net/enp0s31f6
2580 \&...
2581 Parsed configuration file /usr/lib/systemd/network/99\-default\&.link
2582 Parsed configuration file /etc/systemd/network/10\-eth0\&.link
2583 Created link configuration context\&.
2584 ID_NET_DRIVER=e1000e
2585 Config file /usr/lib/systemd/network/99\-default\&.link applies to device enp0s31f6
2586 link_config: autonegotiation is unset or enabled, the speed and duplex are not writable\&.
2587 enp0s31f6: Device has name_assign_type=4
2588 Using default interface naming scheme \*(Aqv240\*(Aq\&.
2589 enp0s31f6: Policy *keep*: keeping existing userspace name
2590 enp0s31f6: Device has addr_assign_type=0
2591 enp0s31f6: MAC on the device already matches policy *persistent*
2592 ID_NET_LINK_FILE=/usr/lib/systemd/network/99\-default\&.link
2593 \&...
2594 .fi
2595 .if n \{\
2596 .RE
2597 .\}
2598 .PP
2599 In this case, the interface was already renamed, so the
2600 \fBkeep\fR
2601 policy specified as the first option in
2602 99\-default\&.link
2603 means that the existing name is preserved\&. If
2604 \fBkeep\fR
2605 was removed, or if were in boot before the renaming has happened, we might get the following instead:
2606 .sp
2607 .if n \{\
2608 .RS 4
2609 .\}
2610 .nf
2611 enp0s31f6: Policy *path* yields "enp0s31f6"\&.
2612 enp0s31f6: Device has addr_assign_type=0
2613 enp0s31f6: MAC on the device already matches policy *persistent*
2614 ID_NET_LINK_FILE=/usr/lib/systemd/network/99\-default\&.link
2615 ID_NET_NAME=enp0s31f6
2616 \&...
2617 .fi
2618 .if n \{\
2619 .RE
2620 .\}
2621 .PP
2622 Please note that the details of output are subject to change\&.
2623 .PP
2624 \fBExample\ \&5.\ \&/etc/systemd/network/10\-internet\&.link\fR
2625 .PP
2626 This example assigns the fixed name
2627 "internet0"
2628 to the interface with the device path
2629 "pci\-0000:00:1a\&.0\-*":
2630 .sp
2631 .if n \{\
2632 .RS 4
2633 .\}
2634 .nf
2635 [Match]
2636 Path=pci\-0000:00:1a\&.0\-*
2637
2638 [Link]
2639 Name=internet0
2640 .fi
2641 .if n \{\
2642 .RE
2643 .\}
2644 .PP
2645 \fBExample\ \&6.\ \&/etc/systemd/network/25\-wireless\&.link\fR
2646 .PP
2647 Here\*(Aqs an overly complex example that shows the use of a large number of [Match] and [Link] settings\&.
2648 .sp
2649 .if n \{\
2650 .RS 4
2651 .\}
2652 .nf
2653 [Match]
2654 MACAddress=12:34:56:78:9a:bc
2655 Driver=brcmsmac
2656 Path=pci\-0000:02:00\&.0\-*
2657 Type=wlan
2658 Virtualization=no
2659 Host=my\-laptop
2660 Architecture=x86\-64
2661
2662 [Link]
2663 Name=wireless0
2664 MTUBytes=1450
2665 BitsPerSecond=10M
2666 WakeOnLan=magic
2667 MACAddress=cb:a9:87:65:43:21
2668 .fi
2669 .if n \{\
2670 .RE
2671 .\}
2672 .SH "SEE ALSO"
2673 .PP
2674 \fBsystemd-udevd.service\fR(8), \fBudevadm\fR(8), \fBsystemd.netdev\fR(5), \fBsystemd.network\fR(5), \fBsystemd-network-generator.service\fR(8)
2675 .SH "NOTES"
2676 .IP " 1." 4
2677 ๐Ÿ’ฃ๐Ÿ’ฅ๐Ÿงจ๐Ÿ’ฅ๐Ÿ’ฅ๐Ÿ’ฃ Please note that those configuration files must be available at all times. If
2678 /usr/local/
2679 is a separate partition, it may not be available during early boot, and must not be used for configuration.
2680 .IP " 2." 4
2681 System and Service Credentials
2682 .RS 4
2683 \%https://systemd.io/CREDENTIALS
2684 .RE
2685 .IP " 3." 4
2686 Partial Generic Segmentation Offload
2687 .RS 4
2688 \%https://docs.kernel.org/networking/segmentation-offloads.html#partial-generic-segmentation-offload
2689 .RE