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   This file is part of systemd.
   7
   8   Copyright 2014 Tom Gundersen
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'>
  25
  26         <refentryinfo>
  27                 <title>systemd-networkd.service</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Tom</firstname>
  34                                 <surname>Gundersen</surname>
  35                                 <email>teg@jklm.no</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd-networkd-wait-online.service</refentrytitle>
  42                 <manvolnum>8</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd-networkd-wait-online.service</refname>
  47                 <refname>systemd-networkd-wait-online</refname>
  48                 <refpurpose>Wait for network to come online</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <para><filename>systemd-networkd-wait-online.service</filename></para>
  53                 <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>systemd-networkd-wait-online</command> is a
  60                 one-shot system service that waits for the network to be configured.
  61                 By default, it will wait for all links it is aware of and which are managed by
  62                 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  63                 to be fully configured or failed, and for at least one link to gain a
  64                 carrier.</para>
  65         </refsect1>
  66
  67         <refsect1>
  68                 <title>Options</title>
  69
  70                 <para>The following options are understood:</para>
  71
  72                 <variablelist>
  73                         <varlistentry>
  74                                 <term><option>-i</option></term>
  75                                 <term><option>--interface=</option></term>
  76
  77                                 <listitem><para>Network interface to wait for
  78                                 before deciding if the system is online. This is
  79                                 useful when a system has several interfaces which
  80                                 will be configured, but a particular one is necessary
  81                                 to access some network resources. This option may be
  82                                 used more than once to wait for multiple network
  83                                 interfaces.</para></listitem>
  84                         </varlistentry>
  85                         <varlistentry>
  86                                 <term><option>--ignore=</option></term>
  87                                 <listitem><para>Network interfaces to be ignored when
  88                                 deciding if the system is online. By default only
  89                                 the loopback interface is ignored. This option may be used
  90                                 more than once to ignore multiple network interfaces.
  91                                 </para></listitem>
  92                         </varlistentry>
  93                         <varlistentry>
  94                                 <term><option>--timeout=</option></term>
  95                                 <listitem><para>Fail the service if the network is not
  96                                 online by the time the timeout elapses. A timeout of 0
  97                                 disables the timeout. Defaults to 120 seconds.
  98                                 </para></listitem>
  99                         </varlistentry>
 100                 </variablelist>
 101         </refsect1>
 102
 103         <refsect1>
 104                 <title>See Also</title>
 105                 <para>
 106                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 107                         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 108                 </para>
 109         </refsect1>
 110
 111 </refentry>