]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
0307f791 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
1ff28eae TG |
5 | |
6 | <refentry id="systemd.link"> | |
798d3a52 ZJS |
7 | <refentryinfo> |
8 | <title>systemd.link</title> | |
9 | <productname>systemd</productname> | |
798d3a52 | 10 | </refentryinfo> |
1ff28eae | 11 | |
798d3a52 ZJS |
12 | <refmeta> |
13 | <refentrytitle>systemd.link</refentrytitle> | |
14 | <manvolnum>5</manvolnum> | |
15 | </refmeta> | |
1ff28eae | 16 | |
798d3a52 ZJS |
17 | <refnamediv> |
18 | <refname>systemd.link</refname> | |
19 | <refpurpose>Network device configuration</refpurpose> | |
20 | </refnamediv> | |
1ff28eae | 21 | |
798d3a52 ZJS |
22 | <refsynopsisdiv> |
23 | <para><filename><replaceable>link</replaceable>.link</filename></para> | |
24 | </refsynopsisdiv> | |
1ff28eae | 25 | |
798d3a52 ZJS |
26 | <refsect1> |
27 | <title>Description</title> | |
1ff28eae | 28 | |
798d3a52 ZJS |
29 | <para>Network link configuration is performed by the |
30 | <command>net_setup_link</command> udev builtin.</para> | |
1ff28eae | 31 | |
798d3a52 | 32 | <para>The link files are read from the files located in the system |
12b42c76 | 33 | network directory <filename>/usr/lib/systemd/network</filename>, |
798d3a52 ZJS |
34 | the volatile runtime network directory |
35 | <filename>/run/systemd/network</filename>, and the local | |
36 | administration network directory | |
12b42c76 | 37 | <filename>/etc/systemd/network</filename>. Link files must have |
798d3a52 ZJS |
38 | the extension <filename>.link</filename>; other extensions are |
39 | ignored. All link files are collectively sorted and processed in | |
40 | lexical order, regardless of the directories in which they live. | |
41 | However, files with identical filenames replace each other. Files | |
42 | in <filename>/etc</filename> have the highest priority, files in | |
43 | <filename>/run</filename> take precedence over files with the same | |
12b42c76 | 44 | name in <filename>/usr/lib</filename>. This can be used to |
57e27ec0 ZJS |
45 | override a system-supplied link file with a local file if needed. |
46 | As a special case, an empty file (file size 0) or symlink with the | |
a8eaaee7 | 47 | same name pointing to <filename>/dev/null</filename> disables the |
57e27ec0 | 48 | configuration file entirely (it is "masked").</para> |
1ff28eae | 49 | |
d7dce7b6 ZJS |
50 | <para>The link file contains a [Match] section, which determines if a given link file may be applied to a |
51 | given device, as well as a [Link] section specifying how the device should be configured. The first (in | |
52 | lexical order) of the link files that matches a given device is applied. Note that a default file | |
53 | <filename>99-default.link</filename> is shipped by the system. Any user-supplied | |
54 | <filename>.link</filename> should hence have a lexically earlier name to be considered at all.</para> | |
55 | ||
56 | <para>See <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> for | |
57 | diagnosing problems with <filename>.link</filename> files.</para> | |
798d3a52 | 58 | </refsect1> |
102bd40e | 59 | |
798d3a52 ZJS |
60 | <refsect1> |
61 | <title>[Match] Section Options</title> | |
1ff28eae | 62 | |
d7dce7b6 ZJS |
63 | <para>A link file is said to match a device if each of the entries in the [Match] section matches, or if |
64 | the section is empty. The following keys are accepted:</para> | |
1ff28eae | 65 | |
798d3a52 ZJS |
66 | <variablelist class='network-directives'> |
67 | <varlistentry> | |
68 | <term><varname>MACAddress=</varname></term> | |
69 | <listitem> | |
9310bf4b YW |
70 | <para>A whitespace-separated list of hardware addresses. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example below. |
71 | 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 | |
72 | of hardware addresses defined prior to this is reset.</para> | |
73 | ||
74 | <para>Example: | |
75 | <programlisting>MACAddress=01:23:45:67:89:ab 00-11-22-33-44-55 AABB.CCDD.EEFF</programlisting></para> | |
798d3a52 ZJS |
76 | </listitem> |
77 | </varlistentry> | |
78 | <varlistentry> | |
79 | <term><varname>OriginalName=</varname></term> | |
80 | <listitem> | |
5256e00e TG |
81 | <para>A whitespace-separated list of shell-style globs matching |
82 | the device name, as exposed by the udev property | |
2dd67817 | 83 | "INTERFACE". This cannot be used to match on names that have |
5256e00e | 84 | already been changed from userspace. Caution is advised when matching on |
798d3a52 ZJS |
85 | kernel-assigned names, as they are known to be unstable |
86 | between reboots.</para> | |
87 | </listitem> | |
88 | </varlistentry> | |
89 | <varlistentry> | |
90 | <term><varname>Path=</varname></term> | |
91 | <listitem> | |
5256e00e TG |
92 | <para>A whitespace-separated list of shell-style globs matching |
93 | the persistent path, as exposed by the udev property | |
d7dce7b6 | 94 | <varname>ID_PATH</varname>.</para> |
798d3a52 ZJS |
95 | </listitem> |
96 | </varlistentry> | |
97 | <varlistentry> | |
98 | <term><varname>Driver=</varname></term> | |
99 | <listitem> | |
d7dce7b6 ZJS |
100 | <para>A whitespace-separated list of shell-style globs matching the driver currently bound to the |
101 | device, as exposed by the udev property <varname>DRIVER</varname> of its parent device, or if that | |
102 | is not set, the driver as exposed by <command>ethtool -i</command> of the device itself.</para> | |
798d3a52 ZJS |
103 | </listitem> |
104 | </varlistentry> | |
105 | <varlistentry> | |
106 | <term><varname>Type=</varname></term> | |
107 | <listitem> | |
5256e00e TG |
108 | <para>A whitespace-separated list of shell-style globs matching |
109 | the device type, as exposed by the udev | |
d7dce7b6 | 110 | property <varname>DEVTYPE</varname>.</para> |
798d3a52 ZJS |
111 | </listitem> |
112 | </varlistentry> | |
113 | <varlistentry> | |
114 | <term><varname>Host=</varname></term> | |
115 | <listitem> | |
116 | <para>Matches against the hostname or machine | |
d7dce7b6 | 117 | ID of the host. See <varname>ConditionHost=</varname> in |
798d3a52 ZJS |
118 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
119 | for details.</para> | |
120 | </listitem> | |
121 | </varlistentry> | |
122 | <varlistentry> | |
123 | <term><varname>Virtualization=</varname></term> | |
124 | <listitem> | |
125 | <para>Checks whether the system is executed in | |
126 | a virtualized environment and optionally test | |
127 | whether it is a specific implementation. See | |
d7dce7b6 | 128 | <varname>ConditionVirtualization=</varname> in |
798d3a52 ZJS |
129 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
130 | for details.</para> | |
131 | </listitem> | |
132 | </varlistentry> | |
133 | <varlistentry> | |
134 | <term><varname>KernelCommandLine=</varname></term> | |
135 | <listitem> | |
136 | <para>Checks whether a specific kernel command line option | |
137 | is set (or if prefixed with the exclamation mark unset). See | |
d7dce7b6 | 138 | <varname>ConditionKernelCommandLine=</varname> in |
798d3a52 ZJS |
139 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
140 | for details.</para> | |
141 | </listitem> | |
142 | </varlistentry> | |
5022f08a LP |
143 | <varlistentry> |
144 | <term><varname>KernelVersion=</varname></term> | |
145 | <listitem> | |
146 | <para>Checks whether the kernel version (as reported by <command>uname -r</command>) matches a certain | |
147 | expression (or if prefixed with the exclamation mark does not match it). See | |
d7dce7b6 | 148 | <varname>ConditionKernelVersion=</varname> in |
5022f08a LP |
149 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for |
150 | details. | |
151 | </para> | |
152 | </listitem> | |
153 | </varlistentry> | |
798d3a52 ZJS |
154 | <varlistentry> |
155 | <term><varname>Architecture=</varname></term> | |
156 | <listitem> | |
157 | <para>Checks whether the system is running on a specific | |
d7dce7b6 | 158 | architecture. See <varname>ConditionArchitecture=</varname> |
798d3a52 ZJS |
159 | in |
160 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
161 | for details.</para> | |
162 | </listitem> | |
163 | </varlistentry> | |
164 | </variablelist> | |
1ff28eae | 165 | |
798d3a52 | 166 | </refsect1> |
102bd40e | 167 | |
798d3a52 ZJS |
168 | <refsect1> |
169 | <title>[Link] Section Options</title> | |
102bd40e | 170 | |
d7dce7b6 | 171 | <para>The [Link] section accepts the following |
798d3a52 | 172 | keys:</para> |
1ff28eae | 173 | |
798d3a52 ZJS |
174 | <variablelist class='network-directives'> |
175 | <varlistentry> | |
176 | <term><varname>Description=</varname></term> | |
177 | <listitem> | |
178 | <para>A description of the device.</para> | |
179 | </listitem> | |
180 | </varlistentry> | |
181 | <varlistentry> | |
182 | <term><varname>Alias=</varname></term> | |
183 | <listitem> | |
d7dce7b6 | 184 | <para>The <varname>ifalias</varname> interface property is set to this value.</para> |
798d3a52 ZJS |
185 | </listitem> |
186 | </varlistentry> | |
187 | <varlistentry> | |
188 | <term><varname>MACAddressPolicy=</varname></term> | |
189 | <listitem> | |
190 | <para>The policy by which the MAC address should be set. The | |
191 | available policies are: | |
192 | </para> | |
1ff28eae | 193 | |
798d3a52 ZJS |
194 | <variablelist> |
195 | <varlistentry> | |
d7dce7b6 | 196 | <term><option>persistent</option></term> |
798d3a52 ZJS |
197 | <listitem> |
198 | <para>If the hardware has a persistent MAC address, as | |
199 | most hardware should, and if it is used by the kernel, | |
200 | nothing is done. Otherwise, a new MAC address is | |
201 | generated which is guaranteed to be the same on every | |
202 | boot for the given machine and the given device, but | |
1c25683e | 203 | which is otherwise random. This feature depends on ID_NET_NAME_* |
a8eaaee7 | 204 | properties to exist for the link. On hardware where these |
b938cb90 | 205 | properties are not set, the generation of a persistent MAC address |
1c25683e | 206 | will fail.</para> |
798d3a52 ZJS |
207 | </listitem> |
208 | </varlistentry> | |
209 | <varlistentry> | |
d7dce7b6 | 210 | <term><option>random</option></term> |
798d3a52 ZJS |
211 | <listitem> |
212 | <para>If the kernel is using a random MAC address, | |
213 | nothing is done. Otherwise, a new address is randomly | |
214 | generated each time the device appears, typically at | |
b938cb90 | 215 | boot. Either way, the random address will have the |
2e229e0c TG |
216 | <literal>unicast</literal> and |
217 | <literal>locally administered</literal> bits set.</para> | |
798d3a52 ZJS |
218 | </listitem> |
219 | </varlistentry> | |
66d3752e | 220 | <varlistentry> |
d7dce7b6 | 221 | <term><option>none</option></term> |
66d3752e JK |
222 | <listitem> |
223 | <para>Keeps the MAC address assigned by the kernel.</para> | |
224 | </listitem> | |
225 | </varlistentry> | |
798d3a52 ZJS |
226 | </variablelist> |
227 | </listitem> | |
228 | </varlistentry> | |
229 | <varlistentry> | |
230 | <term><varname>MACAddress=</varname></term> | |
231 | <listitem> | |
232 | <para>The MAC address to use, if no | |
d7dce7b6 | 233 | <varname>MACAddressPolicy=</varname> |
798d3a52 ZJS |
234 | is specified.</para> |
235 | </listitem> | |
236 | </varlistentry> | |
237 | <varlistentry> | |
238 | <term><varname>NamePolicy=</varname></term> | |
239 | <listitem> | |
3907446f | 240 | <para>An ordered, space-separated list of policies by which the interface name should be set. |
d7dce7b6 | 241 | <varname>NamePolicy=</varname> may be disabled by specifying <option>net.ifnames=0</option> on the |
3907446f | 242 | kernel command line. Each of the policies may fail, and the first successful one is used. The name |
d7dce7b6 ZJS |
243 | is not set directly, but is exported to udev as the property <option>ID_NET_NAME</option>, which |
244 | is, by default, used by a udev rule to set <varname>NAME</varname>. The available policies are: | |
3907446f | 245 | </para> |
1ff28eae | 246 | |
798d3a52 ZJS |
247 | <variablelist> |
248 | <varlistentry> | |
d7dce7b6 | 249 | <term><option>kernel</option></term> |
798d3a52 ZJS |
250 | <listitem> |
251 | <para>If the kernel claims that the name it has set | |
252 | for a device is predictable, then no renaming is | |
253 | performed.</para> | |
254 | </listitem> | |
255 | </varlistentry> | |
256 | <varlistentry> | |
d7dce7b6 | 257 | <term><option>database</option></term> |
798d3a52 ZJS |
258 | <listitem> |
259 | <para>The name is set based on entries in the udev's | |
260 | Hardware Database with the key | |
d7dce7b6 | 261 | <varname>ID_NET_NAME_FROM_DATABASE</varname>. |
798d3a52 ZJS |
262 | </para> |
263 | </listitem> | |
264 | </varlistentry> | |
265 | <varlistentry> | |
d7dce7b6 | 266 | <term><option>onboard</option></term> |
798d3a52 ZJS |
267 | <listitem> |
268 | <para>The name is set based on information given by | |
269 | the firmware for on-board devices, as exported by the | |
d7dce7b6 | 270 | udev property <varname>ID_NET_NAME_ONBOARD</varname>. |
798d3a52 ZJS |
271 | </para> |
272 | </listitem> | |
273 | </varlistentry> | |
274 | <varlistentry> | |
d7dce7b6 | 275 | <term><option>slot</option></term> |
798d3a52 ZJS |
276 | <listitem> |
277 | <para>The name is set based on information given by | |
278 | the firmware for hot-plug devices, as exported by the | |
d7dce7b6 | 279 | udev property <varname>ID_NET_NAME_SLOT</varname>. |
798d3a52 ZJS |
280 | </para> |
281 | </listitem> | |
282 | </varlistentry> | |
283 | <varlistentry> | |
d7dce7b6 | 284 | <term><option>path</option></term> |
798d3a52 ZJS |
285 | <listitem> |
286 | <para>The name is set based on the device's physical | |
287 | location, as exported by the udev property | |
d7dce7b6 | 288 | <varname>ID_NET_NAME_PATH</varname>.</para> |
798d3a52 ZJS |
289 | </listitem> |
290 | </varlistentry> | |
291 | <varlistentry> | |
d7dce7b6 | 292 | <term><option>mac</option></term> |
798d3a52 ZJS |
293 | <listitem> |
294 | <para>The name is set based on the device's persistent | |
295 | MAC address, as exported by the udev property | |
d7dce7b6 | 296 | <varname>ID_NET_NAME_MAC</varname>.</para> |
798d3a52 ZJS |
297 | </listitem> |
298 | </varlistentry> | |
3907446f | 299 | <varlistentry> |
d7dce7b6 | 300 | <term><option>keep</option></term> |
3907446f ZJS |
301 | <listitem> |
302 | <para>If the device already had a name given by userspace (as part of creation of the device | |
303 | or a rename), keep it.</para> | |
798d3a52 ZJS |
304 | </listitem> |
305 | </varlistentry> | |
306 | </variablelist> | |
307 | </listitem> | |
308 | </varlistentry> | |
309 | <varlistentry> | |
310 | <term><varname>Name=</varname></term> | |
311 | <listitem> | |
312 | <para>The interface name to use in case all the | |
313 | policies specified in | |
314 | <varname>NamePolicy=</varname> fail, or in case | |
315 | <varname>NamePolicy=</varname> is missing or | |
316 | disabled.</para> | |
1b934761 ZJS |
317 | |
318 | <para>Note that specifying a name that the kernel might use for another | |
319 | interface (for example <literal>eth0</literal>) is dangerous because the | |
320 | name assignment done by udev will race with the assignment done by the | |
321 | kernel, and only one interface may use the name. Depending on the order of | |
322 | operations, either udev or the kernel will win, making the naming | |
323 | unpredictable. It is best to use some different prefix, for example | |
324 | <literal>internal0</literal>/<literal>external0</literal> or | |
325 | <literal>lan0</literal>/<literal>lan1</literal>/<literal>lan3</literal>. | |
326 | </para> | |
798d3a52 ZJS |
327 | </listitem> |
328 | </varlistentry> | |
329 | <varlistentry> | |
330 | <term><varname>MTUBytes=</varname></term> | |
331 | <listitem> | |
332 | <para>The maximum transmission unit in bytes to set for the | |
333 | device. The usual suffixes K, M, G, are supported and are | |
334 | understood to the base of 1024.</para> | |
335 | </listitem> | |
336 | </varlistentry> | |
337 | <varlistentry> | |
338 | <term><varname>BitsPerSecond=</varname></term> | |
339 | <listitem> | |
340 | <para>The speed to set for the device, the value is rounded | |
341 | down to the nearest Mbps. The usual suffixes K, M, G, are | |
342 | supported and are understood to the base of 1000.</para> | |
343 | </listitem> | |
344 | </varlistentry> | |
345 | <varlistentry> | |
346 | <term><varname>Duplex=</varname></term> | |
347 | <listitem> | |
d7dce7b6 ZJS |
348 | <para>The duplex mode to set for the device. The accepted values are <option>half</option> and |
349 | <option>full</option>.</para> | |
798d3a52 ZJS |
350 | </listitem> |
351 | </varlistentry> | |
a39f92d3 SS |
352 | <varlistentry> |
353 | <term><varname>AutoNegotiation=</varname></term> | |
354 | <listitem> | |
9b6ffef3 | 355 | <para>Takes a boolean. If set to yes, automatic negotiation of transmission parameters is enabled. |
a39f92d3 SS |
356 | Autonegotiation is a procedure by which two connected ethernet devices choose |
357 | common transmission parameters, such as speed, duplex mode, and flow control. | |
9b6ffef3 | 358 | When unset, the kernel's default will be used.</para> |
a39f92d3 | 359 | |
a0e1ad10 JJ |
360 | <para>Note that if autonegotiation is enabled, speed and duplex settings are |
361 | read-only. If autonegotation is disabled, speed and duplex settings are writable | |
a39f92d3 SS |
362 | if the driver supports multiple link modes.</para> |
363 | </listitem> | |
364 | </varlistentry> | |
798d3a52 ZJS |
365 | <varlistentry> |
366 | <term><varname>WakeOnLan=</varname></term> | |
367 | <listitem> | |
368 | <para>The Wake-on-LAN policy to set for the device. The | |
369 | supported values are:</para> | |
1ff28eae | 370 | |
798d3a52 ZJS |
371 | <variablelist> |
372 | <varlistentry> | |
d7dce7b6 | 373 | <term><option>phy</option></term> |
798d3a52 ZJS |
374 | <listitem> |
375 | <para>Wake on PHY activity.</para> | |
376 | </listitem> | |
377 | </varlistentry> | |
617da14c | 378 | <varlistentry> |
d7dce7b6 | 379 | <term><option>unicast</option></term> |
617da14c SS |
380 | <listitem> |
381 | <para>Wake on unicast messages.</para> | |
382 | </listitem> | |
383 | </varlistentry> | |
384 | <varlistentry> | |
d7dce7b6 | 385 | <term><option>multicast</option></term> |
617da14c SS |
386 | <listitem> |
387 | <para>Wake on multicast messages.</para> | |
388 | </listitem> | |
389 | </varlistentry> | |
390 | <varlistentry> | |
d7dce7b6 | 391 | <term><option>broadcast</option></term> |
617da14c SS |
392 | <listitem> |
393 | <para>Wake on broadcast messages.</para> | |
394 | </listitem> | |
395 | </varlistentry> | |
396 | <varlistentry> | |
d7dce7b6 | 397 | <term><option>arp</option></term> |
617da14c SS |
398 | <listitem> |
399 | <para>Wake on ARP.</para> | |
400 | </listitem> | |
401 | </varlistentry> | |
798d3a52 | 402 | <varlistentry> |
d7dce7b6 | 403 | <term><option>magic</option></term> |
798d3a52 ZJS |
404 | <listitem> |
405 | <para>Wake on receipt of a magic packet. | |
406 | </para> | |
407 | </listitem> | |
408 | </varlistentry> | |
617da14c | 409 | <varlistentry> |
d7dce7b6 | 410 | <term><option>secureon</option></term> |
617da14c SS |
411 | <listitem> |
412 | <para>Enable secureon(tm) password for MagicPacket(tm). | |
413 | </para> | |
414 | </listitem> | |
415 | </varlistentry> | |
798d3a52 | 416 | <varlistentry> |
d7dce7b6 | 417 | <term><option>off</option></term> |
798d3a52 ZJS |
418 | <listitem> |
419 | <para>Never wake.</para> | |
420 | </listitem> | |
421 | </varlistentry> | |
422 | </variablelist> | |
c605bd00 | 423 | |
d7dce7b6 | 424 | <para>Defaults to <option>off</option>.</para> |
798d3a52 ZJS |
425 | </listitem> |
426 | </varlistentry> | |
593022fa SS |
427 | <varlistentry> |
428 | <term><varname>Port=</varname></term> | |
429 | <listitem> | |
430 | <para>The port option is used to select the device port. The | |
431 | supported values are:</para> | |
432 | ||
433 | <variablelist> | |
434 | <varlistentry> | |
d7dce7b6 | 435 | <term><option>tp</option></term> |
593022fa SS |
436 | <listitem> |
437 | <para>An Ethernet interface using Twisted-Pair cable as the medium.</para> | |
438 | </listitem> | |
439 | </varlistentry> | |
440 | <varlistentry> | |
d7dce7b6 | 441 | <term><option>aui</option></term> |
593022fa SS |
442 | <listitem> |
443 | <para>Attachment Unit Interface (AUI). Normally used with hubs. | |
444 | </para> | |
445 | </listitem> | |
446 | </varlistentry> | |
447 | <varlistentry> | |
d7dce7b6 | 448 | <term><option>bnc</option></term> |
593022fa SS |
449 | <listitem> |
450 | <para>An Ethernet interface using BNC connectors and co-axial cable.</para> | |
451 | </listitem> | |
452 | </varlistentry> | |
453 | <varlistentry> | |
d7dce7b6 | 454 | <term><option>mii</option></term> |
593022fa SS |
455 | <listitem> |
456 | <para>An Ethernet interface using a Media Independent Interface (MII).</para> | |
457 | </listitem> | |
458 | </varlistentry> | |
459 | <varlistentry> | |
d7dce7b6 | 460 | <term><option>fibre</option></term> |
593022fa SS |
461 | <listitem> |
462 | <para>An Ethernet interface using Optical Fibre as the medium.</para> | |
463 | </listitem> | |
464 | </varlistentry> | |
465 | </variablelist> | |
466 | </listitem> | |
467 | </varlistentry> | |
6cf0a204 SS |
468 | <varlistentry> |
469 | <term><varname>Advertise=</varname></term> | |
470 | <listitem> | |
471 | <para>This sets what speeds and duplex modes of operation are advertised for auto-negotiation. | |
a0e1ad10 | 472 | This implies <literal>AutoNegotiation=yes</literal>. The supported values are: |
6cf0a204 SS |
473 | |
474 | <table> | |
475 | <title>Supported advertise values</title> | |
476 | <tgroup cols='3'> | |
477 | <colspec colname='Advertise' /> | |
478 | <colspec colname='Speed' /> | |
479 | <colspec colname='Duplex Mode' /> | |
480 | ||
481 | <thead><row> | |
482 | <entry>Advertise</entry> | |
483 | <entry>Speed (Mbps)</entry> | |
484 | <entry>Duplex Mode</entry> | |
485 | </row></thead> | |
486 | <tbody> | |
d7dce7b6 | 487 | <row><entry><option>10baset-half</option></entry> |
6cf0a204 SS |
488 | <entry>10</entry><entry>half</entry></row> |
489 | ||
d7dce7b6 | 490 | <row><entry><option>10baset-full</option></entry> |
6cf0a204 SS |
491 | <entry>10</entry><entry>full</entry></row> |
492 | ||
d7dce7b6 | 493 | <row><entry><option>100baset-half</option></entry> |
6cf0a204 SS |
494 | <entry>100</entry><entry>half</entry></row> |
495 | ||
d7dce7b6 | 496 | <row><entry><option>100baset-full</option></entry> |
6cf0a204 SS |
497 | <entry>100</entry><entry>full</entry></row> |
498 | ||
d7dce7b6 | 499 | <row><entry><option>1000baset-half</option></entry> |
6cf0a204 SS |
500 | <entry>1000</entry><entry>half</entry></row> |
501 | ||
d7dce7b6 | 502 | <row><entry><option>1000baset-full</option></entry> |
6cf0a204 SS |
503 | <entry>1000</entry><entry>full</entry></row> |
504 | ||
d7dce7b6 | 505 | <row><entry><option>10000baset-full</option></entry> |
6cf0a204 SS |
506 | <entry>10000</entry><entry>full</entry></row> |
507 | ||
d7dce7b6 | 508 | <row><entry><option>2500basex-full</option></entry> |
6cf0a204 SS |
509 | <entry>2500</entry><entry>full</entry></row> |
510 | ||
d7dce7b6 | 511 | <row><entry><option>1000basekx-full</option></entry> |
6cf0a204 SS |
512 | <entry>1000</entry><entry>full</entry></row> |
513 | ||
d7dce7b6 | 514 | <row><entry><option>10000basekx4-full</option></entry> |
6cf0a204 SS |
515 | <entry>10000</entry><entry>full</entry></row> |
516 | ||
d7dce7b6 | 517 | <row><entry><option>10000basekr-full</option></entry> |
6cf0a204 SS |
518 | <entry>10000</entry><entry>full</entry></row> |
519 | ||
d7dce7b6 | 520 | <row><entry><option>10000baser-fec</option></entry> |
6cf0a204 SS |
521 | <entry>10000</entry><entry>full</entry></row> |
522 | ||
d7dce7b6 | 523 | <row><entry><option>20000basemld2-full</option></entry> |
6cf0a204 SS |
524 | <entry>20000</entry><entry>full</entry></row> |
525 | ||
d7dce7b6 | 526 | <row><entry><option>20000basekr2-full</option></entry> |
6cf0a204 SS |
527 | <entry>20000</entry><entry>full</entry></row> |
528 | </tbody> | |
529 | </tgroup> | |
530 | </table> | |
531 | ||
532 | By default this is unset, i.e. all possible modes will be advertised. | |
533 | This option may be specified more than once, in which case all specified speeds and modes are advertised. | |
534 | If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect. | |
535 | </para> | |
536 | </listitem> | |
537 | </varlistentry> | |
50725d10 SS |
538 | <varlistentry> |
539 | <term><varname>TCPSegmentationOffload=</varname></term> | |
540 | <listitem> | |
9b6ffef3 | 541 | <para>Takes a boolean. If set to true, the TCP Segmentation Offload (TSO) is enabled. |
025314d9 | 542 | When unset, the kernel's default will be used.</para> |
50725d10 | 543 | </listitem> |
ffa69a04 SS |
544 | </varlistentry> |
545 | <varlistentry> | |
546 | <term><varname>TCP6SegmentationOffload=</varname></term> | |
547 | <listitem> | |
9b6ffef3 | 548 | <para>Takes a boolean. If set to true, the TCP6 Segmentation Offload (tx-tcp6-segmentation) is enabled. |
025314d9 | 549 | When unset, the kernel's default will be used.</para> |
ffa69a04 | 550 | </listitem> |
50725d10 SS |
551 | </varlistentry> |
552 | <varlistentry> | |
553 | <term><varname>GenericSegmentationOffload=</varname></term> | |
554 | <listitem> | |
9b6ffef3 | 555 | <para>Takes a boolean. If set to true, the Generic Segmentation Offload (GSO) is enabled. |
025314d9 | 556 | When unset, the kernel's default will be used.</para> |
50725d10 SS |
557 | </listitem> |
558 | </varlistentry> | |
f7ea90fb SS |
559 | <varlistentry> |
560 | <term><varname>GenericReceiveOffload=</varname></term> | |
561 | <listitem> | |
9b6ffef3 | 562 | <para>Takes a boolean. If set to true, the Generic Receive Offload (GRO) is enabled. |
025314d9 | 563 | When unset, the kernel's default will be used.</para> |
f7ea90fb SS |
564 | </listitem> |
565 | </varlistentry> | |
566 | <varlistentry> | |
567 | <term><varname>LargeReceiveOffload=</varname></term> | |
568 | <listitem> | |
9b6ffef3 | 569 | <para>Takes a boolean. If set to true, the Large Receive Offload (LRO) is enabled. |
025314d9 | 570 | When unset, the kernel's default will be used.</para> |
f7ea90fb SS |
571 | </listitem> |
572 | </varlistentry> | |
5f945202 SS |
573 | <varlistentry> |
574 | <term><varname>RxChannels=</varname></term> | |
575 | <listitem> | |
576 | <para>Sets the number of receive channels (a number between 1 and 4294967295) .</para> | |
577 | </listitem> | |
578 | </varlistentry> | |
579 | <varlistentry> | |
580 | <term><varname>TxChannels=</varname></term> | |
581 | <listitem> | |
582 | <para>Sets the number of transmit channels (a number between 1 and 4294967295).</para> | |
583 | </listitem> | |
584 | </varlistentry> | |
585 | <varlistentry> | |
586 | <term><varname>OtherChannels=</varname></term> | |
587 | <listitem> | |
588 | <para>Sets the number of other channels (a number between 1 and 4294967295).</para> | |
589 | </listitem> | |
590 | </varlistentry> | |
591 | <varlistentry> | |
592 | <term><varname>CombinedChannels=</varname></term> | |
593 | <listitem> | |
594 | <para>Sets the number of combined set channels (a number between 1 and 4294967295).</para> | |
595 | </listitem> | |
596 | </varlistentry> | |
798d3a52 ZJS |
597 | </variablelist> |
598 | </refsect1> | |
1ff28eae | 599 | |
798d3a52 | 600 | <refsect1> |
b97e7fab LP |
601 | <title>Examples</title> |
602 | ||
603 | <example> | |
604 | <title>/usr/lib/systemd/network/99-default.link</title> | |
605 | ||
606 | <para>The link file <filename>99-default.link</filename> that is | |
607 | shipped with systemd defines the default naming policy for | |
608 | links.</para> | |
609 | ||
610 | <programlisting>[Link] | |
611 | NamePolicy=kernel database onboard slot path | |
612 | MACAddressPolicy=persistent</programlisting> | |
613 | </example> | |
614 | ||
615 | <example> | |
616 | <title>/etc/systemd/network/10-dmz.link</title> | |
617 | ||
618 | <para>This example assigns the fixed name | |
619 | <literal>dmz0</literal> to the interface with the MAC address | |
620 | 00:a0:de:63:7a:e6:</para> | |
621 | ||
622 | <programlisting>[Match] | |
623 | MACAddress=00:a0:de:63:7a:e6 | |
624 | ||
625 | [Link] | |
626 | Name=dmz0</programlisting> | |
627 | </example> | |
628 | ||
629 | <example> | |
630 | <title>/etc/systemd/network/10-internet.link</title> | |
631 | ||
632 | <para>This example assigns the fixed name | |
633 | <literal>internet0</literal> to the interface with the device | |
634 | path <literal>pci-0000:00:1a.0-*</literal>:</para> | |
635 | ||
636 | <programlisting>[Match] | |
637 | Path=pci-0000:00:1a.0-* | |
638 | ||
639 | [Link] | |
640 | Name=internet0</programlisting> | |
641 | </example> | |
642 | ||
798d3a52 | 643 | <example> |
6c1695be | 644 | <title>/etc/systemd/network/25-wireless.link</title> |
1ff28eae | 645 | |
b97e7fab LP |
646 | <para>Here's an overly complex example that shows the use of a large number of [Match] and [Link] settings.</para> |
647 | ||
798d3a52 | 648 | <programlisting>[Match] |
7abaad1a | 649 | MACAddress=12:34:56:78:9a:bc |
650 | Driver=brcmsmac | |
651 | Path=pci-0000:02:00.0-* | |
652 | Type=wlan | |
653 | Virtualization=no | |
654 | Host=my-laptop | |
655 | Architecture=x86-64 | |
1ff28eae | 656 | |
7abaad1a | 657 | [Link] |
658 | Name=wireless0 | |
659 | MTUBytes=1450 | |
660 | BitsPerSecond=10M | |
661 | WakeOnLan=magic | |
662 | MACAddress=cb:a9:87:65:43:21</programlisting> | |
798d3a52 ZJS |
663 | </example> |
664 | </refsect1> | |
1ff28eae | 665 | |
798d3a52 ZJS |
666 | <refsect1> |
667 | <title>See Also</title> | |
668 | <para> | |
669 | <citerefentry> | |
670 | <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> | |
671 | </citerefentry>, | |
672 | <citerefentry> | |
673 | <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum> | |
674 | </citerefentry>, | |
675 | <citerefentry> | |
676 | <refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum> | |
677 | </citerefentry>, | |
678 | <citerefentry> | |
679 | <refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum> | |
680 | </citerefentry> | |
681 | </para> | |
682 | </refsect1> | |
1ff28eae TG |
683 | |
684 | </refentry> |