summaryrefslogtreecommitdiff
path: root/man/systemd-networkd-wait-online.service.xml
blob: 83186b4e2cc666e28bc1c71e1fa9f8cd2f3a02c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  SPDX-License-Identifier: LGPL-2.1+

  This file is part of systemd.

  Copyright 2014 Tom Gundersen
-->

<refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'>

  <refentryinfo>
    <title>systemd-networkd.service</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Tom</firstname>
        <surname>Gundersen</surname>
        <email>teg@jklm.no</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-networkd-wait-online.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-networkd-wait-online.service</refname>
    <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>
    <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>systemd-networkd-wait-online</command> is a
    one-shot system service that waits for the network to be
    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>
    to be fully configured or failed, and for at least one link to
    gain a carrier.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term><option>-i</option></term>
        <term><option>--interface=</option></term>

        <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. This option
        may be used more than once to wait for multiple network
        interfaces. When used, all other interfaces are ignored.
        </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--ignore=</option></term>
        <listitem><para>Network interfaces to be ignored when deciding
        if the system is online. By default, only the loopback
        interface is ignored. This option may be used more than once
        to ignore multiple network interfaces. </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--timeout=</option></term>
        <listitem><para>Fail the service if the network is not online
        by the time the timeout elapses. A timeout of 0 disables the
        timeout. Defaults to 120 seconds. </para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>