man/systemd-networkd-wait-online.service.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7 -->
   8
   9 <refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'>
  10
  11   <refentryinfo>
  12     <title>systemd-networkd-wait-online.service</title>
  13     <productname>systemd</productname>
  14   </refentryinfo>
  15
  16   <refmeta>
  17     <refentrytitle>systemd-networkd-wait-online.service</refentrytitle>
  18     <manvolnum>8</manvolnum>
  19   </refmeta>
  20
  21   <refnamediv>
  22     <refname>systemd-networkd-wait-online.service</refname>
  23     <refname>systemd-networkd-wait-online</refname>
  24     <refpurpose>Wait for network to come online</refpurpose>
  25   </refnamediv>
  26
  27   <refsynopsisdiv>
  28     <para><filename>systemd-networkd-wait-online.service</filename></para>
  29     <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para>
  30   </refsynopsisdiv>
  31
  32   <refsect1>
  33     <title>Description</title>
  34
  35     <para><command>systemd-networkd-wait-online</command> is a
  36     oneshot system service (see <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>), that waits for the network to be
  37     configured. By default, it will wait for all links it is aware of
  38     and which are managed by
  39     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  40     to be fully configured or failed, and for at least one link to
  41     gain a carrier.</para>
  42   </refsect1>
  43
  44   <refsect1>
  45     <title>Options</title>
  46
  47     <para>The following options are understood:</para>
  48
  49     <variablelist>
  50       <varlistentry>
  51         <term><option>-i</option></term>
  52         <term><option>--interface=</option></term>
  53
  54         <listitem><para>Network interface to wait for before deciding
  55         if the system is online. This is useful when a system has
  56         several interfaces which will be configured, but a particular
  57         one is necessary to access some network resources. This option
  58         may be used more than once to wait for multiple network
  59         interfaces. When used, all other interfaces are ignored.
  60         </para></listitem>
  61       </varlistentry>
  62       <varlistentry>
  63         <term><option>--ignore=</option></term>
  64         <listitem><para>Network interfaces to be ignored when deciding
  65         if the system is online. By default, only the loopback
  66         interface is ignored. This option may be used more than once
  67         to ignore multiple network interfaces. </para></listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term><option>--timeout=</option></term>
  71         <listitem><para>Fail the service if the network is not online
  72         by the time the timeout elapses. A timeout of 0 disables the
  73         timeout. Defaults to 120 seconds. </para></listitem>
  74       </varlistentry>
  75     </variablelist>
  76   </refsect1>
  77
  78   <refsect1>
  79     <title>See Also</title>
  80     <para>
  81       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  82       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  83       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  84     </para>
  85   </refsect1>
  86
  87 </refentry>