.network/.netdev/.link: allow to match on architecture

[elogind.git] / man / systemd-networkd.service.xml

diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml
index 1b1ea4c5fe8735be0af7e32bd51b8ca4ce14e2a1..91e13924888d95f63d16fa4a162d4227448f61d6 100644 (file)
--- a/man/systemd-networkd.service.xml
+++ b/man/systemd-networkd.service.xml
@@ -61,11 +61,16 @@
                 network devices as they appear, as well as creating virtual
                 network devices.</para>
 
                 network devices as they appear, as well as creating virtual
                 network devices.</para>
 

+                <para>To configure low-level link settings independently of
+                networks, see
+                <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                .</para>
+

                 <para>Network configurations applied before networkd is started
                 <para>Network configurations applied before networkd is started

-                are not removed, and configuration applied by networkd are not
-                removed when networkd exits. This ensures restarting networkd
-                does not cut the network connection, and, in particular, that
-                it is safe to transition between the initrd and the real root,
+                are not removed, and static configuration applied by networkd
+                are not removed when networkd exits. This ensures restarting
+                networkd does not cut the network connection, and, in particular,
+                that it is safe to transition between the initrd and the real root,

                 and back.</para>
         </refsect1>
 
                 and back.</para>
         </refsect1>
 


@@ -91,6 +96,55 @@
                         <filename>.netdev</filename>; other extensions are ignored. Virtual
                         network devices are created as soon as networkd is started.</para>
 
                         <filename>.netdev</filename>; other extensions are ignored. Virtual
                         network devices are created as soon as networkd is started.</para>
 

+                        <para>A virtual network device is only created if the
+                        <literal>[Match]</literal> section matches the current
+                        environment, or if the section is empty. The following keys are accepted:</para>
+
+                        <variablelist class='network-directives'>
+                                <varlistentry>
+                                        <term><varname>Host</varname></term>
+                                        <listitem>
+                                                <para>Matches against the hostname or machine ID of the
+                                                host. See <literal>ConditionHost=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Virtualization</varname></term>
+                                        <listitem>
+                                                <para>Checks whether the system is executed in a virtualized
+                                                environment and optionally test whether it is a specific
+                                                implementation. See <literal>ConditionVirtualization=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>KernelCommandLine</varname></term>
+                                        <listitem>
+                                                <para>Checks whether a specific kernel command line option is
+                                                set (or if prefixed with the exclamation mark unset). See
+                                                <literal>ConditionKernelCommandLine=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Architecture</varname></term>
+                                        <listitem>
+                                                <para>Checks whether the system is running on a specific
+                                                architecture. See <literal>ConditionArchitecture=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                        </variablelist>
+

                         <para>The <literal>[NetDev]</literal> section accepts the following
                         keys:</para>
 
                         <para>The <literal>[NetDev]</literal> section accepts the following
                         keys:</para>
 


@@ -105,20 +159,21 @@
                                 <varlistentry>
                                         <term><varname>Kind</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>Kind</varname></term>
                                         <listitem>

-                                                <para>The netdev kind. Currently, 'bridge', 'bond' and 'vlan'
+                                                <para>The netdev kind. Currently, <literal>bridge</literal>,
+                                                <literal>bond</literal> and <literal>vlan</literal>

                                                 are supported. This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>
                         </variablelist>
 
                                                 are supported. This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>
                         </variablelist>
 

-                        <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind 'vlan',
-                        and accepts the following keys:</para>
+                        <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind <literal>vlan</literal>,
+                        and accepts the following key:</para>

 
                         <variablelist class='network-directives'>
                                 <varlistentry>
                                         <term><varname>Id</varname></term>
                                         <listitem>
 
                         <variablelist class='network-directives'>
                                 <varlistentry>
                                         <term><varname>Id</varname></term>
                                         <listitem>

-                                                <para>The VLAN ID to use. An integer in the range 0-4094.
+                                                <para>The VLAN ID to use. An integer in the range 0–4094.

                                                 This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>
                                                 This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>


@@ -152,14 +207,16 @@
                                         <term><varname>Path</varname></term>
                                         <listitem>
                                                 <para>The persistent path, as exposed by the udev
                                         <term><varname>Path</varname></term>
                                         <listitem>
                                                 <para>The persistent path, as exposed by the udev

-                                                property <literal>ID_PATH</literal>.</para>
+                                                property <literal>ID_PATH</literal>. May contain shell
+                                                style globs.</para>

                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>Driver</varname></term>
                                         <listitem>
                                                 <para>The driver currently bound to the device, as
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>Driver</varname></term>
                                         <listitem>
                                                 <para>The driver currently bound to the device, as

-                                                exposed by the udev property <literal>DRIVER</literal>.
+                                                exposed by the udev property <literal>DRIVER</literal>
+                                                of its parent device.

                                                 </para>
                                         </listitem>
                                 </varlistentry>
                                                 </para>
                                         </listitem>
                                 </varlistentry>


@@ -174,7 +231,50 @@
                                         <term><varname>Name</varname></term>
                                         <listitem>
                                                 <para>The device name, as exposed by the udev property
                                         <term><varname>Name</varname></term>
                                         <listitem>
                                                 <para>The device name, as exposed by the udev property

-                                                <literal>INTERFACE</literal>.</para>
+                                                <literal>INTERFACE</literal>. May contain shell style
+                                                globs.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Host</varname></term>
+                                        <listitem>
+                                                <para>Matches against the hostname or machine ID of the
+                                                host. See <literal>ConditionHost=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Virtualization</varname></term>
+                                        <listitem>
+                                                <para>Checks whether the system is executed in a virtualized
+                                                environment and optionally test whether it is a specific
+                                                implementation. See <literal>ConditionVirtualization=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>KernelCommandLine</varname></term>
+                                        <listitem>
+                                                <para>Checks whether a specific kernel command line option is
+                                                set (or if prefixed with the exclamation mark unset). See
+                                                <literal>ConditionKernelCommandLine=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Architecture</varname></term>
+                                        <listitem>
+                                                <para>Checks whether the system is running on a specific
+                                                architecture. See <literal>ConditionArchitecture=</literal> in
+                                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                                for details.
+                                                </para>

                                         </listitem>
                                 </varlistentry>
                         </variablelist>
                                         </listitem>
                                 </varlistentry>
                         </variablelist>


@@ -192,14 +292,14 @@
                                 <varlistentry>
                                         <term><varname>DHCP</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>DHCP</varname></term>
                                         <listitem>

-                                                <para>A boolean. When true enables basic DHCPv4 support.</para>
+                                                <para>A boolean. When true, enables basic DHCPv4 support.</para>

                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>Address</varname></term>
                                         <listitem>
                                                 <para>A static IPv4 or IPv6 address and its prefix length,
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>Address</varname></term>
                                         <listitem>
                                                 <para>A static IPv4 or IPv6 address and its prefix length,

-                                                separated by a '/' character. The format of the address must
+                                                separated by a <literal>/</literal> character. The format of the address must

                                                 be as described in
                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                                                 . This is a short-hand for an [Address] section only containing an Address key (see below).</para>
                                                 be as described in
                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                                                 . This is a short-hand for an [Address] section only containing an Address key (see below).</para>


@@ -251,6 +351,15 @@
                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
                                         </listitem>
                                 </varlistentry>
                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
                                         </listitem>
                                 </varlistentry>

+                                <varlistentry>
+                                        <term><varname>Broadcast</varname></term>
+                                        <listitem>
+                                                <para>The broadcast address, which must be in the format described in
+                                                <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                                                . This key only applies to IPv4 addresses. If it is not given, it is
+                                                derived from the <literal>Address</literal> key.</para>
+                                        </listitem>
+                                </varlistentry>

                                 <varlistentry>
                                         <term><varname>Label</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>Label</varname></term>
                                         <listitem>


@@ -283,28 +392,28 @@
                                 <varlistentry>
                                         <term><varname>UseDNS</varname></term>
                                         <listitem>
                                 <varlistentry>
                                         <term><varname>UseDNS</varname></term>
                                         <listitem>

-                                                <para>When true (the default) the DNS servers received from the DHCP server will
-                                                be used, and take precedence over any statically configured ones.</para>
+                                                <para>When true (the default), the DNS servers received from the DHCP server will
+                                                be used and take precedence over any statically configured ones.</para>

                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>UseMTU</varname></term>
                                         <listitem>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>UseMTU</varname></term>
                                         <listitem>

-                                                <para>When true the interface maximum transmission unit from the DHCP server will
+                                                <para>When true, the interface maximum transmission unit from the DHCP server will

                                                 be used on the current link. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>UseHostname</varname></term>
                                         <listitem>
                                                 be used on the current link. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>UseHostname</varname></term>
                                         <listitem>

-                                                <para>When true (the default) the hostname received from the DHCP server
+                                                <para>When true (the default), the hostname received from the DHCP server

                                                 will be used as the transient hostname.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>CriticalConnection</varname></term>
                                         <listitem>
                                                 will be used as the transient hostname.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>CriticalConnection</varname></term>
                                         <listitem>

-                                                <para>When true the connection will never be torn down even if the DHCP lease
+                                                <para>When true, the connection will never be torn down even if the DHCP lease

                                                 expires. This is contrary to the DHCP specification, but may be the best choice
                                                 if, say, the root filesystem relies on this connection. Defaults to false.</para>
                                         </listitem>
                                                 expires. This is contrary to the DHCP specification, but may be the best choice
                                                 if, say, the root filesystem relies on this connection. Defaults to false.</para>
                                         </listitem>