mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-11-05 19:03:31 +00:00
180 lines
6.8 KiB
XML
180 lines
6.8 KiB
XML
<?xml version='1.0'?>
|
|
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % entities SYSTEM "common.ent" >
|
|
%entities;
|
|
]>
|
|
|
|
<!--
|
|
SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
|
|
|
|
nm-online(1) manual page
|
|
|
|
Copyright 2010 - 2016 Red Hat, Inc.
|
|
-->
|
|
|
|
<refentry id='nm-online'>
|
|
|
|
<refentryinfo>
|
|
<title>nm-online</title>
|
|
<author>NetworkManager developers</author>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>nm-online</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo class="source">NetworkManager</refmiscinfo>
|
|
<refmiscinfo class="manual">General Commands Manual</refmiscinfo>
|
|
<refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>nm-online</refname>
|
|
<refpurpose>ask NetworkManager whether the network is connected</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id='synopsis'>
|
|
<cmdsynopsis>
|
|
<command>nm-online</command>
|
|
<arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 id='description'><title>Description</title>
|
|
<para><command>nm-online</command> is a utility to find out whether we are
|
|
online. It is done by asking NetworkManager about its status. When run,
|
|
<command>nm-online</command> waits until NetworkManager reports an active
|
|
connection, or specified timeout expires. On exit, the returned status code
|
|
should be checked (see the return codes below).</para>
|
|
|
|
<para>This tool is not very useful to call directly. It is however used by
|
|
<literal>NetworkManager-wait-online.service</literal> with
|
|
<literal>--wait-for-startup</literal> argument
|
|
(see <link linkend='NetworkManager-wait-online.service'><citerefentry><refentrytitle>NetworkManager-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>).
|
|
</para>
|
|
|
|
<para>By default, connections have the <literal>ipv4.may-fail</literal> and
|
|
<literal>ipv6.may-fail</literal> properties set to <literal>yes</literal>;
|
|
this means that NetworkManager waits for one of the two address families to
|
|
complete configuration before considering the connection activated. If you
|
|
need a specific address family configured before
|
|
<literal>network-online.target</literal> is reached, set the corresponding
|
|
<literal>may-fail</literal> property to <literal>no</literal>.</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id='options'><title>Options</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><group choice='plain'>
|
|
<arg choice='plain'><option>-h</option></arg>
|
|
<arg choice='plain'><option>--help</option></arg>
|
|
</group></term>
|
|
|
|
<listitem>
|
|
<para>Print help information.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><group choice='plain'>
|
|
<arg choice='plain'><option>-q</option></arg>
|
|
<arg choice='plain'><option>--quiet</option></arg>
|
|
</group></term>
|
|
|
|
<listitem>
|
|
<para>Don't print anything.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><group choice='plain'>
|
|
<arg choice='plain'><option>-s</option></arg>
|
|
<arg choice='plain'><option>--wait-for-startup</option></arg>
|
|
</group></term>
|
|
|
|
<listitem>
|
|
<para>Wait for NetworkManager startup to complete, rather than waiting for
|
|
network connectivity specifically. Startup is considered complete once
|
|
NetworkManager has activated (or attempted to activate) every auto-activate
|
|
connection which is available given the current network state. This corresponds
|
|
to the moment when NetworkManager logs <literal>"startup complete"</literal>.
|
|
This mode is generally only useful at boot time. After startup has completed,
|
|
<command>nm-online -s</command> will just return immediately, regardless of the
|
|
current network state.</para>
|
|
<para>There are various ways to affect when startup complete is reached.
|
|
For details see
|
|
<link linkend='NetworkManager-wait-online.service'><citerefentry><refentrytitle>NetworkManager-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<group choice='plain'>
|
|
<arg choice='plain'><option>-t</option></arg>
|
|
<arg choice='plain'><option>--timeout</option></arg>
|
|
</group>
|
|
<arg choice='plain'><replaceable>seconds</replaceable></arg>
|
|
</term>
|
|
|
|
<listitem>
|
|
<para>Time to wait for a connection, in seconds. If the option is not provided,
|
|
the environment variable <literal>NM_ONLINE_TIMEOUT</literal> is honored.
|
|
The default timeout is 30 seconds.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
|
|
<varlistentry>
|
|
<term><group choice='plain'>
|
|
<arg choice='plain'><option>-x</option></arg>
|
|
<arg choice='plain'><option>--exit</option></arg>
|
|
</group></term>
|
|
|
|
<listitem>
|
|
<para>Exit immediately if NetworkManager is not running or connecting.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 id='exit_status'><title>Exit Status</title>
|
|
|
|
<para><command>nm-online</command> exits with status 0 if it succeeds, a value
|
|
greater than 0 is returned if an error occurs.</para>
|
|
|
|
<variablelist spacing='compact' termlength='3'>
|
|
<varlistentry>
|
|
<term><errorcode>0</errorcode></term>
|
|
<listitem>
|
|
<para>Success – already online or connection established within given timeout.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><errorcode>1</errorcode></term>
|
|
<listitem>
|
|
<para>Offline or not online within given timeout.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><errorcode>2</errorcode></term>
|
|
<listitem>
|
|
<para>Unknown or unspecified error.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 id='see_also'><title>See Also</title>
|
|
<para><link linkend='nmcli'><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
|
|
<link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>,
|
|
<link linkend='NetworkManager-wait-online.service'><citerefentry><refentrytitle>NetworkManager-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|