1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>systemd-networkd-wait-online.service
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>systemd-networkd-wait-online.service
</refentrytitle>
16 <manvolnum>8</manvolnum>
20 <refname>systemd-networkd-wait-online.service
</refname>
21 <refname>systemd-networkd-wait-online
</refname>
22 <refpurpose>Wait for network to come online
</refpurpose>
26 <para><filename>systemd-networkd-wait-online.service
</filename></para>
27 <para><filename>/usr/lib/systemd/systemd-networkd-wait-online
</filename></para>
31 <title>Description
</title>
33 <para><command>systemd-networkd-wait-online
</command> is a
34 oneshot system service (see
<citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>), that waits for the network to be
35 configured. By default, it will wait for all links it is aware of
36 and which are managed by
37 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
38 to be fully configured or failed, and for at least one link to be online. Here, online means that
39 the link's operational state is equal or higher than
<literal>degraded
</literal>. The threshold
40 can be configured by
<option>--operational-state=
</option> option.
</para>
44 <title>Options
</title>
46 <para>The following options are understood:
</para>
50 <term><option>-i
</option> <replaceable>INTERFACE
</replaceable><optional>:
<replaceable>MIN_OPERSTATE
</replaceable><optional>:
<replaceable>MAX_OPERSTATE
</replaceable></optional></optional></term>
51 <term><option>--interface=
</option><replaceable>INTERFACE
</replaceable><optional>:
<replaceable>MIN_OPERSTATE
</replaceable><optional>:
<replaceable>MAX_OPERSTATE
</replaceable></optional></optional></term>
53 <listitem><para>Network interface to wait for before deciding if the system is online. This
54 is useful when a system has several interfaces which will be configured, but a particular
55 one is necessary to access some network resources. When used, all other interfaces are ignored.
56 This option may be used more than once to wait for multiple network interfaces. When this
57 option is specified multiple times, then
<command>systemd-networkd-wait-online
</command> waits
58 for all specified interfaces to be online. Optionally, required minimum and maximum operational
59 states can be specified after a colon
<literal>:
</literal>. Please see
60 <citerefentry><refentrytitle>networkctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
61 for possible operational states. If the operational state is not specified here, then
62 the value from
<varname>RequiredForOnline=
</varname> in the corresponding
63 <filename>.network
</filename> file is used if present, and
<literal>degraded
</literal> otherwise.
68 <term><option>--ignore=
</option><replaceable>INTERFACE
</replaceable></term>
70 <listitem><para>Network interfaces to be ignored when deciding
71 if the system is online. By default, only the loopback
72 interface is ignored. This option may be used more than once
73 to ignore multiple network interfaces.
</para></listitem>
77 <term><option>-o
</option> <replaceable>MIN_OPERSTATE
</replaceable><optional>:
<replaceable>MAX_OPERSTATE
</replaceable></optional></term>
78 <term><option>--operational-state=
</option><replaceable>MIN_OPERSTATE
</replaceable><optional>:
<replaceable>MAX_OPERSTATE
</replaceable></optional></term>
80 <listitem><para>Takes a minimum operational state and an optional maximum operational state.
81 Please see
<citerefentry><refentrytitle>networkctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
82 for possible operational states. If set, the specified value overrides
83 <varname>RequiredForOnline=
</varname> settings in
<filename>.network
</filename> files.
84 But this does not override operational states specified in
<option>--interface=
</option> option.
89 <term><option>-
4</option></term>
90 <term><option>--ipv4
</option></term>
92 <listitem><para>Waiting for an IPv4 address of each network interface to be configured. If this
93 option is specified with
<option>--any
</option>, then
94 <command>systemd-networkd-wait-online
</command> exits with success when at least one interface
95 becomes online and has an IPv4 address. The option is applied only for the operational state
96 <literal>degraded
</literal> or above. If neither
<option>--ipv4
</option> nor
97 <option>--ipv6
</option> is specified, then the value from
98 <varname>RequiredFamilyForOnline=
</varname> in the corresponding
<filename>.network
</filename>
99 file is used if present.
</para></listitem>
103 <term><option>-
6</option></term>
104 <term><option>--ipv6
</option></term>
106 <listitem><para>Waiting for an IPv6 address of each network interface to be configured. If this
107 option is specified with
<option>--any
</option>, then
108 <command>systemd-networkd-wait-online
</command> exits with success when at least one interface
109 becomes online and has an IPv6 address. The option is applied only for the operational state
110 <literal>degraded
</literal> or above. If neither
<option>--ipv4
</option> nor
111 <option>--ipv6
</option> is specified, then the value from
112 <varname>RequiredFamilyForOnline=
</varname> in the corresponding
<filename>.network
</filename>
113 file is used if present.
</para></listitem>
117 <term><option>--any
</option></term>
119 <listitem><para>Even if several interfaces are in configuring state,
120 <command>systemd-networkd-wait-online
</command> exits with success when at least one interface
121 becomes online. When this option is specified with
<option>--interface=
</option>, then
122 <command>systemd-networkd-wait-online
</command> waits for one of the specified interfaces to be
123 online. This option is useful when some interfaces may not have carrier on boot.
128 <term><option>--timeout=
</option><replaceable>SECS
</replaceable></term>
130 <listitem><para>Fail the service if the network is not online
131 by the time the timeout elapses. A timeout of
0 disables the
132 timeout. Defaults to
120 seconds.
</para></listitem>
136 <term><option>-q
</option></term>
137 <term><option>--quiet
</option></term>
139 <listitem><para>Suppress log messages.
</para></listitem>
142 <xi:include href=
"standard-options.xml" xpointer=
"help" />
143 <xi:include href=
"standard-options.xml" xpointer=
"version" />
148 <title>See Also
</title>
150 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
151 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
152 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
153 <citerefentry><refentrytitle>networkctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>