man/systemd-networkd-wait-online.service.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-networkd-wait-online.service</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-networkd-wait-online.service</refentrytitle>
  16     <manvolnum>8</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-networkd-wait-online.service</refname>
  21     <refname>systemd-networkd-wait-online</refname>
  22     <refpurpose>Wait for network to come online</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <para><filename>systemd-networkd-wait-online.service</filename></para>
  27     <para><filename>/usr/lib/systemd/systemd-networkd-wait-online</filename></para>
  28   </refsynopsisdiv>
  29
  30   <refsect1>
  31     <title>Description</title>
  32
  33     <para><command>systemd-networkd-wait-online</command> is a
  34     oneshot system service (see <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>), that waits for the network to be
  35     configured. By default, it will wait for all links it is aware of
  36     and which are managed by
  37     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  38     to be fully configured or failed, and for at least one link to be online. Here, online means that
  39     the link's operational state is equal or higher than <literal>degraded</literal>. The threshold
  40     can be configured by <option>--operational-state=</option> option.</para>
  41   </refsect1>
  42
  43   <refsect1>
  44     <title>Options</title>
  45
  46     <para>The following options are understood:</para>
  47
  48     <variablelist>
  49       <varlistentry>
  50         <term><option>-i</option> <replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term>
  51         <term><option>--interface=</option><replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term>
  52
  53         <listitem><para>Network interface to wait for before deciding if the system is online. This
  54         is useful when a system has several interfaces which will be configured, but a particular
  55         one is necessary to access some network resources. When used, all other interfaces are ignored.
  56         This option may be used more than once to wait for multiple network interfaces. When this
  57         option is specified multiple times, then <command>systemd-networkd-wait-online</command> waits
  58         for all specified interfaces to be online. Optionally, required minimum operational state can be
  59         specified after a colon <literal>:</literal>. Please see
  60         <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  61         for possible operational states. If the operational state is not specified here, then
  62         the value from <varname>RequiredForOnline=</varname> in the corresponding
  63         <filename>.network</filename> file is used if present, and <literal>degraded</literal> otherwise.
  64         </para></listitem>
  65       </varlistentry>
  66
  67       <varlistentry>
  68         <term><option>--ignore=</option><replaceable>INTERFACE</replaceable></term>
  69
  70         <listitem><para>Network interfaces to be ignored when deciding
  71         if the system is online. By default, only the loopback
  72         interface is ignored. This option may be used more than once
  73         to ignore multiple network interfaces. </para></listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term><option>-o</option> <replaceable>OPERSTATE</replaceable></term>
  78         <term><option>--operational-state=</option><replaceable>OPERSTATE</replaceable></term>
  79
  80         <listitem><para>Takes an operational state. Please see
  81         <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  82         for possible operational states. If set, the specified value overrides
  83         <varname>RequiredForOnline=</varname> settings in <filename>.network</filename> files.
  84         But this does not override operational states specified in <option>--interface=</option> option.
  85         </para></listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term><option>--any</option></term>
  90
  91         <listitem><para>Even if several interfaces are in configuring state,
  92         <command>systemd-networkd-wait-online</command> exits with success when at least one interface
  93         becomes online. When this option is specified with <option>--interface=</option>, then
  94         <command>systemd-networkd-wait-online</command> waits for one of the specified interfaces to be
  95         online. This option is useful when some interfaces may not have carrier on boot.
  96         </para></listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><option>--timeout=</option> <replaceable>SECS</replaceable></term>
 101
 102         <listitem><para>Fail the service if the network is not online
 103         by the time the timeout elapses. A timeout of 0 disables the
 104         timeout. Defaults to 120 seconds. </para></listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term><option>-q</option></term>
 109         <term><option>--quiet</option></term>
 110
 111         <listitem><para>Suppress log messages.</para></listitem>
 112       </varlistentry>
 113
 114       <xi:include href="standard-options.xml" xpointer="help" />
 115       <xi:include href="standard-options.xml" xpointer="version" />
 116     </variablelist>
 117   </refsect1>
 118
 119   <refsect1>
 120     <title>See Also</title>
 121     <para>
 122       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 123       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 124       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 125       <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 126     </para>
 127   </refsect1>
 128
 129 </refentry>