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   Copyright 2014 Tom Gundersen
   9 -->
  10
  11 <refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'>
  12
  13   <refentryinfo>
  14     <title>systemd-networkd-wait-online.service</title>
  15     <productname>systemd</productname>
  16
  17     <authorgroup>
  18       <author>
  19         <contrib>Developer</contrib>
  20         <firstname>Tom</firstname>
  21         <surname>Gundersen</surname>
  22         <email>teg@jklm.no</email>
  23       </author>
  24     </authorgroup>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle>systemd-networkd-wait-online.service</refentrytitle>
  29     <manvolnum>8</manvolnum>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname>systemd-networkd-wait-online.service</refname>
  34     <refname>systemd-networkd-wait-online</refname>
  35     <refpurpose>Wait for network to come online</refpurpose>
  36   </refnamediv>
  37
  38   <refsynopsisdiv>
  39     <para><filename>systemd-networkd-wait-online.service</filename></para>
  40     <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para>
  41   </refsynopsisdiv>
  42
  43   <refsect1>
  44     <title>Description</title>
  45
  46     <para><command>systemd-networkd-wait-online</command> is a
  47     oneshot system service (see <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>), that waits for the network to be
  48     configured. By default, it will wait for all links it is aware of
  49     and which are managed by
  50     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  51     to be fully configured or failed, and for at least one link to
  52     gain a carrier.</para>
  53   </refsect1>
  54
  55   <refsect1>
  56     <title>Options</title>
  57
  58     <para>The following options are understood:</para>
  59
  60     <variablelist>
  61       <varlistentry>
  62         <term><option>-i</option></term>
  63         <term><option>--interface=</option></term>
  64
  65         <listitem><para>Network interface to wait for before deciding
  66         if the system is online. This is useful when a system has
  67         several interfaces which will be configured, but a particular
  68         one is necessary to access some network resources. This option
  69         may be used more than once to wait for multiple network
  70         interfaces. When used, all other interfaces are ignored.
  71         </para></listitem>
  72       </varlistentry>
  73       <varlistentry>
  74         <term><option>--ignore=</option></term>
  75         <listitem><para>Network interfaces to be ignored when deciding
  76         if the system is online. By default, only the loopback
  77         interface is ignored. This option may be used more than once
  78         to ignore multiple network interfaces. </para></listitem>
  79       </varlistentry>
  80       <varlistentry>
  81         <term><option>--timeout=</option></term>
  82         <listitem><para>Fail the service if the network is not online
  83         by the time the timeout elapses. A timeout of 0 disables the
  84         timeout. Defaults to 120 seconds. </para></listitem>
  85       </varlistentry>
  86     </variablelist>
  87   </refsect1>
  88
  89   <refsect1>
  90     <title>See Also</title>
  91     <para>
  92       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  94       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  95     </para>
  96   </refsect1>
  97
  98 </refentry>