man: update wait-online and RequiredForOnline= setting
This commit is contained in:
parent
f023184e6d
commit
8d6082e4dd
|
@ -6,7 +6,8 @@
|
||||||
SPDX-License-Identifier: LGPL-2.1+
|
SPDX-License-Identifier: LGPL-2.1+
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'>
|
<refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
|
|
||||||
<refentryinfo>
|
<refentryinfo>
|
||||||
<title>systemd-networkd-wait-online.service</title>
|
<title>systemd-networkd-wait-online.service</title>
|
||||||
|
@ -48,8 +49,8 @@
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><option>-i</option></term>
|
<term><option>-i</option> <replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term>
|
||||||
<term><option>--interface=</option></term>
|
<term><option>--interface=</option><replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term>
|
||||||
|
|
||||||
<listitem><para>Network interface to wait for before deciding
|
<listitem><para>Network interface to wait for before deciding
|
||||||
if the system is online. This is useful when a system has
|
if the system is online. This is useful when a system has
|
||||||
|
@ -57,21 +58,53 @@
|
||||||
one is necessary to access some network resources. This option
|
one is necessary to access some network resources. This option
|
||||||
may be used more than once to wait for multiple network
|
may be used more than once to wait for multiple network
|
||||||
interfaces. When used, all other interfaces are ignored.
|
interfaces. When used, all other interfaces are ignored.
|
||||||
|
Optinally, required minimum operational state can be
|
||||||
|
specified after a colon <literal>:</literal>. Please see
|
||||||
|
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||||
|
for possible operational states. If the operational state is not specified here, then
|
||||||
|
the value from <varname>RequiredForOnline=</varname> in the corresponding
|
||||||
|
<filename>.network</filename> file is used if present, and <literal>degraded</literal> otherwise.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><option>--ignore=</option></term>
|
<term><option>--ignore=</option><replaceable>INTERFACE</replaceable></term>
|
||||||
|
|
||||||
<listitem><para>Network interfaces to be ignored when deciding
|
<listitem><para>Network interfaces to be ignored when deciding
|
||||||
if the system is online. By default, only the loopback
|
if the system is online. By default, only the loopback
|
||||||
interface is ignored. This option may be used more than once
|
interface is ignored. This option may be used more than once
|
||||||
to ignore multiple network interfaces. </para></listitem>
|
to ignore multiple network interfaces. </para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><option>--timeout=</option></term>
|
<term><option>-o</option> <replaceable>OPERSTATE</replaceable></term>
|
||||||
|
<term><option>--operational-state=</option><replaceable>OPERSTATE</replaceable></term>
|
||||||
|
|
||||||
|
<listitem><para>Takes an operational state. Please see
|
||||||
|
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||||
|
for possible operational states. If set, the specified value overrides
|
||||||
|
<varname>RequiredForOnline=</varname> settings in <filename>.network</filename> files.
|
||||||
|
But this does not override operational states specified in <option>--interface</option> option.
|
||||||
|
</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>--timeout=</option> <replaceable>SECS</replaceable></term>
|
||||||
|
|
||||||
<listitem><para>Fail the service if the network is not online
|
<listitem><para>Fail the service if the network is not online
|
||||||
by the time the timeout elapses. A timeout of 0 disables the
|
by the time the timeout elapses. A timeout of 0 disables the
|
||||||
timeout. Defaults to 120 seconds. </para></listitem>
|
timeout. Defaults to 120 seconds. </para></listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>-q</option></term>
|
||||||
|
<term><option>--quiet</option></term>
|
||||||
|
|
||||||
|
<listitem><para>Suppress log messages.</para></listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
<xi:include href="standard-options.xml" xpointer="help" />
|
||||||
|
<xi:include href="standard-options.xml" xpointer="version" />
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
||||||
|
@ -80,7 +113,8 @@
|
||||||
<para>
|
<para>
|
||||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||||
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||||
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||||
|
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||||
</para>
|
</para>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
||||||
|
|
|
@ -255,15 +255,19 @@
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><varname>RequiredForOnline=</varname></term>
|
<term><varname>RequiredForOnline=</varname></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Takes a boolean. When <literal>yes</literal>, the network is deemed
|
<para>Takes a boolean or operational state. Please see
|
||||||
required when determining whether the system is online when running
|
<citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||||
<literal>systemd-networkd-wait-online</literal>.
|
for possible operational states. When <literal>yes</literal>, the network is deemed required when
|
||||||
When <literal>no</literal>, the network is ignored when checking for
|
determining whether the system is online when running
|
||||||
online state. Defaults to <literal>yes</literal>.</para>
|
<command>systemd-networkd-wait-online</command>. When <literal>no</literal>, the network is ignored
|
||||||
|
when checking for online state. When an operational state is set, <literal>yes</literal> is implied,
|
||||||
|
and this controls the operational state required for the network interface to be considered online.
|
||||||
|
Defaults to <literal>yes</literal>.</para>
|
||||||
|
|
||||||
<para>The network will be brought up normally in all cases, but in
|
<para>The network will be brought up normally in all cases, but in
|
||||||
the event that there is no address being assigned by DHCP or the
|
the event that there is no address being assigned by DHCP or the
|
||||||
cable is not plugged in, the link will simply remain offline and be
|
cable is not plugged in, the link will simply remain offline and be
|
||||||
skipped automatically by <literal>systemd-networkd-wait-online</literal>
|
skipped automatically by <command>systemd-networkd-wait-online</command>
|
||||||
if <literal>RequiredForOnline=no</literal>.</para>
|
if <literal>RequiredForOnline=no</literal>.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
Loading…
Reference in a new issue