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