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
  61     configured. By default, it will wait for all links it is aware of
  62     and which are managed by
  63     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  64     to be fully configured or failed, and for at least one link to
  65     gain a carrier.</para>
  66   </refsect1>
  67
  68   <refsect1>
  69     <title>Options</title>
  70
  71     <para>The following options are understood:</para>
  72
  73     <variablelist>
  74       <varlistentry>
  75         <term><option>-i</option></term>
  76         <term><option>--interface=</option></term>
  77
  78         <listitem><para>Network interface to wait for before deciding
  79         if the system is online. This is useful when a system has
  80         several interfaces which will be configured, but a particular
  81         one is necessary to access some network resources. This option
  82         may be 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 deciding
  88         if the system is online. By default only the loopback
  89         interface is ignored. This option may be used more than once
  90         to ignore multiple network interfaces. </para></listitem>
  91       </varlistentry>
  92       <varlistentry>
  93         <term><option>--timeout=</option></term>
  94         <listitem><para>Fail the service if the network is not online
  95         by the time the timeout elapses. A timeout of 0 disables the
  96         timeout. Defaults to 120 seconds. </para></listitem>
  97       </varlistentry>
  98     </variablelist>
  99   </refsect1>
 100
 101   <refsect1>
 102     <title>See Also</title>
 103     <para>
 104       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 105       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 106     </para>
 107   </refsect1>
 108
 109 </refentry>