chiark / gitweb /
networkd: explicitly enable/disable ipv6ll addresses
[elogind.git] / man / systemd.network.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6   This file is part of systemd.
7
8   Copyright 2013 Tom Gundersen
9
10   systemd is free software; you can redistribute it and/or modify it
11   under the terms of the GNU Lesser General Public License as published by
12   the Free Software Foundation; either version 2.1 of the License, or
13   (at your option) any later version.
14
15   systemd is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   Lesser General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public License
21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd.network" conditional='ENABLE_NETWORKD'>
25
26   <refentryinfo>
27     <title>systemd.network</title>
28     <productname>systemd</productname>
29
30     <authorgroup>
31       <author>
32         <contrib>Developer</contrib>
33         <firstname>Tom</firstname>
34         <surname>Gundersen</surname>
35         <email>teg@jklm.no</email>
36       </author>
37     </authorgroup>
38   </refentryinfo>
39
40   <refmeta>
41     <refentrytitle>systemd.network</refentrytitle>
42     <manvolnum>5</manvolnum>
43   </refmeta>
44
45   <refnamediv>
46     <refname>systemd.network</refname>
47     <refpurpose>Network configuration</refpurpose>
48   </refnamediv>
49
50   <refsynopsisdiv>
51     <para><filename><replaceable>network</replaceable>.network</filename></para>
52   </refsynopsisdiv>
53
54   <refsect1>
55     <title>Description</title>
56
57     <para>Network setup is performed by
58     <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
59     </para>
60
61     <para>Network files must have the extension
62     <filename>.network</filename>; other extensions are ignored.
63     Networks are applied to links whenever the links appear.</para>
64
65     <para>The <filename>.network</filename> files are read from the
66     files located in the system network directory
67     <filename>/usr/lib/systemd/network</filename>, the volatile
68     runtime network directory
69     <filename>/run/systemd/network</filename> and the local
70     administration network directory
71     <filename>/etc/systemd/network</filename>. All configuration files
72     are collectively sorted and processed in lexical order, regardless
73     of the directories in which they live. However, files with
74     identical filenames replace each other. Files in
75     <filename>/etc</filename> have the highest priority, files in
76     <filename>/run</filename> take precedence over files with the same
77     name in <filename>/usr/lib</filename>. This can be used to
78     override a system-supplied configuration file with a local file if
79     needed; a symlink in <filename>/etc</filename> with the same name
80     as a configuration file in <filename>/usr/lib</filename>, pointing
81     to <filename>/dev/null</filename>, disables the configuration file
82     entirely.</para>
83
84   </refsect1>
85
86   <refsect1>
87     <title>[Match] Section Options</title>
88
89       <para>The network file contains a <literal>[Match]</literal>
90       section, which determines if a given network file may be applied
91       to a given device; and a <literal>[Network]</literal> section
92       specifying how the device should be configured. The first (in
93       lexical order) of the network files that matches a given device
94       is applied.</para>
95
96       <para>A network file is said to match a device if each of the
97       entries in the <literal>[Match]</literal> section matches, or if
98       the section is empty. The following keys are accepted:</para>
99
100       <variablelist class='network-directives'>
101         <varlistentry>
102           <term><varname>MACAddress=</varname></term>
103           <listitem>
104             <para>The hardware address.</para>
105           </listitem>
106         </varlistentry>
107         <varlistentry>
108           <term><varname>Path=</varname></term>
109           <listitem>
110             <para>A whitespace-separated list of shell-style globs
111             matching the persistent path, as exposed by the udev
112             property <literal>ID_PATH</literal>.</para>
113           </listitem>
114         </varlistentry>
115         <varlistentry>
116           <term><varname>Driver=</varname></term>
117           <listitem>
118             <para>A whitespace-separated list of shell-style globs
119             matching the driver currently bound to the device, as
120             exposed by the udev property <literal>DRIVER</literal>
121             of its parent device, or if that is not set the driver
122             as exposed by <literal>ethtool -i</literal> of the
123             device itself.</para>
124           </listitem>
125         </varlistentry>
126         <varlistentry>
127           <term><varname>Type=</varname></term>
128           <listitem>
129             <para>A whitespace-separated list of shell-style globs
130             matching the device type, as exposed by the udev property
131             <literal>DEVTYPE</literal>.</para>
132           </listitem>
133         </varlistentry>
134         <varlistentry>
135           <term><varname>Name=</varname></term>
136           <listitem>
137             <para>A whitespace-separated list of shell-style globs
138             matching the device name, as exposed by the udev property
139             <literal>INTERFACE</literal>.</para>
140           </listitem>
141         </varlistentry>
142         <varlistentry>
143           <term><varname>Host=</varname></term>
144           <listitem>
145             <para>Matches against the hostname or machine ID of the
146             host. See <literal>ConditionHost=</literal> in
147             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
148             for details.
149             </para>
150           </listitem>
151         </varlistentry>
152         <varlistentry>
153           <term><varname>Virtualization=</varname></term>
154           <listitem>
155             <para>Checks whether the system is executed in a virtualized
156             environment and optionally test whether it is a specific
157             implementation. See <literal>ConditionVirtualization=</literal> in
158             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
159             for details.
160             </para>
161           </listitem>
162         </varlistentry>
163         <varlistentry>
164           <term><varname>KernelCommandLine=</varname></term>
165           <listitem>
166             <para>Checks whether a specific kernel command line option is
167             set (or if prefixed with the exclamation mark unset). See
168             <literal>ConditionKernelCommandLine=</literal> in
169             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
170             for details.
171             </para>
172           </listitem>
173         </varlistentry>
174         <varlistentry>
175           <term><varname>Architecture=</varname></term>
176           <listitem>
177             <para>Checks whether the system is running on a specific
178             architecture. See <literal>ConditionArchitecture=</literal> in
179             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
180             for details.
181             </para>
182           </listitem>
183         </varlistentry>
184       </variablelist>
185
186   </refsect1>
187
188   <refsect1>
189     <title>[Link] Section Options</title>
190
191     <para> The <literal>[Link]</literal> section accepts the following keys:</para>
192
193     <variablelist class='network-directives'>
194       <varlistentry>
195         <term><varname>MACAddress=</varname></term>
196         <listitem>
197           <para>The hardware address.</para>
198         </listitem>
199       </varlistentry>
200       <varlistentry>
201         <term><varname>MTUBytes=</varname></term>
202         <listitem>
203           <para>The maximum transmission unit in bytes to set for the
204           device. The usual suffixes K, M, G, are supported and are
205           understood to the base of 1024.</para>
206         </listitem>
207       </varlistentry>
208     </variablelist>
209   </refsect1>
210
211   <refsect1>
212     <title>[Network] Section Options</title>
213
214       <para>The <literal>[Network]</literal> section accepts the following keys:</para>
215
216       <variablelist class='network-directives'>
217         <varlistentry>
218           <term><varname>Description=</varname></term>
219           <listitem>
220             <para>A description of the device. This is only used for
221             presentation purposes.</para>
222           </listitem>
223         </varlistentry>
224         <varlistentry>
225           <term><varname>DHCP=</varname></term>
226           <listitem>
227             <para>Enables DHCPv4 and/or DHCPv6 support. Accepts
228             <literal>yes</literal>, <literal>no</literal>,
229             <literal>ipv4</literal>, or <literal>ipv6</literal>.</para>
230           </listitem>
231         </varlistentry>
232         <varlistentry>
233           <term><varname>DHCPServer=</varname></term>
234           <listitem>
235             <para>A boolean. Enables a basic DHCPv4 server on the
236             device. Mostly useful for handing out leases to container
237             instances.</para>
238           </listitem>
239         </varlistentry>
240         <varlistentry>
241           <term><varname>LinkLocal=</varname></term>
242           <listitem>
243             <para>Enables link-local address autoconfiguration. Accepts
244             <literal>yes</literal>, <literal>no</literal>,
245             <literal>ipv4</literal>, or <literal>ipv6</literal>. Defaults to
246             <literal>ipv6</literal>.</para>
247           </listitem>
248         </varlistentry>
249         <varlistentry>
250           <term><varname>IPv4LLRoute=</varname></term>
251           <listitem>
252             <para>A boolean. When true, sets up the route needed for
253             non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults
254             to false.
255             </para>
256           </listitem>
257         </varlistentry>
258         <varlistentry>
259           <term><varname>LLMNR=</varname></term>
260           <listitem>
261             <para>A boolean or <literal>resolve</literal>. When true, enables
262             Link-Local Multicast Name Resolution on the link, when set to
263             <literal>resolve</literal> only resolution is enabled, but not
264             announcement. Defaults to true.</para>
265           </listitem>
266         </varlistentry>
267         <varlistentry>
268           <term><varname>LLDP=</varname></term>
269           <listitem>
270             <para>A boolean. When true, enables LLDP link receive support.
271             </para>
272           </listitem>
273         </varlistentry>
274         <varlistentry>
275           <term><varname>Address=</varname></term>
276           <listitem>
277             <para>A static IPv4 or IPv6 address and its prefix length,
278             separated by a <literal>/</literal> character. Specify
279             this key more than once to configure several addresses.
280             The format of the address must be as described in
281             <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
282             This is a short-hand for an [Address] section only
283             containing an Address key (see below). This option may be
284             specified more than once.
285             </para>
286
287             <para>If the specified address is 0.0.0.0 (for IPv4) or
288             [::] (for IPv6), a new address range of the requested size
289             is automatically allocated from a system-wide pool of
290             unused ranges. The allocated range is checked against all
291             current network interfaces and all known network
292             configuration files to avoid address range conflicts. The
293             default system-wide pool consists of 192.168.0.0/16,
294             172.16.0.0/12 and 10.0.0.0/8 for IPv4, and fc00::/7 for
295             IPv6. This functionality is useful to manage a large
296             number of dynamically created network interfaces with the
297             same network configuration and automatic address range
298             assignment.</para>
299
300           </listitem>
301         </varlistentry>
302         <varlistentry>
303           <term><varname>Gateway=</varname></term>
304           <listitem>
305             <para>The gateway address, which must be in the format
306             described in
307             <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
308             This is a short-hand for a [Route] section only containing
309             a Gateway key. This option may be specified more than
310             once.</para>
311           </listitem>
312         </varlistentry>
313         <varlistentry>
314           <term><varname>DNS=</varname></term>
315           <listitem>
316             <para>A DNS server address, which must be in the format
317             described in
318             <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
319             This option may be specified more than once.</para>
320           </listitem>
321         </varlistentry>
322         <varlistentry>
323           <term><varname>Domains=</varname></term>
324           <listitem>
325             <para>The domains used for DNS resolution over this link.</para>
326           </listitem>
327         </varlistentry>
328         <varlistentry>
329           <term><varname>NTP=</varname></term>
330           <listitem>
331             <para>An NTP server address. This option may be specified more than once.</para>
332           </listitem>
333         </varlistentry>
334         <varlistentry>
335           <term><varname>IPForward=</varname></term>
336           <listitem><para>Configures IP forwarding for the network
337           interface. If enabled incoming packets on the network
338           interface will be forwarded to other interfaces according to
339           the routing table. Takes either a boolean argument, or the
340           values <literal>ipv4</literal> or <literal>ipv6</literal>,
341           which only enables IP forwarding for the specified address
342           family.</para></listitem>
343         </varlistentry>
344         <varlistentry>
345           <term><varname>IPMasquerade=</varname></term>
346           <listitem><para>Configures IP masquerading for the network
347           interface. If enabled packets forwarded from the network
348           interface will be appear as coming from the local host.
349           Takes a boolean argument. Implies
350           <varname>IPForward=yes</varname>.</para></listitem>
351         </varlistentry>
352         <varlistentry>
353           <term><varname>Bridge=</varname></term>
354           <listitem>
355             <para>The name of the bridge to add the link to.</para>
356           </listitem>
357         </varlistentry>
358         <varlistentry>
359           <term><varname>Bond=</varname></term>
360           <listitem>
361             <para>The name of the bond to add the link to.</para>
362           </listitem>
363         </varlistentry>
364         <varlistentry>
365           <term><varname>VLAN=</varname></term>
366           <listitem>
367             <para>The name of a VLAN to create on the link. This
368             option may be specified more than once.</para>
369           </listitem>
370         </varlistentry>
371         <varlistentry>
372           <term><varname>MACVLAN=</varname></term>
373           <listitem>
374             <para>The name of a MACVLAN to create on the link. This
375             option may be specified more than once.</para>
376           </listitem>
377         </varlistentry>
378         <varlistentry>
379           <term><varname>VXLAN=</varname></term>
380           <listitem>
381             <para>The name of a VXLAN to create on the link. This
382             option may be specified more than once.</para>
383           </listitem>
384         </varlistentry>
385         <varlistentry>
386           <term><varname>Tunnel=</varname></term>
387           <listitem>
388             <para>The name of a Tunnel to create on the link. This
389             option may be specified more than once.</para>
390           </listitem>
391         </varlistentry>
392       </variablelist>
393
394   </refsect1>
395
396   <refsect1>
397     <title>[Address] Section Options</title>
398
399       <para>An <literal>[Address]</literal> section accepts the
400       following keys. Specify several <literal>[Address]</literal>
401       sections to configure several addresses.</para>
402
403       <variablelist class='network-directives'>
404         <varlistentry>
405           <term><varname>Address=</varname></term>
406           <listitem>
407             <para>As in the <literal>[Network]</literal> section. This
408             key is mandatory.</para>
409           </listitem>
410         </varlistentry>
411         <varlistentry>
412           <term><varname>Peer=</varname></term>
413           <listitem>
414             <para>The peer address in a point-to-point connection.
415             Accepts the same format as the <literal>Address</literal>
416             key.</para>
417           </listitem>
418         </varlistentry>
419         <varlistentry>
420           <term><varname>Broadcast=</varname></term>
421           <listitem>
422             <para>The broadcast address, which must be in the format
423             described in
424             <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
425             This key only applies to IPv4 addresses. If it is not
426             given, it is derived from the <literal>Address</literal>
427             key.</para>
428           </listitem>
429         </varlistentry>
430         <varlistentry>
431           <term><varname>Label=</varname></term>
432           <listitem>
433             <para>An address label.</para>
434           </listitem>
435         </varlistentry>
436       </variablelist>
437   </refsect1>
438
439   <refsect1>
440     <title>[Route] Section Options</title>
441       <para>The <literal>[Route]</literal> section accepts the
442       following keys. Specify several <literal>[Route]</literal>
443       sections to configure several routes.</para>
444
445       <variablelist class='network-directives'>
446         <varlistentry>
447           <term><varname>Gateway=</varname></term>
448           <listitem>
449             <para>As in the <literal>[Network]</literal> section.</para>
450           </listitem>
451         </varlistentry>
452         <varlistentry>
453           <term><varname>Destination=</varname></term>
454           <listitem>
455             <para>The destination prefix of the route. Possibly
456             followed by a slash and the prefixlength. If omitted, a
457             full-length host route is assumed.</para>
458           </listitem>
459         </varlistentry>
460         <varlistentry>
461           <term><varname>Source=</varname></term>
462           <listitem>
463             <para>The source prefix of the route. Possibly followed by
464             a slash and the prefixlength. If omitted, a full-length
465             host route is assumed.</para>
466           </listitem>
467         </varlistentry>
468         <varlistentry>
469           <term><varname>Metric=</varname></term>
470           <listitem>
471             <para>The metric of the route. An unsigned integer</para>
472           </listitem>
473         </varlistentry>
474         <varlistentry>
475           <term><varname>Scope=</varname></term>
476           <listitem>
477             <para>The scope of the route. One of the values <literal>global</literal>,
478             <literal>link</literal> or <literal>host</literal>. Defaults to
479             <literal>global</literal>.</para>
480           </listitem>
481         </varlistentry>
482       </variablelist>
483   </refsect1>
484
485   <refsect1>
486     <title>[DHCP] Section Options</title>
487       <para>The <literal>[DHCP]</literal> section accepts the following keys:</para>
488
489       <variablelist class='network-directives'>
490         <varlistentry>
491           <term><varname>UseDNS=</varname></term>
492           <listitem>
493             <para>When true (the default), the DNS servers received
494             from the DHCP server will be used and take precedence over
495             any statically configured ones.</para>
496           </listitem>
497         </varlistentry>
498         <varlistentry>
499           <term><varname>UseMTU=</varname></term>
500           <listitem>
501             <para>When true, the interface maximum transmission unit
502             from the DHCP server will be used on the current link.
503             Defaults to false.</para>
504           </listitem>
505         </varlistentry>
506         <varlistentry>
507           <term><varname>SendHostname=</varname></term>
508           <listitem>
509             <para>When true (the default), the machine's hostname will be sent to the DHCP
510             server</para>
511           </listitem>
512         </varlistentry>
513         <varlistentry>
514           <term><varname>UseHostname=</varname></term>
515           <listitem>
516             <para>When true (the default), the hostname received from
517             the DHCP server will be used as the transient
518             hostname.</para>
519           </listitem>
520         </varlistentry>
521         <varlistentry>
522           <term><varname>UseDomains=</varname></term>
523           <listitem>
524             <para>When true (not the default), the domain name
525             received from the DHCP server will be used for DNS
526             resolution over this link.</para>
527           </listitem>
528         </varlistentry>
529         <varlistentry>
530           <term><varname>UseRoutes=</varname></term>
531           <listitem>
532             <para>When true (the default), the static routes will be
533             requested from the DHCP server and added to the routing
534             table with metric of 1024.</para>
535           </listitem>
536         </varlistentry>
537         <varlistentry>
538           <term><varname>CriticalConnection=</varname></term>
539           <listitem>
540             <para>When true, the connection will never be torn down
541             even if the DHCP lease expires. This is contrary to the
542             DHCP specification, but may be the best choice if, say,
543             the root filesystem relies on this connection. Defaults to
544             false.</para>
545           </listitem>
546         </varlistentry>
547         <varlistentry>
548           <term><varname>VendorClassIdentifier=</varname></term>
549           <listitem>
550             <para>The vendor class identifier used to identify vendor
551             type and configuration.</para>
552           </listitem>
553         </varlistentry>
554         <varlistentry>
555           <term><varname>RequestBroadcast=</varname></term>
556           <listitem>
557             <para>Request the server to use broadcast messages before
558             the IP address has been configured. This is necessary for
559             devices that cannot receive RAW packets, or that cannot
560             receive packets at all before an IP address has been
561             configured. On the other hand, this must not be enabled on
562             networks where broadcasts are filtered out.</para>
563           </listitem>
564         </varlistentry>
565         <varlistentry>
566           <term><varname>RouteMetric=</varname></term>
567           <listitem>
568             <para>Set the routing metric for routes specified by the
569             DHCP server.</para>
570           </listitem>
571         </varlistentry>
572            </variablelist>
573
574   </refsect1>
575
576   <refsect1>
577     <title>[Bridge] Section Options</title>
578       <para>The <literal>[Bridge]</literal> section accepts the
579       following keys.</para>
580       <variablelist class='network-directives'>
581         <varlistentry>
582           <term><varname>Cost=</varname></term>
583           <listitem>
584             <para>Each port in a bridge may have different speed. Cost
585             is used to decide which link to use. Faster interfaces
586             should have lower costs</para>
587           </listitem>
588         </varlistentry>
589       </variablelist>
590   </refsect1>
591
592   <refsect1>
593     <title>[BridgeFDB] Section Options</title>
594       <para>The <literal>[BridgeFDB]</literal> section manages the
595       forwarding database table of a port and accepts the following
596       keys. Specify several <literal>[BridgeFDB]</literal> sections to
597       configure several static MAC table entries.</para>
598
599       <variablelist class='network-directives'>
600         <varlistentry>
601           <term><varname>MACAddress=</varname></term>
602           <listitem>
603             <para>As in the <literal>[Network]</literal> section. This
604             key is mandatory.</para>
605           </listitem>
606         </varlistentry>
607         <varlistentry>
608           <term><varname>VLANId=</varname></term>
609           <listitem>
610             <para>The VLAN Id for the new static MAC table entry. If
611             omitted, no VLAN Id info is appended to the new static MAC
612             table entry.</para>
613           </listitem>
614         </varlistentry>
615       </variablelist>
616   </refsect1>
617
618   <refsect1>
619     <title>Example</title>
620     <example>
621       <title>/etc/systemd/network/50-static.network</title>
622
623       <programlisting>[Match]
624 Name=enp2s0
625
626 [Network]
627 Address=192.168.0.15/24
628 Gateway=192.168.0.1</programlisting>
629     </example>
630
631     <example>
632       <title>/etc/systemd/network/80-dhcp.network</title>
633
634       <programlisting>[Match]
635 Name=en*
636
637 [Network]
638 DHCP=both</programlisting>
639     </example>
640
641     <example>
642       <title>/etc/systemd/network/bridge-static.network</title>
643
644       <programlisting>[Match]
645 Name=bridge0
646
647 [Network]
648 Address=192.168.0.15/24
649 Gateway=192.168.0.1
650 DNS=192.168.0.1</programlisting>
651     </example>
652
653     <example>
654       <title>/etc/systemd/network/bridge-slave-interface.network</title>
655
656       <programlisting>[Match]
657 Name=enp2s0
658
659 [Network]
660 Bridge=bridge0</programlisting>
661     </example>
662     <example>
663       <title>/etc/systemd/network/ipip.network</title>
664
665       <programlisting>[Match]
666 Name=em1
667
668 [Network]
669 Tunnel=ipip-tun</programlisting>
670     </example>
671
672     <example>
673       <title>/etc/systemd/network/sit.network</title>
674
675       <programlisting>[Match]
676 Name=em1
677
678 [Network]
679 Tunnel=sit-tun</programlisting>
680     </example>
681
682     <example>
683       <title>/etc/systemd/network/gre.network</title>
684
685       <programlisting>[Match]
686 Name=em1
687
688 [Network]
689 Tunnel=gre-tun</programlisting>
690     </example>
691
692     <example>
693       <title>/etc/systemd/network/vti.network</title>
694
695       <programlisting>[Match]
696 Name=em1
697
698 [Network]
699 Tunnel=vti-tun</programlisting>
700     </example>
701   </refsect1>
702
703   <refsect1>
704     <title>See Also</title>
705     <para>
706       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
707       <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
708       <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
709       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
710     </para>
711   </refsect1>
712
713 </refentry>