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