networkd-wait-online: improve interoptability and enable by default
To make sure we don't delay boot on systems where (some) network links are managed by someone else
we don't block if something else has successfully brought up a link.
We will still block until all links we are aware of that are managed by networkd have been
configured, but if no such links exist, and someone else have configured a link sufficiently
that it has a carrier, it may be that the link is ready so we should no longer block.
Note that in all likelyhood the link is not ready (no addresses/routes configured),
so whatever network managment daemon configured it should provide a similar wait-online
service to block network-online.target until it is ready.
The aim is to block as long as we know networking is not fully configured, but no longer. This
will allow systemd-networkd-wait-online.service to be enabled on any system, even if we don't
know whether networkd is the main/only network manager.
Even in the case networking is fully configured by networkd, the default behavior may not be
sufficient: if two links need to be configured, but the first is fully configured before the
second one appears we will assume the network is up. To work around that, we allow specifying
specific devices to wait for before considering the network up.
This unit is enabled by default, just like systemd-networkd, but will only be pulled in if
anyone pulls in network-online.target.
2014-04-23 19:42:55 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
2019-03-14 16:40:58 +03:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
2020-11-09 07:23:58 +03:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
networkd-wait-online: improve interoptability and enable by default
To make sure we don't delay boot on systems where (some) network links are managed by someone else
we don't block if something else has successfully brought up a link.
We will still block until all links we are aware of that are managed by networkd have been
configured, but if no such links exist, and someone else have configured a link sufficiently
that it has a carrier, it may be that the link is ready so we should no longer block.
Note that in all likelyhood the link is not ready (no addresses/routes configured),
so whatever network managment daemon configured it should provide a similar wait-online
service to block network-online.target until it is ready.
The aim is to block as long as we know networking is not fully configured, but no longer. This
will allow systemd-networkd-wait-online.service to be enabled on any system, even if we don't
know whether networkd is the main/only network manager.
Even in the case networking is fully configured by networkd, the default behavior may not be
sufficient: if two links need to be configured, but the first is fully configured before the
second one appears we will assume the network is up. To work around that, we allow specifying
specific devices to wait for before considering the network up.
This unit is enabled by default, just like systemd-networkd, but will only be pulled in if
anyone pulls in network-online.target.
2014-04-23 19:42:55 +04:00
2019-03-06 17:47:29 +03:00
<refentry id= "systemd-networkd-wait-online.service" conditional= 'ENABLE_NETWORKD'
xmlns:xi="http://www.w3.org/2001/XInclude">
networkd-wait-online: improve interoptability and enable by default
To make sure we don't delay boot on systems where (some) network links are managed by someone else
we don't block if something else has successfully brought up a link.
We will still block until all links we are aware of that are managed by networkd have been
configured, but if no such links exist, and someone else have configured a link sufficiently
that it has a carrier, it may be that the link is ready so we should no longer block.
Note that in all likelyhood the link is not ready (no addresses/routes configured),
so whatever network managment daemon configured it should provide a similar wait-online
service to block network-online.target until it is ready.
The aim is to block as long as we know networking is not fully configured, but no longer. This
will allow systemd-networkd-wait-online.service to be enabled on any system, even if we don't
know whether networkd is the main/only network manager.
Even in the case networking is fully configured by networkd, the default behavior may not be
sufficient: if two links need to be configured, but the first is fully configured before the
second one appears we will assume the network is up. To work around that, we allow specifying
specific devices to wait for before considering the network up.
This unit is enabled by default, just like systemd-networkd, but will only be pulled in if
anyone pulls in network-online.target.
2014-04-23 19:42:55 +04:00
2015-02-04 05:14:13 +03:00
<refentryinfo >
2018-05-08 11:53:52 +03:00
<title > systemd-networkd-wait-online.service</title>
2015-02-04 05:14:13 +03:00
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > systemd-networkd-wait-online.service</refentrytitle>
<manvolnum > 8</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd-networkd-wait-online.service</refname>
2022-01-28 09:30:01 +03:00
<refname > systemd-networkd-wait-online@.service</refname>
2015-02-04 05:14:13 +03:00
<refname > systemd-networkd-wait-online</refname>
<refpurpose > Wait for network to come online</refpurpose>
</refnamediv>
<refsynopsisdiv >
<para > <filename > systemd-networkd-wait-online.service</filename> </para>
2022-01-28 09:30:01 +03:00
<para > <filename > systemd-networkd-wait-online@.service</filename> </para>
2015-06-18 20:47:44 +03:00
<para > <filename > /usr/lib/systemd/systemd-networkd-wait-online</filename> </para>
2015-02-04 05:14:13 +03:00
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <command > systemd-networkd-wait-online</command> is a
2018-05-10 06:47:03 +03:00
oneshot system service (see <citerefentry > <refentrytitle > systemd.service</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ), that waits for the network to be
2015-02-04 05:14:13 +03:00
configured. By default, it will wait for all links it is aware of
and which are managed by
<citerefentry > <refentrytitle > systemd-networkd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2019-04-01 00:43:48 +03:00
to be fully configured or failed, and for at least one link to be online. Here, online means that
the link's operational state is equal or higher than <literal > degraded</literal> . The threshold
can be configured by <option > --operational-state=</option> option.</para>
2022-01-28 09:30:01 +03:00
<para > The service <filename > systemd-networkd-wait-online.service</filename> invokes
<command > systemd-networkd-wait-online</command> without any options. Thus, it waits for all managed
interfaces to be configured or failed, and for at least one to be online.</para>
<para > The service <filename > systemd-networkd-wait-online@.service</filename> takes an interface
name, and invokes <command > systemd-networkd-wait-online</command> with <option > -i</option> and the
specified interface name. Thus, wait for the specified interface to be configured and online. For
example, <filename > systemd-networkd-wait-online@eth0.service</filename> waits for
<filename > eth0</filename> to be configured by <command > systemd-networkd</command> and online.
</para>
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following options are understood:</para>
<variablelist >
<varlistentry >
2020-01-09 23:31:50 +03:00
<term > <option > -i</option> <replaceable > INTERFACE</replaceable> <optional > :<replaceable > MIN_OPERSTATE</replaceable> <optional > :<replaceable > MAX_OPERSTATE</replaceable> </optional> </optional> </term>
<term > <option > --interface=</option> <replaceable > INTERFACE</replaceable> <optional > :<replaceable > MIN_OPERSTATE</replaceable> <optional > :<replaceable > MAX_OPERSTATE</replaceable> </optional> </optional> </term>
2015-02-04 05:14:13 +03:00
2019-04-01 00:43:48 +03:00
<listitem > <para > Network interface to wait for before deciding if the system is online. This
is useful when a system has several interfaces which will be configured, but a particular
one is necessary to access some network resources. When used, all other interfaces are ignored.
This option may be used more than once to wait for multiple network interfaces. When this
option is specified multiple times, then <command > systemd-networkd-wait-online</command> waits
2020-01-09 23:31:50 +03:00
for all specified interfaces to be online. Optionally, required minimum and maximum operational
states can be specified after a colon <literal > :</literal> . Please see
2019-03-06 17:47:29 +03:00
<citerefentry > <refentrytitle > networkctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
for possible operational states. If the operational state is not specified here, then
the value from <varname > RequiredForOnline=</varname> in the corresponding
<filename > .network</filename> file is used if present, and <literal > degraded</literal> otherwise.
2023-08-22 19:52:36 +03:00
</para>
2023-09-18 18:03:38 +03:00
<xi:include href= "version-info.xml" xpointer= "v213" /> </listitem>
2015-02-04 05:14:13 +03:00
</varlistentry>
2019-03-06 17:47:29 +03:00
2015-02-04 05:14:13 +03:00
<varlistentry >
2019-03-06 17:47:29 +03:00
<term > <option > --ignore=</option> <replaceable > INTERFACE</replaceable> </term>
2015-02-04 05:14:13 +03:00
<listitem > <para > Network interfaces to be ignored when deciding
2014-08-03 09:11:12 +04:00
if the system is online. By default, only the loopback
2015-02-04 05:14:13 +03:00
interface is ignored. This option may be used more than once
2023-08-22 19:52:36 +03:00
to ignore multiple network interfaces. </para>
2023-09-18 18:03:38 +03:00
<xi:include href= "version-info.xml" xpointer= "v219" /> </listitem>
2015-02-04 05:14:13 +03:00
</varlistentry>
2019-03-06 17:47:29 +03:00
<varlistentry >
2020-01-09 23:31:50 +03:00
<term > <option > -o</option> <replaceable > MIN_OPERSTATE</replaceable> <optional > :<replaceable > MAX_OPERSTATE</replaceable> </optional> </term>
<term > <option > --operational-state=</option> <replaceable > MIN_OPERSTATE</replaceable> <optional > :<replaceable > MAX_OPERSTATE</replaceable> </optional> </term>
2019-03-06 17:47:29 +03:00
2020-01-09 23:31:50 +03:00
<listitem > <para > Takes a minimum operational state and an optional maximum operational state.
Please see <citerefentry > <refentrytitle > networkctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
2019-03-06 17:47:29 +03:00
for possible operational states. If set, the specified value overrides
<varname > RequiredForOnline=</varname> settings in <filename > .network</filename> files.
2019-04-01 00:43:48 +03:00
But this does not override operational states specified in <option > --interface=</option> option.
2023-08-22 19:52:36 +03:00
</para>
2023-09-18 18:03:38 +03:00
<xi:include href= "version-info.xml" xpointer= "v242" /> </listitem>
2019-04-01 00:43:48 +03:00
</varlistentry>
2021-04-13 14:57:19 +03:00
<varlistentry >
<term > <option > -4</option> </term>
<term > <option > --ipv4</option> </term>
<listitem > <para > Waiting for an IPv4 address of each network interface to be configured. If this
option is specified with <option > --any</option> , then
<command > systemd-networkd-wait-online</command> exits with success when at least one interface
2021-12-13 14:14:06 +03:00
becomes online and has an IPv4 address. If the required minimum operational state is
below <literal > routable</literal> , then each link (or at least one link with
<option > --any</option> ) must have an IPv4 link-local or routable address. If the required
minimum operational state is <literal > routable</literal> , then each link must have an IPv4
routable address.</para>
<para > If neither <option > --ipv4</option> nor
2021-04-13 14:57:19 +03:00
<option > --ipv6</option> is specified, then the value from
<varname > RequiredFamilyForOnline=</varname> in the corresponding <filename > .network</filename>
2023-08-22 19:52:36 +03:00
file is used if present.</para>
<xi:include href= "version-info.xml" xpointer= "v249" /> </listitem>
2021-04-13 14:57:19 +03:00
</varlistentry>
<varlistentry >
<term > <option > -6</option> </term>
<term > <option > --ipv6</option> </term>
<listitem > <para > Waiting for an IPv6 address of each network interface to be configured. If this
option is specified with <option > --any</option> , then
<command > systemd-networkd-wait-online</command> exits with success when at least one interface
2021-12-13 14:14:06 +03:00
becomes online and has an IPv6 address. If the required minimum operational state is
below <literal > routable</literal> , then each link (or at least one link with
<option > --any</option> ) must have an IPv6 link-local or routable address. If the required
minimum operational state is <literal > routable</literal> , then each link must have an IPv6
routable address.</para>
<para > If neither <option > --ipv4</option> nor
2021-04-13 14:57:19 +03:00
<option > --ipv6</option> is specified, then the value from
<varname > RequiredFamilyForOnline=</varname> in the corresponding <filename > .network</filename>
2023-08-22 19:52:36 +03:00
file is used if present.</para>
<xi:include href= "version-info.xml" xpointer= "v249" /> </listitem>
2021-04-13 14:57:19 +03:00
</varlistentry>
2019-04-01 00:43:48 +03:00
<varlistentry >
<term > <option > --any</option> </term>
<listitem > <para > Even if several interfaces are in configuring state,
<command > systemd-networkd-wait-online</command> exits with success when at least one interface
becomes online. When this option is specified with <option > --interface=</option> , then
<command > systemd-networkd-wait-online</command> waits for one of the specified interfaces to be
online. This option is useful when some interfaces may not have carrier on boot.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href= "version-info.xml" xpointer= "v242" /> </listitem>
2019-03-06 17:47:29 +03:00
</varlistentry>
2015-02-04 05:14:13 +03:00
<varlistentry >
2020-01-07 11:54:55 +03:00
<term > <option > --timeout=</option> <replaceable > SECS</replaceable> </term>
2019-03-06 17:47:29 +03:00
2015-02-04 05:14:13 +03:00
<listitem > <para > Fail the service if the network is not online
by the time the timeout elapses. A timeout of 0 disables the
2023-08-22 19:52:36 +03:00
timeout. Defaults to 120 seconds. </para>
2023-09-18 18:03:38 +03:00
<xi:include href= "version-info.xml" xpointer= "v219" /> </listitem>
2015-02-04 05:14:13 +03:00
</varlistentry>
2019-03-06 17:47:29 +03:00
<varlistentry >
<term > <option > -q</option> </term>
<term > <option > --quiet</option> </term>
2023-08-22 19:52:36 +03:00
<listitem > <para > Suppress log messages.</para>
<xi:include href= "version-info.xml" xpointer= "v242" /> </listitem>
2019-03-06 17:47:29 +03:00
</varlistentry>
<xi:include href= "standard-options.xml" xpointer= "help" />
<xi:include href= "standard-options.xml" xpointer= "version" />
2015-02-04 05:14:13 +03:00
</variablelist>
</refsect1>
<refsect1 >
<title > See Also</title>
2023-12-22 21:09:32 +03:00
<para > <simplelist type= "inline" >
<member > <citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd.service</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd-networkd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > networkctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </member>
</simplelist> </para>
2015-02-04 05:14:13 +03:00
</refsect1>
networkd-wait-online: improve interoptability and enable by default
To make sure we don't delay boot on systems where (some) network links are managed by someone else
we don't block if something else has successfully brought up a link.
We will still block until all links we are aware of that are managed by networkd have been
configured, but if no such links exist, and someone else have configured a link sufficiently
that it has a carrier, it may be that the link is ready so we should no longer block.
Note that in all likelyhood the link is not ready (no addresses/routes configured),
so whatever network managment daemon configured it should provide a similar wait-online
service to block network-online.target until it is ready.
The aim is to block as long as we know networking is not fully configured, but no longer. This
will allow systemd-networkd-wait-online.service to be enabled on any system, even if we don't
know whether networkd is the main/only network manager.
Even in the case networking is fully configured by networkd, the default behavior may not be
sufficient: if two links need to be configured, but the first is fully configured before the
second one appears we will assume the network is up. To work around that, we allow specifying
specific devices to wait for before considering the network up.
This unit is enabled by default, just like systemd-networkd, but will only be pulled in if
anyone pulls in network-online.target.
2014-04-23 19:42:55 +04:00
</refentry>
