about summary refs log tree commit diff
path: root/docs/api/html/nm-online.html
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2020-04-11 21:28:04 +0200
committerMichael Biebl <biebl@debian.org>2020-04-11 21:28:04 +0200
commit1e5977b62f896e844b548c3007ace9e1dfa7f9ed (patch)
tree7a7416ed410e72b6200f3d860fd315ec11cc106b /docs/api/html/nm-online.html
parentb012fa6e1d808e0736c009799c62d835cbfcc1dd (diff)
New upstream version 1.23.90 upstream/1.23.90
Diffstat (limited to 'docs/api/html/nm-online.html')
-rw-r--r--docs/api/html/nm-online.html46
1 files changed, 34 insertions, 12 deletions
diff --git a/docs/api/html/nm-online.html b/docs/api/html/nm-online.html
index bc91ee24..e84e865f 100644
--- a/docs/api/html/nm-online.html
+++ b/docs/api/html/nm-online.html
@@ -8,7 +8,7 @@
 <link rel="up" href="manpages.html" title="Part I. Manual Pages">
 <link rel="prev" href="nm-settings-ifcfg-rh.html" title="nm-settings-ifcfg-rh">
 <link rel="next" href="nm-initrd-generator.html" title="nm-initrd-generator">
-<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.32.1 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -39,12 +39,17 @@
     <span class="command"><strong>nm-online</strong></span> 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).</p>
-<p>By default NetworkManager waits for IPv4 dynamic addressing to complete
-    but does not wait for the <code class="literal">auto</code> IPv6 dynamic addressing. To
-    wait for IPv6 addressing to complete, either (1) change the network
-    connection's IPv6 <code class="literal">may-fail</code> setting to <code class="literal">no</code>,
-    and/or (2) change the IPv6 addressing method to <code class="literal">manual</code> or
-    <code class="literal">dhcp</code>, to indicate that IPv6 connectivity is expected.</p>
+<p>This tool is not very useful to call directly. It is however used by
+    <code class="literal">NetworkManager-wait-online.service</code> with
+    <code class="literal">--wait-for-startup</code> argument. This is used to delay
+    the service and indirectly <code class="literal">network-online.target</code>,
+    until networking is up. Don't order your own systemd services after
+    <code class="literal">NetworkManager-wait-online.service</code> directly. Instead
+    if necessary, order your services after <code class="literal">network-online.target</code>.
+    Even better is to have your services react to network changes dynamically
+    and don't order them with respect to <code class="literal">network-online.target</code>
+    at all.
+    </p>
 </div>
 <div class="refsect1">
 <a name="options"></a><h2>Options</h2>
@@ -64,13 +69,30 @@
 </tr>
 <tr>
 <td><p><span class="term">  <code class="option">-s</code>  |   <code class="option">--wait-for-startup</code>  </span></p></td>
-<td><p>Wait for NetworkManager startup to complete, rather than waiting for
+<td>
+<p>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 is
-          generally only useful at boot time; after startup has completed,
+          connection which is available given the current network state. This corresponds
+          to the moment when NetworkManager logs <code class="literal">"startup complete"</code>.
+          This mode is generally only useful at boot time. After startup has completed,
           <span class="command"><strong>nm-online -s</strong></span> will just return immediately, regardless of the
-          current network state.)</p></td>
+          current network state.</p>
+<p>There are various ways to affect when startup complete is reached.
+          For example, by setting a connection profile to autoconnect, such a profile
+          possibly will activate during startup and thus delay startup complete being reached.
+          Also, a profile is considered ready when it fully reached the logical <code class="literal">connected</code>
+          state in NetworkManager. That means, properties like <code class="literal">ipv4.may-fail</code> and <code class="literal">ipv6.may-fail</code>
+          affect whether a certain address family is required. Also, the connection property
+          <code class="literal">connection.wait-device-timeout</code> affects whether to wait for
+          the driver to detect a certain device. Generally, a failure of <code class="literal">NetworkManager-wait-online.service</code>
+          indicates a configuration error, where NetworkManager won't be able to reach the
+          desired connectivity state during startup. An example for that are bridge or bond master
+          profiles, that get autoconnected but without activating any slaves. Such master devices
+          hang in activating state indefinitely, and cause <code class="literal">NetworkManager-wait-online.service</code>
+          to fail.
+          </p>
+</td>
 </tr>
 <tr>
 <td><p><span class="term">
@@ -119,6 +141,6 @@
 </div>
 </div>
 <div class="footer">
-<hr>Generated by GTK-Doc V1.29</div>
+<hr>Generated by GTK-Doc V1.32.1</div>
 </body>
 </html>
\ No newline at end of file