]>
Commit | Line | Data |
---|---|---|
3a67e927 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
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+ --> |
3a67e927 | 5 | |
8d6082e4 YW |
6 | <refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD' |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
3a67e927 | 8 | |
798d3a52 | 9 | <refentryinfo> |
77e3a240 | 10 | <title>systemd-networkd-wait-online.service</title> |
798d3a52 | 11 | <productname>systemd</productname> |
798d3a52 ZJS |
12 | </refentryinfo> |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>systemd-networkd-wait-online.service</refentrytitle> | |
16 | <manvolnum>8</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>systemd-networkd-wait-online.service</refname> | |
21 | <refname>systemd-networkd-wait-online</refname> | |
22 | <refpurpose>Wait for network to come online</refpurpose> | |
23 | </refnamediv> | |
24 | ||
25 | <refsynopsisdiv> | |
26 | <para><filename>systemd-networkd-wait-online.service</filename></para> | |
12b42c76 | 27 | <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para> |
798d3a52 ZJS |
28 | </refsynopsisdiv> |
29 | ||
30 | <refsect1> | |
31 | <title>Description</title> | |
32 | ||
33 | <para><command>systemd-networkd-wait-online</command> is a | |
7cfcb252 | 34 | oneshot system service (see <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>), that waits for the network to be |
798d3a52 ZJS |
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 | |
39 | gain a carrier.</para> | |
40 | </refsect1> | |
41 | ||
42 | <refsect1> | |
43 | <title>Options</title> | |
44 | ||
45 | <para>The following options are understood:</para> | |
46 | ||
47 | <variablelist> | |
48 | <varlistentry> | |
8d6082e4 YW |
49 | <term><option>-i</option> <replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term> |
50 | <term><option>--interface=</option><replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term> | |
798d3a52 ZJS |
51 | |
52 | <listitem><para>Network interface to wait for before deciding | |
53 | if the system is online. This is useful when a system has | |
54 | several interfaces which will be configured, but a particular | |
55 | one is necessary to access some network resources. This option | |
56 | may be used more than once to wait for multiple network | |
be0c1370 | 57 | interfaces. When used, all other interfaces are ignored. |
8d6082e4 YW |
58 | Optinally, required minimum operational state can be |
59 | 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. | |
be0c1370 | 64 | </para></listitem> |
798d3a52 | 65 | </varlistentry> |
8d6082e4 | 66 | |
798d3a52 | 67 | <varlistentry> |
8d6082e4 YW |
68 | <term><option>--ignore=</option><replaceable>INTERFACE</replaceable></term> |
69 | ||
798d3a52 | 70 | <listitem><para>Network interfaces to be ignored when deciding |
b938cb90 | 71 | if the system is online. By default, only the loopback |
798d3a52 ZJS |
72 | interface is ignored. This option may be used more than once |
73 | to ignore multiple network interfaces. </para></listitem> | |
74 | </varlistentry> | |
8d6082e4 YW |
75 | |
76 | <varlistentry> | |
77 | <term><option>-o</option> <replaceable>OPERSTATE</replaceable></term> | |
78 | <term><option>--operational-state=</option><replaceable>OPERSTATE</replaceable></term> | |
79 | ||
80 | <listitem><para>Takes an operational state. Please see | |
81 | <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. | |
85 | </para></listitem> | |
86 | </varlistentry> | |
87 | ||
798d3a52 | 88 | <varlistentry> |
8d6082e4 YW |
89 | <term><option>--timeout=</option> <replaceable>SECS</replaceable></term> |
90 | ||
798d3a52 ZJS |
91 | <listitem><para>Fail the service if the network is not online |
92 | by the time the timeout elapses. A timeout of 0 disables the | |
93 | timeout. Defaults to 120 seconds. </para></listitem> | |
94 | </varlistentry> | |
8d6082e4 YW |
95 | |
96 | <varlistentry> | |
97 | <term><option>-q</option></term> | |
98 | <term><option>--quiet</option></term> | |
99 | ||
100 | <listitem><para>Suppress log messages.</para></listitem> | |
101 | </varlistentry> | |
102 | ||
103 | <xi:include href="standard-options.xml" xpointer="help" /> | |
104 | <xi:include href="standard-options.xml" xpointer="version" /> | |
798d3a52 ZJS |
105 | </variablelist> |
106 | </refsect1> | |
107 | ||
108 | <refsect1> | |
109 | <title>See Also</title> | |
110 | <para> | |
111 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
7cfcb252 | 112 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
8d6082e4 YW |
113 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
114 | <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
798d3a52 ZJS |
115 | </para> |
116 | </refsect1> | |
3a67e927 TG |
117 | |
118 | </refentry> |